rc-input

React input component

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
rc-input
1230.1.22 months ago7 months agoMinified + gzip package size for rc-input in KB

Readme

rc-input ⌨️
!NPM versionnpm-imagenpm-url !npm downloaddownload-imagedownload-url dumi !build statusgithub-actions-imagegithub-actions-url !Codecovcodecov-imagecodecov-url !Dependenciesdavid-image !DevDependenciesdavid-dev-imagedavid-dev-url !bundle sizebundlephobia-imagebundlephobia-url

Install

rc-input

Usage

import Input from 'rc-input';
import { render } from 'react-dom';

render(<Input placeholder="input" allowClear />, mountNode);

API

| Property | Type | Default | Description | | --------------------- | ---------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | prefixCls | string | rc-input | | | className | string | '' | additional class name of input | | style | React.CSSProperties | | style properties of input | | affixWrapperClassName | string | - | className with 'rc-input-affix-wrapper' | | groupClassName | string | - | className with 'rc-input-group-wrapper' | | wrapperClassName | string | - | className with 'rc-input-wrapper' | | addonAfter | ReactNode | - | The label text displayed after (on the right side of) the input field | | addonBefore | ReactNode | - | The label text displayed before (on the left side of) the input field | | allowClear | boolean | { clearIcon: ReactNode } | false | If allow to remove input content with clear icon | | bordered | boolean | true | Whether has border style | | defaultValue | string | - | The initial input content | | disabled | boolean | false | Whether the input is disabled | | id | string | - | The ID for input | | maxLength | number | - | The max length | | showCount | boolean | { formatter: ({ value: string, count: number, maxLength?: number }) => ReactNode } | false | Whether show text count | | prefix | ReactNode | - | The prefix icon for the Input | | suffix | ReactNode | - | The suffix icon for the Input | | type | string | text | The type of input, see: MDN( use Input.TextArea instead of type="textarea") | | value | string | - | The input content value | | onChange | function(e) | - | Callback when user input | | onPressEnter | function(e) | - | The callback function that is triggered when Enter key is pressed |

Development

npm install
npm start

License

rc-input is released under the MIT license.