@toast-ui/editor-plugin-color-syntax
Advanced tools
Readme
This is a plugin of TOAST UI Editor to color editing text.
- node_modules/
- @toast-ui/
- editor-plugin-color-syntax/
- dist/
- toastui-editor-plugin-color-syntax.js
The bundle files include all dependencies of this plugin.
- uicdn.toast.com/
- editor-plugin-color-syntax/
- latest/
- toastui-editor-plugin-color-syntax.js
- toastui-editor-plugin-color-syntax.min.js
To use the plugin, @toast-ui/editor must be installed.
Ref. Getting Started
$ npm install @toast-ui/editor-plugin-color-syntax
Along with the plugin, the plugin's dependency style must be imported. The color-syntax plugin has TOAST UI Color Picker as a dependency, and you need to add a CSS file of TOAST UI Color Picker.
import 'tui-color-picker/dist/tui-color-picker.css';
import colorSyntax from '@toast-ui/editor-plugin-color-syntax';
require('tui-color-picker/dist/tui-color-picker.css');
const colorSyntax = require('@toast-ui/editor-plugin-color-syntax');
// ...
import 'tui-color-picker/dist/tui-color-picker.css';
import Editor from '@toast-ui/editor';
import colorSyntax from '@toast-ui/editor-plugin-color-syntax';
const editor = new Editor({
// ...
plugins: [colorSyntax]
});
To use the plugin, the CDN files(CSS, Script) of @toast-ui/editor must be included.
...
<head>
...
<link
rel="stylesheet"
href="https://uicdn.toast.com/tui-color-picker/latest/tui-color-picker.min.css"
/>
...
</head>
<body>
...
<!-- Editor -->
<script src="https://uicdn.toast.com/editor/latest/toastui-editor-all.min.js"></script>
<!-- Editor's Plugin -->
<script src="https://uicdn.toast.com/editor-plugin-color-syntax/latest/toastui-editor-plugin-color-syntax.min.js"></script>
...
</body>
...
const { Editor } = toastui;
const { colorSyntax } = Editor.plugin;
const editor = new Editor({
// ...
plugins: [colorSyntax]
});
The color-syntax plugin can set options when used. Just add the plugin function and options related to the plugin to the array([pluginFn, pluginOptions]) and push them to the plugins option of the editor.
The following options are available in the color-syntax plugin.
The useCustomSyntax option is false by default, applying color syntax using the span tag. (e.g. <span style="color:#ff00ff">foo</span>) If enabled, it will use custom syntax instead of the span tag. (e.g. {color:# ff00ff}test{color})
| Name | Type | Default Value | Description |
|---|---|---|---|
preset | Array.<string> | Preset for color palette | |
useCustomSyntax | boolean | false | Whether use custom syntax or not |
// ...
import 'tui-color-picker/dist/tui-color-picker.css';
import Editor from '@toast-ui/editor';
import colorSyntax from '@toast-ui/editor-plugin-color-syntax';
const colorSyntaxOptions = {
preset: ['#181818', '#292929', '#393939'],
useCustomSyntax: true
};
const editor = new Editor({
// ...
plugins: [[colorSyntax, colorSyntaxOptions]]
});
FAQs
TOAST UI Editor : Color Syntax Plugin
The npm package @toast-ui/editor-plugin-color-syntax receives a total of 4,133 weekly downloads. As such, @toast-ui/editor-plugin-color-syntax popularity was classified as popular.
We found that @toast-ui/editor-plugin-color-syntax demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The US Justice Department has penalized two consulting firms $11.3 million for failing to meet cybersecurity requirements on federally funded projects, emphasizing strict enforcement to protect sensitive government data.
Security News
ua-parser-js is set to drop the MIT license and adopt a controversial dual AGPLv3 + PRO licensing model in its upcoming v2.0 release, raising significant concerns among developers and enterprise users.
Security News
Researchers recently demonstrated that the npm Registry is vulnerable to cache poisoning combined with DoS, posing significant risks for package availability.