Overview

The scroller provides a container that horizontally scrolls the content which are too large to fit within the visible area of the window or containing element.

Summarise it!

✨ This is an auto-generated AI summary of the ns-scroller's documentation. It may not be accurate. ✨

Examples

Standard

Use to display a list of items.

Configure

with action-links

Use to display a list of ns-action-link items.

Configure

with card

Use to display a list of ns-card items.

Configure

with image

Use to display a list of ns-image items.

Configure

Guidance

Do

• Use when there are 2 or more items
• Consider the position of the content. Items in the first few positions could be seen and interacted with more than those that are effectively hidden.
• Use the same type of content for the entire scroller, (eg. all ns-card components with images and direct CTAs).

Don't

• Use excessively long content. Users should not need to vertcially scroll in addition when horizontally scrolling.
• Idealy use more than 9 items in one ns-scroller to keep cognitive load manageable for the user (Hick’s law).
• Override with with custom CSS for aesthetics, as this can cause issues elsewhere and creates technical debt.
• Nest a ns-scroller within another.
• Use ns-scroller as a direct child of <main>

Standard

Key

Key	Field type	Guidelines
A	Heading	Introduces an single instance or group of ns-scroller components.
B	Controls	Helps the user navigate the list of items incrementally in both directions
C	Content items	A list of same type components such as ns-cards, for the user to choose from.

Implementation

Placement

The ns-scroller component can only be used as a child of the <ns-panel> element.

Specification

Attributes

hide-scrollbar

Property

hideScrollbar

Description

The toggle to display the scrollbar along the direction of the scroll.

Type

boolean

Default

false

show-control

Property

showControl

Description

The option to ahow the navigation controls of the scroller in specific viewport breakpoint.

Type

string

Options

always mobile desktop none

Default

always

type

Property

type

Type

string

Default

standard

Slots

Slot	Permitted tags	Description
heading	<h2> <h3>	The heading of the scroller that is releated the content within the scroller.
Anonymous slot	<ns-card> <ns-image> <ns-action-link>	The list of homogenous contents.

Events

Name	Description
scroll	Dispatched when the scrollbar is moved.
move-scroller	Dispatched when the navigation control buttons are clicked. The event detail holds the direction of the movement.

Figma

Please note: The ns-scroller Figma component configuration instructions are available only to members of the British Gas workspace who have access to the Nucleus Figma UI Kit.

Configuration instructions

(Opens in Figma).