Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/React-Artibox/artibox
Artibox - A complete rich text editor based on Slate framework.
https://github.com/React-Artibox/artibox
editor framework javascript react rich-editor rich-text rich-text-editor slate typescript
Last synced: 15 days ago
JSON representation
Artibox - A complete rich text editor based on Slate framework.
- Host: GitHub
- URL: https://github.com/React-Artibox/artibox
- Owner: React-Artibox
- License: mit
- Created: 2019-10-14T05:31:51.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T22:40:02.000Z (almost 2 years ago)
- Last Synced: 2024-10-21T05:31:07.049Z (22 days ago)
- Topics: editor, framework, javascript, react, rich-editor, rich-text, rich-text-editor, slate, typescript
- Language: TypeScript
- Homepage: https://react-artibox.github.io/artibox
- Size: 9.28 MB
- Stars: 20
- Watchers: 3
- Forks: 3
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Artibox
A complete rich text editor.
Currently based on [Slate](https://github.com/ianstormtaylor/slate) framework.
[](https://www.npmjs.com/package/@artibox/slate-common)
[](https://www.npmjs.com/package/@artibox/slate-common)
[](https://github.com/React-Artibox/artibox/blob/master/LICENSE)
[Try out our plugins](./?path=/story/examples-playgroud--all).
## Documentation
- [Getting Started](./?path=/story/docs-getting-started--page)
- [Theme](./?path=/story/docs-theme--page)
- [Locale](./?path=/story/docs-locale--page)
- [Icons](./?path=/story/docs-icons--page)
## Features
| Elements | |
| :-------------------------------------------------------- | :-------------------------------------------------------------------- |
| [Paragraph](./?path=/story/elements-paragraph--example) | Enables support for paragraphs. |
| [Blockquote](./?path=/story/elements-blockquote--example) | Enables support for block quotes. |
| [Embed](./?path=/story/elements-embed--example) | Enables support for embeddable media such as YouTube or Vimeo videos. |
| [Divider](./?path=/story/elements-divider--example) | Enables support for dividers. |
| [Heading](./?path=/story/elements-heading--example) | Enables support for headings (from 1 to 6). |
| [Image](./?path=/story/elements-image--example) | Enables support for images. |
| [Link](./?path=/story/elements-link--example) | Enables support for hyperlinks. |
| [List](./?path=/story/elements-list--example) | Enables support for bulleted, numbered lists. |
| [ReadMore](./?path=/story/elements-readmore--example) | Enables support for read more dividers. Commonly used in CMS. |
| Marks | |
| :----------------------------------------------------------- | :-------------------------------------------- |
| [Bold](./?path=/story/marks-bold--example) | Enables support for bold formatting. |
| [Highlight](./?path=/story/marks-highlight--example) | Enables support for highlights. |
| [Italic](./?path=/story/marks-italic--example) | Enables support for italic formatting. |
| [Strikethrough](./?path=/story/marks-strikethrough--example) | Enables support for strikethrough formatting. |
| [Underline](./?path=/story/marks-underline--example) | Enables support for underline formatting. |
| Handlers | |
| :---------------------------------------------- | :-------------------------------------------------- |
| [Break](./?path=/story/handlers-break--example) | Enables support for inserting exit and soft breaks. |
| Widgets | |
| :----------------------------------------------------------- | :---------------------------------------- |
| [FileUploader](./?path=/story/widgets-fileuploader--example) | Enables support for uploading files. |
| [InputBlock](./?path=/story/widgets-inputblock--example) | Enables support for inputting processing. |
| [Toolbar](./?path=/story/widgets-toolbar--example) | Provides a toolbar with tools. |
| Serializers | |
| :------------------------------------------------------- | :------------------------------------- |
| [JsxSerializer](./?path=/story/serializers-jsx--example) | Provides serializer for rendering jsx. |
## Development scripts
Useful scripts include:
```bash
yarn
```
> Installs package dependencies
```bash
yarn build
```
> Build the local packages.
```bash
yarn storybook:start
```
> Starts storybook dev (after building).
```bash
yarn lint
```
> Lint ts/js files w/ [eslint](https://eslint.org/) and scss files w/ [stylelint](https://stylelint.io/).
```bash
yarn test
```
> Test w/ [jest](https://jestjs.io/).
```bash
yarn release
```
> Using lerna to bump package versions, build and publish to npm via [conventional changelog](https://github.com/conventional-changelog).