Label
Text label control for form fields.
Contract
Section titled “Contract”Overview
Machine-readable contract from Component Spec.
component: labelexport: Labelversion: 1attributes: data-refineui=label
Anatomy
| Part | data-refineui |
|---|---|
| root | label |
| required | label-required |
Variants
| Axis | Values |
|---|---|
| size | sm, md, lg |
Layout
| Property | Value |
|---|---|
| direction | logical |
| rtl | true |
Installation
Section titled “Installation”npm install @refineui/react @refineui/tokensyarn add @refineui/react @refineui/tokenspnpm add @refineui/react @refineui/tokensbun add @refineui/react @refineui/tokensimport { Label, LabelRequired } from "@refineui/react";
<Label htmlFor="email">Email address</Label>
<Label htmlFor="password" required> Password</Label>
<Label size="lg" disabled> Disabled Label</Label>
<Label htmlFor="name"> Name <LabelRequired /></Label>API Reference
Section titled “API Reference”| Prop | Default | Type | Description |
|---|---|---|---|
| required | false | boolean | Convenience prop that appends LabelRequired. |
| size | "md" | "sm" | "md" | "lg" | Label size tier. |
| disabled | false | boolean | Shows disabled styling. |
| htmlFor | — | string | Associates label with form control. |
LabelRequired
Section titled “LabelRequired”Visual required indicator (asterisk). Use when composing labels manually.