@base-ui-components/react/scroll-area/scrollbar/ScrollAreaScrollbar.d.ts

Base UI is a library of headless ('unstyled') React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.

import * as React from 'react';
import type { BaseUIComponentProps } from "../../utils/types.js";
import type { ScrollAreaRoot } from "../root/ScrollAreaRoot.js";
/**
 * A vertical or horizontal scrollbar for the scroll area.
 * Renders a `<div>` element.
 *
 * Documentation: [Base UI Scroll Area](https://base-ui.com/react/components/scroll-area)
 */
export declare const ScrollAreaScrollbar: React.ForwardRefExoticComponent<ScrollAreaScrollbarProps & React.RefAttributes<HTMLDivElement>>;
export interface ScrollAreaScrollbarState extends ScrollAreaRoot.State {
  /** Whether the scroll area is being hovered. */
  hovering: boolean;
  /** Whether the scroll area is being scrolled. */
  scrolling: boolean;
  /** The orientation of the scrollbar. */
  orientation: 'vertical' | 'horizontal';
}
export interface ScrollAreaScrollbarProps extends BaseUIComponentProps<'div', ScrollAreaScrollbar.State> {
  /**
   * Whether the scrollbar controls vertical or horizontal scroll.
   * @default 'vertical'
   */
  orientation?: 'vertical' | 'horizontal';
  /**
   * Whether to keep the HTML element in the DOM when the viewport isn’t scrollable.
   * @default false
   */
  keepMounted?: boolean;
}
export declare namespace ScrollAreaScrollbar {
  type State = ScrollAreaScrollbarState;
  type Props = ScrollAreaScrollbarProps;
}