mirror of
https://github.com/codex-team/editor.js
synced 2024-05-07 00:46:45 +02:00
63eeec0f3b
Co-authored-by: George Berezhnoy <gohabereg@users.noreply.github.com> Co-authored-by: Georgy Berezhnoy <gohabereg@gmail.com> Co-authored-by: tasuku-s <tasuku@freemind.co.jp> Co-authored-by: Athul Anil Kumar <athul7744@outlook.com> Co-authored-by: Taly <vitalik7tv@yandex.ru> Co-authored-by: flaming-cl <51183663+flaming-cl@users.noreply.github.com> Co-authored-by: Nguyen Ngoc Son <sonnn.se@gmail.com> Co-authored-by: Sisir Das K <37764463+sis-dk@users.noreply.github.com> Co-authored-by: Sisir <sisir@hellosivi.com>
382 lines
12 KiB
HTML
382 lines
12 KiB
HTML
<!--
|
|
This page contains example of editor.js internalization.
|
|
See <script> section -> i18n property of the configuration object
|
|
|
|
\ (•◡•) /
|
|
-->
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>Editor.js 🤩🧦🤨 example</title>
|
|
<link href="https://fonts.googleapis.com/css?family=PT+Mono" rel="stylesheet">
|
|
<link href="assets/demo.css" rel="stylesheet">
|
|
<script src="assets/json-preview.js"></script>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
|
|
</head>
|
|
<body>
|
|
<div class="ce-example">
|
|
<div class="ce-example__header">
|
|
<a class="ce-example__header-logo" href="https://codex.so/editor">Editor.js 🤩🧦🤨</a>
|
|
|
|
<div class="ce-example__header-menu">
|
|
<a href="https://github.com/editor-js" target="_blank">Plugins</a>
|
|
<a href="https://editorjs.io/usage" target="_blank">Usage</a>
|
|
<a href="https://editorjs.io/configuration" target="_blank">Configuration</a>
|
|
<a href="https://editorjs.io/creating-a-block-tool" target="_blank">API</a>
|
|
</div>
|
|
</div>
|
|
<div class="ce-example__content _ce-example__content--small">
|
|
<div id="editorjs"></div>
|
|
|
|
<div class="ce-example__button" id="saveButton">
|
|
editor.save()
|
|
</div>
|
|
</div>
|
|
<div class="ce-example__output">
|
|
<pre class="ce-example__output-content" id="output"></pre>
|
|
|
|
<div class="ce-example__output-footer">
|
|
<a href="https://codex.so" style="font-weight: bold;">Made by CodeX</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Load Tools -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/header@latest"></script><!-- Header -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/simple-image@latest"></script><!-- Image -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/delimiter@latest"></script><!-- Delimiter -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/list@latest"></script><!-- List -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/checklist@latest"></script><!-- Checklist -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/quote@latest"></script><!-- Quote -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/code@latest"></script><!-- Code -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/embed@latest"></script><!-- Embed -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/table@latest"></script><!-- Table -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/link@latest"></script><!-- Link -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/warning@latest"></script><!-- Warning -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/marker@latest"></script><!-- Marker -->
|
|
<script src="https://cdn.jsdelivr.net/npm/@editorjs/inline-code@latest"></script><!-- Inline Code -->
|
|
|
|
<!-- Load Editor.js's Core -->
|
|
<script src="../dist/editor.js"></script>
|
|
|
|
<!-- Initialization -->
|
|
<script>
|
|
/**
|
|
* Saving button
|
|
*/
|
|
const saveButton = document.getElementById('saveButton');
|
|
|
|
/**
|
|
* To initialize the Editor, create a new instance with configuration object
|
|
* @see docs/installation.md for mode details
|
|
*/
|
|
var editor = new EditorJS({
|
|
/**
|
|
* Wrapper of Editor
|
|
*/
|
|
holder: 'editorjs',
|
|
|
|
/**
|
|
* Tools list
|
|
*/
|
|
tools: {
|
|
/**
|
|
* Each Tool is a Plugin. Pass them via 'class' option with necessary settings {@link docs/tools.md}
|
|
*/
|
|
header: {
|
|
class: Header,
|
|
inlineToolbar: ['link'],
|
|
config: {
|
|
placeholder: 'Header'
|
|
},
|
|
shortcut: 'CMD+SHIFT+H'
|
|
},
|
|
|
|
/**
|
|
* Or pass class directly without any configuration
|
|
*/
|
|
image: SimpleImage,
|
|
|
|
list: {
|
|
class: List,
|
|
inlineToolbar: true,
|
|
shortcut: 'CMD+SHIFT+L'
|
|
},
|
|
|
|
checklist: {
|
|
class: Checklist,
|
|
inlineToolbar: true,
|
|
},
|
|
|
|
quote: {
|
|
class: Quote,
|
|
inlineToolbar: true,
|
|
config: {
|
|
quotePlaceholder: 'Enter a quote',
|
|
captionPlaceholder: 'Quote\'s author',
|
|
},
|
|
shortcut: 'CMD+SHIFT+O'
|
|
},
|
|
|
|
warning: Warning,
|
|
|
|
marker: {
|
|
class: Marker,
|
|
shortcut: 'CMD+SHIFT+M'
|
|
},
|
|
|
|
code: {
|
|
class: CodeTool,
|
|
shortcut: 'CMD+SHIFT+C'
|
|
},
|
|
|
|
delimiter: Delimiter,
|
|
|
|
inlineCode: {
|
|
class: InlineCode,
|
|
shortcut: 'CMD+SHIFT+C'
|
|
},
|
|
|
|
linkTool: LinkTool,
|
|
|
|
embed: Embed,
|
|
|
|
table: {
|
|
class: Table,
|
|
inlineToolbar: true,
|
|
shortcut: 'CMD+ALT+T'
|
|
},
|
|
|
|
},
|
|
/**
|
|
* To provide localization of the editor.js you need to provide 'i18n' option with 'messages' dictionary:
|
|
*
|
|
* 1. At the 'ui' section of 'messages' there are translations for the internal editor.js UI elements.
|
|
* You can create or find/download a dictionary for your language
|
|
*
|
|
* 2. As long as tools list is a user-specific thing (we do not know which tools you use and under which names),
|
|
* so we can't provide a ready-to-use tool names dictionary.
|
|
* There is a 'toolNames' section for that reason. Put translations for the names of your tools there.
|
|
*
|
|
* 3. Also, the UI of the tools you use is also invisible to editor.js core.
|
|
* To pass translations for specific tools (that supports I18n API), there are 'tools' and 'blockTunes' section.
|
|
* Pass dictionaries for specific plugins through them.
|
|
*/
|
|
i18n: {
|
|
/**
|
|
* @type {I18nDictionary}
|
|
*/
|
|
messages: {
|
|
/**
|
|
* Other below: translation of different UI components of the editor.js core
|
|
*/
|
|
"ui": {
|
|
"blockTunes": {
|
|
"toggler": {
|
|
"Click to tune": "Нажмите, чтобы настроить",
|
|
"or drag to move": "или перетащите"
|
|
},
|
|
},
|
|
"inlineToolbar": {
|
|
"converter": {
|
|
"Convert to": "Конвертировать в"
|
|
}
|
|
},
|
|
"toolbar": {
|
|
"toolbox": {
|
|
"Add": "Добавить"
|
|
}
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Section for translation Tool Names: both block and inline tools
|
|
*/
|
|
"toolNames": {
|
|
"Text": "Параграф",
|
|
"Heading": "Заголовок",
|
|
"List": "Список",
|
|
"Warning": "Примечание",
|
|
"Checklist": "Чеклист",
|
|
"Quote": "Цитата",
|
|
"Code": "Код",
|
|
"Delimiter": "Разделитель",
|
|
"Raw HTML": "HTML-фрагмент",
|
|
"Table": "Таблица",
|
|
"Link": "Ссылка",
|
|
"Marker": "Маркер",
|
|
"Bold": "Полужирный",
|
|
"Italic": "Курсив",
|
|
"InlineCode": "Моноширинный",
|
|
},
|
|
|
|
/**
|
|
* Section for passing translations to the external tools classes
|
|
*/
|
|
"tools": {
|
|
/**
|
|
* Each subsection is the i18n dictionary that will be passed to the corresponded plugin
|
|
* The name of a plugin should be equal the name you specify in the 'tool' section for that plugin
|
|
*/
|
|
"warning": { // <-- 'Warning' tool will accept this dictionary section
|
|
"Title": "Название",
|
|
"Message": "Сообщение",
|
|
},
|
|
|
|
/**
|
|
* Link is the internal Inline Tool
|
|
*/
|
|
"link": {
|
|
"Add a link": "Вставьте ссылку"
|
|
},
|
|
/**
|
|
* The "stub" is an internal block tool, used to fit blocks that does not have the corresponded plugin
|
|
*/
|
|
"stub": {
|
|
'The block can not be displayed correctly.': 'Блок не может быть отображен'
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Section allows to translate Block Tunes
|
|
*/
|
|
"blockTunes": {
|
|
/**
|
|
* Each subsection is the i18n dictionary that will be passed to the corresponded Block Tune plugin
|
|
* The name of a plugin should be equal the name you specify in the 'tunes' section for that plugin
|
|
*
|
|
* Also, there are few internal block tunes: "delete", "moveUp" and "moveDown"
|
|
*/
|
|
"delete": {
|
|
"Delete": "Удалить"
|
|
},
|
|
"moveUp": {
|
|
"Move up": "Переместить вверх"
|
|
},
|
|
"moveDown": {
|
|
"Move down": "Переместить вниз"
|
|
}
|
|
},
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Initial Editor data
|
|
*/
|
|
data: {
|
|
blocks: [
|
|
{
|
|
type: "header",
|
|
data: {
|
|
text: "Editor.js",
|
|
level: 2
|
|
}
|
|
},
|
|
{
|
|
type : 'paragraph',
|
|
data : {
|
|
text : 'Hey. Meet the new Editor. On this page you can see it in action — try to edit this text. Source code of the page contains the example of connection and configuration.'
|
|
}
|
|
},
|
|
{
|
|
type: "header",
|
|
data: {
|
|
text: "Key features",
|
|
level: 3
|
|
}
|
|
},
|
|
{
|
|
type : 'list',
|
|
data : {
|
|
items : [
|
|
'It is a block-styled editor',
|
|
'It returns clean data output in JSON',
|
|
'Designed to be extendable and pluggable with a simple API',
|
|
],
|
|
style: 'unordered'
|
|
}
|
|
},
|
|
{
|
|
type: "header",
|
|
data: {
|
|
text: "What does it mean «block-styled editor»",
|
|
level: 3
|
|
}
|
|
},
|
|
{
|
|
type : 'paragraph',
|
|
data : {
|
|
text : 'Workspace in classic editors is made of a single contenteditable element, used to create different HTML markups. Editor.js <mark class=\"cdx-marker\">workspace consists of separate Blocks: paragraphs, headings, images, lists, quotes, etc</mark>. Each of them is an independent contenteditable element (or more complex structure) provided by Plugin and united by Editor\'s Core.'
|
|
}
|
|
},
|
|
{
|
|
type : 'paragraph',
|
|
data : {
|
|
text : `There are dozens of <a href="https://github.com/editor-js">ready-to-use Blocks</a> and the <a href="https://editorjs.io/creating-a-block-tool">simple API</a> for creation any Block you need. For example, you can implement Blocks for Tweets, Instagram posts, surveys and polls, CTA-buttons and even games.`
|
|
}
|
|
},
|
|
{
|
|
type: "header",
|
|
data: {
|
|
text: "What does it mean clean data output",
|
|
level: 3
|
|
}
|
|
},
|
|
{
|
|
type : 'paragraph',
|
|
data : {
|
|
text : 'Classic WYSIWYG-editors produce raw HTML-markup with both content data and content appearance. On the contrary, Editor.js outputs JSON object with data of each Block. You can see an example below'
|
|
}
|
|
},
|
|
{
|
|
type : 'paragraph',
|
|
data : {
|
|
text : `Given data can be used as you want: render with HTML for <code class="inline-code">Web clients</code>, render natively for <code class="inline-code">mobile apps</code>, create markup for <code class="inline-code">Facebook Instant Articles</code> or <code class="inline-code">Google AMP</code>, generate an <code class="inline-code">audio version</code> and so on.`
|
|
}
|
|
},
|
|
{
|
|
type : 'paragraph',
|
|
data : {
|
|
text : 'Clean data is useful to sanitize, validate and process on the backend.'
|
|
}
|
|
},
|
|
{
|
|
type : 'delimiter',
|
|
data : {}
|
|
},
|
|
{
|
|
type : 'paragraph',
|
|
data : {
|
|
text : 'We have been working on this project more than three years. Several large media projects help us to test and debug the Editor, to make its core more stable. At the same time we significantly improved the API. Now, it can be used to create any plugin for any task. Hope you enjoy. 😏'
|
|
}
|
|
},
|
|
{
|
|
type: 'image',
|
|
data: {
|
|
url: 'assets/codex2x.png',
|
|
caption: '',
|
|
stretched: false,
|
|
withBorder: true,
|
|
withBackground: false,
|
|
}
|
|
},
|
|
]
|
|
},
|
|
onReady: function(){
|
|
saveButton.click();
|
|
},
|
|
});
|
|
|
|
/**
|
|
* Saving example
|
|
*/
|
|
saveButton.addEventListener('click', function () {
|
|
editor.save().then((savedData) => {
|
|
cPreview.show(savedData, document.getElementById("output"));
|
|
});
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|