UNPKG

@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.

48 lines (46 loc) 1.56 kB
'use client'; import * as React from 'react'; import { useIsoLayoutEffect } from '@base-ui-components/utils/useIsoLayoutEffect'; import { useFieldRootContext } from "../root/FieldRootContext.js"; import { useLabelableContext } from "../../labelable-provider/LabelableContext.js"; import { fieldValidityMapping } from "../utils/constants.js"; import { useBaseUiId } from "../../utils/useBaseUiId.js"; import { useRenderElement } from "../../utils/useRenderElement.js"; /** * A paragraph with additional information about the field. * Renders a `<p>` element. * * Documentation: [Base UI Field](https://base-ui.com/react/components/field) */ export const FieldDescription = /*#__PURE__*/React.forwardRef(function FieldDescription(componentProps, forwardedRef) { const { render, id: idProp, className, ...elementProps } = componentProps; const id = useBaseUiId(idProp); const fieldRootContext = useFieldRootContext(false); const { setMessageIds } = useLabelableContext(); useIsoLayoutEffect(() => { if (!id) { return undefined; } setMessageIds(v => v.concat(id)); return () => { setMessageIds(v => v.filter(item => item !== id)); }; }, [id, setMessageIds]); const element = useRenderElement('p', componentProps, { ref: forwardedRef, state: fieldRootContext.state, props: [{ id }, elementProps], stateAttributesMapping: fieldValidityMapping }); return element; }); if (process.env.NODE_ENV !== "production") FieldDescription.displayName = "FieldDescription";