@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.
63 lines (60 loc) • 2.02 kB
JavaScript
'use client';
import * as React from 'react';
import { useIsoLayoutEffect } from '@base-ui-components/utils/useIsoLayoutEffect';
import { getTarget } from "../../floating-ui-react/utils.js";
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";
/**
* An accessible label that is automatically associated with the field control.
* Renders a `<label>` element.
*
* Documentation: [Base UI Field](https://base-ui.com/react/components/field)
*/
export const FieldLabel = /*#__PURE__*/React.forwardRef(function FieldLabel(componentProps, forwardedRef) {
const {
render,
className,
id: idProp,
...elementProps
} = componentProps;
const fieldRootContext = useFieldRootContext(false);
const {
controlId,
setLabelId,
labelId
} = useLabelableContext();
const id = useBaseUiId(idProp);
const labelRef = React.useRef(null);
useIsoLayoutEffect(() => {
if (id) {
setLabelId(id);
}
return () => {
setLabelId(undefined);
};
}, [id, setLabelId]);
const element = useRenderElement('label', componentProps, {
ref: [forwardedRef, labelRef],
state: fieldRootContext.state,
props: [{
id: labelId,
htmlFor: controlId ?? undefined,
onMouseDown(event) {
const target = getTarget(event.nativeEvent);
if (target?.closest('button,input,select,textarea')) {
return;
}
// Prevent text selection when double clicking label.
if (!event.defaultPrevented && event.detail > 1) {
event.preventDefault();
}
}
}, elementProps],
stateAttributesMapping: fieldValidityMapping
});
return element;
});
if (process.env.NODE_ENV !== "production") FieldLabel.displayName = "FieldLabel";