@base-ui-components/react
Version:
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.
87 lines (85 loc) • 3.26 kB
JavaScript
'use client';
import * as React from 'react';
import PropTypes from 'prop-types';
import { useComponentRenderer } from '../../utils/useComponentRenderer.js';
import { useScrollAreaRootContext } from '../root/ScrollAreaRootContext.js';
import { useForkRef } from '../../utils/useForkRef.js';
import { mergeReactProps } from '../../utils/mergeReactProps.js';
import { useScrollAreaScrollbarContext } from '../scrollbar/ScrollAreaScrollbarContext.js';
import { ScrollAreaScrollbarCssVars } from '../scrollbar/ScrollAreaScrollbarCssVars.js';
/**
* The draggable part of the the scrollbar that indicates the current scroll position.
* Renders a `<div>` element.
*
* Documentation: [Base UI Scroll Area](https://base-ui.com/react/components/scroll-area)
*/
const ScrollAreaThumb = /*#__PURE__*/React.forwardRef(function ScrollAreaThumb(props, forwardedRef) {
const {
render,
className,
...otherProps
} = props;
const {
thumbYRef,
thumbXRef,
handlePointerDown,
handlePointerMove,
handlePointerUp,
setScrolling
} = useScrollAreaRootContext();
const {
orientation
} = useScrollAreaScrollbarContext();
const mergedRef = useForkRef(forwardedRef, orientation === 'vertical' ? thumbYRef : thumbXRef);
const state = React.useMemo(() => ({
orientation
}), [orientation]);
const {
renderElement
} = useComponentRenderer({
render: render ?? 'div',
ref: mergedRef,
className,
state,
extraProps: mergeReactProps(otherProps, {
onPointerDown: handlePointerDown,
onPointerMove: handlePointerMove,
onPointerUp(event) {
setScrolling(false);
handlePointerUp(event);
},
style: {
...(orientation === 'vertical' && {
height: `var(${ScrollAreaScrollbarCssVars.scrollAreaThumbHeight})`
}),
...(orientation === 'horizontal' && {
width: `var(${ScrollAreaScrollbarCssVars.scrollAreaThumbWidth})`
})
}
})
});
return renderElement();
});
process.env.NODE_ENV !== "production" ? ScrollAreaThumb.propTypes /* remove-proptypes */ = {
// ┌────────────────────────────── Warning ──────────────────────────────┐
// │ These PropTypes are generated from the TypeScript type definitions. │
// │ To update them, edit the TypeScript types and run `pnpm proptypes`. │
// └─────────────────────────────────────────────────────────────────────┘
/**
* @ignore
*/
children: PropTypes.node,
/**
* CSS class applied to the element, or a function that
* returns a class based on the component’s state.
*/
className: PropTypes.oneOfType([PropTypes.func, PropTypes.string]),
/**
* Allows you to replace the component’s HTML element
* with a different tag, or compose it with another component.
*
* Accepts a `ReactElement` or a function that returns the element to render.
*/
render: PropTypes.oneOfType([PropTypes.element, PropTypes.func])
} : void 0;
export { ScrollAreaThumb };