react-edit-in-place
v0.10.0
Published
Edit In Place Component For React
Downloads
14
Readme
Edit In Place React
All in one edit in place component for react covers most of the input types as the following :
- text
- number
- select
- textarea
- date
- datetime-local
- color
- month
- number
- range
- search
- tel
- time
- url
- week
Usege
1 - install the module :
npm i react-edit-in-place
2 - import the EditInPlace Module:
import EditInPlace from "react-edit-in-place"
3 - add JSX :
text | number | date | time | datetime-local | color | email | month | range | search | tel | url | week inputs
<EditInPlace
value="my text"
name="text1"
type="text"
placeholder="text1"
className="test"
style={{color:"red"}}
errorStyle={{color:"red"}}
isDisabled={false}
validate={(value) => true}
extraParams={{id:"1"}}
onChange={(value, name, extraParams) => console.log(value, name, extraParams)}
/>
textarea
<EditInPlace
value="text"
name="textarea1"
type="textarea"
onChange={(value, name) => console.log(value, name)}
/>
select
<EditInPlace
value="option1"
name="select1"
type="select"
dropDownOptions={['option1','option2']}
onChange={(value, name) => console.log(value, name)}
/>
Props
- name (String | Required): name or unique identifier of the input.
- value (String | Required) : the value of the input.
- onChange (Function | Required) : triggred when the value is changed.
- placeholder (String) : input Place Holder.
- className (String) : Custom Classes to be added to the input when it is displayed.
- validate (Function): a validation function that get passed the value before triggering the onChange Event, it returns true or false as of valid data of invalid data.
- style (Object): Style Object to be added to the input when it is displayed.
- extraParams (Object): any extra data you need to be passed on calling the onChange Function.
- errorStyle (Object) : the style of the input when the validation function returnes false which is invalid data.
- isDisabled (Bool) : disable the edit.
- type (String) : the type of the edit input , which covers only the following (color,date,datetime-local,email,month,number,range,search,tel,time,url,week,text,select,textarea).
- dropDownOptions (Array) : DropDown input options list
Feedback
For any bugs or feedback , please contact me at [email protected]
Github Repo : https://github.com/hassan-alnator/react-edit-in-place