Scroll Area

GitHubnpm
Augments native scroll functionality for custom, cross-browser styling.

ScrollArea

Tags
v1.2.0-beta.50
v1.2.0-beta.49
v1.2.0-beta.48
v1.2.0-beta.47
v1.2.0-beta.46
v1.2.0-beta.45
v1.2.0-beta.44
v1.2.0-beta.43
v1.2.0-beta.42
v1.2.0-beta.41
v1.2.0-beta.40
v1.2.0-beta.39
v1.2.0-beta.38
v1.2.0-beta.37
v1.2.0-beta.36
v1.2.0-beta.35
v1.2.0-beta.34
v1.2.0-beta.33
v1.2.0-beta.32
v1.2.0-beta.31
v1.2.0-beta.30
v1.2.0-beta.29
v1.2.0-beta.28
v1.2.0-beta.27
v1.2.0-beta.26
v1.2.0-beta.25
v1.2.0-beta.24
v1.2.0-beta.23
v1.2.0-beta.22
v1.2.0-beta.21
v1.2.0-beta.20
v1.2.0-beta.19
v1.2.0-beta.18
v1.2.0-beta.17
v1.2.0-beta.16
v1.2.0-beta.15
v1.2.0-beta.14
v1.2.0-beta.13
v1.2.0-beta.12
v1.2.0-beta.11
v1.2.0-beta.10
v1.2.0-beta.9
v1.2.0-beta.8
v1.2.0-beta.7
v1.2.0-beta.6
v1.2.0-beta.5
v1.2.0-beta.4
v1.2.0-beta.3
v1.2.0-beta.2
v1.2.0-beta.1
<script setup lang="ts">
import { ScrollAreaRoot, ScrollAreaScrollbar, ScrollAreaThumb, ScrollAreaViewport } from 'akar';
import './styles.css';

const tags = Array.from({ length: 50 }).map((_, i, a) => `v1.2.0-beta.${a.length - i}`);
</script>

<template>
  <div class="akar-demo akar-demo-ScrollArea">
    <ScrollAreaRoot
      class="ScrollAreaRoot"
      style="--scrollbar-size: 10px"
    >
      <ScrollAreaViewport class="ScrollAreaViewport">
        <div :style="{ padding: '15px 20px' }">
          <div class="Text">
            Tags
          </div>
          <div
            v-for="tag in tags"
            :key="tag"
            class="Tag"
          >
            {{ tag }}
          </div>
        </div>
      </ScrollAreaViewport>
      <ScrollAreaScrollbar
        class="ScrollAreaScrollbar"
        orientation="vertical"
      >
        <ScrollAreaThumb
          class="ScrollAreaThumb"
        />
      </ScrollAreaScrollbar>
      <ScrollAreaScrollbar
        class="ScrollAreaScrollbar"
        orientation="horizontal"
      >
        <ScrollAreaThumb
          class="ScrollAreaThumb"
        />
      </ScrollAreaScrollbar>
    </ScrollAreaRoot>
  </div>
</template>

Features

  • Scrollbar sits on top of the scrollable content, taking up no space.
  • Scrolling is native; no underlying position movements via CSS transformations.
  • Shims pointer behaviors only when interacting with the controls, so keyboard controls are unaffected.
  • Supports Right to Left direction.

Installation

Install the component from your command line.

pnpm add akar

Anatomy

Import all parts and piece them together.

<script setup>
import { ScrollAreaRoot, ScrollAreaScrollbar, ScrollAreaThumb, ScrollAreaViewport } from 'akar';
</script>

<template>
  <ScrollAreaRoot>
    <ScrollAreaViewport />
    <ScrollAreaScrollbar orientation="horizontal">
      <ScrollAreaThumb />
    </ScrollAreaScrollbar>
    <ScrollAreaScrollbar orientation="vertical">
      <ScrollAreaThumb />
    </ScrollAreaScrollbar>
    <ScrollAreaCorner />
  </ScrollAreaRoot>
</template>

API Reference

Root

Contains all the parts of a scroll area.

PropDefaultType
as
"div"
AsTag | Component

The element or component this component should render as. Can be overwritten by asChild.

asChild
boolean

Change the default rendered element for the one passed as a child, merging their props and behavior.

Read our Composition guide for more details.

dir
"ltr" | "rtl"

The reading direction of the combobox when applicable.

