4.0.3 • Published 8 months ago

@licuido-ui/ui_input-field v4.0.3

Weekly downloads
-
License
MIT
Repository
-
Last release
8 months ago

InputField

Input fields are an essential user interface design element, providing users with the means to enter non-standardized responses

Author Input

Author Add Filled Variant Input

Link

Story Book Link InputField

PlayGround

Try it have a fun codeBox

Installation

npm i @licuido-ui/ui_input-field

Import component

import { InputField } from '@licuido-ui/ui_input-field';

Usage

<InputField label={'input'} value={''} />

Image

alt text

Sample Code

<InputField 
    fullWidth={true}
    variant={'outlined'}
    size={'small'}
    label={''}
    type={'text'}
    id={''}
    value={''}
    rowMax={Infinity}
    rowMin={1}
    isError={''}
    disabled={false}
    fullwidth={false}
    isMulti={false}
    isReadOnly={false}
    helperText={''}
    placeholder={''}
    className={''}
    endAdornment={null}
    defaultValue={null}
    inLineStyles={{}}
    startAdornments={null}
    onChange={undefined}  
  />
PropTypeDescriptionDefault
inputIdstringThis id is unique.-
labelstring | undefinedTo change label text.''
valueunknownThe input value. Providing an empty string will select no options.-
classNamestringOverride or extend the styles applied.''
sxSxProps<Theme>Allows defining system overrides as well as additional CSS styles.{}
variant'outlined' | 'standard' | 'filled'To change declare variant types.'outlined'
labelStyleSxPropsAllows defining system overrides as well as additional CSS styles for the label.See defaultProps
labelVariant'standard' | 'floating'To change label variant.'standard'
errorMessagestringTo change error message text.-
inputStyleSxPropsAllows defining system overrides as well as additional CSS styles for the input.-
isLabelRequiredbooleanIf true, the label is required.true
isErrorRequiredbooleanIf true, the error message is required.true
borderFilledstringIf can you change a borderFilled, the borderFilled is required.'1px solid'
borderColorFilledstringIf can you change a borderColorFilled, the borderColorFilled is required.'#D9DBDD'
borderRadiusFilledstringIf can you change a borderRadiusFilled, the borderRadiusFilled is required.'8px'
filledHeightstringIf can you change a filledHeight, the filledHeight is required. It can be used as a string.'62px'
filledLabelPaddingstringIf can you change a filledLabelPadding, the filledLabelPadding is required. It can be used as a string.'4px'
fontSizeFilledstringIf can you change a fontSizeFilled, the fontSizeFilled is required.'14px'
fontWeightFillednumber | string | undefinedIf can you change a fontWeightFilled, the fontWeightFilled is required.500
errorStyleSxPropsAllows defining system overrides as well as additional CSS styles for the error message.See defaultProps
errorVariantstringIf can you change a Variant, the errorVariant is requiredcaption

Default Props:

{
  label: '',
  type: 'text',
  variant: 'outlined',
  inputId: 'InputField',
  value: '',
  size: undefined,
  className: '',
  labelStyle: {
    'fontSize': '12px',
    'marginRight': '5px',
    'marginBottom': '8px',
    'color': '#3B3B3B',
    'fontWeight': 400,
    'lineHeight': '20px',
    '& span': {
      color: '#F44F5A',
    },
  },
  errorStyle: {
    'mt': 0.5,
    'mb': 0,
    'caret-color': 'transparent',
  },
  borderFilled: '1px solid',
  borderColorFilled: '#D9DBDD',
  borderRadiusFilled: '8px',
  filledHeight: '62px',
  filledLabelPadding: '4px',
  fontWeightFilled: 500,
  fontSizeFilled: '14px',
  labelVariant: 'standard',
  errorMessage: '',
}