1.5.1 • Published 1 year ago

rc-input-modern v1.5.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

rc-input ⌨️

NPM version npm download dumi build status Codecov Dependencies DevDependencies bundle size

Install

rc-input

Usage

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

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

API

PropertyTypeDefaultDescription
prefixClsstringrc-input
classNamestring''additional class name of input
styleReact.CSSPropertiesstyle properties of input
affixWrapperClassNamestring-className with 'rc-input-affix-wrapper'
groupClassNamestring-className with 'rc-input-group-wrapper'
wrapperClassNamestring-className with 'rc-input-wrapper'
addonAfterReactNode-The label text displayed after (on the right side of) the input field
addonBeforeReactNode-The label text displayed before (on the left side of) the input field
allowClearboolean | { clearIcon: ReactNode }falseIf allow to remove input content with clear icon
borderedbooleantrueWhether has border style
defaultValuestring-The initial input content
disabledbooleanfalseWhether the input is disabled
idstring-The ID for input
maxLengthnumber-The max length
showCountboolean | { formatter: ({ value: string, count: number, maxLength?: number }) => ReactNode }falseWhether show text count
prefixReactNode-The prefix icon for the Input
suffixReactNode-The suffix icon for the Input
typestringtextThe type of input, see: MDN( use Input.TextArea instead of type="textarea")
valuestring-The input content value
onChangefunction(e)-Callback when user input
onPressEnterfunction(e)-The callback function that is triggered when Enter key is pressed

inputRef

const inputRef = useRef(null);

useEffect(() => {
  inputRef.current.focus();// the input will get focus
  inputRef.current.blur();// the input will lose focus
  console.log(inputRef.current.input);// The origin input element
}, []);
// ....
<Input ref={inputRef} />
PropertyTypeDescription
focus(options?: InputFocusOptions) => voidThe input get focus when called
blur() => voidThe input loses focus when called
inputHTMLInputElement \| nullThe origin input element

Development

npm install
npm start

License

rc-input is released under the MIT license.