Leave Yamada UI a star

Star
Yamada UIYamada UIv1.7.2

Fieldset

Fieldset is a component used to group elements such as legends, helper messages, and error messages in a fieldset element.

Source@yamada-ui/form-control

Props

FieldsetProps

errorMessage

Description

The fieldset error message to use.

Type

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

errorMessageProps

Description

Props the error message component.

Type

ErrorMessageProps

helperMessage

Description

The fieldset helper message to use.

Type

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

helperMessageProps

Description

Props the helper message component.

Type

HelperMessageProps

invalid

Description

If true, the fieldset will be invalid.

Type

boolean

Default

false

isDisabled

Deprecated

Description

If true, the fieldset will be disabled.

Deprecated

Use disabled instead.

Type

boolean

Default

false

isInvalid

Deprecated

Description

If true, the fieldset will be invalid.

Deprecated

Use invalid instead.

Type

boolean

Default

false

isReadOnly

Deprecated

Description

If true, the fieldset will be readonly.

Deprecated

Use readOnly instead.

Type

boolean

Default

false

isReplace

Deprecated

Description

If true, switch between helper message and error message using isInvalid.

Deprecated

Use replace instead.

Type

boolean

Default

true

isRequired

Deprecated

Deprecated

Use required instead.

Type

boolean

legend

Description

The fieldset legend to use.

Type

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

legendProps

Description

Props the label component.

Type

LegendProps

optionalIndicator

Type

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

readOnly

Description

If true, the fieldset will be readonly.

Type

boolean

Default

false

replace

Description

If true, switch between helper message and error message using isInvalid.

Type

boolean

Default

true

required

Type

boolean

requiredIndicator

Type

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

LegendProps

isRequired

Deprecated

Deprecated

Use required instead.

Type

boolean

optionalIndicator

Type

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

required

Type

boolean

requiredIndicator

Type

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

Edit this page on GitHub

PreviousFormControlNextButton