@lendi-ui/field v3.1.23

@lendi-ui/field

A Field component with Label, Tooltip, Input and ErrorMessage component.

Installation

yarn add @lendi-ui/field

Usage

import Field from '@lendi-ui/field';
<Field
  labelSize="sm"
  label="This is a label"
  assistiveText="Assistive text"
  link={<Link>forgot</Link>}
  toolTip={<></>}
  error="error message"
>
  <Input
    size="md"
    placeholder="input here ..."
    onChange={() => {}}
    isFullWidth={true}
    after={<span style={{ width: '24px', height: '24px' }}>x</span>}
  />
</Field>;

Properties

<PropTable>
  <PropTable.Entry name="assistiveText" type="string" description="The Label assistive text content"/>
  <PropTable.Entry name="children" required type="React.ReactNode" description="The Field content"/>
  <PropTable.Entry name="error" type="string" description="The error message"/>
  <PropTable.Entry name="htmlFor" type="string" description="The for attribute of the <Field> tag should be equal to the id attribute of the related element to bind them together."/>
  <PropTable.Entry name="isRequired" type="boolean" defaultValue='true' description="Whether or not a field is required"/>
  <PropTable.Entry name="label" type="string" description="The Label content"/>
  <PropTable.Entry name="link" type="string" description="The Label link content"/>
  <PropTable.Entry name="size" type={`"lg" | "sm"`} defaultValue="sm" description="The Field Label size"/>
  <PropTable.Entry name="tooltip" type="React.ReactNode" description="ToolTip"/>
  <PropTable.Entry name="touched" type="boolean" description="Whether the user has interacted with the field"/>
</PropTable>