Askr documentation
Generated API snapshot

@askrjs/ui/scroll-area

Exports from the declarations published in @askrjs/ui. Signatures reflect the published artifact.

Exports

This entrypoint publishes 13 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

ScrollAreatype

ScrollArea: { (props: ScrollAreaProps): JSX.Element; (props: ScrollAreaAsChildProps): JSX.Element; }

Renders a part of `scroll-area`.

ScrollAreaAsChildPropstype

ScrollAreaAsChildProps: ScrollAreaOwnProps & {
  asChild: true;
  children: JSX.Element;
}

Props for the `asChild` (polymorphic) rendering of Scroll Area.

asChild
asChild: true;
children
children: JSX.Element;
id
id?: string | undefined;

ScrollAreaCornertype

ScrollAreaCorner: (props: ScrollAreaCornerProps) => JSX.Element

Renders the `scroll-area-corner` part of `scroll-area`.

ScrollAreaCornerPropstype

ScrollAreaCornerProps: BoxProps<'div', HTMLDivElement>

Props for Scroll Area Corner.

asChild
asChild?: false | undefined;
children
children?: unknown;
ref
ref?: Ref<HTMLDivElement>;

ScrollAreaOwnPropstype

ScrollAreaOwnProps: {
  children?: unknown;
  id?: string;
}

Own props for Scroll Area, before merging with native element attributes.

children
children?: unknown;
id
id?: string | undefined;

ScrollAreaPropstype

ScrollAreaProps: ScrollAreaOwnProps

Props for Scroll Area.

children
children?: unknown;
id
id?: string | undefined;

ScrollAreaScrollbartype

ScrollAreaScrollbar: (props: ScrollAreaScrollbarProps) => JSX.Element

Renders the `scroll-area-scrollbar` part of `scroll-area` with `role="scrollbar"`.

ScrollAreaScrollbarPropstype

ScrollAreaScrollbarProps: BoxProps<'div', HTMLDivElement> & {
  orientation?: 'vertical' | 'horizontal';
}

Props for Scroll Area Scrollbar.

asChild
asChild?: false | undefined;
children
children?: unknown;
orientation
orientation?: "vertical" | "horizontal" | undefined;
ref
ref?: Ref<HTMLDivElement>;

ScrollAreaThumbtype

ScrollAreaThumb: (props: ScrollAreaThumbProps) => JSX.Element

Renders the `scroll-area-thumb` part of `scroll-area`.

ScrollAreaThumbPropstype

ScrollAreaThumbProps: BoxProps<'div', HTMLDivElement>

Props for Scroll Area Thumb.

asChild
asChild?: false | undefined;
children
children?: unknown;
ref
ref?: Ref<HTMLDivElement>;

ScrollAreaViewporttype

ScrollAreaViewport: { (props: ScrollAreaViewportProps): JSX.Element; (props: ScrollAreaViewportAsChildProps): JSX.Element; }

Renders a part of `scroll-area`.

ScrollAreaViewportAsChildPropstype

ScrollAreaViewportAsChildProps: BoxAsChildProps

Props for the `asChild` (polymorphic) rendering of Scroll Area Viewport.

asChild
asChild: true;
children
children: JSXElement;
ref
ref?: Ref<Element>;

ScrollAreaViewportPropstype

ScrollAreaViewportProps: BoxProps<'div', HTMLDivElement>

Props for Scroll Area Viewport.

asChild
asChild?: false | undefined;
children
children?: unknown;
ref
ref?: Ref<HTMLDivElement>;