1.0.0 • Published 6 years ago

react-bootstrap-xeditable v1.0.0

Weekly downloads
214
License
MIT
Repository
github
Last release
6 years ago

react-bootstrap-xeditable

X-Editable for React with Bootstrap. Demo

Build Status npm version devDependencies Status

Install

# npm
npm install react-bootstrap-xeditable

# yarn
yarn add react-bootstrap-xeditable

import bootstrap css and xeditable css

<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">

<link rel="stylesheet" href="https://vitalets.github.io/x-editable/assets/x-editable/bootstrap3-editable/css/bootstrap-editable.css">

Usage:

TextField

import {EditableTextField} from 'react-bootstrap-xeditable';

<EditableTextField name='username' value={this.state.value} onSave={this.onSave} placeholder='Please input your username'/>

Options

OptionTypeRequiredDescription
isEditingbooleanoptionalSet editing status
isEditablebooleanoptionalYou can make it readonly
linkClassNamestringoptionalDefined the css class for the link text
nonValueTextstringoptionalthe default text if no value
valuestringrequiredThe value of input text
onSavefunctionrequiredthe callback when click save button
onCancelfunctionoptionalthe callback when click cancel button
placeholderstringoptional

Select

const options = [
  {
    text: 'China',
    value: 'CN'
  }, {
    text: 'India',
    value: 'IN'
  }, {
    text: 'United Kingdom (UK)',
    value: 'UK'
  }, {
    text: 'United States of America (USA)',
    value: 'USA'
  }
];
import {EditableSelect} from 'react-bootstrap-xeditable';

<EditableSelect name='country' onSave={this.onSave} value={this.state.value} options={options}/>

Options

OptionTypeRequiredDescription
isEditingbooleanoptionalSet editing status
isEditablebooleanoptionalYou can make it readonly
linkClassNamestringoptionalDefined the css class for the link text
nonValueTextstringoptionalthe default text if no value
valuestringstring[]requiredThe value of input text
multiplebooleanoptionalIf the select support multiple
optionsIOption[]string[]requiredThe options
onSavefunctionrequiredthe callback when click save button
onCancelfunctionoptionalthe callback when click cancel button

TextArea

import {EditableTextArea} from 'react-bootstrap-xeditable';

<EditableTextArea name='username' value={this.state.value} onSave={this.onSave} placeholder='Please input your username'/>

Options

OptionTypeRequiredDescription
isEditingbooleanoptionalSet editing status
isEditablebooleanoptionalYou can make it readonly
linkClassNamestringoptionalDefined the css class for the link text
nonValueTextstringoptionalthe default text if no value
valuestringrequiredThe value of input text
onSavefunctionrequiredthe callback when click save button
onCancelfunctionoptionalthe callback when click cancel button

Progress:

  • :white_check_mark: : Supported
  • :runner: : In Progress
  • :thought_balloon: : Planning
ElementSupportReactXElement
textfield:white_check_mark:EditableTextField
select:white_check_mark:EditableSelect
textarea:white_check_mark:EditableTextArea
date:thought_balloon: 
datetime:thought_balloon: 
select2:thought_balloon: 

TypeScript:

d.ts already intergrated. just import it.

Known Issues:

  1. Only support inline mode
  2. onBlur not support yet

License

Licensed under the MIT license. Copyright (C) 2018 Kun Yan

1.0.0

6 years ago

0.2.12

6 years ago

0.2.10

7 years ago

0.2.9

8 years ago

0.2.8

8 years ago

0.2.7

8 years ago

0.2.6

8 years ago

0.2.5

8 years ago

0.2.4

8 years ago

0.2.3

8 years ago

0.2.2

8 years ago

0.2.1

8 years ago