FormLabel API

API reference for the FormLabel component: its props with their token values and defaults, the styled-system prop groups, and forwarded HTML attributes.

Demos

For usage examples, visit the component demo page: FormLabel

Import

import { FormLabel } from '@soroush.tech/design-system/FormLabel'

Props

`children`

ReactNode - the label text.

`required`

boolean - appends a * indicator. Falls back to the FormControl required value. Default: false.

`htmlFor`

string - target control id. Falls back to the FormControl id.

Styled-system props

All Typography props pass through (variant, color, textTransform, letterSpacing, space props, etc.). Defaults to variant="body2". When color is not set, the label inherits textColor from FormControl/Form context (theme.text).

Source code

If this page does not answer your question, have a look at the implementation of the component for more detail.