Skip to content
WebJs
Menu

Scroll Area

Augments native scroll functionality with custom, cross-browser styling.

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
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { scrollAreaClass } from '#components/ui/scroll-area.ts';
import { separatorClass } from '#components/ui/separator.ts';

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

export default function ScrollAreaDemo() {
  return html`
    <div data-slot="scroll-area" tabindex="0" role="region" aria-label="Tags" class=${cn(scrollAreaClass(), 'h-72 w-48 rounded-md border')}>
      <div class="p-4">
        <h4 class="mb-4 text-sm leading-none font-medium">Tags</h4>
        ${tags.map((tag) => html`
          <div class="text-sm">${tag}</div>
          <div role="none" data-slot="separator" data-orientation="horizontal" class=${cn(separatorClass(), 'my-2')}></div>
        `)}
      </div>
    </div>
  `;
}
View Code

Installation

pnpm dlx @webjsdev/ui add scroll-area

Usage

import { scrollAreaClass } from '#components/ui/scroll-area.ts';
import { cn } from '#lib/utils/cn.ts';
<div
  tabindex="0"
  role="region"
  aria-label="Release notes"
  class=${cn(scrollAreaClass(), 'h-[200px] w-[350px] rounded-md border p-4')}
>
  Your scrollable content here.
</div>

Composition

A scroll area is one element. The kit styles the browser's own scrollbar rather than drawing a ScrollBar part, so native scrolling, momentum and keyboard scrolling keep working:

div (scrollAreaClass)
└── your content

Horizontal

Use scrollAreaClass({ orientation: 'horizontal' }) for horizontal scrolling.

Photo by Ornella Binni
Photo by Ornella Binni
Photo by Tom Byrom
Photo by Tom Byrom
Photo by Vladimir Malyavko
Photo by Vladimir Malyavko
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { scrollAreaClass } from '#components/ui/scroll-area.ts';

export interface Artwork {
  artist: string;
  art: string;
}

export const works: Artwork[] = [
  {
    artist: 'Ornella Binni',
    art: 'https://images.unsplash.com/photo-1465869185982-5a1a7522cbcb?auto=format&fit=crop&w=300&q=80',
  },
  {
    artist: 'Tom Byrom',
    art: 'https://images.unsplash.com/photo-1548516173-3cabfa4607e9?auto=format&fit=crop&w=300&q=80',
  },
  {
    artist: 'Vladimir Malyavko',
    art: 'https://images.unsplash.com/photo-1494337480532-3725c85fd2ab?auto=format&fit=crop&w=300&q=80',
  },
];

export default function ScrollAreaHorizontalDemo() {
  return html`
    <div data-slot="scroll-area" tabindex="0" role="region" aria-label="Artwork" class=${cn(scrollAreaClass({ orientation: 'horizontal' }), 'w-96 rounded-md border whitespace-nowrap')}>
      <div class="flex w-max space-x-4 p-4">
        ${works.map((artwork) => html`
          <figure class="shrink-0">
            <div class="overflow-hidden rounded-md">
              <img
                src=${artwork.art}
                alt=${`Photo by ${artwork.artist}`}
                class="aspect-[3/4] h-fit w-fit object-cover"
                width="300"
                height="400"
              >
            </div>
            <figcaption class="pt-2 text-xs text-muted-foreground">
              Photo by
              <span class="font-semibold text-foreground">${artwork.artist}</span>
            </figcaption>
          </figure>
        `)}
      </div>
    </div>
  `;
}
View Code

RTL

To enable RTL support, see the RTL configuration guide.

العلامات

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
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { scrollAreaClass } from '#components/ui/scroll-area.ts';
import { separatorClass } from '#components/ui/separator.ts';

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

const translations = {
  en: {
    dir: 'ltr',
    values: {
      tags: 'Tags',
    },
  },
  ar: {
    dir: 'rtl',
    values: {
      tags: 'العلامات',
    },
  },
  he: {
    dir: 'rtl',
    values: {
      tags: 'תגיות',
    },
  },
};

export default function ScrollAreaRtl() {
  const lang = 'ar';
  const { dir, values: t } = translations[lang];

  return html`
    <div data-slot="scroll-area" tabindex="0" role="region" aria-label=${t.tags} dir=${dir} lang=${lang} class=${cn(scrollAreaClass(), 'h-72 w-48 rounded-md border')}>
      <div class="p-4">
        <h4 class="mb-4 text-sm leading-none font-medium">${t.tags}</h4>
        ${tags.map((tag) => html`
          <div class="text-sm">${tag}</div>
          <div role="none" data-slot="separator" data-orientation="horizontal" class=${cn(separatorClass(), 'my-2')}></div>
        `)}
      </div>
    </div>
  `;
}
View Code

API Reference

scrollAreaClass

scrollAreaClass() returns the classes for the scrolling region: native overflow on the chosen axis, a thin scrollbar in the theme's border colour, and a focus ring. Give the element a size so it has something to scroll inside, and tabindex="0", role="region" and an aria-label so a keyboard can reach it and a screen reader can name it.

OptionTypeDefault
orientation"vertical" | "horizontal" | "both""vertical"