React wrapper for lightweight WYSIWYG editor Trumbowyg
JavaScript HTML
Latest commit 48cbaaa Nov 29, 2016 @sochix sochix committed on GitHub Update README.md
Permalink
Failed to load latest commit information.
examples-es6 Initial commit Nov 9, 2016
examples-vanilla-js Initial commit Nov 9, 2016
src
.babelrc Initial commit Nov 9, 2016
.eslintignore
.eslintrc
.gitignore Initial commit Nov 9, 2016
.npmignore
LICENSE
README.md
demo.gif
package.json
webpack.config.js

README.md

React-Trumbowyg

npm version

React wrapper for trumbowyg.

If you ❤️ library, please star it and upvote it on awesome-react-components

Demo

Table of contents

How do I add this to my project?

Install react-trumbowyg via npm:

> npm i react-trumbowyg --save

or build from source:

> npm install && npm build

Dependencies

React-Trumbowyg depends on Trymbowyg only.

Starter Guide

Trumbowyg requires some setup procedures before you can use it.

First of all, you need to install jQuery

> npm i jquery --save

If you are using webpack or another build system you need to expose jQuery to window as global variable.

Webpack example:

new webpack.ProvidePlugin({
    $: "jquery",
    jQuery: "jquery"
}) 

Secondly, you need to add Trymbowyg styles

import 'react-trumbowyg/dist/trumbowyg.min.css'

Finally, import React-Trymbowyg component

import Trumbowyg from 'react-trumbowyg'

<Trumbowyg id='react-trumbowyg'/>

That's it!

Examples

Available Properties and Event Handlers

React-Trumbowyg expose all properties of Trumbowyg, and adds self as well

Trumbowyg properties

Trumbowyg Prop Default Type
id String
data String
placeholder String
buttons Array<String>
semantic true Bool
resetCss false Bool
removeformatPasted false Bool
autogrow false Bool
disabled false Bool

Self properties

  • shouldUseSvgIcons:boolean - if true, displays SVG icons, else show only text. (Default: true)
  • svgIconsPath:string - path to SVG icons file. SVG file will be loaded with AJAX request. (Default: '')
  • shouldInjectSvgIcons: boolean - React-Trumbowyg can inject SVG icons to body, so you can avoid loading it. If this prop is false, you should specify the path to your own svg icons in svgIconsPath prop. (Default: true)

Event handlers

  • onFocus - Event handler when the focus is on editor
  • onBlur - Blur on editor
  • onInit - Editor is initialized
  • onChange - Change in editor
  • onResize - Resize the editor on autogrow
  • onPaste - Paste something in the editor
  • onOpenFullScreen - Switch to fullscreen mode
  • onCloseFullScreen - Leave editor's fullscreen mode
  • onClose - Close the editor

Contributors

License

The MIT License

Copyright (c) 2016 RD17 http://rdseventeen.com/

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.