Field
version
5.1.0
install
yarn add @welcome-ui/field
usage
import { Field } from '@welcome-ui/field'
About #
We recommend using React-hook-form or Formik with these components. If so, use Field
for your fields (as in the examples below). The examples below give you an overview of common props (e.g. size
, disable
, required
etc.)
You can find props for each field component in the other Forms
pages.
Label #
Use label
to add an Label to your field
Hint #
Use hint
to add an hint to your field (it can be overload by a variant - see below)
Variants #
Use warning
, error
, info
or success
properties to add a variant status on your fields. The label, hint or border color are set by magic 🪄
Disabled #
Add disabled
on Field component
Required #
Add required
on Field component
Refs #
Properties #
Name | Type(s) | Default | Required |
---|---|---|---|
disabled | Boolean | ||
disabledIcon | Element | ||
error | string Element | ||
label | string Element | ||
hint | string Element | ||
required | Boolean | ||
warning | string Element | ||
success | string Element | ||
info | string Element | ||
transparent | Boolean |
Packages #
Dependencies #
Peer dependencies #
Previous
EmojiPickerNext
FileDrop