Skip to content

Repository files navigation

Logo

js-standard-style

pell is the simplest and smallest WYSIWYG text editor for web, with no dependencies

Live demo: https://jaredreich.com/pell

Alt text

Comparisons

librarysize (min+gzip)size (min)jquerybootstrap
pell1.1kB2.9kB
medium-editor27kB105kB
quill43kB205kB
ckeditor163kB551kB
summernote26kB93kBxx
froala52kB186kBx
tinymce157kB491kBx

Features

  • Pure JavaScript, no dependencies, written in ES6
  • Easily customizable with the sass file (pell.scss) or overwrite the CSS

Current actions:

  • Bold
  • Italic
  • Underline
  • Strike-through
  • Heading 1
  • Heading 2
  • Paragraph
  • Quote
  • Ordered List
  • Unordered List
  • Code
  • Horizontal Rule
  • Link
  • Image
  • Undo
  • Redo

Other possible future actions:

  • Justify Center
  • Justify Full
  • Justify Left
  • Justify Right
  • Subscript
  • Superscript
  • Font Name
  • Font Size
  • Indent
  • Outdent
  • Clear Formatting

Browser Support

  • IE 9+
  • Chrome 5+
  • Firefox 4+
  • Safari 5+
  • Opera 11.6+

Installation

npm:

npm install --save pell

HTML:

<head>
...
<linkrel="stylesheet" type="text/css" href="https://unpkg.com/pell/dist/pell.min.css"><style>/* override styles here */
.pell-editor {
background-color: pink;
}
</style></head><body>
...
<!-- Bottom of body --><scriptsrc="https://unpkg.com/pell"></script></body>

Usage

// ES6importpellfrom'pell'// orimport{init}from'pell'
// Browserpell// orwindow.pell

Example:

<divid="pell"></div><div>
Text output:
<divid="text-output"></div>
HTML output:
<preid="html-output"></pre></div>
pell.init({actions: ['bold',{name: 'italic',icon: '&#9786;',title: 'Zitalic'},'underline'],classes: {actionbar: 'pell-actionbar',button: 'pell-button',editor: 'pell-editor'},onChange: html=>{document.getElementById('text-output').innerHTML=htmldocument.getElementById('html-output').textContent=html},root: 'pell'})

Custom Styles

SCSS:

$pell-editor-height: 400px;
// See all overwriteable variables in src/pell.scss// Then import pell.scss into styles:@import'../../node_modules/pell/src/pell';

CSS:

/* After pell styles are applied to DOM: */
.pell-editor {
height:400px;
}

License

MIT

About

📝 the simplest and smallest (1kB) WYSIWYG text editor for web, with no dependencies

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages