Skip to main content

ns-column

Introduction#

Brings flexibility and control to responsive layouts.

Allows the user interface to be split into multiple columns by defining the number of columns required at specific viewports.

Note: This is used for arranging components and content not multiple columns like you would see in a newspaper or magazine.

Best practice#

๐Ÿ’š Do's๐Ÿ’” Don'ts
Pick the number of columns to complement the contentHave complicated column structures, try to simplify your content first
Test the full responsive range of your page's and not just the defined viewportsUse in components that are too small to support multiple components
Try to stick to one column as much as possibleUse to put components in columns that are designed to be standalone or stack (e.g multiple ns-highlighers or ns-accordions)
Try to avoid having widowed itemsUse to create newspaper style columns and layouts
Use multiple columns when the user needs to compare items
Use the ratio options to add side panels
When using ratios put the primary page content in the largest column

Considerations of best practice#

Some components (e.g. ns-cta) have a minimum width, care should be taken so that these components don't overflow the columns.

Usage#

View example on Storybook

Component placement#

The ns-column component can be used in the following components:

Note: only used in ns-inputter to control the layout of ns-selector

Specification#

AttributeTypeDefaultOptionsDescription
basketballcourtnumber11, 2The number of columns to show at the Basketball Court viewport
hockeypitchnumberinherit1, 2, 3, 1:2, 2:1The number of columns to show at the Hockey Pitch viewport
rugbypitchnumberinherit1, 2, 3, 4, 1:2, 2:1, 1:3, 3:1The number of columns to show at the Rugby Pitch viewport
footballpitchnumberinherit1, 2, 3, 4, 1:2, 2:1, 1:3, 3:1The number of columns to show at the Football Pitch viewport
polofieldnumberinherit1, 2, 3, 4, 1:2, 2:1, 1:3, 3:1The number of columns to show at the Polo Field viewport

Specification notes#

How do viewports inherit values?#

Each value is applied at that viewpoint and each larger viewport unless the larger viewport has a column value applied.

Examples#

Setting 2 columns for every viewport larger than basketball court#
<ns-column basketballcourt="2"></ns-column>
Going from 1 column to 3 columns at a larger viewport#
<ns-column hockeypitch="3"></ns-column>
Going from 1 to 2 columns and then 4 columns#
<ns-column hockeypitch="2" rugbypitch="4"></ns-column>
Going from 2 columns, to 4 columns, and back down to 3 columns#
<ns-column basketballcourt="2" rugbypitch="4" polofield="3"></ns-column>
Going from 1 columns to 2:1 columns and then 3:1 columns#
<ns-column hockeypitch="2:1" polofield="3:1"></ns-column>

How do the 2:1, 3:1 columns work?#

If you want to have width ratios that make for a different width for your columns, you can set the value to 1:2, 2:1, 1:3, and 3:1. The first value will apply to the width of all odd child elements, and the second to all child even elements.

Example#

If we take the example of a 2:1 column, it essentially means that all odd child elements have a width of 2 and all even child elements have a width of 1.

This is how your markup would look like:

<ns-column hockeypitch="2:1">
<div>
this will have width of 2
</div>
<div>
this will have width of 1
</div>
</ns-column>

Design Tokens

You can change the branded look and feel of the ns-column by modifying these options in the design tokens.

Read more about design tokens in our getting started guide.

{
  "gutter": {
    "squash-court": "1.5rem",
    "basketball-court": "1.75rem",
    "hockey-pitch": "2rem"
  }
}

Feedback#

  • Do you have insights or concerns to share? You can raise an issue via Github bugs.
  • See all the issues already raised via Github issues.

๐Ÿ’ฉ ๐ŸŽ‰ ๐Ÿฆ„ You can also contact the team on Slack on the #product-nucleus channel!

Related links#