Skip to content

Commit

Permalink
edit readme and release v1.0.2 in npm
Browse files Browse the repository at this point in the history
  • Loading branch information
MostafaRostami72 committed Oct 17, 2021
1 parent 656d73f commit 5da1680
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 5 deletions.
42 changes: 40 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,40 @@
## Install

```bash
npm install --save react-selection-box
npm install react-selection-box
```

## Types
With this package, you can create select input with the following types.

* Single select
* Multiple select
* Range select
* Async select (autocomplete)

See the document page for more examples.

## Some features
* Searchable
* Cleanable
* Loading
* Disabled
* RTL
* Translates
* Show Label
* ...

Please see the document page for more examples.

## Async (autocomplete)
Easily create an autocomplete selection to get values from the server by typing and list them for the user.

Please see the [document](https://mostafarostami72.github.io/react-selection-box) page and go to examples.

## Usage

```jsx
import React, { Component } from 'react'
import React from 'react'

import Selection from 'react-selection-box'
import 'react-selection-box/dist/index.css'
Expand All @@ -38,11 +65,22 @@ const MyComponent = () => {
<div>

<Selection
type="single" // single, muliple, renge
name="counties"
label="Select Counties"
className=""
options={options}
onChange={handleChange}
searchable={true}
cleanable={true}
loading={false}
disabled={false}
rtl={false}
translates={{
placeholder: {
search: "Search countries"
}
}}
/>

</div>
Expand Down
4 changes: 2 additions & 2 deletions example/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-selection-box",
"version": "1.0.1",
"version": "1.0.2",
"description": "A beautiful and responsive Select Input control for ReactJS with singleselect, multiselect, rangeselect and autocomplete (async) support.",
"author": "MostafaRostami72",
"license": "MIT",
Expand Down

0 comments on commit 5da1680

Please sign in to comment.