@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.
83 lines (81 loc) • 2.78 kB
JavaScript
'use client';
import * as React from 'react';
import PropTypes from 'prop-types';
import { useComponentRenderer } from '../../utils/useComponentRenderer.js';
import { useSelectRootContext } from '../root/SelectRootContext.js';
import { popupStateMapping } from '../../utils/popupStateMapping.js';
import { transitionStatusMapping } from '../../utils/styleHookMapping.js';
const customStyleHookMapping = {
...popupStateMapping,
...transitionStatusMapping
};
/**
* An overlay displayed beneath the menu popup.
* Renders a `<div>` element.
*
* Documentation: [Base UI Select](https://base-ui.com/react/components/select)
*/
const SelectBackdrop = /*#__PURE__*/React.forwardRef(function SelectBackdrop(props, forwardedRef) {
const {
className,
render,
keepMounted = false,
...other
} = props;
const {
open,
mounted,
transitionStatus
} = useSelectRootContext();
const state = React.useMemo(() => ({
open,
transitionStatus
}), [open, transitionStatus]);
const {
renderElement
} = useComponentRenderer({
render: render ?? 'div',
className,
state,
ref: forwardedRef,
extraProps: {
role: 'presentation',
hidden: !mounted,
...other
},
customStyleHookMapping
});
const shouldRender = keepMounted || mounted;
if (!shouldRender) {
return null;
}
return renderElement();
});
process.env.NODE_ENV !== "production" ? SelectBackdrop.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]),
/**
* Whether to keep the HTML element in the DOM while the select menu is hidden.
* @default false
*/
keepMounted: PropTypes.bool,
/**
* 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 { SelectBackdrop };