vael-ui v0.3.10

Layout & Structure

ScrollArea

Install

import { ScrollArea } from 'vael-ui'

Playground

  • Item 1
  • Item 2
  • Item 3
  • Item 4
  • Item 5
  • Item 6
  • Item 7
  • Item 8
  • Item 9
  • Item 10
  • Item 11
  • Item 12
  • Item 13
  • Item 14
  • Item 15
  • Item 16
  • Item 17
  • Item 18
  • Item 19
  • Item 20
import { ScrollArea } from 'vael-ui'

<ScrollArea orientation="vertical" scrollFade :autoHide="false">ScrollArea</ScrollArea>

Props

NameTypeDefaultDescription
orientation"horizontal" | "vertical" | "both""vertical"
scrollFadeboolean | undefinedtrueMasks the scrolling edge(s) as content scrolls under them.
autoHideboolean | undefinedfalseScrollbar thumb is transparent until you hover/scroll the viewport (Chromium/WebKit only — `::-webkit-scrollbar-thumb` has no hover-reveal equivalent for Firefox's `scrollbar-color`, which always shows the thin thumb).
uiPartial<{ root: UiPartValue; viewport: UiPartValue; }> | undefined

Slots

NameTypeDescription
defaultany

Events

NameTypeDescription
scroll[event: Event]

Exposed

NameTypeDescription
elHTMLElement | null
viewportElHTMLElement | null
scrollTopnumber
scrollLeftnumber
atTopboolean
atBottomboolean
atStartboolean
atEndboolean
isScrollingbooleanTrue while a scroll (including native momentum/rubber-band settling) is in flight.
directions{ left: boolean; right: boolean; top: boolean; bottom: boolean; }
scrollTo(options: ScrollToOptions) => void
scrollToTop(options?: Omit<ScrollToOptions, "top"> | undefined) => void
scrollToBottom(options?: Omit<ScrollToOptions, "top"> | undefined) => void
scrollToStart(options?: Omit<ScrollToOptions, "left"> | undefined) => void
scrollToEnd(options?: Omit<ScrollToOptions, "left"> | undefined) => void