diff --git a/README.md b/README.md index 6200c41..5f44699 100644 --- a/README.md +++ b/README.md @@ -39,31 +39,61 @@ import { render } from 'react-dom'; render(, mountNode); ``` +```js +import Input from '@rc-component/input'; +import { render } from 'react-dom'; + +render(, 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-component/input-affix-wrapper' | -| groupClassName | string | - | className with '@rc-component/input-group-wrapper' | -| wrapperClassName | string | - | className with '@rc-component/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 | +| 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-component/input-affix-wrapper' | +| groupClassName | string | - | className with '@rc-component/input-group-wrapper' | +| wrapperClassName | string | - | className with '@rc-component/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](https://developer.mozilla.org/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types)( 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 | +| 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](https://developer.mozilla.org/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types)( 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 | + +## TextArea + +`rc-textarea` has been migrated into `@rc-component/input`. Use `Input.TextArea` or the named `TextArea` export for all textarea-related features. + +```js +import Input, { TextArea } from '@rc-component/input'; + +; + + + + suffix + + 3 + + + + +