https://github.com/nstr/rc-inputs
Special inputs for React JS
https://github.com/nstr/rc-inputs
react react-input react-inputs react-tags reactjs
Last synced: 10 months ago
JSON representation
Special inputs for React JS
- Host: GitHub
- URL: https://github.com/nstr/rc-inputs
- Owner: nstr
- License: mit
- Created: 2017-02-23T22:14:41.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-27T08:57:31.000Z (over 7 years ago)
- Last Synced: 2024-04-25T04:21:36.954Z (almost 2 years ago)
- Topics: react, react-input, react-inputs, react-tags, reactjs
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/rc-inputs
- Size: 96.7 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rc-inputs
* [Installation](#installation)
* [EmailInput](#emailinput)
* [PasswordInput](#passwordinput)
* [TagInput](#taginput)
* [Select](#select)
## Installation
```
npm i rc-inputs --save
```
## EmailInput
```jsx
import { EmailInput } from "rc-inputs";
console.log("value", element.target.value)}
onValid={(valid, element) => console.log("valid", valid, "value", element.target.value)}
onEnter={(value) => console.log(value)}
autofill={true}
autoComplete={"email"}
/>
```
Property | Type | Description
:---|:---|:---
`className` | string | CSS classes of the input.
`placeholder` | string | Default placeholder of the input.
`value` | string | Value of the input.
`onChange` | function | The function returns the same as onChange of an average input.
`onValid` | function | The first argument returns bool (true if the email is valid). The second argument returns the same as onChange of an average input.
`onPaste` | function | Handler of paste event.
`onEnter` | function | Handling enter button.
`onFocus` | function | The function called after focus event.
`onBlur` | function | The function called after blur (unfocus) event.
`autofill` | bool | Turn off, turn on autofill. You can fetch "remembers" of a browser.
`autoComplete` | string | Default autoComplete of the input.
`clickableKeys` | array of int | This is keyCodes of keyboard events
`onKeyClick` | function | Onclicks handler of `clickableKeys`
## PasswordInput
```jsx
import { PasswordInput } from "rc-inputs";
console.log("value", element.target.value)}
pattern={"^.{6,}$"}
onValid={(valid, element) => console.log("valid", valid, "value", element.target.value)}
onEnter={(value) => console.log(value)}
autofill={true}
autoComplete={"password"}
/>
```
Property | Type | Description
:---|:---|:---
`className` | string | CSS classes of the input.
`placeholder` | string | Default placeholder of the input.
`value` | string | Value of the input.
`onChange` | function | The function returns the same as onChange of an average input.
`pattern` | string | You can use RegExp for handle input value.
`onValid` | function | The first argument of the function returns bool (true if the password is valid according to your pattern). The second argument returns the same as onChange of an average input. Without `pattern` property `onValid` doesn't work.
`onEnter` | function | Handling enter button.
`onPaste` | function | Handler of paste event.
`onFocus` | function | The function called after focus event.
`onBlur` | function | The function called after blur (unfocus) event.
`autofill` | bool | Turn off, turn on autofill. You can fetch "remembers" of a browser.
`autoComplete` | string | Default autoComplete of the input.
`clickableKeys` | array of int | This is keyCodes of keyboard events
`onKeyClick` | function | Onclicks handler of `clickableKeys`
## Select
```jsx
import { Select } from "rc-inputs";
import "rc-inputs/styles/select.css" // or select.less or select.scss
console.log("e", e)}
selected={{option: "item 2"}}
customeArrow={}
/>
```
Property | Type | Description
:---|:---|:---
`className` | string | CSS classes of the Select.
`dropdownClassName` | string | CSS classes for dropdown list of the Select.
`activeClass` | string | CSS class for the active option
`options` | array of string, or array of objects | In the case of using Objects, the tag requires a field `option` and in this case possible use to className and style. It is possible to to put the component in the field `option`. Example of the `option` like an Object `{option: }` or `{option: "item 1", className: "some-class", style: {backgroundColor: "red"}}`.
`listPlaceholder` | string or Object | This item will be shown if the list will be empty.
`onChange` | function | The function returns selected option and index of this option.
`activeIndex` | Int | If you are using jsx like a option `{option: }`, you have to use `activeIndex`. Example bellow.
```jsx
class App extends React.Component{
constructor(props) {
super(props);
this.state = {
activeIndex: 0,
option: test 1
};
this.handleSelect = this.handleSelect.bind(this);
}
handleSelect(option, index) {
this.setState({
activeIndex: index,
option: option
});
}
render() {
return (
item 1, className: "some-class"},
{option: item 2, className: "some-class"},
{option: item 3, className: "some-class"},
{option: item 4, className: "some-class"}
]}/>
);
}
}
```
## TagInput
```jsx
import { TagInput } from "rc-inputs";
import "rc-inputs/styles/tag-input.css" // or tag-input.less or tag-input.scss
console.log(tag)}
onDelete={(tagIndex, tag, tags) => console.log(tagIndex, tag, tags)}
onChange={(tags) => console.log(tags)}
disableInput={false}
createTagOnKeys={[13, 32]}
createTagOnPress={[","]}
/>
```
Property | Type | Description
:---|:---|:---
`className` | string | CSS classes of the tag list element.
`classNameWrap` | string | CSS classes of the element wrapper.
`tags` | array of string, or array of objects | In the case of using Objects, the tag requires a name and in this case possible use to className and style. Example of the tag like an Object `{name: "tag name", className: "some-class", style: {color: "#fff"}}`.
`onAdd` | function | The function returns new tag created by a user.
`onDelete` | function | The first argument of the function returns deleted tag. The second argument returns tag's index of deleted tag in the tags array. The third argument returns the tags.
`onChange` | function | The function returns the array of current tags.
`onInputChange` | function | Handler of own input typing.
`onPaste` | function | Handler of paste event.
`onFocus` | function | The function called after focus event.
`onBlur` | function | The function called after blur (unfocus) event.
`createTagOnKeys` | array (int) | Array of keyCodes. When you press this character on the keyboard, a tag will be created and functions `onAdd` and `onChange` will be called
`createTagOnPress` | array | Array of characters. When you press this character on the keyboard, a tag will be created and functions `onAdd` and `onChange` will be called
`disableInput` | bool | You can hide input. In this case `TagInput` will be just for reading.
`dynamicInputWidth` | bool | The prop makes any inner input(custom or default) stretched on all remaining width. The default is false.
`autocomplete` | object | Special data for autocomplete. See schema below.
`showAutocomplete` | bool | An alternative way to show and hide an indenture autocomplete.
`inputValue` | string | Value setter. Use only with `autocomplete` and included input. This prop required if you want to use `autocomplete`.
`onSelect` | function | The function returns selected tag from `autocomplete` and all used `tags`
`renderAutocompleteItem` | function | The function for render custom autocomplete items.
Autocomplete Schema
Property | Type | Description
:---|:---|:---
`items` | array | Displayed items of autocomplete
`searchKey` | string | If you are using objects in `items` you will have to select key of an object on which will be searched.
`searchPath` | string | Completely the same as `searchKey` but works for the deep key. Use dots for going deeper. For exemple key for object `{test: {abc: 123}}` will be `test.abc`. Attention! It doesn't work with `searchKey`.
`label` | string | text in the begin of the autocomplete list.
`isUnderInput` | bool | Show autocomplete under input (on another line).
Also exist posobility include some elements into TagInput. In this way, the elements will be added after all elements of TagInput. If you are using autocomplete, don't forget `inputValue`. Usage example: Add EmailInput Component with handling valid emails.
```jsx
class SomeComponent extends React.Component{
constructor(props) {
super(props);
this.state = {
emails: [],
isValid: false,
inputValue: ""
};
this.addTag = this.addTag.bind(this);
this.handleValidity = this.handleValidity.bind(this);
}
addTag(value) {
if (this.state.isValid) {
const emails = this.state.emails.concat([value]);
this.setState({
emails: emails,
inputValue: ""
});
}
}
handleValidity(isValid, e) {
this.setState({
isValid: isValid,
inputValue: e.target.value
});
}
render() {
return (
);
}
}
```