If omitted, inherits globally from ConfigProvider or assumes LTR (left-to-right) reading mode.

scrollHideDelay
600
number

If type is set to either scroll or hover, this prop determines the length of time, in milliseconds,

before the scrollbars are hidden after the user stops interacting with scrollbars.

type
"hover"
"scroll" | "always" | "hover" | "auto" | "glimpse"

Describes the nature of scrollbar visibility, similar to how the scrollbar preferences in MacOS control visibility of native scrollbars.

auto - means that scrollbars are visible when content is overflowing on the corresponding orientation.

always - means that scrollbars are always visible regardless of whether the content is overflowing.

scroll - means that scrollbars are visible when the user is scrolling along its corresponding orientation.

hover - when the user is scrolling along its corresponding orientation and when the user is hovering over the scroll area.

glimpse - a hybrid approach that briefly shows scrollbars when the user enters the scroll area, then hides them until further interaction.

MethodType
scrollTop
() => void

Scroll viewport to top

scrollTopLeft
() => void

Scroll viewport to top-left

ScrollAreaRoot.vue source

Viewport

The viewport area of the scroll area.

PropDefaultType
as
"div"
AsTag | Component

The element or component this component should render as. Can be overwritten by asChild.

asChild
boolean

Change the default rendered element for the one passed as a child, merging their props and behavior.

Read our Composition guide for more details.

nonce
string

Will add nonce attribute to the style tag which can be used by Content Security Policy.

If omitted, inherits globally from ConfigProvider.

ScrollAreaViewport.vue source

Scrollbar

The vertical scrollbar. Add a second Scrollbar with an orientation prop to enable horizontal scrolling.

Defer mounting with forceMount / Presence. See the animation guide.
PropDefaultType
as
"div"
AsTag | Component

The element or component this component should render as. Can be overwritten by asChild.

asChild
boolean

Change the default rendered element for the one passed as a child, merging their props and behavior.

Read our Composition guide for more details.

forceMount
boolean

Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.

orientation
"vertical"
"vertical" | "horizontal"

The orientation of the scrollbar

ScrollAreaScrollbar.vue source

Data attribute Value
[data-state]
"visible" | "hidden"
[data-orientation]
"vertical" | "horizontal"

Thumb

The thumb to be used in ScrollAreaScrollbar.

PropDefaultType
as
"div"
AsTag | Component

The element or component this component should render as. Can be overwritten by asChild.

asChild
boolean

Change the default rendered element for the one passed as a child, merging their props and behavior.

Read our Composition guide for more details.

ScrollAreaThumb.vue source

Data attribute Value
[data-state]
"visible" | "hidden"

Corner

The corner where both vertical and horizontal scrollbars meet.

PropDefaultType
as
"div"
AsTag | Component

The element or component this component should render as. Can be overwritten by asChild.

asChild
boolean

Change the default rendered element for the one passed as a child, merging their props and behavior.

Read our Composition guide for more details.

ScrollAreaCorner.vue source

Examples

Custom Scroll

Use the exposed viewport to modify / or set the scroll position outside default methods

<script setup lang="ts">
import { ScrollAreaRoot, ScrollAreaScrollbar, ScrollAreaThumb, ScrollAreaViewport } from 'akar'

const scrollArea = useTemplateRef('scrollArea')
function scrollToBottom() {
  const viewport = scrollArea.value?.viewport
  if (viewport) {
    const top = scrollArea.value?.$el.scrollHeight
    viewport.scrollTo({
      top,
      behavior: 'smooth'
    })
  }
}
</script>

<template>
  <ScrollAreaRoot ref="scrollArea">
    <ScrollAreaViewport />
    <ScrollAreaScrollbar orientation="horizontal">
      <ScrollAreaThumb />
    </ScrollAreaScrollbar>
    <ScrollAreaScrollbar orientation="vertical">
      <ScrollAreaThumb />
    </ScrollAreaScrollbar>
    <ScrollAreaCorner />
  </ScrollAreaRoot>
</template>

Accessibility

In most cases, it's best to rely on native scrolling and work with the customization options available in CSS. When that isn't enough, ScrollArea provides additional customizability while maintaining the browser's native scroll behavior (as well as accessibility features, like keyboard scrolling).

Keyboard Interactions

Scrolling via keyboard is supported by default because the component relies on native scrolling. Specific keyboard interactions may differ between platforms, so we do not specify them here or add specific event listeners to handle scrolling via key events.