draftjs-formsy-input

This React component is to be used as a draft.js input type for formsy-react. It is possible to use with draft-js-plugins.

Demo & Examples

Live demo: michalpierzchlewicz.github.io/draftjs-formsy-input

To build the examples locally, run:

npm install
npm start

Then open localhost:8000 in a browser.

Installation

The easiest way to use draftjs-formsy-input is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/draftjs-formsy-input.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

npm install draftjs-formsy-input --save

Usage

To get started with using it, import DraftjsFormsyInput and insert it inside a forsmy-rest Form component.

// pre ES6
var DraftjsFormsyInput = require('draftjs-formsy-input');
// ES6
import DraftjsFormsyInput from 'draftjs-formsy-input';

<DraftjsFormsyInput
    name="draftjsFormsyInput "
/>

Properties

name string [required] – inherited from Formsy input
label string – input label
help string – help info displayed below input
required boolean [default: false] – if input is required (used by a forsmy-rest Form)
style object – styling the input (more information below)
outputValueMode string [default: ‘html’] – ‘html’ or ‘raw’ output value format
value string – default value of the input (IMPORTANT: use with outputValueMode prop correctly)
plugins array – use the same as plugin prop in draft-js-plugins Editor

Notes

ADDITIONAL USAGE NOTES

Development (`src`, `lib` and the build process)

NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run npm start. If you just want to watch changes to src and rebuild lib, run npm run watch (this is useful if you are working with npm link).

michalpierzchlewicz / draftjs-formsy-input Goto Github PK