mirror of
https://github.com/hanzoai/gui.git
synced 2026-10-25 02:31:41 +00:00
zeekayandHanzo Dev
751ef5c778
Both old names are owned by a different npm account (artemis-prime), so publishing them returns 403 — which is how this surfaced: the 8.0.0 run shipped @hanzogui/logo and @hanzogui/demos depending on [email protected], a version that cannot be published and therefore does not exist. Those two were uninstallable. @hanzo/gui and @hanzogui/* are ours, so the framework now carries the name it is imported by everywhere downstream, and the loader moves under the scope we control. The rewrite is limited to package references. `DEBUG?.startsWith('hanzogui')` is a log-namespace filter and join(dir, 'hanzogui') is a path — rewriting either would change behaviour, so both are untouched. Co-authored-by: Hanzo Dev <[email protected]>
149 lines
3.5 KiB
Plaintext
149 lines
3.5 KiB
Plaintext
---
|
|
title: Label
|
|
description: Label form elements with accessibility
|
|
name: label
|
|
component: Label
|
|
package: label
|
|
demoName: Label
|
|
---
|
|
|
|
<HeroContainer>
|
|
<LabelDemo />
|
|
</HeroContainer>
|
|
|
|
```tsx hero template=Label
|
|
|
|
```
|
|
|
|
<Highlights
|
|
features={[
|
|
`Supports nested controls and custom controls.`,
|
|
`Sizable and styleable inline.`,
|
|
`Works on web with aria-labelledby.`,
|
|
]}
|
|
/>
|
|
|
|
## Installation
|
|
|
|
Label is already installed in `hanzogui`, or you can install it independently:
|
|
|
|
```bash
|
|
npm install @hanzogui/label
|
|
```
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { Label } from '@hanzo/gui'
|
|
|
|
export default () => (
|
|
<>
|
|
<Label htmlFor="name">Name</Label>
|
|
<Input id="name" defaultValue="Nate Wienert" />
|
|
</>
|
|
)
|
|
```
|
|
|
|
## Accessibility
|
|
|
|
Use with Input or other form elements to automatically get correct labelling by id and aria-labelledby. You can also use the provided `useLabelContext` hook to build your own controls.
|
|
|
|
Label supports all standard ARIA attributes for form accessibility. These work on both web and React Native - see the [React Native Accessibility docs](https://reactnative.dev/docs/accessibility) for native behavior.
|
|
|
|
### Required Fields
|
|
|
|
```tsx
|
|
<Label htmlFor="email" aria-required>
|
|
Email
|
|
</Label>
|
|
<Input id="email" aria-required />
|
|
```
|
|
|
|
### Invalid State
|
|
|
|
```tsx
|
|
<Label htmlFor="email" aria-invalid={hasError}>
|
|
Email
|
|
</Label>
|
|
<Input id="email" aria-invalid={hasError} aria-errormessage="email-error" />
|
|
{hasError && <Text id="email-error">Please enter a valid email</Text>}
|
|
```
|
|
|
|
### With Description
|
|
|
|
```tsx
|
|
<Label htmlFor="password" aria-describedby="password-hint">
|
|
Password
|
|
</Label>
|
|
<Input id="password" aria-describedby="password-hint" />
|
|
<Text id="password-hint">Must be at least 8 characters</Text>
|
|
```
|
|
|
|
## API Reference
|
|
|
|
### Label
|
|
|
|
Labels extend SizableText inheriting all the [Gui standard props](/docs/intro/props), plus:
|
|
|
|
<PropsTable
|
|
data={[
|
|
{
|
|
name: 'htmlFor',
|
|
type: 'string',
|
|
required: true,
|
|
description: `Matches the \`id\` of a form element to associate with.`,
|
|
},
|
|
{
|
|
name: 'unstyled',
|
|
required: false,
|
|
type: `boolean`,
|
|
description: `Removes all default Gui styles.`,
|
|
},
|
|
]}
|
|
/>
|
|
|
|
### Accessibility Props
|
|
|
|
Label passes through all ARIA attributes. These are the most commonly used for form labeling:
|
|
|
|
<PropsTable
|
|
data={[
|
|
{
|
|
name: 'aria-required',
|
|
type: 'boolean',
|
|
description: `Indicates user input is required before form submission.`,
|
|
},
|
|
{
|
|
name: 'aria-invalid',
|
|
type: 'boolean',
|
|
description: `Indicates the associated field has a validation error.`,
|
|
},
|
|
{
|
|
name: 'aria-disabled',
|
|
type: 'boolean',
|
|
description: `Indicates the associated control is disabled.`,
|
|
},
|
|
{
|
|
name: 'aria-describedby',
|
|
type: 'string',
|
|
description: `References an element providing additional description such as hint text or error messages.`,
|
|
},
|
|
{
|
|
name: 'aria-labelledby',
|
|
type: 'string',
|
|
description: `References another element that labels this one. \`Label\` sets this automatically on the target input.`,
|
|
},
|
|
{
|
|
name: 'aria-details',
|
|
type: 'string',
|
|
description: `References an element providing extended description or instructions.`,
|
|
},
|
|
]}
|
|
/>
|
|
|
|
<Notice theme="green">
|
|
These props work cross-platform. On web they render as standard ARIA attributes. On
|
|
React Native they map to the native accessibility system. See the [React Native
|
|
Accessibility docs](https://reactnative.dev/docs/accessibility) for details.
|
|
</Notice>
|