Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract inline fragments from HTML markup #1801

Draft
wants to merge 6 commits into
base: next
Choose a base branch
from
Draft

Extract inline fragments from HTML markup #1801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2831423
Extract inline fragments from HTML markup
gohabereg Oct 16, 2021
929dcc4
Merge branch 'next' of github.com:codex-team/editor.js into feature/c…
gohabereg Dec 26, 2021
80cffee
Merge branch 'next' of github.com:codex-team/editor.js into feature/c…
gohabereg Jan 13, 2022
aacc10f
Merge branch 'next' of github.com:codex-team/editor.js into feature/c…
gohabereg May 1, 2022
f57c694
WIP
gohabereg Jul 14, 2022
6ac47d1
Merge branch 'next' of github.com:codex-team/editor.js into feature/c…
gohabereg Nov 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 5 additions & 180 deletions example/example-dev.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,75 +138,12 @@
* Tools list
*/
tools: {
paragraph: {
inlineToolbar: ['italic', 'bold', 'link']
}
/**
* Each Tool is a Plugin. Pass them via 'class' option with necessary settings {@link docs/tools.md}
*/
header: {
class: Header,
inlineToolbar: ['marker', 'link'],
config: {
placeholder: 'Header'
},
shortcut: 'CMD+SHIFT+H'
},

/**
* Or pass class directly without any configuration
*/
image: SimpleImage,

list: {
class: NestedList,
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,

raw: RawTool,

embed: Embed,

table: {
class: Table,
inlineToolbar: true,
shortcut: 'CMD+ALT+T'
},

},

/**
Expand All @@ -220,123 +157,11 @@
data: {
blocks: [
{
id: "zcKCF1S7X8",
type: "header",
data: {
text: "Editor.js",
level: 1
}
},
{
"id": "b6ji-DvaKb",
"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",
id: "7ItVl5biRo",
data: {
text: "Key features",
level: 2
}
},
{
type : 'list',
id: "SSBSguGvP7",
data : {
items : [
{
content: 'It is a block-styled editor',
items: []
},
{
content: 'It returns clean data output in JSON',
items: []
},
{
content: 'Designed to be extendable and pluggable with a simple API',
items: []
}
],
style: 'unordered'
}
},
{
type: "header",
id: "QZFox1m_ul",
data: {
text: "What does it mean «block-styled editor»",
level: 2
}
},
{
type : 'paragraph',
id: "bwnFX5LoX7",
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',
id: "mTrPOHAQTe",
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",
id: "1sYMhUrznu",
data: {
text: "What does it mean clean data output",
level: 2
}
},
{
type : 'paragraph',
id: "jpd7WEXrJG",
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',
id: "0lOGNUKxqt",
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',
id: "WvX7kBjp0I",
data : {
text : 'Clean data is useful to sanitize, validate and process on the backend.'
}
},
{
type : 'delimiter',
id: "H9LWKQ3NYd",
data : {}
},
{
type : 'paragraph',
id: "h298akk2Ad",
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',
id: "9802bjaAA2",
data: {
url: 'assets/codex2x.png',
caption: '',
stretched: false,
withBorder: true,
withBackground: false,
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer commodo, neque in pulvinar sodales, ante lacus blandit massa, vel tempor."
}
},
}
]
},
onReady: function(){
Expand Down
5 changes: 4 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
"terser-webpack-plugin": "^2.3.6",
"ts-loader": "^7.0.1",
"tslint": "^6.1.1",
"typescript": "3.8.3",
"typescript": "^4.6.4",
"webpack": "^4.43.0",
"webpack-cli": "^3.3.11"
},
Expand All @@ -101,5 +101,8 @@
"codex-notifier": "^1.1.2",
"codex-tooltip": "^1.0.5",
"nanoid": "^3.1.22"
},
"resolutions": {
"typescript": "4.6.4"
}
}
8 changes: 8 additions & 0 deletions src/components/block/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
BlockTool as IBlockTool,
BlockToolData,
BlockTune as IBlockTune,
InlineTool as IInlineTool,
SanitizerConfig,
ToolConfig,
ToolboxConfigEntry,
Expand All @@ -21,6 +22,7 @@ import BlockTune from '../tools/tune';
import { BlockTuneData } from '../../../types/block-tunes/block-tune-data';
import ToolsCollection from '../tools/collection';
import EventsDispatcher from '../utils/events';
import InlineFragmentsContainer from './inline-fragments/container';

/**
* Interface describes Block class constructor argument
Expand Down Expand Up @@ -146,6 +148,8 @@ export default class Block extends EventsDispatcher<BlockEvents> {
*/
public readonly config: ToolConfig;

public fragments: InlineFragmentsContainer;

/**
* Cached inputs
*
Expand Down Expand Up @@ -278,6 +282,8 @@ export default class Block extends EventsDispatcher<BlockEvents> {
this.composeTunes(tunesData);

this.holder = this.compose();

this.fragments = new InlineFragmentsContainer(tool, this.inputs[0]);
}

/**
Expand Down Expand Up @@ -585,6 +591,8 @@ export default class Block extends EventsDispatcher<BlockEvents> {
const extractedBlock = await this.toolInstance.save(this.pluginsContent as HTMLElement);
const tunesData: { [name: string]: BlockTuneData } = this.unavailableTunesData;

console.log(this.fragments.save());

[
...this.tunesInstances.entries(),
...this.defaultTunesInstances.entries(),
Expand Down
Loading