Skip to content

Scroll Area ​

Loading...

<flint-scroll-bar> ​

Custom overlay scrollbar. Place inside flint-scroll-area with slot="scrollbar" for an explicit horizontal or second-axis bar.

  • Tag: <flint-scroll-bar>
  • Class: FlintScrollBar

Import ​

ts
import '@getufy/flint-ui'; // auto-registers all
// or
import { FlintScrollBar } from '@getufy/flint-ui';

Usage ​

html
<flint-scroll-bar></flint-scroll-bar>

Properties ​

PropertyAttributeTypeDefaultDescription
orientationorientationOrientation'vertical'Which axis this scrollbar controls. Reflects to attribute.

Slots ​

NameDescription
—none (fully shadow DOM)

CSS Parts ​

NameDescription
thumbThe thumb/handle element.
trackThe track element.

CSS Custom Properties ​

PropertyDefault
--flint-scrollbar-size—
--flint-scrollbar-thumb-color—
--flint-scrollbar-thumb-hover-color—
--flint-scrollbar-thumb-radius—
--flint-scrollbar-track-color—

Methods ​

MethodDescription
setThumb(pos: number, size: number): voidPush updated thumb geometry from the parent scroll area.
setVisible(visible: boolean): voidShow or hide the scrollbar (parent controls visibility).

<flint-scroll-area> ​

Augments native scroll with custom, cross-browser overlay scrollbars. Native scrollbars are hidden; lightweight custom thumbs are rendered in shadow DOM and synced to the viewport via scroll + ResizeObserver events.

  • Tag: <flint-scroll-area>
  • Class: FlintScrollArea

Import ​

ts
import '@getufy/flint-ui'; // auto-registers all
// or
import { FlintScrollArea } from '@getufy/flint-ui';

Usage ​

html
<flint-scroll-area></flint-scroll-area>

Properties ​

PropertyAttributeTypeDefaultDescription
typetype'auto' | 'always' | 'scroll' | 'hover''hover'Controls when the scrollbars appear.
dirdir'ltr' | 'rtl''ltr'Text direction. 'rtl' flips the vertical bar to the left side.

Slots ​

NameDescription
(default)Scrollable content.
scrollbarOptional explicit flint-scroll-bar elements (e.g. horizontal).

CSS Parts ​

NameDescription
baseThe component's base wrapper element.
viewportThe viewport element.
thumbThe default scrollbar thumb element.

CSS Custom Properties ​

PropertyDefault
--flint-scrollbar-size—
--flint-scrollbar-thumb-color—
--flint-scrollbar-thumb-hover-color—
--flint-scrollbar-thumb-radius—
--flint-scrollbar-track-color—

Methods ​

MethodDescription
scrollTo(options: ScrollToOptions): voidScroll the viewport to a position.
scrollTo(x: number, y: number): void
scrollTo(optionsOrX: ScrollToOptions | number, y: number): void
scrollBy(options: ScrollToOptions): voidScroll the viewport by a relative amount.
scrollBy(x: number, y: number): void
scrollBy(optionsOrX: ScrollToOptions | number, y: number): void