UNPKG

@material-ui/unstyled

Version:

Unstyled React components with which to implement custom design systems.

230 lines (203 loc) 7.22 kB
import _extends from "@babel/runtime/helpers/esm/extends"; import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray"; import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties"; import * as React from 'react'; import PropTypes from 'prop-types'; import clsx from 'clsx'; import { unstable_useControlled as useControlled } from '@material-ui/utils'; import FormControlUnstyledContext from './FormControlContext'; import appendOwnerState from '../utils/appendOwnerState'; import classes from './formControlUnstyledClasses'; import { jsx as _jsx } from "react/jsx-runtime"; function hasValue(value) { return value != null && !(Array.isArray(value) && value.length === 0) && value !== ''; } /** * Provides context such as filled/focused/error/required for form inputs. * Relying on the context provides high flexibility and ensures that the state always stays * consistent across the children of the `FormControl`. * This context is used by the following components: * * * FormLabel * * FormHelperText * * Input * * InputLabel * * You can find one composition example below and more going to [the demos](https://material-ui.com/components/text-fields/#components). * * ```jsx * <FormControl> * <InputLabel htmlFor="my-input">Email address</InputLabel> * <Input id="my-input" aria-describedby="my-helper-text" /> * <FormHelperText id="my-helper-text">We'll never share your email.</FormHelperText> * </FormControl> * ``` * * ⚠️ Only one `Input` can be used within a FormControl because it create visual inconsistencies. * For instance, only one input can be focused at the same time, the state shouldn't be shared. * * Demos: * * - [Text Fields](https://material-ui.com/components/text-fields/) * * API: * * - [FormControlUnstyled API](https://material-ui.com/api/form-control-unstyled/) */ var FormControlUnstyled = /*#__PURE__*/React.forwardRef(function FormControlUnstyled(props, ref) { var _ref; var defaultValue = props.defaultValue, children = props.children, className = props.className, component = props.component, _props$components = props.components, components = _props$components === void 0 ? {} : _props$components, _props$componentsProp = props.componentsProps, componentsProps = _props$componentsProp === void 0 ? {} : _props$componentsProp, _props$disabled = props.disabled, disabled = _props$disabled === void 0 ? false : _props$disabled, _props$error = props.error, error = _props$error === void 0 ? false : _props$error, _props$focused = props.focused, visuallyFocused = _props$focused === void 0 ? false : _props$focused, onChange = props.onChange, _props$required = props.required, required = _props$required === void 0 ? false : _props$required, incomingValue = props.value, other = _objectWithoutProperties(props, ["defaultValue", "children", "className", "component", "components", "componentsProps", "disabled", "error", "focused", "onChange", "required", "value"]); var _useControlled = useControlled({ controlled: incomingValue, default: defaultValue, name: 'FormControl', state: 'value' }), _useControlled2 = _slicedToArray(_useControlled, 2), value = _useControlled2[0], setValue = _useControlled2[1]; var filled = hasValue(value); var _React$useState = React.useState(false), focusedState = _React$useState[0], setFocused = _React$useState[1]; if (disabled && focusedState) { setFocused(false); } var focused = visuallyFocused !== undefined && !disabled ? visuallyFocused : focusedState; var ownerState = _extends({}, props, { disabled: disabled, error: error, filled: filled, focused: focused, required: required }); var registerEffect = function registerEffect() {}; if (process.env.NODE_ENV !== 'production') { // eslint-disable-next-line react-hooks/rules-of-hooks var registeredInput = React.useRef(false); registerEffect = function registerEffect() { if (registeredInput.current) { console.error(['Material-UI: There are multiple `Input` components inside a FormControl.', 'This creates visual inconsistencies, only use one `Input`.'].join('\n')); } registeredInput.current = true; return function () { registeredInput.current = false; }; }; } var handleChange = function handleChange(event) { setValue(event.target.value); onChange == null ? void 0 : onChange(event); }; var childContext = { disabled: disabled, error: error, filled: filled, focused: focused, onBlur: function onBlur() { setFocused(false); }, onChange: handleChange, onFocus: function onFocus() { setFocused(true); }, registerEffect: registerEffect, required: required, value: value != null ? value : '' }; var Root = (_ref = component != null ? component : components.Root) != null ? _ref : 'div'; var rootProps = appendOwnerState(Root, _extends({}, other, componentsProps.root), ownerState); return /*#__PURE__*/_jsx(FormControlUnstyledContext.Provider, { value: childContext, children: /*#__PURE__*/_jsx(Root, _extends({ ref: ref }, rootProps, { className: clsx(classes.root, className, rootProps == null ? void 0 : rootProps.className, disabled && classes.disabled), children: children })) }); }); process.env.NODE_ENV !== "production" ? FormControlUnstyled.propTypes /* remove-proptypes */ = { // ----------------------------- Warning -------------------------------- // | These PropTypes are generated from the TypeScript type definitions | // | To update them edit TypeScript types and run "yarn proptypes" | // ---------------------------------------------------------------------- /** * The content of the component. */ children: PropTypes.node, /** * Class name applied to the root element. */ className: PropTypes.string, /** * The component used for the root node. * Either a string to use a HTML element or a component. */ component: PropTypes.elementType, /** * The components used for each slot inside the FormControl. * Either a string to use a HTML element or a component. * @default {} */ components: PropTypes.shape({ Root: PropTypes.elementType }), /** * @ignore */ componentsProps: PropTypes.object, /** * @ignore */ defaultValue: PropTypes.any, /** * If `true`, the label, input and helper text should be displayed in a disabled state. * @default false */ disabled: PropTypes.bool, /** * If `true`, the label is displayed in an error state. * @default false */ error: PropTypes.bool, /** * If `true`, the component is displayed in focused state. * @default false */ focused: PropTypes.bool, /** * @ignore */ onChange: PropTypes.func, /** * If `true`, the label will indicate that the `input` is required. * @default false */ required: PropTypes.bool, /** * @ignore */ value: PropTypes.any } : void 0; export default FormControlUnstyled;