@lendi-ui/auto-complete

@lendi-ui/auto-complete

AutoCompleteStateless and AutocompleteStateful component.

Installation

yarn add @lendi-ui/auto-complete

Usage

import { AutoComplete, AutoCompleteStateless } from '@lendi-ui/auto-complete';

<AutoComplete dataSource={(input) => Promise.resolve([{
    label: 'AMP Bank',
    value: 'AMP',
  },
  {
    label: 'ANZ',
    value: 'anz',
  }])}/>

AutoCompleteStateful component

<PropTable>
  <PropTable.Entry name="before" type="React.ReactElement" description="Before icon for AutoComplete"/>
  <PropTable.Entry name="className" type="string" description="External classname to override style of the component"/>
  <PropTable.Entry name="dataSource" required type="(input) => Promise.resolve([{label, value}]) | [{label, value}]"
   description="Datasource - It could resolve to a promise of an array of {label, value} or just an array of {label, value}, where label is searchable"/>
  <PropTable.Entry name="isAutoFocus" type="boolean" defaultValue={false} description="Whether the Input is automatically focused on when form loads."/>
  <PropTable.Entry name="isDisabled" type="boolean" description="Disable AutoComplete"/>
  <PropTable.Entry name="isError" type="boolean" description="Errored AutoComplete"/>
  <PropTable.Entry name="isFullWidth" type="boolean" description="Fullwidth for AutoComplete"/>
  <PropTable.Entry name="isInverse" type="boolean" defaultValue={false} description="Whether the InputButton is inversed"/>
  <PropTable.Entry name="isReadOnly" type="boolean" defaultValue={false} description="Whether the Input is read-only."/>
  <PropTable.Entry name="isRequired" type="boolean" defaultValue={false} description="Whether the Input is required."/>
  <PropTable.Entry name="onSelectItem" type="(selectedItem: string | number)=> void" description="Selected item from the datasource"/>
  <PropTable.Entry name="placeholder" type="string" description="Placeholder for AutoComplete"/>
  <PropTable.Entry name="size" type={`"lg" | "md" | "sm"`} defaultValue='md' description="Size to AutoComplete"/>
  <PropTable.Entry name="value" type="string" description="AutoComplete value"/>
</PropTable>

AutoCompleteStateless component

<PropTable>
  <PropTable.Entry name="before" type="React.ReactElement" description="Before icon for AutoComplete"/>
  <PropTable.Entry name="className" type="string" description="External classname to override style of the component"/>
  <PropTable.Entry name="dataSource" required type="[{label, value}]" description="The items to display in the dropdown menu"/>
  <PropTable.Entry name="isAutoFocus" type="boolean" defaultValue={false} description="Whether the Input is automatically focused on when form loads."/>
  <PropTable.Entry name="isDisabled" type="boolean" description="Disable AutoComplete"/>
  <PropTable.Entry name="isError" type="boolean" description="Errored AutoComplete"/>
  <PropTable.Entry name="isFullWidth" type="boolean" description="Fullwidth for AutoComplete"/>
  <PropTable.Entry name="isInverse" type="boolean" defaultValue={false} description="Whether the InputButton is inversed"/>
  <PropTable.Entry name="isLoading" type="boolean" defaultValue={false} description="Loading indicator"/>
  <PropTable.Entry name="isReadOnly" type="boolean" defaultValue={false} description="Whether the Input is read-only."/>
  <PropTable.Entry name="isRequired" type="boolean" defaultValue={false} description="Whether the Input is required."/>
  <PropTable.Entry name="open" type="boolean" defaultValue={false} description="Displays/hides the dropdown menu"/>
  <PropTable.Entry name="onBlur" type="(event: React.FocusEvent<HTMLInputElement>)=> void" description="Blur handler"/>
  <PropTable.Entry name="onChange" type="(event: React.ChangeEvent<HTMLInputElement>)=> void" description="Change handler"/>
  <PropTable.Entry name="onFocus" type="(event: React.FocusEvent<HTMLInputElement>) => void" description="Focus handler"/>
  <PropTable.Entry name="onKeyDown" type="(event: React.KeyboardEvent<HTMLDivElement>) => void" description="OnKeyDown handler"/>
  <PropTable.Entry name="onMenuVisibilityChange" type="(isOpen: boolean) => void" description="By default Autocomplete will manage its own menu visibility, using basic logic to decide whether or not to display it (e.g. open on focus, keypress, close on blur, select, escape, etc). If you need full control over when the menu opens and closes you can put Autocomplete into 'managed menu visibility mode' by supplying props.open. This will force AutocompleteStateless to ignore its internal menu visibility status and always hide/show the menu based on props.open. Pair this with props.onMenuVisibilityChange - which is invoked each time the internal visibility state changes - for full control over the menu's visibility"/>
  <PropTable.Entry name="onReset" type="() => void" description="Called when clear(cross) button is being called, consumer need to implement it to clear input"/>
  <PropTable.Entry name="onSelect" type="(selectedItem: string | number)=> void" description="Selected item from the datasource"/>
  <PropTable.Entry name="placeholder" type="string" description="Placeholder for AutoComplete"/>
  <PropTable.Entry name="size" type={`"lg" | "md" | "sm"`} defaultValue='md' description="Size to AutoComplete"/>
  <PropTable.Entry name="value" type="string" description="AutoComplete value"/>
</PropTable>