@wordpress/components
Version:
UI components for WordPress.
83 lines (81 loc) • 2.05 kB
JavaScript
/**
* WordPress dependencies
*/
import { createContext } from '@wordpress/element';
/**
* Internal dependencies
*/
import { disabledStyles } from './styles/disabled-styles';
import { useCx } from '../utils';
import { jsx as _jsx } from "react/jsx-runtime";
const Context = createContext(false);
const {
Consumer,
Provider
} = Context;
/**
* `Disabled` is a component which disables descendant tabbable elements and
* prevents pointer interaction.
*
* _Note: this component may not behave as expected in browsers that don't
* support the `inert` HTML attribute. We recommend adding the official WICG
* polyfill when using this component in your project._
*
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert
*
* ```jsx
* import { Button, Disabled, TextControl } from '@wordpress/components';
* import { useState } from '@wordpress/element';
*
* const MyDisabled = () => {
* const [ isDisabled, setIsDisabled ] = useState( true );
*
* let input = (
* <TextControl
* __next40pxDefaultSize
* __nextHasNoMarginBottom
* label="Input"
* onChange={ () => {} }
* />
* );
* if ( isDisabled ) {
* input = <Disabled>{ input }</Disabled>;
* }
*
* const toggleDisabled = () => {
* setIsDisabled( ( state ) => ! state );
* };
*
* return (
* <div>
* { input }
* <Button variant="primary" onClick={ toggleDisabled }>
* Toggle Disabled
* </Button>
* </div>
* );
* };
* ```
*/
function Disabled({
className,
children,
isDisabled = true,
...props
}) {
const cx = useCx();
return /*#__PURE__*/_jsx(Provider, {
value: isDisabled,
children: /*#__PURE__*/_jsx("div", {
// @ts-ignore Reason: inert is a recent HTML attribute
inert: isDisabled ? 'true' : undefined,
className: isDisabled ? cx(disabledStyles, className, 'components-disabled') : undefined,
...props,
children: children
})
});
}
Disabled.Context = Context;
Disabled.Consumer = Consumer;
export default Disabled;
//# sourceMappingURL=index.js.map