Responsive Layout

Responsive-layout allows you to declare layout structures that will only be rendered in a specific screen-size breakpoint.

{"base64":" ","img":{"width":2840,"height":1428,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":1208072,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-responsive-layout-0.gif"}}

There are four blocks defined and exported by this app:

responsive-layout.desktop
responsive-layout.mobile
responsive-layout.tablet
responsive-layout.phone

Each of them have composition: children, which means that they expect to receive an array of children blocks to be rendered by them, if the current screen-size is right for their breakpoint.

Configuration

Import the Responsive Layout app to your theme's dependencies on the manifest.json, for example:

  "dependencies: {
    "vtex.responsive-layout": "0.x"
  }

Add the responsive-layout block into your theme. Here's an example:

  "store.custom#about-us": {
    "blocks": [
      "responsive-layout.desktop",
      "responsive-layout.tablet",
      "responsive-layout.phone"
    ]
  },
  
  "responsive-layout.desktop": {
    "children": ["rich-text#desktop"]
  },
  "responsive-layout.tablet": {
    "children": ["rich-text#tablet"]
  },
  "responsive-layout.phone": {
    "children": ["rich-text#phone"]
  },

  "rich-text#desktop": {
    "props": {
      "text": "# This will only show up on desktop.",
      "blockClass": "title"
    }
  },
  "rich-text#tablet": {
    "props": {
      "text": "# This will only show up on tablet.",
      "blockClass": "title"
    }
  },
  "rich-text#phone": {
    "props": {
      "text": "# This will only show up on phone.",
      "blockClass": "title"
    }
  },

Notice that you could use any array of blocks as children, given that they are allowed by the block that is directly above your responsive-layout.