ship-components-texteditor

React rich text editor built on draft-js. Exports a commonjs module that can be used with webpack. Source is in ES6 and is compiled down to ES5 using Babel.

Usage

ES6/JSX (Recommended)

The component is written using ES6/JSX therefore Babel is recommended to use it. The below example is based on using webpack and babel-loader.

import React from 'react';
import TextEditor from 'ship-components-texteditor';

class Examples extends React.Component {

  constructor(props) {
    super(props);
    this.state ={
      basic: '<p>This is <b>some </b><u><b>sample</b></u> <i><b>text</b></i></p>'
    };

    this.handleChange = this.handleChange.bind(this);
  }

  <!-- Cause the text editor to update its internal state -->
  forceUpdateState() {
    return this.refs.editor.forceUpdateState();
  }

  handleChange(key, event) {
    this.setState({
      [key]: event.target.value
    });
  }

  render() {
    return (
      <div>
        <h1>{'<TextEditor /> Examples'}</h1>
        <div className='example-group'>
          <h2>Basic (HTML)</h2>
          <TextEditor
            ref='editor'
            editable
            type='html'
            inlineStyles={new Immutable.Set(['BOLD', 'UNDERLINE', 'ITALIC'])}
            onChange={this.handleChange.bind(this, 'basic')}
            value={this.state.basic}
          />
        </div>
      </div>
    );
  }
}

Note (Using forceUpdateState)

The function needs to be called in order to update the TextEditor internal state. Add the following code to the parent class to update TextEditor when the text value is changed. You may also need to implement the onFocus and / or onBlur methods to prevent the TextEditor from updating the internal state while user is typing which will cause double typing or cursur jumps around.

forceUpdateState() {
    if (this.refs.editor && typeof this.refs.editor.forceUpdateState === 'function') {
      this.refs.editor.forceUpdateState();
    } else if (process.env.NODE_ENV !== 'production') {
      console.warn('this.refs.editor.forceUpdateState is not a function');
    }
  }

Examples and Development

Examples can be found in the examples/ folder. A development server can be run with:

$ npm install
$ npm start

This will live reload any changes you make and serve them at http://localhost:8080.

Webpack Configuration

This module is designed to be used with webpack but requires a few loaders if you are pulling the source into another project.

$ npm install webpack babel-loader css-loader style-loader postcss-loader extract-text-webpack-plugin postcss-nested postcss-color-hex-alpha postcss-color-function postcss-calc postcss-simple-vars autoprefixer --save-dev

Below are is a sample of how to setup the loaders:

/**
 * Relevant Webpack Configuration
 */
{
  [...]
  module: {
    loaders: [
      // Setup support for ES6
      {
        test: /\.(jsx?|es6)$/,
        exclude: /node_modules/,
        loader: 'babel'
      },
      // ES6/JSX for external ship-components modules
      {
        test: /\.(jsx?|es6)$/,
        include: [
          /ship-components\-.*\/src/
        ],
        loader: 'babel'
      },
      // Loaded for fonts and images
      {
       test: /\.(png|svg|jpeg|jpg|ttf|eot|woff)/,
       loader: 'file?name=[path][name].[ext]'
      },
      // Setup support for CSS Modules
      {
        test: /\.css$/,
        loader: ExtractTextPlugin.extract('style-loader', 'css-loader?modules&importLoaders=1&localIdentName=[name]__[local]___[hash:base64:5]!postcss-loader')
      }
    ]
  },
  plugins: [
    // Extract the css and put it in one file. Path is relative to output path
    new ExtractTextPlugin('../css/[name].css', { allChunks: true })
  ],
  // CSS Modules
  postcss: [
    require('postcss-nested'),
    require('postcss-color-hex-alpha'),
    require('postcss-color-function'),
    require('postcss-calc'),
    require('autoprefixer')
  ],
  [...]
}

Tests

1. npm install
2. npm test

History

• 2.2.3 - Fixed errors in specific scenarios when replacing text with entities. Plus, minor linting fixes.
• 2.2.2 - Fixed convert to text conversion when certain entities are present.
• 2.2.1 - Reverted original example text, improved convert to text conversion.
• 2.2.0 - Added support for custom entities (suggestion, mention, and hashtag)
• 2.1.10 - Continued possible onChange loop bug fixes for 2.1.8 and 2.1.9
• 2.1.9 - Fixes breaking bug in 2.1.8 happening when certain links in text are converted.
• 2.1.8 - Optimized link recognizing to call the onChange callback only if neccessary.
• 2.1.7 - Performance improvements, and fix for toolbar buttons not toggling without a selection.
• 2.1.6 - Inline converted links can be edited via the link editing modal.
• 2.1.5 - Adding links now works without requiring a selection, and malformatted URLs entered in link modal will be better parsed
• 2.1.4 - Fixes the bug where editor loses focus when a toolbar button is clicked
• 2.1.3 - Modals will not be not part of the texteditor render method
• 2.1.2 - Added basic convert to hyperlink functionality
• 2.0.0 - Upgrade to React 16
• 1.0.2 - Update to use postcss-calc 6
• 1.0.1 - Update to use latest draft-js and draft-convert (for React 16 compatibility)
• 1.0.0 - Update to use prop-types (for React 16 compatibility)
• 0.4.0 - Babel preset update
• 0.3.4 - Added more unit tests
• 0.3.3 - Adds the JSON loader to parse the json files (Bug fix).
• 0.3.2 - Fixes the bug where adding line breaks (br tag) was getting removed.
• 0.3.0 - Adds Tests, Travis CI and coverage
• 0.2.4 - Adds an option to pass in a prop to only show inline style buttons or no buttons.
• 0.2.3 - Added an option to remove HTML tags from string when passing prop type='text'
• 0.2.2 - Renamed method to forceUpdateState to avoid name conflict
• 0.2.1 - Fixed devDeps -> deps issue
• 0.2.0 - Switched to draft-js for core engine, added inline link support, added more styles
• 0.1.0 - Initial

License

The MIT License (MIT)

Copyright (c) 2016 SHIP

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.