Overflow

A scrollable container with gradient shadow indicators that show when there is more content to scroll to. Supports both vertical and horizontal scrolling.

Source
avatar
dolanske
avatar
Jokler
avatar
zealsprince
avatar
kilmanio

Props

NameDefaultType
horizontalboolean
Use horizontal scrolling instead of vertical
hideScrollbarboolean
Hides the scrollbar and removes the scrollbar gutter padding
hideShadowsboolean
Hides the gradient shadows indicating more scrollable content
snapboolean
Enables scroll-snap so items snap into place when scrolling stops

Slots

NameAcceptsDescription
defaultanyThe scrollable content

Tokens

CSS variable tokens used for global or per-instance manipulation of certain styling.

TokenDefaultDescription
--vui-overflow-gutter-size8pxScrollbar gutter width
--vui-overflow-shadow-size32pxEdge fade shadow size
--vui-overflow-shadow-colorvar(--color-bg)Edge fade shadow color

Exposes

When queried via useTemplateRef, this component exposes

NameTypeUsage
contentRefTemplateRefForwards the ref for the internal overflow content element.