Skip to content

malhindi/react-inline-editing

 
 

Repository files navigation

A simple React inline editing component.

This is an inline, editable text/label component built in React.

The <EditableLabel /> allows the user to simply click and edit text inline. It consists of a <label> element to display the unedited text and an <input /> element to allow editing.

example

Installation

npm install --save react-inline-editing

Component props

* Required

Prop Type Description
text (*) string Text to be displayed on both the label and initially in the editor
isEditing bool Flags whether the label should be in editor mode
isTextarea bool Flags whether input type text or textarea
labelClassName string Class name for the text styling
labelId string Id for the label
labelFontSize string Font size for the text
labelFontWeight string Font weight for the text
inputMaxLength number Max length for the input in editing mode
inputPlaceHolder string Placeholder for the input in editing mode
inputWidth string Width of the input in editing mode
inputHeight string Height of the input in editing mode
inputFontSize string Font size for the input in editing mode
inputFontWeight string Font weight for the input in editing mode
inputClassName string Class name for the input editor's styling
inputId string Id for the input
inputBorderWidth string Border width for the input in editing mode
textareaCols number Specifies the visible width of the textarea
onFocus function Callback for text focusing. Parameter(s): text
onFocusOut function Callback for focus leaving editor. Parameter(s): text

Example

import React from 'react';
import ReactDOM from 'react-dom';
import EditableLabel from 'react-inline-editing';

class App extends React.Component {
    constructor(props){
      super(props);

      this._handleFocus = this._handleFocus.bind(this);
      this._handleFocusOut = this._handleFocusOut.bind(this);
    }

    _handleFocus(text, event) {
        console.log('Focused with text: ' + text);
        console.log('Label id: ' + event.target.id);        
    }

    _handleFocusOut(text, event) {
        console.log('Left editor with text: ' + text);
        console.log('Input id: ' + event.target.id);
    }

    render() {
        return <div>
            <EditableLabel text='Hello!'
                labelClassName='myLabelClass'
                labelId='myLabelId'
                inputClassName='myInputClass'
                inputId="myInputId"
                inputWidth='200px'
                inputHeight='25px'
                inputMaxLength='50'
                labelFontWeight='bold'
                inputFontWeight='bold'
                onFocus={this._handleFocus}
                onFocusOut={this._handleFocusOut}
            />
                <EditableLabel text='Hello this is a textarea!'
                isTextarea={true}
                labelClassName='myLabelClass'
                labelId='myLabelId'
                inputClassName='myInputClass'
                inputId="myInputId"
                textareaCols='50'
                onFocus={this._handleFocus}
                onFocusOut={this._handleFocusOut}
            />
        </div>
    }
}

ReactDOM.render(
  <App />,
  document.getElementById('container')
);

About

An inline, customizable and editable text component built in React.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%