Skip to content

SalahEddin/react-simple-editlabel

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A simple React inline editing component.

This is an inline, editable text/label component ✍️ built using React Hooks 🔥

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-simple-editlabel

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
labelClassName string Class name for the text styling
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
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
inputBorderWidth string Border width for the input in editing mode
onFocus function Callback for text focusing. Parameter(s): text
onFocusOut function Callback for focus leaving editor. Parameter(s): text
raiseOnFocusOutOnEsc bool Whether to call onFocusOut when escpe is clicked

Example

import React from 'react';
import ReactDOM from 'react-dom';
import EditableLabel from 'react-simple-editlabel';

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

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

    _handleFocus(text) {
        console.log('Focused with text: ' + text);
    }

    _handleFocusOut(text) {
        console.log('Left editor with text: ' + text);
    }

    render() {
        return <div>
            <EditableLabel text='Hello!'
                labelClassName='myLabelClass'
                inputClassName='myInputClass'
                inputWidth='200px'
                inputMaxLength='50'
                labelFontWeight='bold'
                inputFontWeight='bold'
                onFocus={this._handleFocus}
                onFocusOut={this._handleFocusOut}
            />
        </div>
    }
}

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

Based on the work of cheekujha

About

An inline and editable text component built in React.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 82.0%
  • HTML 11.4%
  • CSS 6.6%