https://github.com/amirkarimi/neptune

The simplest and smallest WYSIWYG text editor for web, with no dependencies ported to ScalaJS!
https://github.com/amirkarimi/neptune

editor javascript scala scalajs wysiwyg

Last synced: 3 months ago
JSON representation

The simplest and smallest WYSIWYG text editor for web, with no dependencies ported to ScalaJS!

• Host: GitHub
• URL: https://github.com/amirkarimi/neptune
• Owner: amirkarimi
• Created: 2017-07-16T20:29:09.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-09-27T17:36:01.000Z (over 3 years ago)
• Last Synced: 2023-07-31T12:25:47.203Z (over 1 year ago)
• Topics: editor, javascript, scala, scalajs, wysiwyg
• Language: Scala
• Size: 609 KB
• Stars: 7
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
> Neptune is ScalaJS port of [pell](https://github.com/jaredreich/pell), the simplest and smallest WYSIWYG text editor for web, with no dependencies.

![Neptune](neptune.png)

It's pure Scala; even the CSS is written in Scala using [ScalaCSS](https://github.com/japgolly/scalacss)

![Neptune Demo](neptune_demo.gif)

## Comparisons

| library       | size (min+gzip) | size (min) | jquery | bootstrap |

|---------------|-----------------|------------|--------|-----------|

| neptune       | 73kB            | 291kB      |        |           |

| pell          | 1.11kB          | 2.85kB     |        |           |

| medium-editor | 27kB            | 105kB      |        |           |

| quill         | 43kB            | 205kB      |        |           |

| ckeditor      | 163kB           | 551kB      |        |           |

| summernote    | 26kB            | 93kB       | x      | x         |

| froala        | 52kB            | 186kB      | x      |           |

| tinymce       | 157kB           | 491kB      | x      |           |

## Features

* Pure Scala, no dependencies

* Easily customizable with the Scala CSS DSL

* No separate CSS file, it's merged inside a single JS file and will be added to document automatically

Current actions:

- Bold

- Italic

- Underline

- Strike-through

- Heading 1

- Heading 2

- Paragraph

- Quote

- Ordered List

- Unordered List

- Code

- Horizontal Rule

- Link

- Image

## Browser Support

* IE 9+

* Chrome 5+

* Firefox 4+

* Safari 5+

* Opera 11.6+

## Compile

[Install SBT](http://www.scala-sbt.org/download.html) and then

```bash

sbt fullOptJS

```

Find the generated optimized JS file at: `target/scala-2.11/neptune-opt.js`

## License

MIT