Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

rc-input

Package Overview
Dependencies
Maintainers
0
Versions
47
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

rc-input

React input component

  • 1.7.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.3M
decreased by-3.38%
Maintainers
0
Weekly downloads
 
Created
Source

rc-input ⌨️

NPM version npm download build status Codecov bundle size dumi

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.

Keywords

FAQs

Package last updated on 30 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc