Compare commits
89 commits
v2.27.0-rc
...
next
Author | SHA1 | Date | |
---|---|---|---|
29d68ecb47 | |||
d18eeb5dc8 | |||
50f43bb35d | |||
f78972ee09 | |||
bd1de56ef3 | |||
8276daa5ca | |||
238c909016 | |||
23858e0025 | |||
5eafda5ec4 | |||
efa0a34f8e | |||
c48fca1be3 | |||
1028577521 | |||
844272656e | |||
7821e35302 | |||
4118dc3aea | |||
e1c70b4fb8 | |||
54c4c234a5 | |||
5125f015dc | |||
ecdd73347c | |||
1320b047a2 | |||
b355f1673c | |||
bb2047c60f | |||
cc0d6de04b | |||
9b3e9615b0 | |||
ee6433201d | |||
e9b4c30407 | |||
8138ce95b2 | |||
7ff5faa46f | |||
b619946e8f | |||
9542551d84 | |||
4bdf7a12b7 | |||
c5ddf91189 | |||
11925ca980 | |||
cd29c52e51 | |||
ea2be754e7 | |||
5515c3b534 | |||
6385ab2a39 | |||
c5854eea14 | |||
348c1c7752 | |||
8726f8bdfa | |||
494d6e4b9b | |||
531ab06f63 | |||
5e8fe06dd6 | |||
af6b64a3e6 | |||
92ccfc5317 | |||
ee188bfe5d | |||
35337747c5 | |||
d936bf08b7 | |||
e8acc59487 | |||
bdb6eed9d1 | |||
b8cfcaec26 | |||
7d0db9b622 | |||
ca2bc803a1 | |||
c9014e670d | |||
ec569f9981 | |||
77eb320203 | |||
0369ff5827 | |||
59c8d28da5 | |||
f8e9414217 | |||
42612a0fd9 | |||
be0d33ce0f | |||
922dfd8741 | |||
b39996616c | |||
0e64665b0f | |||
022320940e | |||
41dc65274d | |||
b24bebbc40 | |||
2ab9eb13bc | |||
9e64003c0a | |||
c8993332e3 | |||
39018e07e4 | |||
1f74c5bec9 | |||
0d6c8bd4af | |||
26dce94e67 | |||
e6c265d0fa | |||
b7b00fd060 | |||
aafab1d395 | |||
0491155e33 | |||
707ff72a94 | |||
f5313fda40 | |||
d7f1853ca1 | |||
75379c66a9 | |||
c18011595a | |||
b7d754c93d | |||
5257b061c4 | |||
293135a795 | |||
e9e0146961 | |||
599d332aef | |||
839daf556f |
19
.babelrc
|
@ -1,19 +0,0 @@
|
|||
{
|
||||
"presets": [
|
||||
["@babel/preset-env", {
|
||||
"modules": "umd",
|
||||
"useBuiltIns": "entry",
|
||||
"corejs": 3
|
||||
}]
|
||||
],
|
||||
"plugins": [
|
||||
"babel-plugin-add-module-exports",
|
||||
"babel-plugin-class-display-name",
|
||||
"@babel/plugin-transform-runtime"
|
||||
],
|
||||
"env": {
|
||||
"test": {
|
||||
"plugins": [ "istanbul" ]
|
||||
}
|
||||
}
|
||||
}
|
|
@ -31,6 +31,8 @@
|
|||
"ClientRect": true,
|
||||
"ArrayLike": true,
|
||||
"InputEvent": true,
|
||||
"unknown": true
|
||||
"unknown": true,
|
||||
"requestAnimationFrame": true,
|
||||
"navigator": true
|
||||
}
|
||||
}
|
||||
|
|
2
.github/FUNDING.yml
vendored
|
@ -1,5 +1,5 @@
|
|||
# These are supported funding model platforms
|
||||
|
||||
github: neSpecc
|
||||
patreon: editorjs
|
||||
open_collective: editorjs
|
||||
custom: https://codex.so/donate
|
30
.github/workflows/bump-version-on-merge-next.yml
vendored
|
@ -1,7 +1,14 @@
|
|||
name: Bump version on merge
|
||||
|
||||
# Caution:
|
||||
# the use of "pull_request_target" trigger allows to successfully
|
||||
# run workflow even when triggered from a fork. The trigger grants
|
||||
# access to repo's secrets and gives write permission to the runner.
|
||||
# This can be used to run malicious code on untrusted PR, so, please
|
||||
# DO NOT checkout any PR's ongoing commits (aka github.event.pull_request.head.sha)
|
||||
# while using this trigger.
|
||||
on:
|
||||
pull_request:
|
||||
pull_request_target:
|
||||
branches:
|
||||
- next
|
||||
types: [closed]
|
||||
|
@ -11,6 +18,8 @@ jobs:
|
|||
check-for-no-version-changing:
|
||||
if: github.event.pull_request.merged == true
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
actions: write
|
||||
steps:
|
||||
# Checkout to target branch
|
||||
- uses: actions/checkout@v2
|
||||
|
@ -32,16 +41,22 @@ jobs:
|
|||
uses: codex-team/action-nodejs-package-info@v1
|
||||
|
||||
# Stop workflow and do not bump version if it was changed already
|
||||
- name: Stop workflow and do not bump version if it was changed already
|
||||
uses: actions/github-script@v3
|
||||
- name: Stop workflow if version was changed already
|
||||
if: steps.packageOld.outputs.version != steps.packageNew.outputs.version
|
||||
with:
|
||||
script: |
|
||||
core.setFailed('Version was changed! ${{ steps.packageOld.outputs.version }} -> ${{ steps.packageNew.outputs.version }}')
|
||||
run: |
|
||||
curl -L \
|
||||
-X POST \
|
||||
-H "Accept: application/vnd.github+json" \
|
||||
-H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
|
||||
-H "X-GitHub-Api-Version: 2022-11-28" \
|
||||
https://api.github.com/repos/${{ github.repository }}/actions/runs/${{ github.run_id }}/cancel
|
||||
|
||||
bump-version:
|
||||
needs: check-for-no-version-changing
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
steps:
|
||||
# Checkout to target branch
|
||||
- uses: actions/checkout@v2
|
||||
|
@ -49,8 +64,7 @@ jobs:
|
|||
# Setup node environment
|
||||
- uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 15
|
||||
registry-url: https://registry.npmjs.org/
|
||||
node-version: 16
|
||||
|
||||
# Bump version to the next prerelease (patch) with rc suffix
|
||||
- name: Suggest the new version
|
||||
|
|
49
.github/workflows/create-a-release-draft.yml
vendored
|
@ -1,7 +1,14 @@
|
|||
name: Create a release draft
|
||||
|
||||
# Caution:
|
||||
# the use of "pull_request_target" trigger allows to successfully
|
||||
# run workflow even when triggered from a fork. The trigger grants
|
||||
# access to repo's secrets and gives write permission to the runner.
|
||||
# This can be used to run malicious code on untrusted PR, so, please
|
||||
# DO NOT checkout any PR's ongoing commits (aka github.event.pull_request.head.sha)
|
||||
# while using this trigger.
|
||||
on:
|
||||
pull_request:
|
||||
pull_request_target:
|
||||
branches:
|
||||
- next
|
||||
types: [closed]
|
||||
|
@ -11,7 +18,12 @@ jobs:
|
|||
check-version-changing:
|
||||
if: github.event.pull_request.merged == true
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
actions: write
|
||||
steps:
|
||||
- uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 16
|
||||
# Checkout to target branch
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
|
@ -33,16 +45,21 @@ jobs:
|
|||
|
||||
# Stop workflow if version was not changed
|
||||
- name: Stop workflow if version was not changed
|
||||
uses: actions/github-script@v3
|
||||
if: steps.packageOld.outputs.version == steps.packageNew.outputs.version
|
||||
with:
|
||||
script: |
|
||||
core.setFailed('No version changes. ${{ steps.packageOld.outputs.version }}')
|
||||
run: |
|
||||
curl -L \
|
||||
-X POST \
|
||||
-H "Accept: application/vnd.github+json" \
|
||||
-H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
|
||||
-H "X-GitHub-Api-Version: 2022-11-28" \
|
||||
https://api.github.com/repos/${{ github.repository }}/actions/runs/${{ github.run_id }}/cancel
|
||||
|
||||
# Create a new draft release
|
||||
release-draft:
|
||||
needs: check-version-changing
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
# Checkout to target branch
|
||||
- uses: actions/checkout@v2
|
||||
|
@ -53,8 +70,7 @@ jobs:
|
|||
# Setup node environment
|
||||
- uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 14.17.0
|
||||
registry-url: https://registry.npmjs.org/
|
||||
node-version: 16
|
||||
|
||||
# Prepare, build and publish project
|
||||
- name: Install dependencies
|
||||
|
@ -87,16 +103,27 @@ jobs:
|
|||
# If version name contains "-rc" suffix than mark a "pre-release" checkbox
|
||||
prerelease: ${{ contains(steps.package.outputs.version, '-rc') }}
|
||||
|
||||
# Build and upload target Editor.js build to release as artifact
|
||||
# Build and upload target Editor.js UMD build to release as artifact
|
||||
- name: Upload Release Asset
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: dist/editor.js
|
||||
asset_name: editor.js
|
||||
asset_path: dist/editorjs.umd.js
|
||||
asset_name: editorjs.umd.js
|
||||
asset_content_type: application/javascript
|
||||
|
||||
# Build and upload target Editor.js MJS build to release as artifact
|
||||
- name: Upload Release Asset
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: dist/editorjs.mjs
|
||||
asset_name: editorjs.mjs
|
||||
asset_content_type: application/javascript
|
||||
|
||||
# Send a notification message
|
||||
- name: Send a message
|
||||
|
@ -105,4 +132,4 @@ jobs:
|
|||
webhook: ${{ secrets.CODEX_BOT_WEBHOOK_FRONTEND }}
|
||||
message: '🦥 [Draft release v${{ steps.package.outputs.version }}](${{ steps.create_release.outputs.html_url }}) for package [${{ steps.package.outputs.name }}](${{ steps.package.outputs.npmjs-link }}) has been created. Add changelog and publish it!'
|
||||
parse_mode: 'markdown'
|
||||
disable_web_page_preview: true
|
||||
disable_web_page_preview: true
|
50
.github/workflows/cypress.yml
vendored
|
@ -1,45 +1,21 @@
|
|||
name: Tests
|
||||
name: Cypress
|
||||
|
||||
on: [pull_request]
|
||||
|
||||
jobs:
|
||||
firefox:
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: cypress/browsers:node14.17.0-chrome88-ff89
|
||||
options: --user 1001
|
||||
steps:
|
||||
- uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 16
|
||||
- uses: actions/checkout@v2
|
||||
- run: yarn ci:pull_paragraph
|
||||
- uses: cypress-io/github-action@v2
|
||||
with:
|
||||
config: video=false
|
||||
browser: firefox
|
||||
build: yarn build
|
||||
chrome:
|
||||
run-tests:
|
||||
strategy:
|
||||
matrix:
|
||||
browser: [firefox, chrome, edge]
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 16
|
||||
- uses: actions/checkout@v2
|
||||
- run: yarn ci:pull_paragraph
|
||||
- uses: cypress-io/github-action@v2
|
||||
node-version: 18
|
||||
- uses: actions/checkout@v4
|
||||
- uses: cypress-io/github-action@v6
|
||||
with:
|
||||
config: video=false
|
||||
browser: chrome
|
||||
build: yarn build
|
||||
edge:
|
||||
runs-on: windows-latest
|
||||
steps:
|
||||
- uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 16
|
||||
- uses: actions/checkout@v2
|
||||
- run: yarn ci:pull_paragraph
|
||||
- uses: cypress-io/github-action@v2
|
||||
with:
|
||||
config: video=false
|
||||
browser: edge
|
||||
build: yarn build
|
||||
browser: ${{ matrix.browser }}
|
||||
build: yarn build:test
|
||||
|
|
3
.github/workflows/eslint.yml
vendored
|
@ -19,6 +19,5 @@ jobs:
|
|||
${{ runner.OS }}-build-
|
||||
${{ runner.OS }}-
|
||||
|
||||
- run: yarn install
|
||||
|
||||
- run: yarn
|
||||
- run: yarn lint
|
||||
|
|
12
.github/workflows/publish-package-to-npm.yml
vendored
|
@ -10,7 +10,7 @@ jobs:
|
|||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
# Checkout to target branch
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
# Pull submodules
|
||||
submodules: 'recursive'
|
||||
|
@ -22,7 +22,7 @@ jobs:
|
|||
# Setup node environment
|
||||
- uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 14.17.0
|
||||
node-version: 16
|
||||
registry-url: https://registry.npmjs.org/
|
||||
|
||||
# Prepare, build and publish project
|
||||
|
@ -46,9 +46,11 @@ jobs:
|
|||
notify:
|
||||
needs: publish
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
GITHUB_LINK: ${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ github.ref_name }}
|
||||
steps:
|
||||
# Checkout to target branch
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Get package info
|
||||
id: package
|
||||
|
@ -58,6 +60,6 @@ jobs:
|
|||
uses: codex-team/action-codexbot-notify@v1
|
||||
with:
|
||||
webhook: ${{ secrets.CODEX_BOT_NOTIFY_EDITORJS_PUBLIC_CHAT }}
|
||||
message: '📦 [${{ steps.package.outputs.name }}](${{ steps.package.outputs.npmjs-link }}) ${{ steps.package.outputs.version }} was published'
|
||||
message: '📦 [${{ steps.package.outputs.name }} ${{ steps.package.outputs.version }}](${{ env.GITHUB_LINK }}) was published'
|
||||
parse_mode: 'markdown'
|
||||
disable_web_page_preview: true
|
||||
disable_web_page_preview: true
|
1
.gitignore
vendored
|
@ -17,3 +17,4 @@ dist/
|
|||
|
||||
coverage/
|
||||
.nyc_output/
|
||||
.vscode/launch.json
|
||||
|
|
3
.gitmodules
vendored
|
@ -16,9 +16,6 @@
|
|||
[submodule "example/tools/simple-image"]
|
||||
path = example/tools/simple-image
|
||||
url = https://github.com/editor-js/simple-image
|
||||
[submodule "src/tools/paragraph"]
|
||||
path = src/tools/paragraph
|
||||
url = https://github.com/editor-js/paragraph
|
||||
[submodule "example/tools/marker"]
|
||||
path = example/tools/marker
|
||||
url = https://github.com/editor-js/marker
|
||||
|
|
10
.npmignore
|
@ -1,6 +1,6 @@
|
|||
*
|
||||
!dist/**/*
|
||||
!types/**/*
|
||||
!LICENSE
|
||||
!README.md
|
||||
!package.json
|
||||
!/dist/**/*
|
||||
!/types/**/*
|
||||
!/LICENSE
|
||||
!/README.md
|
||||
!/package.json
|
||||
|
|
|
@ -1,8 +1,4 @@
|
|||
plugins:
|
||||
# Consumes files by @import rule
|
||||
# https://github.com/postcss/postcss-import
|
||||
postcss-import: {}
|
||||
|
||||
# Apply custom property sets via @apply rule
|
||||
# https://github.com/pascalduez/postcss-apply
|
||||
postcss-apply: {}
|
||||
|
@ -26,16 +22,6 @@ plugins:
|
|||
# https://github.com/csstools/postcss-preset-env#preserve
|
||||
preserve: false
|
||||
|
||||
# Enable or disable specific polyfills
|
||||
# https://github.com/csstools/postcss-preset-env#features
|
||||
#
|
||||
# List of available plugins
|
||||
# https://github.com/csstools/postcss-preset-env/blob/master/src/lib/plugins-by-id.js
|
||||
features:
|
||||
# Modify colors using the color-mod() function in CSS
|
||||
# https://github.com/jonathantneal/postcss-color-mod-function
|
||||
color-mod-function: {}
|
||||
|
||||
# Nested rules unwrapper
|
||||
# https://github.com/postcss/postcss-nested
|
||||
#
|
||||
|
@ -43,7 +29,3 @@ plugins:
|
|||
# 'postcss-nesting' feature but it does not work with BEM
|
||||
# Report: https://github.com/csstools/postcss-preset-env/issues/40
|
||||
postcss-nested: {}
|
||||
|
||||
# Compression tool
|
||||
# https://github.com/cssnano/cssnano
|
||||
cssnano: {}
|
||||
|
|
2
.vscode/settings.json
vendored
|
@ -8,6 +8,7 @@
|
|||
"colspan",
|
||||
"contenteditable",
|
||||
"contentless",
|
||||
"Convertable",
|
||||
"cssnano",
|
||||
"cssnext",
|
||||
"Debouncer",
|
||||
|
@ -34,6 +35,7 @@
|
|||
"textareas",
|
||||
"twitterwidget",
|
||||
"typeof",
|
||||
"Unmergeable",
|
||||
"viewports"
|
||||
]
|
||||
}
|
||||
|
|
35
cypress.config.ts
Normal file
|
@ -0,0 +1,35 @@
|
|||
import { defineConfig } from 'cypress';
|
||||
|
||||
export default defineConfig({
|
||||
env: {
|
||||
NODE_ENV: 'test',
|
||||
},
|
||||
fixturesFolder: 'test/cypress/fixtures',
|
||||
screenshotsFolder: 'test/cypress/screenshots',
|
||||
video: false,
|
||||
videosFolder: 'test/cypress/videos',
|
||||
e2e: {
|
||||
// We've imported your old cypress plugins here.
|
||||
// You may want to clean this up later by importing these.
|
||||
setupNodeEvents(on, config) {
|
||||
on('file:preprocessor', require('cypress-vite')(config));
|
||||
|
||||
/**
|
||||
* Plugin for cypress that adds better terminal output for easier debugging.
|
||||
* Prints cy commands, browser console logs, cy.request and cy.intercept data. Great for your pipelines.
|
||||
* https://github.com/archfz/cypress-terminal-report
|
||||
*/
|
||||
require('cypress-terminal-report/src/installLogsPrinter')(on);
|
||||
|
||||
require('./test/cypress/plugins/index.ts')(on, config);
|
||||
},
|
||||
specPattern: 'test/cypress/tests/**/*.cy.{js,jsx,ts,tsx}',
|
||||
supportFile: 'test/cypress/support/index.ts',
|
||||
},
|
||||
'retries': {
|
||||
// Configure retry attempts for `cypress run`
|
||||
'runMode': 2,
|
||||
// Configure retry attempts for `cypress open`
|
||||
'openMode': 0,
|
||||
},
|
||||
});
|
11
cypress.json
|
@ -1,11 +0,0 @@
|
|||
{
|
||||
"env": {
|
||||
"NODE_ENV": "test"
|
||||
},
|
||||
"fixturesFolder": "test/cypress/fixtures",
|
||||
"integrationFolder": "test/cypress/tests",
|
||||
"screenshotsFolder": "test/cypress/screenshots",
|
||||
"videosFolder": "test/cypress/videos",
|
||||
"supportFile": "test/cypress/support/index.ts",
|
||||
"pluginsFile": "test/cypress/plugins/index.ts"
|
||||
}
|
|
@ -1,14 +1,118 @@
|
|||
# Changelog
|
||||
|
||||
### 2.30.0
|
||||
|
||||
- `New` – Block Tunes now supports nesting items
|
||||
- `New` – Block Tunes now supports separator items
|
||||
- `New` – "Convert to" control is now also available in Block Tunes
|
||||
- `Improvement` — The ability to merge blocks of different types (if both tools provide the conversionConfig)
|
||||
- `Fix` — `onChange` will be called when removing the entire text within a descendant element of a block.
|
||||
- `Fix` - Unexpected new line on Enter press with selected block without caret
|
||||
- `Fix` - Search input autofocus loosing after Block Tunes opening
|
||||
- `Fix` - Block removing while Enter press on Block Tunes
|
||||
- `Fix` – Unwanted scroll on first typing on iOS devices
|
||||
- `Fix` - Unwanted soft line break on Enter press after period and space (". |") on iOS devices
|
||||
- `Fix` - Caret lost after block conversion on mobile devices.
|
||||
- `Fix` - Caret lost after Backspace at the start of block when previoius block is not convertable
|
||||
- `Improvement` - The API `blocks.convert()` now returns the new block API
|
||||
- `Improvement` - The API `caret.setToBlock()` now can accept either BlockAPI or block index or block id
|
||||
- `New` – *Menu Config* – New item type – HTML
|
||||
– `Refactoring` – Switched to Vite as Cypress bundler
|
||||
– `New` – *Menu Config* – Default and HTML items now support hints
|
||||
|
||||
### 2.29.1
|
||||
|
||||
- `Fix` — Toolbox wont be shown when Slash pressed with along with Shift or Alt
|
||||
- `Fix` — Toolbox will be opened when Slash pressed in non-US keyboard layout where there is no physical '/' key.
|
||||
|
||||
### 2.29.0
|
||||
|
||||
- `New` — Editor Config now has the `style.nonce` attribute that could be used to allowlist editor style tag for Content Security Policy "style-src"
|
||||
- `New` — Toolbox now will be opened by '/' in empty Block instead of Tab
|
||||
- `New` — Block Tunes now will be opened by 'CMD+/' instead of Tab in non-empty block
|
||||
- `New` — Tab now will navigate through Blocks. In last block Tab will navigate to the next input on page.
|
||||
- `Fix` — Passing an empty array via initial data or `blocks.render()` won't break the editor
|
||||
- `Fix` — Layout did not shrink when a large document cleared in Chrome
|
||||
- `Fix` — Multiple Tooltip elements creation fixed
|
||||
- `Fix` — When the focusing Block is out of the viewport, the page will be scrolled.
|
||||
- `Fix` - Compiler error "This import is never used as a value and must use 'import type'..." fixed
|
||||
- `Fix` — `blocks.render()` won't lead the `onChange` call in Safari
|
||||
- `Fix` — Editor wrapper element growing on the Inline Toolbar close
|
||||
- `Fix` — Fix errors thrown by clicks on a document when the editor is being initialized
|
||||
- `Fix` — Caret losing on Mobile Devices when adding a block via Toolbox or via Backspace at the beginning of a Block
|
||||
- `Improvement` — Now you can set focus via arrows/Tab to "contentless" (decorative) blocks like Delimiter which have no inputs.
|
||||
- `Improvement` — Inline Toolbar sometimes opened in an incorrect position. Now it will be aligned by the left side of the selected text. And won't overflow the right side of the text column.
|
||||
- `Improvement` - Now the `data-mutation-free` supports deep nesting, so you can mark some element with it to prevent the onChange call caused by child element mutating
|
||||
- `Improvement` - Now the `data-mutation-free` also allows to skip "characterData" mutations (eg. text content change)
|
||||
- `Refactoring` — `ce-block--focused` class toggling removed as unused.
|
||||
|
||||
### 2.28.2
|
||||
|
||||
- `Fix` — Get rid of redundant logs from the build
|
||||
|
||||
### 2.28.1
|
||||
|
||||
- `Fix` — Some Block were be skipped on saving after pasting them as HTML
|
||||
|
||||
### 2.28.0
|
||||
|
||||
- `New` - Block ids now displayed in DOM via a data-id attribute. Could be useful for plugins that want to access a Block's element by id.
|
||||
- `New` - The `blocks.convert(blockId, newType)` API method was added. It allows to convert existing Block to a Block of another type.
|
||||
- `New` - The `blocks.insertMany()` API method added. It allows to insert several Blocks to the specified index.
|
||||
- `Improvement` - The Delete keydown at the end of the Block will now work opposite a Backspace at the start. Next Block will be removed (if empty) or merged with the current one.
|
||||
- `Improvement` - The Delete keydown will work like a Backspace when several Blocks are selected.
|
||||
- `Improvement` - If we have two empty Blocks, and press Backspace at the start of the second one, the previous will be removed instead of the current.
|
||||
- `Improvement` - Tools shortcuts could be used to convert one Block to another.
|
||||
- `Improvement` - Tools shortcuts displayed in the Conversion Toolbar
|
||||
- `Improvement` - Initialization Loader has been removed.
|
||||
- `Improvement` - Selection style won't override your custom style for `::selection` outside the editor.
|
||||
- `Improvement` - Performance optimizations: initialization speed increased, `blocks.render()` API method optimized. Big documents will be displayed faster.
|
||||
- `Improvement` - "Editor saving" log removed
|
||||
- `Improvement` - "I'm ready" log removed
|
||||
- `Improvement` - The stub-block style is simplified.
|
||||
- `Improvement` - If some Block's tool throws an error during construction, we will show Stub block instead of skipping it during render
|
||||
- `Improvement` - Call of `blocks.clear()` now will trigger onChange with "block-removed" event for all removed blocks.
|
||||
- `Improvement` - The `blocks.clear()` now can be awaited.
|
||||
- `Improvement` - `BlockMutationType` and `BlockMutationEvent` types exported
|
||||
- `Improvement` - `blocks.update(id, data)` now can accept partial data object — it will update only passed properties, others will remain the same.
|
||||
- `Improvement` - `blocks.update(id, data)` now will trigger onChange with only `block-change` event.
|
||||
- `Improvement` - `blocks.update(id, data)` will return a promise with BlockAPI object of the changed block.
|
||||
|
||||
|
||||
### 2.27.2
|
||||
|
||||
- `Fix` - `onChange` won't be called when element with data-mutation-free changes some attribute
|
||||
|
||||
### 2.27.1
|
||||
|
||||
- `Fix` - `onChange` will be called on removing the whole text in a block
|
||||
|
||||
### 2.27.0
|
||||
|
||||
- `Refactoring` — Popover class refactored.
|
||||
- `New` — *Toolbar API* — Added a new method for toggling the toolbox.
|
||||
- `New` — Added types for block mutation events
|
||||
- `New` — Batching added to the `onChange` callback. Now the second argument can contain an array of CustomEvents as well as a single one. Multiple changes made in a short period of time will be batched under a single `onChange` call.
|
||||
- `Improvement` — *Toolbox* — Number of `close()` method calls optimized.
|
||||
- `Improvement` — The `onChange` callback won't be triggered only if all mutations contain nodes with the `data-mutation-free` attributes.
|
||||
- `Fix` — Resolve compiler error from importing the BlockToolData type.
|
||||
- `Fix` — Resolved a problem when document was being scrolled to the beginning after moving up a Block above the viewport.
|
||||
- `Improvement` — Package size reduced by removing redundant files
|
||||
- `Fix`- Entire block being deleted on backspace key press when the browser has 3rd party grammer checker extension
|
||||
- `Improvement` — The `onChange` callback can be muted if all mutations contain nodes with the `data-mutation-free` attribute.
|
||||
- `Improvement` — Pressing "Enter" at the end of a Block won't lead to redundant `block-changed` event triggering. Only `block-added` event will be dispatched.
|
||||
- `Improvement` — The block mutation handler is now called on every block change (including background changes), instead of only when a block is focused
|
||||
- `Improvement` — Number of caret saving method calls optimized for Block Tunes opening/closing.
|
||||
- `Improvement` — Package size reduced by removing redundant files.
|
||||
- `Refactoring` — Switched from Webpack to Vite as the build system.
|
||||
- `Refactoring` — *Dependencies* — Upgraded Cypress to v12 and related libraries to the latest versions.
|
||||
- `Refactoring` — *Dependencies* — Upgraded TypeScript to v5.
|
||||
- `Refactoring` — `EventDispatcher` types improved. Now we can pass `EventsMap` via generic to specify a map of event names and their payloads that can be used in a particular EventDispatcher instance.
|
||||
- `Refactoring` — All events in common editor Event Bus now have own type declarations.
|
||||
- `Refactoring` — Removed the block mutation observer from blocks and attached a single observer to the editor's blocks wrapper element.
|
||||
- `Refactoring` — Removed the debounce from the block mutation handler and used batching instead.
|
||||
- `Refactoring` — Refactored the popover class for better performance and maintenance.
|
||||
- `Fix` — The `onChange` callback won't trigger when block tunes are opened or closed.
|
||||
- `Fix` — Resolved a compiler error caused by importing the `BlockToolData` type.
|
||||
- `Fix` — Resolved a problem where the document would scroll to the beginning after moving a block above the viewport.
|
||||
- `Fix`- Fixed several bugs caused by browser extensions — Removed the search for a block's container in the DOM on saving and kept it in memory instead, updating it when the tool changes a container element.
|
||||
- `Fix` — *ToolsAPI* — `pasteConfig` getter with `false` value could be used to disable paste handling by Editor.js core. Could be useful if your tool has its own paste handler.
|
||||
- `CI` — Ubuntu container is now used for Edge tests runner.
|
||||
- `CI` — Node 16 is used for GitHib Actions.
|
||||
|
||||
### 2.26.5
|
||||
|
||||
|
|
|
@ -180,7 +180,7 @@ this.api.notifier.show({
|
|||
});
|
||||
```
|
||||
|
||||
![](https://capella.pics/14fcdbe4-d6eb-41d4-b66e-e0e86ccf1a4b.jpg)
|
||||
![](assets/14fcdbe4-d6eb-41d4-b66e-e0e86ccf1a4b.jpg)
|
||||
|
||||
|
||||
Check out [`codex-notifier` package page](https://github.com/codex-team/js-notifier) on GitHub to find docs, params and examples.
|
||||
|
@ -203,8 +203,6 @@ After executing the `destroy` method, editor inctance becomes an empty object. T
|
|||
|
||||
Methods for showing Tooltip helper near your elements. Parameters are the same as in [CodeX Tooltips](http://github.com/codex-team/codex.tooltips) lib.
|
||||
|
||||
![](https://capella.pics/00e7094a-fdb9-429b-8015-9c56f19b4ef5.jpg)
|
||||
|
||||
#### Show
|
||||
|
||||
Method shows tooltip with custom content on passed element
|
||||
|
|
BIN
docs/assets/01a55381-46cd-47c7-b92e-34765434f2ca.jpg
Normal file
After Width: | Height: | Size: 328 KiB |
BIN
docs/assets/14fcdbe4-d6eb-41d4-b66e-e0e86ccf1a4b.jpg
Normal file
After Width: | Height: | Size: 8.3 KiB |
BIN
docs/assets/57267bab-f2f0-411b-a9d1-69abee6abab5.jpg
Normal file
After Width: | Height: | Size: 77 KiB |
BIN
docs/assets/6c1f708b-a30c-4ffd-a427-5b59a1a472e0.jpg
Normal file
After Width: | Height: | Size: 404 KiB |
BIN
docs/assets/796de9eb-bbe0-485c-bc8f-9a4cb76641b7.jpg
Normal file
After Width: | Height: | Size: 12 KiB |
BIN
docs/assets/79ce946a-d636-41cd-aa96-d3bc5ecfde03.jpg
Normal file
After Width: | Height: | Size: 58 KiB |
BIN
docs/assets/7ccbcfcd-1c49-4674-bea7-71021468a1bd.jpg
Normal file
After Width: | Height: | Size: 137 KiB |
|
@ -69,7 +69,7 @@ Check [Editor.js's community](https://github.com/editor-js/) to see Tools exampl
|
|||
## Create Editor instance
|
||||
|
||||
Create an instance of Editor.js and pass [Configuration Object](../src/types-internal/editor-config.ts).
|
||||
At least the `holderId` option is required.
|
||||
At least the `holder` option is required.
|
||||
|
||||
```html
|
||||
<div id="editorjs"></div>
|
||||
|
@ -92,7 +92,7 @@ var editor = new EditorJS({
|
|||
/**
|
||||
* Create a holder for the Editor and pass its ID
|
||||
*/
|
||||
holderId : 'editorjs',
|
||||
holder : 'editorjs',
|
||||
|
||||
/**
|
||||
* Available Tools list.
|
||||
|
|
|
@ -33,7 +33,7 @@ There is a [workflow](.github/workflows/publish-package-to-npm.yml) that fired o
|
|||
|
||||
Use target version changelog as a description.
|
||||
|
||||
![](https://capella.pics/57267bab-f2f0-411b-a9d1-69abee6abab5.jpg)
|
||||
![](assets/57267bab-f2f0-411b-a9d1-69abee6abab5.jpg)
|
||||
|
||||
Then you can publish the release and wait for package publishing via action.
|
||||
|
||||
|
@ -44,7 +44,7 @@ This package version will be published to NPM with default `latest` tag.
|
|||
If you want to publish release candidate version, use suffix `-rc.*` for package
|
||||
version in package.json file and in tag on releases page. Workflow will detect it and mark a release as "pre-release".
|
||||
|
||||
![](https://capella.pics/796de9eb-bbe0-485c-bc8f-9a4cb76641b7.jpg)
|
||||
![](assets/796de9eb-bbe0-485c-bc8f-9a4cb76641b7.jpg)
|
||||
|
||||
This package version will be published to NPM with `next` tag.
|
||||
|
||||
|
|
|
@ -129,8 +129,6 @@ Read more about Sanitizer configuration at the [Tools#sanitize](tools.md#sanitiz
|
|||
You can pass your Tool's title via `title` static getter. It can be used, for example, in the Tooltip with
|
||||
icon description that appears by hover.
|
||||
|
||||
![](https://capella.pics/00e7094a-fdb9-429b-8015-9c56f19b4ef5.jpg)
|
||||
|
||||
```ts
|
||||
export default class BoldInlineTool implements InlineTool {
|
||||
/**
|
||||
|
|
|
@ -70,7 +70,7 @@ to the `tools` property of Editor Config.
|
|||
|
||||
```javascript
|
||||
var editor = new EditorJS({
|
||||
holderId : 'editorjs',
|
||||
holder : 'editorjs',
|
||||
tools: {
|
||||
text: {
|
||||
class: Text,
|
||||
|
@ -410,7 +410,7 @@ static get sanitize() {
|
|||
|
||||
Editor.js has a Conversion Toolbar that allows user to convert one Block to another.
|
||||
|
||||
![](https://capella.pics/6c1f708b-a30c-4ffd-a427-5b59a1a472e0.jpg)
|
||||
![](assets/6c1f708b-a30c-4ffd-a427-5b59a1a472e0.jpg)
|
||||
|
||||
1. You can add ability to your Tool to be converted. Specify «export» property of `conversionConfig`.
|
||||
2. You can add ability to convert other Tools to your Tool. Specify «import» property of `conversionConfig`.
|
||||
|
|
|
@ -17,12 +17,12 @@ So how to use the Editor after [Installation](installation.md).
|
|||
|
||||
- Select text fragment and apply a style or insert a link from the Inline Toolbar
|
||||
|
||||
![](https://capella.pics/7ccbcfcd-1c49-4674-bea7-71021468a1bd.jpg)
|
||||
![](assets/7ccbcfcd-1c49-4674-bea7-71021468a1bd.jpg)
|
||||
|
||||
- Use «three-dots» button on the right to open Block Settings. From here, you can move and delete a Block
|
||||
or apply Tool's settings, if it provided. For example, set a Heading level or List style.
|
||||
|
||||
![](https://capella.pics/01a55381-46cd-47c7-b92e-34765434f2ca.jpg)
|
||||
![](assets/01a55381-46cd-47c7-b92e-34765434f2ca.jpg)
|
||||
|
||||
## Shortcuts
|
||||
|
||||
|
|
|
@ -10,8 +10,8 @@
|
|||
<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>
|
||||
<link href="../public/assets/demo.css" rel="stylesheet">
|
||||
<script src="../public/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>
|
||||
|
@ -89,25 +89,25 @@
|
|||
Read more in Tool's README file. For example:
|
||||
https://github.com/editor-js/header#installation
|
||||
-->
|
||||
<script src="./tools/header/dist/bundle.js" onload="document.getElementById('hint-tools').hidden = true"></script><!-- Header -->
|
||||
<script src="./tools/simple-image/dist/bundle.js"></script><!-- Image -->
|
||||
<script src="./tools/delimiter/dist/bundle.js"></script><!-- Delimiter -->
|
||||
<!-- <script src="./tools/list/dist/bundle.js"></script> List-->
|
||||
<script src="./tools/nested-list/dist/nested-list.js"></script><!-- Nested List -->
|
||||
<script src="./tools/checklist/dist/bundle.js"></script><!-- Checklist -->
|
||||
<script src="./tools/quote/dist/bundle.js"></script><!-- Quote -->
|
||||
<script src="./tools/code/dist/bundle.js"></script><!-- Code -->
|
||||
<script src="./tools/embed/dist/bundle.js"></script><!-- Embed -->
|
||||
<script src="./tools/table/dist/table.js"></script><!-- Table -->
|
||||
<script src="./tools/link/dist/bundle.js"></script><!-- Link -->
|
||||
<script src="./tools/raw/dist/bundle.js"></script><!-- Raw -->
|
||||
<script src="./tools/warning/dist/bundle.js"></script><!-- Warning -->
|
||||
<script src="./tools/header/dist/header.umd.js" onload="document.getElementById('hint-tools').hidden = true"></script><!-- Header -->
|
||||
<script src="./tools/simple-image/dist/simple-image.umd.js"></script><!-- Image -->
|
||||
<script src="./tools/delimiter/dist/delimiter.umd.js"></script><!-- Delimiter -->
|
||||
<!-- <script src="./tools/list/dist/list.umd.js"></script> List-->
|
||||
<script src="./tools/nested-list/dist/nested-list.umd.js"></script><!-- Nested List -->
|
||||
<script src="./tools/checklist/dist/checklist.umd.js"></script><!-- Checklist -->
|
||||
<script src="./tools/quote/dist/quote.umd.js"></script><!-- Quote -->
|
||||
<script src="./tools/code/dist/code.umd.js"></script><!-- Code -->
|
||||
<script src="./tools/embed/dist/embed.umd.js"></script><!-- Embed -->
|
||||
<script src="./tools/table/dist/table.umd.js"></script><!-- Table -->
|
||||
<script src="./tools/link/dist/link.umd.js"></script><!-- Link -->
|
||||
<script src="./tools/raw/dist/raw.umd.js"></script><!-- Raw -->
|
||||
<script src="./tools/warning/dist/warning.umd.js"></script><!-- Warning -->
|
||||
|
||||
<script src="./tools/marker/dist/bundle.js"></script><!-- Marker -->
|
||||
<script src="./tools/inline-code/dist/bundle.js"></script><!-- Inline Code -->
|
||||
<script src="./tools/marker/dist/marker.umd.js"></script><!-- Marker -->
|
||||
<script src="./tools/inline-code/dist/inline-code.umd.js"></script><!-- Inline Code -->
|
||||
|
||||
<!-- Load Editor.js's Core -->
|
||||
<script src="../dist/editor.js" onload="document.getElementById('hint-core').hidden = true;"></script>
|
||||
<script src="../dist/editorjs.umd.js" onload="document.getElementById('hint-core').hidden = true;"></script>
|
||||
|
||||
<!-- Initialization -->
|
||||
<script>
|
||||
|
|
|
@ -10,8 +10,8 @@
|
|||
<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>
|
||||
<link href="../public/assets/demo.css" rel="stylesheet">
|
||||
<script src="../public/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>
|
||||
|
@ -61,7 +61,7 @@
|
|||
<script src="https://cdn.jsdelivr.net/npm/@editorjs/inline-code@latest"></script><!-- Inline Code -->
|
||||
|
||||
<!-- Load Editor.js's Core -->
|
||||
<script src="../dist/editor.js" onload="document.getElementById('hint-core').hidden = true"></script>
|
||||
<script src="../dist/editorjs.umd.js" onload="document.getElementById('hint-core').hidden = true"></script>
|
||||
|
||||
<!-- Initialization -->
|
||||
<script>
|
||||
|
|
|
@ -9,7 +9,7 @@
|
|||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>Editor.js 🤩🧦🤨 example: Multiple instances</title>
|
||||
<link href="assets/demo.css" rel="stylesheet">
|
||||
<link href="../public/assets/demo.css" rel="stylesheet">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
|
||||
</head>
|
||||
<body>
|
||||
|
@ -41,7 +41,7 @@
|
|||
</div>
|
||||
|
||||
<!-- Load Editor.js's Core -->
|
||||
<script src="../dist/editor.js" onload="document.getElementById('hint-core').hidden = true"></script>
|
||||
<script src="../dist/editorjs.umd.js" onload="document.getElementById('hint-core').hidden = true"></script>
|
||||
<script src="./tools/header/dist/bundle.js"></script><!-- Header -->
|
||||
|
||||
<!-- Initialization -->
|
||||
|
|
|
@ -9,7 +9,7 @@
|
|||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>Editor.js 🤩🧦🤨 example: Popup</title>
|
||||
<link href="assets/demo.css" rel="stylesheet">
|
||||
<link href="../public/assets/demo.css" rel="stylesheet">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
|
||||
</head>
|
||||
<body>
|
||||
|
@ -111,7 +111,7 @@
|
|||
</div>
|
||||
|
||||
<!-- Load Editor.js's Core -->
|
||||
<script src="../dist/editor.js" onload="document.getElementById('hint-core').hidden = true"></script>
|
||||
<script src="../dist/editorjs.umd.js" onload="document.getElementById('hint-core').hidden = true"></script>
|
||||
<script src="./tools/header/dist/bundle.js"></script><!-- Header -->
|
||||
|
||||
<!-- Initialization -->
|
||||
|
|
|
@ -9,8 +9,8 @@
|
|||
<meta charset="UTF-8">
|
||||
<title>Editor.js RTL 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>
|
||||
<link href="../public/assets/demo.css" rel="stylesheet">
|
||||
<script src="../public/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>
|
||||
|
@ -70,7 +70,7 @@
|
|||
<script src="./tools/inline-code/dist/bundle.js"></script><!-- Inline Code -->
|
||||
|
||||
<!-- Load Editor.js's Core -->
|
||||
<script src="../dist/editor.js" onload="document.getElementById('hint-core').hidden = true"></script>
|
||||
<script src="../dist/editorjs.umd.js" onload="document.getElementById('hint-core').hidden = true"></script>
|
||||
|
||||
<!-- Initialization -->
|
||||
<script>
|
||||
|
|
|
@ -4,8 +4,8 @@
|
|||
<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>
|
||||
<link href="../public/assets/demo.css" rel="stylesheet">
|
||||
<script src="../public/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>
|
||||
|
|
|
@ -1 +1 @@
|
|||
Subproject commit b1367277e070bbbf80b7b14b1963845ba9a71d8c
|
||||
Subproject commit 1c116d5e09e19951948d6166047aa2f30877aaf9
|
|
@ -1 +1 @@
|
|||
Subproject commit 193f5f6f00288679a97bfe620a4d811e5acd9b16
|
||||
Subproject commit f281996f82c7ac676172757e45687cae27443427
|
|
@ -1 +1 @@
|
|||
Subproject commit 86e8c5501dcbb8eaaeec756e1145db49b8339160
|
||||
Subproject commit 4ca1c1c972261f47dd34f6b8754763a4a79a4866
|
|
@ -1 +1 @@
|
|||
Subproject commit 23de06be69bb9e636a2278b0d54f8c2d85d7ae13
|
||||
Subproject commit dfdbf2423d2777f7026a7df768c6582e1a409db7
|
|
@ -1 +1 @@
|
|||
Subproject commit 80278ee75146ff461e9dcaeff1a337167ef97162
|
||||
Subproject commit 5118ce87a752515fb6b31325f234f4ccd62f42c9
|
|
@ -1 +1 @@
|
|||
Subproject commit 927ec04edae75fb2e9a83add24be38d439dc3a19
|
||||
Subproject commit 25d46cd8d3930851b14ddc26ee80fb5b485e1496
|
|
@ -1 +1 @@
|
|||
Subproject commit 7cc94718e4c20d6f9db2c236a60b119c39d389e0
|
||||
Subproject commit dcd4c17740c9ba636140751596aff1e9f6ef6b01
|
|
@ -1 +1 @@
|
|||
Subproject commit 861de29b1d553bb9377dcbaf451af605b28b57bd
|
||||
Subproject commit aaa69d5408bad34027d6252a3892d40f9fa121be
|
|
@ -1 +1 @@
|
|||
Subproject commit f0e9f0110983cd973a1345f2885b18db4fd54636
|
||||
Subproject commit a6dc6a692b88c9eff3d87223b239e7517b160c67
|
|
@ -1 +1 @@
|
|||
Subproject commit 13e0b1cf72cfa706dc236e617683a5e349a021f5
|
||||
Subproject commit 8d6897fca43e387bcdf4a681380be975fe8f2a07
|
|
@ -1 +1 @@
|
|||
Subproject commit c5c47395516cae0e456881a67a84fd69fec06c47
|
||||
Subproject commit 95b37462dc93c19b83f0481f509034a40d436cf2
|
|
@ -1 +1 @@
|
|||
Subproject commit 02e0db32a101ec5cfa61210de45be7de647c40c6
|
||||
Subproject commit 9377ca713f552576b8b11f77cf371b67261ec00b
|
|
@ -1 +1 @@
|
|||
Subproject commit b4164eac4d81259a15368d7681884e3554554662
|
||||
Subproject commit cae470fded570ef9a82a45734526ccf45959e204
|
|
@ -1 +1 @@
|
|||
Subproject commit 2d411a650afa04f0468f7648ee0b5a765362161c
|
||||
Subproject commit 963883520c7bbe5040366335c9a37bbdc7cf60fd
|
|
@ -1 +1 @@
|
|||
Subproject commit 4a94a1592a500ebb6cc570fa1d6216a149b541a0
|
||||
Subproject commit 2948cd7595e632f7555e2dc09e6bac050a2b87ea
|
|
@ -1 +1 @@
|
|||
Subproject commit 7e706b1cb67655db75d3a154038e4f11e2d00128
|
||||
Subproject commit e63e91aa833d774be9bf4a76013b1025a009989d
|
413
index.html
Normal file
|
@ -0,0 +1,413 @@
|
|||
<!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>
|
||||
<script>
|
||||
if (localStorage.getItem('theme') === 'dark') {
|
||||
document.body.classList.add("dark-mode");
|
||||
}
|
||||
</script>
|
||||
<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">
|
||||
<div id="editorjs"></div>
|
||||
<div class="ce-example__button" id="saveButton">
|
||||
editor.save()
|
||||
</div>
|
||||
<div class="ce-example__statusbar">
|
||||
<div class="ce-example__statusbar-item">
|
||||
Readonly:
|
||||
<b id="readonly-state">
|
||||
Off
|
||||
</b>
|
||||
|
||||
<div class="ce-example__statusbar-button" id="toggleReadOnlyButton">
|
||||
toggle
|
||||
</div>
|
||||
</div>
|
||||
<div class="ce-example__statusbar-item">
|
||||
<div class="ce-example__statusbar-button" id="showBlocksBoundariesButton">
|
||||
<span data-toggled-text="Hide">Show</span>
|
||||
blocks boundaries
|
||||
</div>
|
||||
</div>
|
||||
<div class="ce-example__statusbar-item">
|
||||
<div class="ce-example__statusbar-button" id="enableThinModeButton">
|
||||
<span data-toggled-text="Disable">Enable</span>
|
||||
thin mode
|
||||
</div>
|
||||
</div>
|
||||
<div class="ce-example__statusbar-item ce-example__statusbar-item--right">
|
||||
<div class="ce-example__statusbar-toggler" id="darkThemeToggler">
|
||||
</div>
|
||||
</div>
|
||||
</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 -->
|
||||
<!--
|
||||
You can upload Tools to your project's directory and connect them by relative links.
|
||||
|
||||
Also you can load each Tool from CDN or use NPM/Yarn packages.
|
||||
|
||||
Read more at Tools Connection doc:
|
||||
https://editorjs.io/getting-started#tools-connection
|
||||
-->
|
||||
<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/nested-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/raw@latest"></script><!-- Raw -->
|
||||
|
||||
<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 -->
|
||||
|
||||
<!-- Initialization -->
|
||||
<script type="module">
|
||||
import EditorJS from './src/codex.ts';
|
||||
|
||||
window.EditorJS = EditorJS;
|
||||
|
||||
/**
|
||||
* To initialize the Editor, create a new instance with configuration object
|
||||
* @see docs/installation.md for mode details
|
||||
*/
|
||||
const editorConfig = {
|
||||
/**
|
||||
* Enable/Disable the read only mode
|
||||
*/
|
||||
readOnly: false,
|
||||
|
||||
/**
|
||||
* Wrapper of Editor
|
||||
*/
|
||||
holder: 'editorjs',
|
||||
|
||||
/**
|
||||
* Common Inline Toolbar settings
|
||||
* - if true (or not specified), the order from 'tool' property will be used
|
||||
* - if an array of tool names, this order will be used
|
||||
*/
|
||||
// inlineToolbar: ['link', 'marker', 'bold', 'italic'],
|
||||
// inlineToolbar: true,
|
||||
|
||||
/**
|
||||
* Tools list
|
||||
*/
|
||||
tools: {
|
||||
/**
|
||||
* 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'
|
||||
},
|
||||
|
||||
},
|
||||
|
||||
/**
|
||||
* This Tool will be used as default
|
||||
*/
|
||||
// defaultBlock: 'paragraph',
|
||||
|
||||
/**
|
||||
* Initial Editor data
|
||||
*/
|
||||
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,
|
||||
}
|
||||
},
|
||||
]
|
||||
},
|
||||
onReady: function(){
|
||||
saveButton.click();
|
||||
},
|
||||
onChange: function(api, event) {
|
||||
console.log('something changed', event);
|
||||
},
|
||||
}
|
||||
/**
|
||||
* To initialize the Editor, create a new instance with configuration object
|
||||
* @see docs/installation.md for mode details
|
||||
*/
|
||||
var editor = new EditorJS(editorConfig);
|
||||
|
||||
/**
|
||||
* Saving button
|
||||
*/
|
||||
const saveButton = document.getElementById('saveButton');
|
||||
|
||||
/**
|
||||
* Toggle read-only button
|
||||
*/
|
||||
const toggleReadOnlyButton = document.getElementById('toggleReadOnlyButton');
|
||||
const readOnlyIndicator = document.getElementById('readonly-state');
|
||||
|
||||
/**
|
||||
* Saving example
|
||||
*/
|
||||
saveButton.addEventListener('click', function () {
|
||||
editor.save()
|
||||
.then((savedData) => {
|
||||
cPreview.show(savedData, document.getElementById("output"));
|
||||
})
|
||||
.catch((error) => {
|
||||
console.error('Saving error', error);
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
* Toggle read-only example
|
||||
*/
|
||||
toggleReadOnlyButton.addEventListener('click', async () => {
|
||||
const readOnlyState = await editor.readOnly.toggle();
|
||||
|
||||
readOnlyIndicator.textContent = readOnlyState ? 'On' : 'Off';
|
||||
});
|
||||
|
||||
/**
|
||||
* Button for displaying blocks borders. Useful for UI development
|
||||
*/
|
||||
const showBlocksBoundariesButton = document.getElementById("showBlocksBoundariesButton");
|
||||
|
||||
showBlocksBoundariesButton.addEventListener('click', () => {
|
||||
document.body.classList.toggle("show-block-boundaries")
|
||||
})
|
||||
|
||||
/**
|
||||
* Button for enabling the 'Thin' mode
|
||||
*/
|
||||
const enableThinModeButton = document.getElementById("enableThinModeButton");
|
||||
|
||||
enableThinModeButton.addEventListener('click', () => {
|
||||
document.body.classList.toggle("thin-mode")
|
||||
|
||||
editor.destroy();
|
||||
|
||||
editor = new EditorJS(editorConfig);
|
||||
})
|
||||
|
||||
/**
|
||||
* Toggler for toggling the dark mode
|
||||
*/
|
||||
const darkThemeToggler = document.getElementById("darkThemeToggler");
|
||||
|
||||
darkThemeToggler.addEventListener('click', () => {
|
||||
document.body.classList.toggle("dark-mode");
|
||||
|
||||
localStorage.setItem('theme', document.body.classList.contains("dark-mode") ? 'dark' : 'default');
|
||||
})
|
||||
|
||||
window.editor = editor;
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
89
package.json
|
@ -1,8 +1,9 @@
|
|||
{
|
||||
"name": "@editorjs/editorjs",
|
||||
"version": "2.27.0-rc.2",
|
||||
"version": "2.30.0-rc.10",
|
||||
"description": "Editor.js — Native JS, based on API and Open Source",
|
||||
"main": "dist/editor.js",
|
||||
"main": "dist/editorjs.umd.js",
|
||||
"module": "dist/editorjs.mjs",
|
||||
"types": "./types/index.d.ts",
|
||||
"keywords": [
|
||||
"codex editor",
|
||||
|
@ -12,16 +13,13 @@
|
|||
"editorjs"
|
||||
],
|
||||
"scripts": {
|
||||
"clear": "rimraf dist && mkdirp dist",
|
||||
"build": "yarn clear && yarn build:webpack:prod",
|
||||
"build:dev": "yarn clear && yarn build:webpack:dev",
|
||||
"build:webpack:dev": "webpack --mode development --progress --display-error-details --display-entrypoints --watch",
|
||||
"build:webpack:prod": "webpack --mode production",
|
||||
"dev": "vite",
|
||||
"build": "vite build --mode production",
|
||||
"build:test": "vite build --mode test",
|
||||
"lint": "eslint src/ --ext .ts && yarn lint:tests",
|
||||
"lint:errors": "eslint src/ --ext .ts --quiet",
|
||||
"lint:fix": "eslint src/ --ext .ts --fix",
|
||||
"lint:tests": "eslint test/ --ext .ts",
|
||||
"ci:pull_paragraph": "git submodule update --init ./src/tools/paragraph",
|
||||
"pull_tools": "git submodule update --init --recursive",
|
||||
"_tools:checkout": "git submodule foreach \"git checkout master || git checkout main\"",
|
||||
"_tools:pull": "git submodule foreach git pull",
|
||||
|
@ -29,8 +27,8 @@
|
|||
"_tools:build": "git submodule foreach yarn build",
|
||||
"_tools:make": "yarn _tools:yarn && yarn _tools:build",
|
||||
"tools:update": "yarn _tools:checkout && yarn _tools:pull && yarn _tools:make",
|
||||
"test:e2e": "yarn build && cypress run",
|
||||
"test:e2e:open": "yarn build && cypress open",
|
||||
"test:e2e": "yarn build:test && cypress run",
|
||||
"test:e2e:open": "yarn build:test && cypress open",
|
||||
"devserver:start": "yarn build && node ./devserver.js"
|
||||
},
|
||||
"author": "CodeX",
|
||||
|
@ -40,64 +38,43 @@
|
|||
"url": "git+https://github.com/codex-team/editor.js.git"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/core": "^7.9.0",
|
||||
"@babel/plugin-transform-runtime": "^7.9.0",
|
||||
"@babel/polyfill": "^7.8.7",
|
||||
"@babel/preset-env": "^7.9.5",
|
||||
"@babel/preset-typescript": "^7.13.0",
|
||||
"@babel/register": "^7.9.0",
|
||||
"@babel/runtime": "^7.9.2",
|
||||
"@babel/register": "^7.21.0",
|
||||
"@codexteam/icons": "^0.3.0",
|
||||
"@codexteam/shortcuts": "^1.1.1",
|
||||
"@cypress/code-coverage": "^3.9.2",
|
||||
"@cypress/webpack-preprocessor": "^5.6.0",
|
||||
"@cypress/code-coverage": "^3.10.3",
|
||||
"@editorjs/code": "^2.7.0",
|
||||
"@editorjs/delimiter": "^1.2.0",
|
||||
"@editorjs/header": "^2.7.0",
|
||||
"@editorjs/paragraph": "^2.11.4",
|
||||
"@editorjs/simple-image": "^1.4.1",
|
||||
"@types/node": "^14.14.35",
|
||||
"@types/webpack": "^4.41.12",
|
||||
"@types/webpack-env": "^1.15.2",
|
||||
"babel-loader": "^8.1.0",
|
||||
"babel-plugin-add-module-exports": "^1.0.0",
|
||||
"babel-plugin-class-display-name": "^2.1.0",
|
||||
"babel-plugin-istanbul": "^6.0.0",
|
||||
"core-js": "3.6.5",
|
||||
"css-loader": "^3.5.3",
|
||||
"cssnano": "^4.1.10",
|
||||
"cypress": "^6.8.0",
|
||||
"cypress-intellij-reporter": "^0.0.6",
|
||||
"eslint": "^8.28.0",
|
||||
"@types/node": "^18.15.11",
|
||||
"chai-subset": "^1.6.0",
|
||||
"codex-notifier": "^1.1.2",
|
||||
"codex-tooltip": "^1.0.5",
|
||||
"core-js": "3.30.0",
|
||||
"cypress": "^13.7.1",
|
||||
"cypress-intellij-reporter": "^0.0.7",
|
||||
"cypress-plugin-tab": "^1.0.5",
|
||||
"cypress-terminal-report": "^5.3.2",
|
||||
"cypress-vite": "^1.5.0",
|
||||
"eslint": "^8.37.0",
|
||||
"eslint-config-codex": "^1.7.1",
|
||||
"eslint-loader": "^4.0.2",
|
||||
"eslint-plugin-chai-friendly": "^0.7.2",
|
||||
"eslint-plugin-cypress": "^2.12.1",
|
||||
"extract-text-webpack-plugin": "^3.0.2",
|
||||
"license-webpack-plugin": "^2.1.4",
|
||||
"mkdirp": "^1.0.4",
|
||||
"eslint-plugin-cypress": "2.12.1",
|
||||
"html-janitor": "^2.0.4",
|
||||
"nanoid": "^4.0.2",
|
||||
"postcss-apply": "^0.12.0",
|
||||
"postcss-import": "^12.0.1",
|
||||
"postcss-loader": "^3.0.0",
|
||||
"postcss-nested": "^4.1.2",
|
||||
"postcss-nested-ancestors": "^2.0.0",
|
||||
"postcss-preset-env": "^6.6.0",
|
||||
"rimraf": "^3.0.2",
|
||||
"stylelint": "^13.3.3",
|
||||
"terser-webpack-plugin": "^2.3.6",
|
||||
"ts-loader": "^7.0.1",
|
||||
"postcss-nested": "4.1.2",
|
||||
"postcss-preset-env": "^8.3.0",
|
||||
"rollup-plugin-license": "^3.0.1",
|
||||
"stylelint": "^15.4.0",
|
||||
"tslint": "^6.1.1",
|
||||
"typescript": "3.8.3",
|
||||
"webpack": "^4.43.0",
|
||||
"webpack-cli": "^3.3.11"
|
||||
"typescript": "5.0.3",
|
||||
"vite": "^4.2.1",
|
||||
"vite-plugin-css-injected-by-js": "^3.1.0"
|
||||
},
|
||||
"collective": {
|
||||
"type": "opencollective",
|
||||
"url": "https://opencollective.com/editorjs"
|
||||
},
|
||||
"dependencies": {
|
||||
"@codexteam/icons": "0.1.0",
|
||||
"codex-notifier": "^1.1.2",
|
||||
"codex-tooltip": "^1.0.5",
|
||||
"html-janitor": "^2.0.4",
|
||||
"nanoid": "^3.1.22"
|
||||
}
|
||||
}
|
||||
|
|
Before Width: | Height: | Size: 126 KiB After Width: | Height: | Size: 126 KiB |
14
src/codex.ts
|
@ -7,20 +7,19 @@ import { EditorConfig } from '../types';
|
|||
*/
|
||||
import '@babel/register';
|
||||
|
||||
import 'components/polyfills';
|
||||
import './components/polyfills';
|
||||
import Core from './components/core';
|
||||
import * as _ from './components/utils';
|
||||
import { destroy as destroyTooltip } from './components/utils/tooltip';
|
||||
|
||||
declare const VERSION: string;
|
||||
|
||||
/**
|
||||
* Editor.js
|
||||
*
|
||||
* Short Description (눈_눈;)
|
||||
*
|
||||
* @version 2.18.0
|
||||
* @license Apache-2.0
|
||||
* @author CodeX-Team <https://ifmo.su>
|
||||
* @see Editor.js <https://editorjs.io>
|
||||
* @author CodeX Team <https://codex.so>
|
||||
*/
|
||||
export default class EditorJS {
|
||||
/**
|
||||
|
@ -69,6 +68,9 @@ export default class EditorJS {
|
|||
*/
|
||||
this.isReady = editor.isReady.then(() => {
|
||||
this.exportAPI(editor);
|
||||
/**
|
||||
* @todo pass API as an argument. It will allow to use Editor's API when editor is ready
|
||||
*/
|
||||
onReady();
|
||||
});
|
||||
}
|
||||
|
@ -89,6 +91,8 @@ export default class EditorJS {
|
|||
moduleInstance.listeners.removeAll();
|
||||
});
|
||||
|
||||
destroyTooltip();
|
||||
|
||||
editor = null;
|
||||
|
||||
for (const field in this) {
|
||||
|
|
|
@ -3,6 +3,7 @@ import { EditorConfig } from '../../types';
|
|||
import { ModuleConfig } from '../types-internal/module-config';
|
||||
import Listeners from './utils/listeners';
|
||||
import EventsDispatcher from './utils/events';
|
||||
import { EditorEventMap } from './events';
|
||||
|
||||
/**
|
||||
* The type <T> of the Module generic.
|
||||
|
@ -42,7 +43,7 @@ export default class Module<T extends ModuleNodes = Record<string, HTMLElement>>
|
|||
/**
|
||||
* Editor event dispatcher class
|
||||
*/
|
||||
protected eventsDispatcher: EventsDispatcher;
|
||||
protected eventsDispatcher: EventsDispatcher<EditorEventMap>;
|
||||
|
||||
/**
|
||||
* Util for bind/unbind DOM event listeners
|
||||
|
|
|
@ -84,6 +84,13 @@ function BlockAPI(
|
|||
return block.stretched;
|
||||
},
|
||||
|
||||
/**
|
||||
* True if Block has inputs to be focused
|
||||
*/
|
||||
get focusable(): boolean {
|
||||
return block.focusable;
|
||||
},
|
||||
|
||||
/**
|
||||
* Call Tool method with errors handler under-the-hood
|
||||
*
|
||||
|
|
|
@ -6,7 +6,7 @@ import {
|
|||
SanitizerConfig,
|
||||
ToolConfig,
|
||||
ToolboxConfigEntry,
|
||||
PopoverItem
|
||||
PopoverItemParams
|
||||
} from '../../../types';
|
||||
|
||||
import { SavedData } from '../../../types/data-formats';
|
||||
|
@ -22,6 +22,11 @@ import { BlockTuneData } from '../../../types/block-tunes/block-tune-data';
|
|||
import ToolsCollection from '../tools/collection';
|
||||
import EventsDispatcher from '../utils/events';
|
||||
import { TunesMenuConfigItem } from '../../../types/tools';
|
||||
import { isMutationBelongsToElement } from '../utils/mutations';
|
||||
import { EditorEventMap, FakeCursorAboutToBeToggled, FakeCursorHaveBeenSet, RedactorDomChanged } from '../events';
|
||||
import { RedactorDomChangedPayload } from '../events/RedactorDomChanged';
|
||||
import { convertBlockDataToString, isSameBlockData } from '../utils/blocks';
|
||||
import { PopoverItemType } from '../utils/popover';
|
||||
|
||||
/**
|
||||
* Interface describes Block class constructor argument
|
||||
|
@ -84,9 +89,11 @@ export enum BlockToolAPI {
|
|||
}
|
||||
|
||||
/**
|
||||
* Names of events supported by Block class
|
||||
* Names of events used in Block
|
||||
*/
|
||||
type BlockEvents = 'didMutated';
|
||||
interface BlockEvents {
|
||||
'didMutated': Block,
|
||||
}
|
||||
|
||||
/**
|
||||
* @classdesc Abstract Block class that contains Block information, Tool name and Tool class instance
|
||||
|
@ -105,7 +112,6 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
wrapper: 'ce-block',
|
||||
wrapperStretched: 'ce-block--stretched',
|
||||
content: 'ce-block__content',
|
||||
focused: 'ce-block--focused',
|
||||
selected: 'ce-block--selected',
|
||||
dropTarget: 'ce-block--drop-target',
|
||||
};
|
||||
|
@ -153,6 +159,11 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
*/
|
||||
private cachedInputs: HTMLElement[] = [];
|
||||
|
||||
/**
|
||||
* We'll store a reference to the tool's rendered element to access it later
|
||||
*/
|
||||
private toolRenderedElement: HTMLElement | null = null;
|
||||
|
||||
/**
|
||||
* Tool class instance
|
||||
*/
|
||||
|
@ -187,89 +198,14 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
private inputIndex = 0;
|
||||
|
||||
/**
|
||||
* Mutation observer to handle DOM mutations
|
||||
*
|
||||
* @type {MutationObserver}
|
||||
* Common editor event bus
|
||||
*/
|
||||
private mutationObserver: MutationObserver;
|
||||
private readonly editorEventBus: EventsDispatcher<EditorEventMap> | null = null;
|
||||
|
||||
/**
|
||||
* Debounce Timer
|
||||
*
|
||||
* @type {number}
|
||||
* Link to editor dom change callback. Used to remove listener on remove
|
||||
*/
|
||||
private readonly modificationDebounceTimer = 450;
|
||||
|
||||
/**
|
||||
* Is fired when DOM mutation has been happened
|
||||
*
|
||||
* mutationsOrInputEvent — actual changes
|
||||
* - MutationRecord[] - any DOM change
|
||||
* - InputEvent — <input> change
|
||||
* - undefined — manual triggering of block.dispatchChange()
|
||||
*/
|
||||
private didMutated = _.debounce((mutationsOrInputEvent: MutationRecord[] | InputEvent = undefined): void => {
|
||||
/**
|
||||
* We won't fire a Block mutation event if mutation contain only nodes marked with 'data-mutation-free' attributes
|
||||
*/
|
||||
let shouldFireUpdate;
|
||||
|
||||
if (mutationsOrInputEvent === undefined) {
|
||||
shouldFireUpdate = true;
|
||||
} else if (mutationsOrInputEvent instanceof InputEvent) {
|
||||
shouldFireUpdate = true;
|
||||
} else {
|
||||
/**
|
||||
* Update from 2023, Feb 17:
|
||||
* Changed mutationsOrInputEvent.some() to mutationsOrInputEvent.every()
|
||||
* since there could be a real mutations same-time with mutation-free changes,
|
||||
* for example when Block Tune change: block is changing along with FakeCursor (mutation-free) removing
|
||||
* — we should fire 'didMutated' event in that case
|
||||
*/
|
||||
const everyRecordIsMutationFree = mutationsOrInputEvent.length > 0 && mutationsOrInputEvent.every((record) => {
|
||||
const { addedNodes, removedNodes } = record;
|
||||
const changedNodes = [
|
||||
...Array.from(addedNodes),
|
||||
...Array.from(removedNodes),
|
||||
];
|
||||
|
||||
return changedNodes.some((node) => {
|
||||
if ($.isElement(node) === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return (node as HTMLElement).dataset.mutationFree === 'true';
|
||||
});
|
||||
});
|
||||
|
||||
if (everyRecordIsMutationFree) {
|
||||
shouldFireUpdate = false;
|
||||
} else {
|
||||
shouldFireUpdate = true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* In case some mutation free elements are added or removed, do not trigger didMutated event
|
||||
*/
|
||||
if (!shouldFireUpdate) {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Drop cache
|
||||
*/
|
||||
this.cachedInputs = [];
|
||||
|
||||
/**
|
||||
* Update current input
|
||||
*/
|
||||
this.updateCurrentInput();
|
||||
|
||||
this.call(BlockToolAPI.UPDATED);
|
||||
|
||||
this.emit('didMutated', this);
|
||||
}, this.modificationDebounceTimer);
|
||||
private redactorDomChangedCallback: (payload: RedactorDomChangedPayload) => void;
|
||||
|
||||
/**
|
||||
* Current block API interface
|
||||
|
@ -277,12 +213,13 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
private readonly blockAPI: BlockAPIInterface;
|
||||
|
||||
/**
|
||||
* @param {object} options - block constructor options
|
||||
* @param {string} [options.id] - block's id. Will be generated if omitted.
|
||||
* @param {BlockToolData} options.data - Tool's initial data
|
||||
* @param {BlockTool} options.tool — block's tool
|
||||
* @param options - block constructor options
|
||||
* @param [options.id] - block's id. Will be generated if omitted.
|
||||
* @param options.data - Tool's initial data
|
||||
* @param options.tool — block's tool
|
||||
* @param options.api - Editor API module for pass it to the Block Tunes
|
||||
* @param {boolean} options.readOnly - Read-Only flag
|
||||
* @param options.readOnly - Read-Only flag
|
||||
* @param [eventBus] - Editor common event bus. Allows to subscribe on some Editor events. Could be omitted when "virtual" Block is created. See BlocksAPI@composeBlockData.
|
||||
*/
|
||||
constructor({
|
||||
id = _.generateBlockId(),
|
||||
|
@ -291,18 +228,16 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
api,
|
||||
readOnly,
|
||||
tunesData,
|
||||
}: BlockConstructorOptions) {
|
||||
}: BlockConstructorOptions, eventBus?: EventsDispatcher<EditorEventMap>) {
|
||||
super();
|
||||
|
||||
this.name = tool.name;
|
||||
this.id = id;
|
||||
this.settings = tool.settings;
|
||||
this.config = tool.settings.config || {};
|
||||
this.api = api;
|
||||
this.editorEventBus = eventBus || null;
|
||||
this.blockAPI = new BlockAPI(this);
|
||||
|
||||
this.mutationObserver = new MutationObserver(this.didMutated);
|
||||
|
||||
this.tool = tool;
|
||||
this.toolInstance = tool.create(data, this.blockAPI, readOnly);
|
||||
|
||||
|
@ -314,6 +249,22 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
this.composeTunes(tunesData);
|
||||
|
||||
this.holder = this.compose();
|
||||
|
||||
/**
|
||||
* Bind block events in RIC for optimizing of constructing process time
|
||||
*/
|
||||
window.requestIdleCallback(() => {
|
||||
/**
|
||||
* Start watching block mutations
|
||||
*/
|
||||
this.watchBlockMutations();
|
||||
|
||||
/**
|
||||
* Mutation observer doesn't track changes in "<input>" and "<textarea>"
|
||||
* so we need to track focus events to update current input and clear cache.
|
||||
*/
|
||||
this.addInputEvents();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -440,13 +391,20 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
return _.isFunction(this.toolInstance.merge);
|
||||
}
|
||||
|
||||
/**
|
||||
* If Block contains inputs, it is focusable
|
||||
*/
|
||||
public get focusable(): boolean {
|
||||
return this.inputs.length !== 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check block for emptiness
|
||||
*
|
||||
* @returns {boolean}
|
||||
*/
|
||||
public get isEmpty(): boolean {
|
||||
const emptyText = $.isEmpty(this.pluginsContent);
|
||||
const emptyText = $.isEmpty(this.pluginsContent, '/');
|
||||
const emptyMedia = !this.hasMedia;
|
||||
|
||||
return emptyText && emptyMedia;
|
||||
|
@ -477,22 +435,6 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
return !!this.holder.querySelector(mediaTags.join(','));
|
||||
}
|
||||
|
||||
/**
|
||||
* Set focused state
|
||||
*
|
||||
* @param {boolean} state - 'true' to select, 'false' to remove selection
|
||||
*/
|
||||
public set focused(state: boolean) {
|
||||
this.holder.classList.toggle(Block.CSS.focused, state);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Block's focused state
|
||||
*/
|
||||
public get focused(): boolean {
|
||||
return this.holder.classList.contains(Block.CSS.focused);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set selected state
|
||||
* We don't need to mark Block as Selected when it is empty
|
||||
|
@ -500,14 +442,21 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
* @param {boolean} state - 'true' to select, 'false' to remove selection
|
||||
*/
|
||||
public set selected(state: boolean) {
|
||||
if (state) {
|
||||
this.holder.classList.add(Block.CSS.selected);
|
||||
this.holder.classList.toggle(Block.CSS.selected, state);
|
||||
|
||||
SelectionUtils.addFakeCursor(this.holder);
|
||||
} else {
|
||||
this.holder.classList.remove(Block.CSS.selected);
|
||||
const fakeCursorWillBeAdded = state === true && SelectionUtils.isRangeInsideContainer(this.holder);
|
||||
const fakeCursorWillBeRemoved = state === false && SelectionUtils.isFakeCursorInsideContainer(this.holder);
|
||||
|
||||
SelectionUtils.removeFakeCursor(this.holder);
|
||||
if (fakeCursorWillBeAdded || fakeCursorWillBeRemoved) {
|
||||
this.editorEventBus?.emit(FakeCursorAboutToBeToggled, { state }); // mutex
|
||||
|
||||
if (fakeCursorWillBeAdded) {
|
||||
SelectionUtils.addFakeCursor();
|
||||
} else {
|
||||
SelectionUtils.removeFakeCursor(this.holder);
|
||||
}
|
||||
|
||||
this.editorEventBus?.emit(FakeCursorHaveBeenSet, { state });
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -553,23 +502,7 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
* @returns {HTMLElement}
|
||||
*/
|
||||
public get pluginsContent(): HTMLElement {
|
||||
const blockContentNodes = this.holder.querySelector(`.${Block.CSS.content}`);
|
||||
|
||||
if (blockContentNodes && blockContentNodes.childNodes.length) {
|
||||
/**
|
||||
* Editors Block content can contain different Nodes from extensions
|
||||
* We use DOM isExtensionNode to ignore such Nodes and return first Block that does not match filtering list
|
||||
*/
|
||||
for (let child = blockContentNodes.childNodes.length - 1; child >= 0; child--) {
|
||||
const contentNode = blockContentNodes.childNodes[child];
|
||||
|
||||
if (!$.isExtensionNode(contentNode)) {
|
||||
return contentNode as HTMLElement;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
return this.toolRenderedElement;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -617,7 +550,7 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
*
|
||||
* @returns {object}
|
||||
*/
|
||||
public async save(): Promise<void | SavedData> {
|
||||
public async save(): Promise<undefined | SavedData> {
|
||||
const extractedBlock = await this.toolInstance.save(this.pluginsContent as HTMLElement);
|
||||
const tunesData: { [name: string]: BlockTuneData } = this.unavailableTunesData;
|
||||
|
||||
|
@ -678,33 +611,54 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns data to render in tunes menu.
|
||||
* Splits block tunes settings into 2 groups: popover items and custom html.
|
||||
* Returns data to render in Block Tunes menu.
|
||||
* Splits block tunes into 2 groups: block specific tunes and common tunes
|
||||
*/
|
||||
public getTunes(): [PopoverItem[], HTMLElement] {
|
||||
const customHtmlTunesContainer = document.createElement('div');
|
||||
const tunesItems: TunesMenuConfigItem[] = [];
|
||||
public getTunes(): {
|
||||
toolTunes: PopoverItemParams[];
|
||||
commonTunes: PopoverItemParams[];
|
||||
} {
|
||||
const toolTunesPopoverParams: TunesMenuConfigItem[] = [];
|
||||
const commonTunesPopoverParams: TunesMenuConfigItem[] = [];
|
||||
|
||||
/** Tool's tunes: may be defined as return value of optional renderSettings method */
|
||||
const tunesDefinedInTool = typeof this.toolInstance.renderSettings === 'function' ? this.toolInstance.renderSettings() : [];
|
||||
|
||||
if ($.isElement(tunesDefinedInTool)) {
|
||||
toolTunesPopoverParams.push({
|
||||
type: PopoverItemType.Html,
|
||||
element: tunesDefinedInTool,
|
||||
});
|
||||
} else if (Array.isArray(tunesDefinedInTool)) {
|
||||
toolTunesPopoverParams.push(...tunesDefinedInTool);
|
||||
} else {
|
||||
toolTunesPopoverParams.push(tunesDefinedInTool);
|
||||
}
|
||||
|
||||
/** Common tunes: combination of default tunes (move up, move down, delete) and third-party tunes connected via tunes api */
|
||||
const commonTunes = [
|
||||
...this.tunesInstances.values(),
|
||||
...this.defaultTunesInstances.values(),
|
||||
].map(tuneInstance => tuneInstance.render());
|
||||
|
||||
[tunesDefinedInTool, commonTunes].flat().forEach(rendered => {
|
||||
if ($.isElement(rendered)) {
|
||||
customHtmlTunesContainer.appendChild(rendered);
|
||||
} else if (Array.isArray(rendered)) {
|
||||
tunesItems.push(...rendered);
|
||||
/** Separate custom html from Popover items params for common tunes */
|
||||
commonTunes.forEach(tuneConfig => {
|
||||
if ($.isElement(tuneConfig)) {
|
||||
commonTunesPopoverParams.push({
|
||||
type: PopoverItemType.Html,
|
||||
element: tuneConfig,
|
||||
});
|
||||
} else if (Array.isArray(tuneConfig)) {
|
||||
commonTunesPopoverParams.push(...tuneConfig);
|
||||
} else {
|
||||
tunesItems.push(rendered);
|
||||
commonTunesPopoverParams.push(tuneConfig);
|
||||
}
|
||||
});
|
||||
|
||||
return [tunesItems, customHtmlTunesContainer];
|
||||
return {
|
||||
toolTunes: toolTunesPopoverParams,
|
||||
commonTunes: commonTunesPopoverParams,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -722,38 +676,6 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
: SelectionUtils.anchorNode;
|
||||
}
|
||||
|
||||
/**
|
||||
* Is fired when Block will be selected as current
|
||||
*/
|
||||
public willSelect(): void {
|
||||
/**
|
||||
* Observe DOM mutations to update Block inputs
|
||||
*/
|
||||
this.mutationObserver.observe(
|
||||
this.holder.firstElementChild,
|
||||
{
|
||||
childList: true,
|
||||
subtree: true,
|
||||
characterData: true,
|
||||
attributes: true,
|
||||
}
|
||||
);
|
||||
|
||||
/**
|
||||
* Mutation observer doesn't track changes in "<input>" and "<textarea>"
|
||||
* so we need to track focus events to update current input and clear cache.
|
||||
*/
|
||||
this.addInputEvents();
|
||||
}
|
||||
|
||||
/**
|
||||
* Is fired when Block will be unselected
|
||||
*/
|
||||
public willUnselect(): void {
|
||||
this.mutationObserver.disconnect();
|
||||
this.removeInputEvents();
|
||||
}
|
||||
|
||||
/**
|
||||
* Allows to say Editor that Block was changed. Used to manually trigger Editor's 'onChange' callback
|
||||
* Can be useful for block changes invisible for editor core.
|
||||
|
@ -766,6 +688,9 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
* Call Tool instance destroy method
|
||||
*/
|
||||
public destroy(): void {
|
||||
this.unwatchBlockMutations();
|
||||
this.removeInputEvents();
|
||||
|
||||
super.destroy();
|
||||
|
||||
if (_.isFunction(this.toolInstance.destroy)) {
|
||||
|
@ -807,14 +732,20 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
const blockData = await this.data;
|
||||
const toolboxItems = toolboxSettings;
|
||||
|
||||
return toolboxItems.find((item) => {
|
||||
return Object.entries(item.data)
|
||||
.some(([propName, propValue]) => {
|
||||
return blockData[propName] && _.equals(blockData[propName], propValue);
|
||||
});
|
||||
return toolboxItems?.find((item) => {
|
||||
return isSameBlockData(item.data, blockData);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Exports Block data as string using conversion config
|
||||
*/
|
||||
public async exportDataAsString(): Promise<string> {
|
||||
const blockData = await this.data;
|
||||
|
||||
return convertBlockDataToString(blockData, this.tool.conversionConfig);
|
||||
}
|
||||
|
||||
/**
|
||||
* Make default Block wrappers and put Tool`s content there
|
||||
*
|
||||
|
@ -825,7 +756,22 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
contentNode = $.make('div', Block.CSS.content),
|
||||
pluginsContent = this.toolInstance.render();
|
||||
|
||||
contentNode.appendChild(pluginsContent);
|
||||
if (import.meta.env.MODE === 'test') {
|
||||
wrapper.setAttribute('data-cy', 'block-wrapper');
|
||||
}
|
||||
|
||||
/**
|
||||
* Export id to the DOM three
|
||||
* Useful for standalone modules development. For example, allows to identify Block by some child node. Or scroll to a particular Block by id.
|
||||
*/
|
||||
wrapper.dataset.id = this.id;
|
||||
|
||||
/**
|
||||
* Saving a reference to plugin's content element for guaranteed accessing it later
|
||||
*/
|
||||
this.toolRenderedElement = pluginsContent;
|
||||
|
||||
contentNode.appendChild(this.toolRenderedElement);
|
||||
|
||||
/**
|
||||
* Block Tunes might wrap Block's content node to provide any UI changes
|
||||
|
@ -882,9 +828,9 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
*/
|
||||
private handleFocus = (): void => {
|
||||
/**
|
||||
* Drop cache
|
||||
* Drop inputs cache to query the new ones
|
||||
*/
|
||||
this.cachedInputs = [];
|
||||
this.dropInputsCache();
|
||||
|
||||
/**
|
||||
* Update current input
|
||||
|
@ -903,7 +849,7 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
* If input is native input add oninput listener to observe changes
|
||||
*/
|
||||
if ($.isNativeInput(input)) {
|
||||
input.addEventListener('input', this.didMutated);
|
||||
input.addEventListener('input', this.didMutated as EventListener);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
@ -916,8 +862,151 @@ export default class Block extends EventsDispatcher<BlockEvents> {
|
|||
input.removeEventListener('focus', this.handleFocus);
|
||||
|
||||
if ($.isNativeInput(input)) {
|
||||
input.removeEventListener('input', this.didMutated);
|
||||
input.removeEventListener('input', this.didMutated as EventListener);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Is fired when DOM mutation has been happened
|
||||
*
|
||||
* @param mutationsOrInputEvent - actual changes
|
||||
* - MutationRecord[] - any DOM change
|
||||
* - InputEvent — <input> change
|
||||
* - undefined — manual triggering of block.dispatchChange()
|
||||
*/
|
||||
private readonly didMutated = (mutationsOrInputEvent: MutationRecord[] | InputEvent = undefined): void => {
|
||||
/**
|
||||
* Block API have dispatchChange() method. In this case, mutations list will be undefined.
|
||||
*/
|
||||
const isManuallyDispatched = mutationsOrInputEvent === undefined;
|
||||
|
||||
/**
|
||||
* True if didMutated has been called as "input" event handler
|
||||
*/
|
||||
const isInputEventHandler = mutationsOrInputEvent instanceof InputEvent;
|
||||
|
||||
/**
|
||||
* If tool updates its own root element, we need to renew it in our memory
|
||||
*/
|
||||
if (!isManuallyDispatched && !isInputEventHandler) {
|
||||
this.detectToolRootChange(mutationsOrInputEvent);
|
||||
}
|
||||
|
||||
/**
|
||||
* We won't fire a Block mutation event if mutation contain only nodes marked with 'data-mutation-free' attributes
|
||||
*/
|
||||
let shouldFireUpdate;
|
||||
|
||||
if (isManuallyDispatched) {
|
||||
shouldFireUpdate = true;
|
||||
} else if (isInputEventHandler) {
|
||||
shouldFireUpdate = true;
|
||||
} else {
|
||||
/**
|
||||
* Update from 2023, Feb 17:
|
||||
* Changed mutationsOrInputEvent.some() to mutationsOrInputEvent.every()
|
||||
* since there could be a real mutations same-time with mutation-free changes,
|
||||
* for example when Block Tune change: block is changing along with FakeCursor (mutation-free) removing
|
||||
* — we should fire 'didMutated' event in that case
|
||||
*/
|
||||
const everyRecordIsMutationFree = mutationsOrInputEvent.length > 0 && mutationsOrInputEvent.every((record) => {
|
||||
const { addedNodes, removedNodes, target } = record;
|
||||
const changedNodes = [
|
||||
...Array.from(addedNodes),
|
||||
...Array.from(removedNodes),
|
||||
target,
|
||||
];
|
||||
|
||||
return changedNodes.some((node) => {
|
||||
if (!$.isElement(node)) {
|
||||
/**
|
||||
* "characterData" mutation record has Text node as a target, so we need to get parent element to check it for mutation-free attribute
|
||||
*/
|
||||
node = node.parentElement;
|
||||
}
|
||||
|
||||
return node && (node as HTMLElement).closest('[data-mutation-free="true"]') !== null;
|
||||
});
|
||||
});
|
||||
|
||||
shouldFireUpdate = !everyRecordIsMutationFree;
|
||||
}
|
||||
|
||||
/**
|
||||
* In case some mutation free elements are added or removed, do not trigger didMutated event
|
||||
*/
|
||||
if (!shouldFireUpdate) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.dropInputsCache();
|
||||
|
||||
/**
|
||||
* Update current input
|
||||
*/
|
||||
this.updateCurrentInput();
|
||||
|
||||
this.call(BlockToolAPI.UPDATED);
|
||||
|
||||
/**
|
||||
* Emit a Block Event with current Block instance.
|
||||
* Block Manager subscribed to these events
|
||||
*/
|
||||
this.emit('didMutated', this);
|
||||
};
|
||||
|
||||
/**
|
||||
* Listen common editor Dom Changed event and detect mutations related to the Block
|
||||
*/
|
||||
private watchBlockMutations(): void {
|
||||
/**
|
||||
* Save callback to a property to remove it on Block destroy
|
||||
*
|
||||
* @param payload - event payload
|
||||
*/
|
||||
this.redactorDomChangedCallback = (payload) => {
|
||||
const { mutations } = payload;
|
||||
|
||||
const mutationBelongsToBlock = mutations.some(record => isMutationBelongsToElement(record, this.toolRenderedElement));
|
||||
|
||||
if (mutationBelongsToBlock) {
|
||||
this.didMutated(mutations);
|
||||
}
|
||||
};
|
||||
|
||||
this.editorEventBus?.on(RedactorDomChanged, this.redactorDomChangedCallback);
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove redactor dom change event listener
|
||||
*/
|
||||
private unwatchBlockMutations(): void {
|
||||
this.editorEventBus?.off(RedactorDomChanged, this.redactorDomChangedCallback);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sometimes Tool can replace own main element, for example H2 -> H4 or UL -> OL
|
||||
* We need to detect such changes and update a link to tools main element with the new one
|
||||
*
|
||||
* @param mutations - records of block content mutations
|
||||
*/
|
||||
private detectToolRootChange(mutations: MutationRecord[]): void {
|
||||
mutations.forEach(record => {
|
||||
const toolRootHasBeenUpdated = Array.from(record.removedNodes).includes(this.toolRenderedElement);
|
||||
|
||||
if (toolRootHasBeenUpdated) {
|
||||
const newToolElement = record.addedNodes[record.addedNodes.length - 1];
|
||||
|
||||
this.toolRenderedElement = newToolElement as HTMLElement;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears inputs cached value
|
||||
*/
|
||||
private dropInputsCache(): void {
|
||||
this.cachedInputs = [];
|
||||
}
|
||||
}
|
||||
|
|
|
@ -220,6 +220,62 @@ export default class Blocks {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Replaces block under passed index with passed block
|
||||
*
|
||||
* @param index - index of existed block
|
||||
* @param block - new block
|
||||
*/
|
||||
public replace(index: number, block: Block): void {
|
||||
if (this.blocks[index] === undefined) {
|
||||
throw Error('Incorrect index');
|
||||
}
|
||||
|
||||
const prevBlock = this.blocks[index];
|
||||
|
||||
prevBlock.holder.replaceWith(block.holder);
|
||||
|
||||
this.blocks[index] = block;
|
||||
}
|
||||
|
||||
/**
|
||||
* Inserts several blocks at once
|
||||
*
|
||||
* @param blocks - blocks to insert
|
||||
* @param index - index to insert blocks at
|
||||
*/
|
||||
public insertMany(blocks: Block[], index: number ): void {
|
||||
const fragment = new DocumentFragment();
|
||||
|
||||
for (const block of blocks) {
|
||||
fragment.appendChild(block.holder);
|
||||
}
|
||||
|
||||
if (this.length > 0) {
|
||||
if (index > 0) {
|
||||
const previousBlockIndex = Math.min(index - 1, this.length - 1);
|
||||
const previousBlock = this.blocks[previousBlockIndex];
|
||||
|
||||
previousBlock.holder.after(fragment);
|
||||
} else if (index === 0) {
|
||||
this.workingArea.prepend(fragment);
|
||||
}
|
||||
|
||||
/**
|
||||
* Insert blocks to the array at the specified index
|
||||
*/
|
||||
this.blocks.splice(index, 0, ...blocks);
|
||||
} else {
|
||||
this.blocks.push(...blocks);
|
||||
this.workingArea.appendChild(fragment);
|
||||
}
|
||||
|
||||
/**
|
||||
* Call Rendered event for each block
|
||||
*/
|
||||
blocks.forEach((block) => block.call(BlockToolAPI.RENDERED));
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove block
|
||||
*
|
||||
|
@ -267,7 +323,7 @@ export default class Blocks {
|
|||
* @param {number} index — Block index
|
||||
* @returns {Block}
|
||||
*/
|
||||
public get(index: number): Block {
|
||||
public get(index: number): Block | undefined {
|
||||
return this.blocks[index];
|
||||
}
|
||||
|
||||
|
|
5
src/components/constants.ts
Normal file
|
@ -0,0 +1,5 @@
|
|||
/**
|
||||
* Debounce timeout for selection change event
|
||||
* {@link modules/ui.ts}
|
||||
*/
|
||||
export const selectionChangeDebounceTimeout = 180;
|
|
@ -5,35 +5,11 @@ import { EditorModules } from '../types-internal/editor-modules';
|
|||
import I18n from './i18n';
|
||||
import { CriticalError } from './errors/critical';
|
||||
import EventsDispatcher from './utils/events';
|
||||
import Modules from './modules';
|
||||
import { EditorEventMap } from './events';
|
||||
|
||||
/**
|
||||
* @typedef {Core} Core - editor core class
|
||||
*/
|
||||
|
||||
/**
|
||||
* Require Editor modules places in components/modules dir
|
||||
*/
|
||||
const contextRequire = require.context('./modules', true);
|
||||
|
||||
const modules = [];
|
||||
|
||||
contextRequire.keys().forEach((filename) => {
|
||||
/**
|
||||
* Include files if:
|
||||
* - extension is .js or .ts
|
||||
* - does not starts with _
|
||||
*/
|
||||
if (filename.match(/^\.\/[^_][\w/]*\.([tj])s$/)) {
|
||||
modules.push(contextRequire(filename));
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* @class Core
|
||||
* @classdesc Editor.js core class
|
||||
* @property {EditorConfig} config - all settings
|
||||
* @property {EditorModules} moduleInstances - constructed editor components
|
||||
* @type {Core}
|
||||
* Editor.js core class. Bootstraps modules.
|
||||
*/
|
||||
export default class Core {
|
||||
/**
|
||||
|
@ -52,9 +28,9 @@ export default class Core {
|
|||
public isReady: Promise<void>;
|
||||
|
||||
/**
|
||||
* Event Dispatcher util
|
||||
* Common Editor Event Bus
|
||||
*/
|
||||
private eventsDispatcher: EventsDispatcher = new EventsDispatcher();
|
||||
private eventsDispatcher: EventsDispatcher<EditorEventMap> = new EventsDispatcher();
|
||||
|
||||
/**
|
||||
* @param {EditorConfig} config - user configuration
|
||||
|
@ -63,7 +39,8 @@ export default class Core {
|
|||
/**
|
||||
* Ready promise. Resolved if Editor.js is ready to work, rejected otherwise
|
||||
*/
|
||||
let onReady, onFail;
|
||||
let onReady: (value?: void | PromiseLike<void>) => void;
|
||||
let onFail: (reason?: unknown) => void;
|
||||
|
||||
this.isReady = new Promise((resolve, reject) => {
|
||||
onReady = resolve;
|
||||
|
@ -74,33 +51,21 @@ export default class Core {
|
|||
.then(async () => {
|
||||
this.configuration = config;
|
||||
|
||||
await this.validate();
|
||||
await this.init();
|
||||
this.validate();
|
||||
this.init();
|
||||
await this.start();
|
||||
await this.render();
|
||||
|
||||
_.logLabeled('I\'m ready! (ノ◕ヮ◕)ノ*:・゚✧', 'log', '', 'color: #E24A75');
|
||||
const { BlockManager, Caret, UI, ModificationsObserver } = this.moduleInstances;
|
||||
|
||||
setTimeout(async () => {
|
||||
await this.render();
|
||||
UI.checkEmptiness();
|
||||
ModificationsObserver.enable();
|
||||
|
||||
if ((this.configuration as EditorConfig).autofocus) {
|
||||
const { BlockManager, Caret } = this.moduleInstances;
|
||||
if ((this.configuration as EditorConfig).autofocus) {
|
||||
Caret.setToBlock(BlockManager.blocks[0], Caret.positions.START);
|
||||
}
|
||||
|
||||
Caret.setToBlock(BlockManager.blocks[0], Caret.positions.START);
|
||||
BlockManager.highlightCurrentNode();
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove loader, show content
|
||||
*/
|
||||
this.moduleInstances.UI.removeLoader();
|
||||
|
||||
/**
|
||||
* Resolve this.isReady promise
|
||||
*/
|
||||
onReady();
|
||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers
|
||||
}, 500);
|
||||
onReady();
|
||||
})
|
||||
.catch((error) => {
|
||||
_.log(`Editor.js is not ready because of ${error}`, 'error');
|
||||
|
@ -228,16 +193,14 @@ export default class Core {
|
|||
*
|
||||
* @returns {EditorConfig}
|
||||
*/
|
||||
public get configuration(): EditorConfig|string {
|
||||
public get configuration(): EditorConfig {
|
||||
return this.config;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks for required fields in Editor's config
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
public async validate(): Promise<void> {
|
||||
public validate(): void {
|
||||
const { holderId, holder } = this.config;
|
||||
|
||||
if (holderId && holder) {
|
||||
|
@ -325,27 +288,14 @@ export default class Core {
|
|||
* Make modules instances and save it to the @property this.moduleInstances
|
||||
*/
|
||||
private constructModules(): void {
|
||||
modules.forEach((module) => {
|
||||
/**
|
||||
* If module has non-default exports, passed object contains them all and default export as 'default' property
|
||||
*/
|
||||
const Module = _.isFunction(module) ? module : module.default;
|
||||
|
||||
Object.entries(Modules).forEach(([key, module]) => {
|
||||
try {
|
||||
/**
|
||||
* We use class name provided by displayName property
|
||||
*
|
||||
* On build, Babel will transform all Classes to the Functions so, name will always be 'Function'
|
||||
* To prevent this, we use 'babel-plugin-class-display-name' plugin
|
||||
*
|
||||
* @see https://www.npmjs.com/package/babel-plugin-class-display-name
|
||||
*/
|
||||
this.moduleInstances[Module.displayName] = new Module({
|
||||
this.moduleInstances[key] = new module({
|
||||
config: this.configuration,
|
||||
eventsDispatcher: this.eventsDispatcher,
|
||||
});
|
||||
} catch (e) {
|
||||
_.log(`Module ${Module.displayName} skipped because`, 'error', e);
|
||||
_.log('[constructModules]', `Module ${key} skipped because`, 'error', e);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
|
|
@ -52,11 +52,13 @@ export default class Dom {
|
|||
* @param {object} [attributes] - any attributes
|
||||
* @returns {HTMLElement}
|
||||
*/
|
||||
public static make(tagName: string, classNames: string | string[] = null, attributes: object = {}): HTMLElement {
|
||||
public static make(tagName: string, classNames: string | (string | undefined)[] | null = null, attributes: object = {}): HTMLElement {
|
||||
const el = document.createElement(tagName);
|
||||
|
||||
if (Array.isArray(classNames)) {
|
||||
el.classList.add(...classNames);
|
||||
const validClassnames = classNames.filter(className => className !== undefined) as string[];
|
||||
|
||||
el.classList.add(...validClassnames);
|
||||
} else if (classNames) {
|
||||
el.classList.add(classNames);
|
||||
}
|
||||
|
@ -145,7 +147,7 @@ export default class Dom {
|
|||
* @param {string} selector - searching string
|
||||
* @returns {Element}
|
||||
*/
|
||||
public static find(el: Element | Document = document, selector: string): Element {
|
||||
public static find(el: Element | Document = document, selector: string): Element | null {
|
||||
return el.querySelector(selector);
|
||||
}
|
||||
|
||||
|
@ -348,9 +350,10 @@ export default class Dom {
|
|||
* @description Method checks simple Node without any childs for emptiness
|
||||
* If you have Node with 2 or more children id depth, you better use {@link Dom#isEmpty} method
|
||||
* @param {Node} node - node to check
|
||||
* @param {string} [ignoreChars] - char or substring to treat as empty
|
||||
* @returns {boolean} true if it is empty
|
||||
*/
|
||||
public static isNodeEmpty(node: Node): boolean {
|
||||
public static isNodeEmpty(node: Node, ignoreChars?: string): boolean {
|
||||
let nodeText;
|
||||
|
||||
if (this.isSingleTag(node as HTMLElement) && !this.isLineBreakTag(node as HTMLElement)) {
|
||||
|
@ -363,6 +366,10 @@ export default class Dom {
|
|||
nodeText = node.textContent.replace('\u200B', '');
|
||||
}
|
||||
|
||||
if (ignoreChars) {
|
||||
nodeText = nodeText.replace(new RegExp(ignoreChars, 'g'), '');
|
||||
}
|
||||
|
||||
return nodeText.trim().length === 0;
|
||||
}
|
||||
|
||||
|
@ -386,9 +393,10 @@ export default class Dom {
|
|||
*
|
||||
* @description Pushes to stack all DOM leafs and checks for emptiness
|
||||
* @param {Node} node - node to check
|
||||
* @param {string} [ignoreChars] - char or substring to treat as empty
|
||||
* @returns {boolean}
|
||||
*/
|
||||
public static isEmpty(node: Node): boolean {
|
||||
public static isEmpty(node: Node, ignoreChars?: string): boolean {
|
||||
/**
|
||||
* Normalize node to merge several text nodes to one to reduce tree walker iterations
|
||||
*/
|
||||
|
@ -403,7 +411,7 @@ export default class Dom {
|
|||
continue;
|
||||
}
|
||||
|
||||
if (this.isLeaf(node) && !this.isNodeEmpty(node)) {
|
||||
if (this.isLeaf(node) && !this.isNodeEmpty(node, ignoreChars)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
|
@ -550,26 +558,6 @@ export default class Dom {
|
|||
return element;
|
||||
}
|
||||
|
||||
/**
|
||||
* Method checks passed Node if it is some extension Node
|
||||
*
|
||||
* @param {Node} node - any node
|
||||
* @returns {boolean}
|
||||
*/
|
||||
public static isExtensionNode(node: Node): boolean {
|
||||
const extensions = [
|
||||
'grammarly-extension',
|
||||
'mci-extension',
|
||||
'gdiv',
|
||||
'pwa-container-wrapper',
|
||||
'pwa-editor-bar-cnt',
|
||||
'editor-squiggler',
|
||||
'quillbot-extension',
|
||||
];
|
||||
|
||||
return node && extensions.includes(node.nodeName.toLowerCase());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if element is anchor (is A tag)
|
||||
*
|
||||
|
|
16
src/components/events/BlockChanged.ts
Normal file
|
@ -0,0 +1,16 @@
|
|||
import { BlockMutationEvent } from '../../../types/events/block';
|
||||
|
||||
/**
|
||||
* Fired when some block state has changed
|
||||
*/
|
||||
export const BlockChanged = 'block changed';
|
||||
|
||||
/**
|
||||
* Payload that will be passed with the event
|
||||
*/
|
||||
export interface BlockChangedPayload {
|
||||
/**
|
||||
* CustomEvent describing a block change
|
||||
*/
|
||||
event: BlockMutationEvent;
|
||||
}
|
16
src/components/events/BlockHovered.ts
Normal file
|
@ -0,0 +1,16 @@
|
|||
import type Block from '../block';
|
||||
|
||||
/**
|
||||
* Fired when some block is hovered by user
|
||||
*/
|
||||
export const BlockHovered = 'block hovered';
|
||||
|
||||
/**
|
||||
* Payload that will be passed with the event
|
||||
*/
|
||||
export interface BlockHoveredPayload {
|
||||
/**
|
||||
* Hovered block
|
||||
*/
|
||||
block: Block;
|
||||
}
|
15
src/components/events/EditorMobileLayoutToggled.ts
Normal file
|
@ -0,0 +1,15 @@
|
|||
/**
|
||||
* Fired when editor mobile layout toggled
|
||||
*/
|
||||
export const EditorMobileLayoutToggled = 'editor mobile layout toggled';
|
||||
|
||||
/**
|
||||
* Payload that will be passed with the event
|
||||
*/
|
||||
export interface EditorMobileLayoutToggledPayload {
|
||||
/**
|
||||
* True, if mobile layout enabled
|
||||
*/
|
||||
isEnabled: boolean;
|
||||
}
|
||||
|
17
src/components/events/FakeCursorAboutToBeToggled.ts
Normal file
|
@ -0,0 +1,17 @@
|
|||
/**
|
||||
* Fired before we're adding/removing a fake cursor.
|
||||
*
|
||||
* Allows to disable mutation observer to skip this block change
|
||||
*/
|
||||
export const FakeCursorAboutToBeToggled = 'fake cursor is about to be toggled';
|
||||
|
||||
/**
|
||||
* Payload that will be passed with the event
|
||||
*/
|
||||
export interface FakeCursorAboutToBeToggledPayload {
|
||||
/**
|
||||
* true - when added a cursor
|
||||
* false - when removed
|
||||
*/
|
||||
state: boolean;
|
||||
}
|
17
src/components/events/FakeCursorHaveBeenSet.ts
Normal file
|
@ -0,0 +1,17 @@
|
|||
/**
|
||||
* Fired after we've added/removed a fake cursor.
|
||||
*
|
||||
* Allows to enable mutation observer which was disabled before setting
|
||||
*/
|
||||
export const FakeCursorHaveBeenSet = 'fake cursor have been set';
|
||||
|
||||
/**
|
||||
* Payload that will be passed with the event
|
||||
*/
|
||||
export interface FakeCursorHaveBeenSetPayload {
|
||||
/**
|
||||
* true - when added a cursor
|
||||
* false - when removed
|
||||
*/
|
||||
state: boolean;
|
||||
}
|
14
src/components/events/RedactorDomChanged.ts
Normal file
|
@ -0,0 +1,14 @@
|
|||
/**
|
||||
* Fired when blocks wrapper (.codex-editor-redactor) dom changed
|
||||
*/
|
||||
export const RedactorDomChanged = 'redactor dom changed';
|
||||
|
||||
/**
|
||||
* Payload that will be passed with the event
|
||||
*/
|
||||
export interface RedactorDomChangedPayload {
|
||||
/**
|
||||
* Mutations happened with blocks wrapper
|
||||
*/
|
||||
mutations: MutationRecord[];
|
||||
}
|
29
src/components/events/index.ts
Normal file
|
@ -0,0 +1,29 @@
|
|||
import { RedactorDomChanged, RedactorDomChangedPayload } from './RedactorDomChanged';
|
||||
import { BlockChanged, BlockChangedPayload } from './BlockChanged';
|
||||
import { BlockHovered, BlockHoveredPayload } from './BlockHovered';
|
||||
import { FakeCursorAboutToBeToggled, FakeCursorAboutToBeToggledPayload } from './FakeCursorAboutToBeToggled';
|
||||
import { FakeCursorHaveBeenSet, FakeCursorHaveBeenSetPayload } from './FakeCursorHaveBeenSet';
|
||||
import { EditorMobileLayoutToggled, EditorMobileLayoutToggledPayload } from './EditorMobileLayoutToggled';
|
||||
|
||||
/**
|
||||
* Events fired by Editor Event Dispatcher
|
||||
*/
|
||||
export {
|
||||
RedactorDomChanged,
|
||||
BlockChanged,
|
||||
FakeCursorAboutToBeToggled,
|
||||
FakeCursorHaveBeenSet,
|
||||
EditorMobileLayoutToggled
|
||||
};
|
||||
|
||||
/**
|
||||
* Event name -> Event payload
|
||||
*/
|
||||
export interface EditorEventMap {
|
||||
[BlockHovered]: BlockHoveredPayload;
|
||||
[RedactorDomChanged]: RedactorDomChangedPayload;
|
||||
[BlockChanged]: BlockChangedPayload;
|
||||
[FakeCursorAboutToBeToggled]: FakeCursorAboutToBeToggledPayload;
|
||||
[FakeCursorHaveBeenSet]: FakeCursorHaveBeenSetPayload;
|
||||
[EditorMobileLayoutToggled]: EditorMobileLayoutToggledPayload
|
||||
}
|
|
@ -49,15 +49,11 @@ export default class Flipper {
|
|||
|
||||
/**
|
||||
* Instance of flipper iterator
|
||||
*
|
||||
* @type {DomIterator|null}
|
||||
*/
|
||||
private readonly iterator: DomIterator = null;
|
||||
private readonly iterator: DomIterator | null = null;
|
||||
|
||||
/**
|
||||
* Flag that defines activation status
|
||||
*
|
||||
* @type {boolean}
|
||||
*/
|
||||
private activated = false;
|
||||
|
||||
|
@ -77,7 +73,7 @@ export default class Flipper {
|
|||
private flipCallbacks: Array<() => void> = [];
|
||||
|
||||
/**
|
||||
* @param {FlipperOptions} options - different constructing settings
|
||||
* @param options - different constructing settings
|
||||
*/
|
||||
constructor(options: FlipperOptions) {
|
||||
this.iterator = new DomIterator(options.items, options.focusedItemClass);
|
||||
|
@ -110,7 +106,6 @@ export default class Flipper {
|
|||
*/
|
||||
public activate(items?: HTMLElement[], cursorPosition?: number): void {
|
||||
this.activated = true;
|
||||
|
||||
if (items) {
|
||||
this.iterator.setItems(items);
|
||||
}
|
||||
|
|
|
@ -18,7 +18,8 @@
|
|||
},
|
||||
"popover": {
|
||||
"Filter": "",
|
||||
"Nothing found": ""
|
||||
"Nothing found": "",
|
||||
"Convert to": ""
|
||||
}
|
||||
},
|
||||
"toolNames": {
|
||||
|
|
|
@ -1,9 +1,10 @@
|
|||
import { BlockAPI as BlockAPIInterface, Blocks } from '../../../../types/api';
|
||||
import { BlockToolData, OutputData, ToolConfig } from '../../../../types';
|
||||
import type { BlockAPI as BlockAPIInterface, Blocks } from '../../../../types/api';
|
||||
import { BlockToolData, OutputBlockData, OutputData, ToolConfig } from '../../../../types';
|
||||
import * as _ from './../../utils';
|
||||
import BlockAPI from '../../block/api';
|
||||
import Module from '../../__module';
|
||||
import Block from '../../block';
|
||||
import { capitalize } from './../../utils';
|
||||
|
||||
/**
|
||||
* @class BlocksAPI
|
||||
|
@ -17,7 +18,7 @@ export default class BlocksAPI extends Module {
|
|||
*/
|
||||
public get methods(): Blocks {
|
||||
return {
|
||||
clear: (): void => this.clear(),
|
||||
clear: (): Promise<void> => this.clear(),
|
||||
render: (data: OutputData): Promise<void> => this.render(data),
|
||||
renderFromHTML: (data: string): Promise<void> => this.renderFromHTML(data),
|
||||
delete: (index?: number): void => this.delete(index),
|
||||
|
@ -31,8 +32,10 @@ export default class BlocksAPI extends Module {
|
|||
stretchBlock: (index: number, status = true): void => this.stretchBlock(index, status),
|
||||
insertNewBlock: (): void => this.insertNewBlock(),
|
||||
insert: this.insert,
|
||||
insertMany: this.insertMany,
|
||||
update: this.update,
|
||||
composeBlockData: this.composeBlockData,
|
||||
convert: this.convert,
|
||||
};
|
||||
}
|
||||
|
||||
|
@ -137,9 +140,11 @@ export default class BlocksAPI extends Module {
|
|||
*
|
||||
* @param {number} blockIndex - index of Block to delete
|
||||
*/
|
||||
public delete(blockIndex?: number): void {
|
||||
public delete(blockIndex: number = this.Editor.BlockManager.currentBlockIndex): void {
|
||||
try {
|
||||
this.Editor.BlockManager.removeBlock(blockIndex);
|
||||
const block = this.Editor.BlockManager.getBlockByIndex(blockIndex);
|
||||
|
||||
this.Editor.BlockManager.removeBlock(block);
|
||||
} catch (e) {
|
||||
_.logLabeled(e, 'warn');
|
||||
|
||||
|
@ -167,8 +172,8 @@ export default class BlocksAPI extends Module {
|
|||
/**
|
||||
* Clear Editor's area
|
||||
*/
|
||||
public clear(): void {
|
||||
this.Editor.BlockManager.clear(true);
|
||||
public async clear(): Promise<void> {
|
||||
await this.Editor.BlockManager.clear(true);
|
||||
this.Editor.InlineToolbar.close();
|
||||
}
|
||||
|
||||
|
@ -177,10 +182,21 @@ export default class BlocksAPI extends Module {
|
|||
*
|
||||
* @param {OutputData} data — Saved Editor data
|
||||
*/
|
||||
public render(data: OutputData): Promise<void> {
|
||||
this.Editor.BlockManager.clear();
|
||||
public async render(data: OutputData): Promise<void> {
|
||||
if (data === undefined || data.blocks === undefined) {
|
||||
throw new Error('Incorrect data passed to the render() method');
|
||||
}
|
||||
|
||||
return this.Editor.Renderer.render(data.blocks);
|
||||
/**
|
||||
* Semantic meaning of the "render" method: "Display the new document over the existing one that stays unchanged"
|
||||
* So we need to disable modifications observer temporarily
|
||||
*/
|
||||
this.Editor.ModificationsObserver.disable();
|
||||
|
||||
await this.Editor.BlockManager.clear();
|
||||
await this.Editor.Renderer.render(data.blocks);
|
||||
|
||||
this.Editor.ModificationsObserver.enable();
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -288,25 +304,105 @@ export default class BlocksAPI extends Module {
|
|||
* @param id - id of the block to update
|
||||
* @param data - the new data
|
||||
*/
|
||||
public update = (id: string, data: BlockToolData): void => {
|
||||
public update = async (id: string, data: Partial<BlockToolData>): Promise<BlockAPIInterface> => {
|
||||
const { BlockManager } = this.Editor;
|
||||
const block = BlockManager.getBlockById(id);
|
||||
|
||||
if (!block) {
|
||||
_.log('blocks.update(): Block with passed id was not found', 'warn');
|
||||
|
||||
return;
|
||||
if (block === undefined) {
|
||||
throw new Error(`Block with id "${id}" not found`);
|
||||
}
|
||||
|
||||
const blockIndex = BlockManager.getBlockIndex(block);
|
||||
const updatedBlock = await BlockManager.update(block, data);
|
||||
|
||||
BlockManager.insert({
|
||||
id: block.id,
|
||||
tool: block.name,
|
||||
data,
|
||||
index: blockIndex,
|
||||
replace: true,
|
||||
tunes: block.tunes,
|
||||
});
|
||||
// we cast to any because our BlockAPI has no "new" signature
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
return new (BlockAPI as any)(updatedBlock);
|
||||
};
|
||||
|
||||
/**
|
||||
* Converts block to another type. Both blocks should provide the conversionConfig.
|
||||
*
|
||||
* @param id - id of the existing block to convert. Should provide 'conversionConfig.export' method
|
||||
* @param newType - new block type. Should provide 'conversionConfig.import' method
|
||||
* @param dataOverrides - optional data overrides for the new block
|
||||
* @throws Error if conversion is not possible
|
||||
*/
|
||||
private convert = async (id: string, newType: string, dataOverrides?: BlockToolData): Promise<BlockAPIInterface> => {
|
||||
const { BlockManager, Tools } = this.Editor;
|
||||
const blockToConvert = BlockManager.getBlockById(id);
|
||||
|
||||
if (!blockToConvert) {
|
||||
throw new Error(`Block with id "${id}" not found`);
|
||||
}
|
||||
|
||||
const originalBlockTool = Tools.blockTools.get(blockToConvert.name);
|
||||
const targetBlockTool = Tools.blockTools.get(newType);
|
||||
|
||||
if (!targetBlockTool) {
|
||||
throw new Error(`Block Tool with type "${newType}" not found`);
|
||||
}
|
||||
|
||||
const originalBlockConvertable = originalBlockTool?.conversionConfig?.export !== undefined;
|
||||
const targetBlockConvertable = targetBlockTool.conversionConfig?.import !== undefined;
|
||||
|
||||
if (originalBlockConvertable && targetBlockConvertable) {
|
||||
const newBlock = await BlockManager.convert(blockToConvert, newType, dataOverrides);
|
||||
|
||||
return new BlockAPI(newBlock);
|
||||
} else {
|
||||
const unsupportedBlockTypes = [
|
||||
!originalBlockConvertable ? capitalize(blockToConvert.name) : false,
|
||||
!targetBlockConvertable ? capitalize(newType) : false,
|
||||
].filter(Boolean).join(' and ');
|
||||
|
||||
throw new Error(`Conversion from "${blockToConvert.name}" to "${newType}" is not possible. ${unsupportedBlockTypes} tool(s) should provide a "conversionConfig"`);
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Inserts several Blocks to a specified index
|
||||
*
|
||||
* @param blocks - blocks data to insert
|
||||
* @param index - index to insert the blocks at
|
||||
*/
|
||||
private insertMany = (
|
||||
blocks: OutputBlockData[],
|
||||
index: number = this.Editor.BlockManager.blocks.length - 1
|
||||
): BlockAPIInterface[] => {
|
||||
this.validateIndex(index);
|
||||
|
||||
const blocksToInsert = blocks.map(({ id, type, data }) => {
|
||||
return this.Editor.BlockManager.composeBlock({
|
||||
id,
|
||||
tool: type || (this.config.defaultBlock as string),
|
||||
data,
|
||||
});
|
||||
});
|
||||
|
||||
this.Editor.BlockManager.insertMany(blocksToInsert, index);
|
||||
|
||||
// we cast to any because our BlockAPI has no "new" signature
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
return blocksToInsert.map((block) => new (BlockAPI as any)(block));
|
||||
};
|
||||
|
||||
/**
|
||||
* Validated block index and throws an error if it's invalid
|
||||
*
|
||||
* @param index - index to validate
|
||||
*/
|
||||
private validateIndex(index: unknown): void {
|
||||
if (typeof index !== 'number') {
|
||||
throw new Error('Index should be a number');
|
||||
}
|
||||
|
||||
if (index < 0) {
|
||||
throw new Error(`Index should be greater than or equal to 0`);
|
||||
}
|
||||
|
||||
if (index === null) {
|
||||
throw new Error(`Index should be greater than or equal to 0`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
import { Caret } from '../../../../types/api';
|
||||
import { BlockAPI, Caret } from '../../../../types/api';
|
||||
import Module from '../../__module';
|
||||
import { resolveBlock } from '../../utils/api';
|
||||
|
||||
/**
|
||||
* @class CaretAPI
|
||||
|
@ -96,21 +97,23 @@ export default class CaretAPI extends Module {
|
|||
/**
|
||||
* Sets caret to the Block by passed index
|
||||
*
|
||||
* @param {number} index - index of Block where to set caret
|
||||
* @param {string} position - position where to set caret
|
||||
* @param {number} offset - caret offset
|
||||
* @param blockOrIdOrIndex - either BlockAPI or Block id or Block index
|
||||
* @param position - position where to set caret
|
||||
* @param offset - caret offset
|
||||
* @returns {boolean}
|
||||
*/
|
||||
private setToBlock = (
|
||||
index: number,
|
||||
blockOrIdOrIndex: BlockAPI | BlockAPI['id'] | number,
|
||||
position: string = this.Editor.Caret.positions.DEFAULT,
|
||||
offset = 0
|
||||
): boolean => {
|
||||
if (!this.Editor.BlockManager.blocks[index]) {
|
||||
const block = resolveBlock(blockOrIdOrIndex, this.Editor);
|
||||
|
||||
if (block === undefined) {
|
||||
return false;
|
||||
}
|
||||
|
||||
this.Editor.Caret.setToBlock(this.Editor.BlockManager.blocks[index], position, offset);
|
||||
this.Editor.Caret.setToBlock(block, position, offset);
|
||||
|
||||
return true;
|
||||
};
|
||||
|
|
|
@ -16,6 +16,7 @@ export default class ToolbarAPI extends Module {
|
|||
close: (): void => this.close(),
|
||||
open: (): void => this.open(),
|
||||
toggleBlockSettings: (openingState?: boolean): void => this.toggleBlockSettings(openingState),
|
||||
toggleToolbox: (openingState?: boolean): void => this.toggleToolbox(openingState),
|
||||
};
|
||||
}
|
||||
|
||||
|
@ -55,4 +56,27 @@ export default class ToolbarAPI extends Module {
|
|||
this.Editor.BlockSettings.close();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Open toolbox
|
||||
*
|
||||
* @param {boolean} openingState - Opening state of toolbox
|
||||
*/
|
||||
public toggleToolbox(openingState: boolean): void {
|
||||
if (this.Editor.BlockManager.currentBlockIndex === -1) {
|
||||
_.logLabeled('Could\'t toggle the Toolbox because there is no block selected ', 'warn');
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
const canOpenToolbox = openingState ?? !this.Editor.Toolbar.toolbox.opened;
|
||||
|
||||
if (canOpenToolbox) {
|
||||
this.Editor.Toolbar.moveAndOpen();
|
||||
this.Editor.Toolbar.toolbox.open();
|
||||
} else {
|
||||
this.Editor.Toolbar.toolbox.close();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -2,16 +2,12 @@ import { Tooltip as ITooltip } from '../../../../types/api';
|
|||
import type { TooltipOptions, TooltipContent } from 'codex-tooltip/types';
|
||||
import Module from '../../__module';
|
||||
import { ModuleConfig } from '../../../types-internal/module-config';
|
||||
import Tooltip from '../../utils/tooltip';
|
||||
import * as tooltip from '../../utils/tooltip';
|
||||
/**
|
||||
* @class TooltipAPI
|
||||
* @classdesc Tooltip API
|
||||
*/
|
||||
export default class TooltipAPI extends Module {
|
||||
/**
|
||||
* Tooltip utility Instance
|
||||
*/
|
||||
private tooltip: Tooltip;
|
||||
/**
|
||||
* @class
|
||||
* @param moduleConfiguration - Module Configuration
|
||||
|
@ -23,15 +19,6 @@ export default class TooltipAPI extends Module {
|
|||
config,
|
||||
eventsDispatcher,
|
||||
});
|
||||
|
||||
this.tooltip = new Tooltip();
|
||||
}
|
||||
|
||||
/**
|
||||
* Destroy Module
|
||||
*/
|
||||
public destroy(): void {
|
||||
this.tooltip.destroy();
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -59,14 +46,14 @@ export default class TooltipAPI extends Module {
|
|||
* @param {TooltipOptions} options - tooltip options
|
||||
*/
|
||||
public show(element: HTMLElement, content: TooltipContent, options?: TooltipOptions): void {
|
||||
this.tooltip.show(element, content, options);
|
||||
tooltip.show(element, content, options);
|
||||
}
|
||||
|
||||
/**
|
||||
* Method hides tooltip on HTML page
|
||||
*/
|
||||
public hide(): void {
|
||||
this.tooltip.hide();
|
||||
tooltip.hide();
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -77,6 +64,6 @@ export default class TooltipAPI extends Module {
|
|||
* @param {TooltipOptions} options - tooltip options
|
||||
*/
|
||||
public onHover(element: HTMLElement, content: TooltipContent, options?: TooltipOptions): void {
|
||||
this.tooltip.onHover(element, content, options);
|
||||
tooltip.onHover(element, content, options);
|
||||
}
|
||||
}
|
||||
|
|
|
@ -5,6 +5,8 @@ import Module from '../__module';
|
|||
import * as _ from '../utils';
|
||||
import SelectionUtils from '../selection';
|
||||
import Flipper from '../flipper';
|
||||
import type Block from '../block';
|
||||
import { areBlocksMergeable } from '../utils/blocks';
|
||||
|
||||
/**
|
||||
*
|
||||
|
@ -29,6 +31,10 @@ export default class BlockEvents extends Module {
|
|||
this.backspace(event);
|
||||
break;
|
||||
|
||||
case _.keyCodes.DELETE:
|
||||
this.delete(event);
|
||||
break;
|
||||
|
||||
case _.keyCodes.ENTER:
|
||||
this.enter(event);
|
||||
break;
|
||||
|
@ -47,6 +53,24 @@ export default class BlockEvents extends Module {
|
|||
this.tabPressed(event);
|
||||
break;
|
||||
}
|
||||
|
||||
/**
|
||||
* We check for "key" here since on different keyboard layouts "/" can be typed as "Shift + 7" etc
|
||||
*
|
||||
* @todo probably using "beforeInput" event would be better here
|
||||
*/
|
||||
if (event.key === '/' && !event.ctrlKey && !event.metaKey) {
|
||||
this.slashPressed(event);
|
||||
}
|
||||
|
||||
/**
|
||||
* If user pressed "Ctrl + /" or "Cmd + /" — open Block Settings
|
||||
* We check for "code" here since on different keyboard layouts there can be different keys in place of Slash.
|
||||
*/
|
||||
if (event.code === 'Slash' && (event.ctrlKey || event.metaKey)) {
|
||||
event.preventDefault();
|
||||
this.commandSlashPressed();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -80,7 +104,6 @@ export default class BlockEvents extends Module {
|
|||
const isShortcut = event.ctrlKey || event.metaKey || event.altKey || event.shiftKey;
|
||||
|
||||
if (!isShortcut) {
|
||||
this.Editor.BlockManager.clearFocused();
|
||||
this.Editor.BlockSelection.clearSelection(event);
|
||||
}
|
||||
}
|
||||
|
@ -107,40 +130,6 @@ export default class BlockEvents extends Module {
|
|||
this.Editor.UI.checkEmptiness();
|
||||
}
|
||||
|
||||
/**
|
||||
* Open Toolbox to leaf Tools
|
||||
*
|
||||
* @param {KeyboardEvent} event - tab keydown event
|
||||
*/
|
||||
public tabPressed(event): void {
|
||||
/**
|
||||
* Clear blocks selection by tab
|
||||
*/
|
||||
this.Editor.BlockSelection.clearSelection(event);
|
||||
|
||||
const { BlockManager, InlineToolbar, ConversionToolbar } = this.Editor;
|
||||
const currentBlock = BlockManager.currentBlock;
|
||||
|
||||
if (!currentBlock) {
|
||||
return;
|
||||
}
|
||||
|
||||
const isEmptyBlock = currentBlock.isEmpty;
|
||||
const canOpenToolbox = currentBlock.tool.isDefault && isEmptyBlock;
|
||||
const conversionToolbarOpened = !isEmptyBlock && ConversionToolbar.opened;
|
||||
const inlineToolbarOpened = !isEmptyBlock && !SelectionUtils.isCollapsed && InlineToolbar.opened;
|
||||
const canOpenBlockTunes = !conversionToolbarOpened && !inlineToolbarOpened;
|
||||
|
||||
/**
|
||||
* For empty Blocks we show Plus button via Toolbox only for default Blocks
|
||||
*/
|
||||
if (canOpenToolbox) {
|
||||
this.activateToolbox();
|
||||
} else if (canOpenBlockTunes) {
|
||||
this.activateBlockSettings();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add drop target styles
|
||||
*
|
||||
|
@ -207,6 +196,71 @@ export default class BlockEvents extends Module {
|
|||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Tab pressed inside a Block.
|
||||
*
|
||||
* @param {KeyboardEvent} event - keydown
|
||||
*/
|
||||
private tabPressed(event: KeyboardEvent): void {
|
||||
const { InlineToolbar, ConversionToolbar, Caret } = this.Editor;
|
||||
|
||||
const isFlipperActivated = ConversionToolbar.opened || InlineToolbar.opened;
|
||||
|
||||
if (isFlipperActivated) {
|
||||
return;
|
||||
}
|
||||
|
||||
const isNavigated = event.shiftKey ? Caret.navigatePrevious(true) : Caret.navigateNext(true);
|
||||
|
||||
/**
|
||||
* If we have next Block/input to focus, then focus it. Otherwise, leave native Tab behaviour
|
||||
*/
|
||||
if (isNavigated) {
|
||||
event.preventDefault();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* '/' + 'command' keydown inside a Block
|
||||
*/
|
||||
private commandSlashPressed(): void {
|
||||
if (this.Editor.BlockSelection.selectedBlocks.length > 1) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.activateBlockSettings();
|
||||
}
|
||||
|
||||
/**
|
||||
* '/' keydown inside a Block
|
||||
*
|
||||
* @param event - keydown
|
||||
*/
|
||||
private slashPressed(event: KeyboardEvent): void {
|
||||
const currentBlock = this.Editor.BlockManager.currentBlock;
|
||||
const canOpenToolbox = currentBlock.isEmpty;
|
||||
|
||||
/**
|
||||
* @todo Handle case when slash pressed when several blocks are selected
|
||||
*/
|
||||
|
||||
/**
|
||||
* Toolbox will be opened only if Block is empty
|
||||
*/
|
||||
if (!canOpenToolbox) {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* The Toolbox will be opened with immediate focus on the Search input,
|
||||
* and '/' will be added in the search input by default — we need to prevent it and add '/' manually
|
||||
*/
|
||||
event.preventDefault();
|
||||
this.Editor.Caret.insertContentAtCaretPosition('/');
|
||||
|
||||
this.activateToolbox();
|
||||
}
|
||||
|
||||
/**
|
||||
* ENTER pressed on block
|
||||
*
|
||||
|
@ -234,8 +288,12 @@ export default class BlockEvents extends Module {
|
|||
|
||||
/**
|
||||
* Allow to create line breaks by Shift+Enter
|
||||
*
|
||||
* Note. On iOS devices, Safari automatically treats enter after a period+space (". |") as Shift+Enter
|
||||
* (it used for capitalizing of the first letter of the next sentence)
|
||||
* We don't need to lead soft line break in this case — new block should be created
|
||||
*/
|
||||
if (event.shiftKey) {
|
||||
if (event.shiftKey && !_.isIosDevice) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
@ -246,6 +304,13 @@ export default class BlockEvents extends Module {
|
|||
*/
|
||||
if (this.Editor.Caret.isAtStart && !this.Editor.BlockManager.currentBlock.hasMedia) {
|
||||
this.Editor.BlockManager.insertDefaultBlockAtIndex(this.Editor.BlockManager.currentBlockIndex);
|
||||
|
||||
/**
|
||||
* If caret is at very end of the block, just append the new block without splitting
|
||||
* to prevent unnecessary dom mutation observing
|
||||
*/
|
||||
} else if (this.Editor.Caret.isAtEnd) {
|
||||
newCurrent = this.Editor.BlockManager.insertDefaultBlockAtIndex(this.Editor.BlockManager.currentBlockIndex + 1);
|
||||
} else {
|
||||
/**
|
||||
* Split the Current Block into two blocks
|
||||
|
@ -270,108 +335,179 @@ export default class BlockEvents extends Module {
|
|||
* @param {KeyboardEvent} event - keydown
|
||||
*/
|
||||
private backspace(event: KeyboardEvent): void {
|
||||
const { BlockManager, BlockSelection, Caret } = this.Editor;
|
||||
const currentBlock = BlockManager.currentBlock;
|
||||
const tool = currentBlock.tool;
|
||||
const { BlockManager, Caret } = this.Editor;
|
||||
const { currentBlock, previousBlock } = BlockManager;
|
||||
|
||||
/**
|
||||
* Check if Block should be removed by current Backspace keydown
|
||||
* If some fragment is selected, leave native behaviour
|
||||
*/
|
||||
if (currentBlock.selected || (currentBlock.isEmpty && currentBlock.currentInput === currentBlock.firstInput)) {
|
||||
event.preventDefault();
|
||||
if (!SelectionUtils.isCollapsed) {
|
||||
return;
|
||||
}
|
||||
|
||||
const index = BlockManager.currentBlockIndex;
|
||||
/**
|
||||
* If caret is not at the start, leave native behaviour
|
||||
*/
|
||||
if (!Caret.isAtStart) {
|
||||
return;
|
||||
}
|
||||
/**
|
||||
* All the cases below have custom behaviour, so we don't need a native one
|
||||
*/
|
||||
event.preventDefault();
|
||||
this.Editor.Toolbar.close();
|
||||
|
||||
if (BlockManager.previousBlock && BlockManager.previousBlock.inputs.length === 0) {
|
||||
/** If previous block doesn't contain inputs, remove it */
|
||||
BlockManager.removeBlock(index - 1);
|
||||
} else {
|
||||
/** If block is empty, just remove it */
|
||||
BlockManager.removeBlock();
|
||||
}
|
||||
const isFirstInputFocused = currentBlock.currentInput === currentBlock.firstInput;
|
||||
|
||||
Caret.setToBlock(
|
||||
BlockManager.currentBlock,
|
||||
index ? Caret.positions.END : Caret.positions.START
|
||||
);
|
||||
|
||||
/** Close Toolbar */
|
||||
this.Editor.Toolbar.close();
|
||||
|
||||
/** Clear selection */
|
||||
BlockSelection.clearSelection(event);
|
||||
/**
|
||||
* For example, caret at the start of the Quote second input (caption) — just navigate previous input
|
||||
*/
|
||||
if (!isFirstInputFocused) {
|
||||
Caret.navigatePrevious();
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Don't handle Backspaces when Tool sets enableLineBreaks to true.
|
||||
* Uses for Tools like <code> where line breaks should be handled by default behaviour.
|
||||
*
|
||||
* But if caret is at start of the block, we allow to remove it by backspaces
|
||||
* Backspace at the start of the first Block should do nothing
|
||||
*/
|
||||
if (tool.isLineBreaksEnabled && !Caret.isAtStart) {
|
||||
if (previousBlock === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
const isFirstBlock = BlockManager.currentBlockIndex === 0;
|
||||
const canMergeBlocks = Caret.isAtStart &&
|
||||
SelectionUtils.isCollapsed &&
|
||||
currentBlock.currentInput === currentBlock.firstInput &&
|
||||
!isFirstBlock;
|
||||
/**
|
||||
* If prev Block is empty, it should be removed just like a character
|
||||
*/
|
||||
if (previousBlock.isEmpty) {
|
||||
BlockManager.removeBlock(previousBlock);
|
||||
|
||||
if (canMergeBlocks) {
|
||||
/**
|
||||
* preventing browser default behaviour
|
||||
*/
|
||||
event.preventDefault();
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge Blocks
|
||||
*/
|
||||
this.mergeBlocks();
|
||||
/**
|
||||
* If current Block is empty, just remove it and set cursor to the previous Block (like we're removing line break char)
|
||||
*/
|
||||
if (currentBlock.isEmpty) {
|
||||
BlockManager.removeBlock(currentBlock);
|
||||
|
||||
const newCurrentBlock = BlockManager.currentBlock;
|
||||
|
||||
Caret.setToBlock(newCurrentBlock, Caret.positions.END);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
const bothBlocksMergeable = areBlocksMergeable(previousBlock, currentBlock);
|
||||
|
||||
/**
|
||||
* If Blocks could be merged, do it
|
||||
* Otherwise, just navigate previous block
|
||||
*/
|
||||
if (bothBlocksMergeable) {
|
||||
this.mergeBlocks(previousBlock, currentBlock);
|
||||
} else {
|
||||
Caret.setToBlock(previousBlock, Caret.positions.END);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge current and previous Blocks if they have the same type
|
||||
* Handles delete keydown on Block
|
||||
* Removes char after the caret.
|
||||
* If caret is at the end of the block, merge next block with current
|
||||
*
|
||||
* @param {KeyboardEvent} event - keydown
|
||||
*/
|
||||
private mergeBlocks(): void {
|
||||
const { BlockManager, Caret, Toolbar } = this.Editor;
|
||||
const targetBlock = BlockManager.previousBlock;
|
||||
const blockToMerge = BlockManager.currentBlock;
|
||||
private delete(event: KeyboardEvent): void {
|
||||
const { BlockManager, Caret } = this.Editor;
|
||||
const { currentBlock, nextBlock } = BlockManager;
|
||||
|
||||
/**
|
||||
* Blocks that can be merged:
|
||||
* 1) with the same Name
|
||||
* 2) Tool has 'merge' method
|
||||
*
|
||||
* other case will handle as usual ARROW LEFT behaviour
|
||||
* If some fragment is selected, leave native behaviour
|
||||
*/
|
||||
if (blockToMerge.name !== targetBlock.name || !targetBlock.mergeable) {
|
||||
/** If target Block doesn't contain inputs or empty, remove it */
|
||||
if (targetBlock.inputs.length === 0 || targetBlock.isEmpty) {
|
||||
BlockManager.removeBlock(BlockManager.currentBlockIndex - 1);
|
||||
if (!SelectionUtils.isCollapsed) {
|
||||
return;
|
||||
}
|
||||
|
||||
Caret.setToBlock(BlockManager.currentBlock);
|
||||
Toolbar.close();
|
||||
/**
|
||||
* If caret is not at the end, leave native behaviour
|
||||
*/
|
||||
if (!Caret.isAtEnd) {
|
||||
return;
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
/**
|
||||
* All the cases below have custom behaviour, so we don't need a native one
|
||||
*/
|
||||
event.preventDefault();
|
||||
this.Editor.Toolbar.close();
|
||||
|
||||
if (Caret.navigatePrevious()) {
|
||||
Toolbar.close();
|
||||
}
|
||||
const isLastInputFocused = currentBlock.currentInput === currentBlock.lastInput;
|
||||
|
||||
/**
|
||||
* For example, caret at the end of the Quote first input (quote text) — just navigate next input (caption)
|
||||
*/
|
||||
if (!isLastInputFocused) {
|
||||
Caret.navigateNext();
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
Caret.createShadow(targetBlock.pluginsContent);
|
||||
BlockManager.mergeBlocks(targetBlock, blockToMerge)
|
||||
/**
|
||||
* Delete at the end of the last Block should do nothing
|
||||
*/
|
||||
if (nextBlock === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* If next Block is empty, it should be removed just like a character
|
||||
*/
|
||||
if (nextBlock.isEmpty) {
|
||||
BlockManager.removeBlock(nextBlock);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* If current Block is empty, just remove it and set cursor to the next Block (like we're removing line break char)
|
||||
*/
|
||||
if (currentBlock.isEmpty) {
|
||||
BlockManager.removeBlock(currentBlock);
|
||||
|
||||
Caret.setToBlock(nextBlock, Caret.positions.START);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
const bothBlocksMergeable = areBlocksMergeable(currentBlock, nextBlock);
|
||||
|
||||
/**
|
||||
* If Blocks could be merged, do it
|
||||
* Otherwise, just navigate to the next block
|
||||
*/
|
||||
if (bothBlocksMergeable) {
|
||||
this.mergeBlocks(currentBlock, nextBlock);
|
||||
} else {
|
||||
Caret.setToBlock(nextBlock, Caret.positions.START);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge passed Blocks
|
||||
*
|
||||
* @param targetBlock - to which Block we want to merge
|
||||
* @param blockToMerge - what Block we want to merge
|
||||
*/
|
||||
private mergeBlocks(targetBlock: Block, blockToMerge: Block): void {
|
||||
const { BlockManager, Caret, Toolbar } = this.Editor;
|
||||
|
||||
Caret.createShadow(targetBlock.lastInput);
|
||||
|
||||
BlockManager
|
||||
.mergeBlocks(targetBlock, blockToMerge)
|
||||
.then(() => {
|
||||
/** Restore caret position after merge */
|
||||
Caret.restoreCaret(targetBlock.pluginsContent as HTMLElement);
|
||||
targetBlock.pluginsContent.normalize();
|
||||
Toolbar.close();
|
||||
});
|
||||
}
|
||||
|
@ -394,9 +530,8 @@ export default class BlockEvents extends Module {
|
|||
}
|
||||
|
||||
/**
|
||||
* Close Toolbar and highlighting when user moves cursor
|
||||
* Close Toolbar when user moves cursor
|
||||
*/
|
||||
this.Editor.BlockManager.clearFocused();
|
||||
this.Editor.Toolbar.close();
|
||||
|
||||
const shouldEnableCBS = this.Editor.Caret.isAtEnd || this.Editor.BlockSelection.anyBlockSelected;
|
||||
|
@ -415,19 +550,21 @@ export default class BlockEvents extends Module {
|
|||
* Default behaviour moves cursor by 1 character, we need to prevent it
|
||||
*/
|
||||
event.preventDefault();
|
||||
} else {
|
||||
/**
|
||||
* After caret is set, update Block input index
|
||||
*/
|
||||
_.delay(() => {
|
||||
/** Check currentBlock for case when user moves selection out of Editor */
|
||||
if (this.Editor.BlockManager.currentBlock) {
|
||||
this.Editor.BlockManager.currentBlock.updateCurrentInput();
|
||||
}
|
||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers
|
||||
}, 20)();
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* After caret is set, update Block input index
|
||||
*/
|
||||
_.delay(() => {
|
||||
/** Check currentBlock for case when user moves selection out of Editor */
|
||||
if (this.Editor.BlockManager.currentBlock) {
|
||||
this.Editor.BlockManager.currentBlock.updateCurrentInput();
|
||||
}
|
||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers
|
||||
}, 20)();
|
||||
|
||||
/**
|
||||
* Clear blocks selection by arrows
|
||||
*/
|
||||
|
@ -453,9 +590,8 @@ export default class BlockEvents extends Module {
|
|||
}
|
||||
|
||||
/**
|
||||
* Close Toolbar and highlighting when user moves cursor
|
||||
* Close Toolbar when user moves cursor
|
||||
*/
|
||||
this.Editor.BlockManager.clearFocused();
|
||||
this.Editor.Toolbar.close();
|
||||
|
||||
const shouldEnableCBS = this.Editor.Caret.isAtStart || this.Editor.BlockSelection.anyBlockSelected;
|
||||
|
@ -474,19 +610,21 @@ export default class BlockEvents extends Module {
|
|||
* Default behaviour moves cursor by 1 character, we need to prevent it
|
||||
*/
|
||||
event.preventDefault();
|
||||
} else {
|
||||
/**
|
||||
* After caret is set, update Block input index
|
||||
*/
|
||||
_.delay(() => {
|
||||
/** Check currentBlock for case when user ends selection out of Editor and then press arrow-key */
|
||||
if (this.Editor.BlockManager.currentBlock) {
|
||||
this.Editor.BlockManager.currentBlock.updateCurrentInput();
|
||||
}
|
||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers
|
||||
}, 20)();
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* After caret is set, update Block input index
|
||||
*/
|
||||
_.delay(() => {
|
||||
/** Check currentBlock for case when user ends selection out of Editor and then press arrow-key */
|
||||
if (this.Editor.BlockManager.currentBlock) {
|
||||
this.Editor.BlockManager.currentBlock.updateCurrentInput();
|
||||
}
|
||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers
|
||||
}, 20)();
|
||||
|
||||
/**
|
||||
* Clear blocks selection by arrows
|
||||
*/
|
||||
|
@ -536,7 +674,6 @@ export default class BlockEvents extends Module {
|
|||
*/
|
||||
private activateBlockSettings(): void {
|
||||
if (!this.Editor.Toolbar.opened) {
|
||||
this.Editor.BlockManager.currentBlock.focused = true;
|
||||
this.Editor.Toolbar.moveAndOpen();
|
||||
}
|
||||
|
||||
|
|
|
@ -12,7 +12,15 @@ import Blocks from '../blocks';
|
|||
import { BlockToolData, PasteEvent } from '../../../types';
|
||||
import { BlockTuneData } from '../../../types/block-tunes/block-tune-data';
|
||||
import BlockAPI from '../block/api';
|
||||
import { BlockMutationType } from '../../../types/events/block/mutation-type';
|
||||
import { BlockMutationEventMap, BlockMutationType } from '../../../types/events/block';
|
||||
import { BlockRemovedMutationType } from '../../../types/events/block/BlockRemoved';
|
||||
import { BlockAddedMutationType } from '../../../types/events/block/BlockAdded';
|
||||
import { BlockMovedMutationType } from '../../../types/events/block/BlockMoved';
|
||||
import { BlockChangedMutationType } from '../../../types/events/block/BlockChanged';
|
||||
import { BlockChanged } from '../events';
|
||||
import { clean, sanitizeBlocks } from '../utils/sanitizer';
|
||||
import { convertStringToBlockData, isBlockConvertable } from '../utils/blocks';
|
||||
import PromiseQueue from '../utils/promise-queue';
|
||||
|
||||
/**
|
||||
* @typedef {BlockManager} BlockManager
|
||||
|
@ -35,14 +43,6 @@ export default class BlockManager extends Module {
|
|||
* @param {number} newIndex - index of Block to set as current
|
||||
*/
|
||||
public set currentBlockIndex(newIndex: number) {
|
||||
if (this._blocks[this._currentBlockIndex]) {
|
||||
this._blocks[this._currentBlockIndex].willUnselect();
|
||||
}
|
||||
|
||||
if (this._blocks[newIndex]) {
|
||||
this._blocks[newIndex].willSelect();
|
||||
}
|
||||
|
||||
this._currentBlockIndex = newIndex;
|
||||
}
|
||||
|
||||
|
@ -69,7 +69,7 @@ export default class BlockManager extends Module {
|
|||
*
|
||||
* @returns {Block}
|
||||
*/
|
||||
public get currentBlock(): Block {
|
||||
public get currentBlock(): Block | undefined {
|
||||
return this._blocks[this.currentBlockIndex];
|
||||
}
|
||||
|
||||
|
@ -87,7 +87,7 @@ export default class BlockManager extends Module {
|
|||
*
|
||||
* @returns {Block|null}
|
||||
*/
|
||||
public get nextBlock(): Block {
|
||||
public get nextBlock(): Block | null {
|
||||
const isLastBlock = this.currentBlockIndex === (this._blocks.length - 1);
|
||||
|
||||
if (isLastBlock) {
|
||||
|
@ -124,7 +124,7 @@ export default class BlockManager extends Module {
|
|||
*
|
||||
* @returns {Block|null}
|
||||
*/
|
||||
public get previousBlock(): Block {
|
||||
public get previousBlock(): Block | null {
|
||||
const isFirstBlock = this.currentBlockIndex === 0;
|
||||
|
||||
if (isFirstBlock) {
|
||||
|
@ -242,10 +242,12 @@ export default class BlockManager extends Module {
|
|||
api: this.Editor.API,
|
||||
readOnly,
|
||||
tunesData,
|
||||
});
|
||||
}, this.eventsDispatcher);
|
||||
|
||||
if (!readOnly) {
|
||||
this.bindBlockEvents(block);
|
||||
window.requestIdleCallback(() => {
|
||||
this.bindBlockEvents(block);
|
||||
}, { timeout: 2000 });
|
||||
}
|
||||
|
||||
return block;
|
||||
|
@ -298,7 +300,7 @@ export default class BlockManager extends Module {
|
|||
* we need to dispatch the 'block-removing' event for the replacing block
|
||||
*/
|
||||
if (replace) {
|
||||
this.blockDidMutated(BlockMutationType.Removed, this.getBlockByIndex(newIndex), {
|
||||
this.blockDidMutated(BlockRemovedMutationType, this.getBlockByIndex(newIndex), {
|
||||
index: newIndex,
|
||||
});
|
||||
}
|
||||
|
@ -308,7 +310,7 @@ export default class BlockManager extends Module {
|
|||
/**
|
||||
* Force call of didMutated event on Block insertion
|
||||
*/
|
||||
this.blockDidMutated(BlockMutationType.Added, block, {
|
||||
this.blockDidMutated(BlockAddedMutationType, block, {
|
||||
index: newIndex,
|
||||
});
|
||||
|
||||
|
@ -322,21 +324,59 @@ export default class BlockManager extends Module {
|
|||
}
|
||||
|
||||
/**
|
||||
* Replace current working block
|
||||
* Inserts several blocks at once
|
||||
*
|
||||
* @param {object} options - replace options
|
||||
* @param {string} options.tool — plugin name
|
||||
* @param {BlockToolData} options.data — plugin data
|
||||
* @returns {Block}
|
||||
* @param blocks - blocks to insert
|
||||
* @param index - index where to insert
|
||||
*/
|
||||
public replace({
|
||||
tool = this.config.defaultBlock,
|
||||
data = {},
|
||||
}): Block {
|
||||
public insertMany(blocks: Block[], index = 0): void {
|
||||
this._blocks.insertMany(blocks, index);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update Block data.
|
||||
*
|
||||
* Currently we don't have an 'update' method in the Tools API, so we just create a new block with the same id and type
|
||||
* Should not trigger 'block-removed' or 'block-added' events
|
||||
*
|
||||
* @param block - block to update
|
||||
* @param data - new data
|
||||
*/
|
||||
public async update(block: Block, data: Partial<BlockToolData>): Promise<Block> {
|
||||
const existingData = await block.data;
|
||||
|
||||
const newBlock = this.composeBlock({
|
||||
id: block.id,
|
||||
tool: block.name,
|
||||
data: Object.assign({}, existingData, data),
|
||||
tunes: block.tunes,
|
||||
});
|
||||
|
||||
const blockIndex = this.getBlockIndex(block);
|
||||
|
||||
this._blocks.replace(blockIndex, newBlock);
|
||||
|
||||
this.blockDidMutated(BlockChangedMutationType, newBlock, {
|
||||
index: blockIndex,
|
||||
});
|
||||
|
||||
return newBlock;
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace passed Block with the new one with specified Tool and data
|
||||
*
|
||||
* @param block - block to replace
|
||||
* @param newTool - new Tool name
|
||||
* @param data - new Tool data
|
||||
*/
|
||||
public replace(block: Block, newTool: string, data: BlockToolData): Block {
|
||||
const blockIndex = this.getBlockIndex(block);
|
||||
|
||||
return this.insert({
|
||||
tool,
|
||||
tool: newTool,
|
||||
data,
|
||||
index: this.currentBlockIndex,
|
||||
index: blockIndex,
|
||||
replace: true,
|
||||
});
|
||||
}
|
||||
|
@ -359,7 +399,16 @@ export default class BlockManager extends Module {
|
|||
});
|
||||
|
||||
try {
|
||||
block.call(BlockToolAPI.ON_PASTE, pasteEvent);
|
||||
/**
|
||||
* We need to call onPaste after Block will be ready
|
||||
* because onPaste could change tool's root element, and we need to do that after block.watchBlockMutations() bound
|
||||
* to detect tool root element change
|
||||
*
|
||||
* @todo make this.insert() awaitable and remove requestIdleCallback
|
||||
*/
|
||||
window.requestIdleCallback(() => {
|
||||
block.call(BlockToolAPI.ON_PASTE, pasteEvent);
|
||||
});
|
||||
} catch (e) {
|
||||
_.log(`${toolName}: onPaste callback call is failed`, 'error', e);
|
||||
}
|
||||
|
@ -384,7 +433,7 @@ export default class BlockManager extends Module {
|
|||
/**
|
||||
* Force call of didMutated event on Block insertion
|
||||
*/
|
||||
this.blockDidMutated(BlockMutationType.Added, block, {
|
||||
this.blockDidMutated(BlockAddedMutationType, block, {
|
||||
index,
|
||||
});
|
||||
|
||||
|
@ -422,61 +471,90 @@ export default class BlockManager extends Module {
|
|||
* @returns {Promise} - the sequence that can be continued
|
||||
*/
|
||||
public async mergeBlocks(targetBlock: Block, blockToMerge: Block): Promise<void> {
|
||||
const blockToMergeIndex = this._blocks.indexOf(blockToMerge);
|
||||
let blockToMergeData: BlockToolData | undefined;
|
||||
|
||||
if (blockToMerge.isEmpty) {
|
||||
/**
|
||||
* We can merge:
|
||||
* 1) Blocks with the same Tool if tool provides merge method
|
||||
*/
|
||||
if (targetBlock.name === blockToMerge.name && targetBlock.mergeable) {
|
||||
const blockToMergeDataRaw = await blockToMerge.data;
|
||||
|
||||
if (_.isEmpty(blockToMergeDataRaw)) {
|
||||
console.error('Could not merge Block. Failed to extract original Block data.');
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
const [ cleanData ] = sanitizeBlocks([ blockToMergeDataRaw ], targetBlock.tool.sanitizeConfig);
|
||||
|
||||
blockToMergeData = cleanData;
|
||||
|
||||
/**
|
||||
* 2) Blocks with different Tools if they provides conversionConfig
|
||||
*/
|
||||
} else if (targetBlock.mergeable && isBlockConvertable(blockToMerge, 'export') && isBlockConvertable(targetBlock, 'import')) {
|
||||
const blockToMergeDataStringified = await blockToMerge.exportDataAsString();
|
||||
const cleanData = clean(blockToMergeDataStringified, targetBlock.tool.sanitizeConfig);
|
||||
|
||||
blockToMergeData = convertStringToBlockData(cleanData, targetBlock.tool.conversionConfig);
|
||||
}
|
||||
|
||||
if (blockToMergeData === undefined) {
|
||||
return;
|
||||
}
|
||||
|
||||
const blockToMergeData = await blockToMerge.data;
|
||||
|
||||
if (!_.isEmpty(blockToMergeData)) {
|
||||
await targetBlock.mergeWith(blockToMergeData);
|
||||
}
|
||||
|
||||
this.removeBlock(blockToMergeIndex);
|
||||
await targetBlock.mergeWith(blockToMergeData);
|
||||
this.removeBlock(blockToMerge);
|
||||
this.currentBlockIndex = this._blocks.indexOf(targetBlock);
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove block with passed index or remove last
|
||||
* Remove passed Block
|
||||
*
|
||||
* @param {number|null} index - index of Block to remove
|
||||
* @throws {Error} if Block to remove is not found
|
||||
* @param block - Block to remove
|
||||
* @param addLastBlock - if true, adds new default block at the end. @todo remove this logic and use event-bus instead
|
||||
*/
|
||||
public removeBlock(index = this.currentBlockIndex): void {
|
||||
/**
|
||||
* If index is not passed and there is no block selected, show a warning
|
||||
*/
|
||||
if (!this.validateIndex(index)) {
|
||||
throw new Error('Can\'t find a Block to remove');
|
||||
}
|
||||
public removeBlock(block: Block, addLastBlock = true): Promise<void> {
|
||||
return new Promise((resolve) => {
|
||||
const index = this._blocks.indexOf(block);
|
||||
|
||||
const blockToRemove = this._blocks[index];
|
||||
/**
|
||||
* If index is not passed and there is no block selected, show a warning
|
||||
*/
|
||||
if (!this.validateIndex(index)) {
|
||||
throw new Error('Can\'t find a Block to remove');
|
||||
}
|
||||
|
||||
blockToRemove.destroy();
|
||||
this._blocks.remove(index);
|
||||
block.destroy();
|
||||
this._blocks.remove(index);
|
||||
|
||||
/**
|
||||
* Force call of didMutated event on Block removal
|
||||
*/
|
||||
this.blockDidMutated(BlockMutationType.Removed, blockToRemove, {
|
||||
index,
|
||||
/**
|
||||
* Force call of didMutated event on Block removal
|
||||
*/
|
||||
this.blockDidMutated(BlockRemovedMutationType, block, {
|
||||
index,
|
||||
});
|
||||
|
||||
if (this.currentBlockIndex >= index) {
|
||||
this.currentBlockIndex--;
|
||||
}
|
||||
|
||||
/**
|
||||
* If first Block was removed, insert new Initial Block and set focus on it`s first input
|
||||
*/
|
||||
if (!this.blocks.length) {
|
||||
this.currentBlockIndex = -1;
|
||||
|
||||
if (addLastBlock) {
|
||||
this.insert();
|
||||
}
|
||||
} else if (index === 0) {
|
||||
this.currentBlockIndex = 0;
|
||||
}
|
||||
|
||||
resolve();
|
||||
});
|
||||
|
||||
if (this.currentBlockIndex >= index) {
|
||||
this.currentBlockIndex--;
|
||||
}
|
||||
|
||||
/**
|
||||
* If first Block was removed, insert new Initial Block and set focus on it`s first input
|
||||
*/
|
||||
if (!this.blocks.length) {
|
||||
this.currentBlockIndex = -1;
|
||||
this.insert();
|
||||
} else if (index === 0) {
|
||||
this.currentBlockIndex = 0;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -496,7 +574,7 @@ export default class BlockManager extends Module {
|
|||
continue;
|
||||
}
|
||||
|
||||
this.removeBlock(index);
|
||||
this.removeBlock(this.blocks[index]);
|
||||
firstSelectedBlockIndex = index;
|
||||
}
|
||||
|
||||
|
@ -546,13 +624,28 @@ export default class BlockManager extends Module {
|
|||
return this.insert({ data });
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns Block by passed index
|
||||
*
|
||||
* If we pass -1 as index, the last block will be returned
|
||||
* There shouldn't be a case when there is no blocks at all — at least one always should exist
|
||||
*/
|
||||
public getBlockByIndex(index: -1): Block;
|
||||
|
||||
/**
|
||||
* Returns Block by passed index.
|
||||
*
|
||||
* Could return undefined if there is no block with such index
|
||||
*/
|
||||
public getBlockByIndex(index: number): Block | undefined;
|
||||
|
||||
/**
|
||||
* Returns Block by passed index
|
||||
*
|
||||
* @param {number} index - index to get. -1 to get last
|
||||
* @returns {Block}
|
||||
*/
|
||||
public getBlockByIndex(index): Block {
|
||||
public getBlockByIndex(index: number): Block | undefined {
|
||||
if (index === -1) {
|
||||
index = this._blocks.length - 1;
|
||||
}
|
||||
|
@ -598,32 +691,6 @@ export default class BlockManager extends Module {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove selection from all Blocks then highlight only Current Block
|
||||
*/
|
||||
public highlightCurrentNode(): void {
|
||||
/**
|
||||
* Remove previous selected Block's state
|
||||
*/
|
||||
this.clearFocused();
|
||||
|
||||
/**
|
||||
* Mark current Block as selected
|
||||
*
|
||||
* @type {boolean}
|
||||
*/
|
||||
this.currentBlock.focused = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove selection from all Blocks
|
||||
*/
|
||||
public clearFocused(): void {
|
||||
this.blocks.forEach((block) => {
|
||||
block.focused = false;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 1) Find first-level Block from passed child Node
|
||||
* 2) Mark it as current
|
||||
|
@ -679,7 +746,11 @@ export default class BlockManager extends Module {
|
|||
* @param {Node} childNode - node to get Block by
|
||||
* @returns {Block}
|
||||
*/
|
||||
public getBlockByChildNode(childNode: Node): Block {
|
||||
public getBlockByChildNode(childNode: Node): Block | undefined {
|
||||
if (!childNode || childNode instanceof Node === false) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* If node is Text TextNode
|
||||
*/
|
||||
|
@ -736,19 +807,74 @@ export default class BlockManager extends Module {
|
|||
/**
|
||||
* Force call of didMutated event on Block movement
|
||||
*/
|
||||
this.blockDidMutated(BlockMutationType.Moved, this.currentBlock, {
|
||||
this.blockDidMutated(BlockMovedMutationType, this.currentBlock, {
|
||||
fromIndex,
|
||||
toIndex,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts passed Block to the new Tool
|
||||
* Uses Conversion Config
|
||||
*
|
||||
* @param blockToConvert - Block that should be converted
|
||||
* @param targetToolName - name of the Tool to convert to
|
||||
* @param blockDataOverrides - optional new Block data overrides
|
||||
*/
|
||||
public async convert(blockToConvert: Block, targetToolName: string, blockDataOverrides?: BlockToolData): Promise<Block> {
|
||||
/**
|
||||
* At first, we get current Block data
|
||||
*/
|
||||
const savedBlock = await blockToConvert.save();
|
||||
|
||||
if (!savedBlock) {
|
||||
throw new Error('Could not convert Block. Failed to extract original Block data.');
|
||||
}
|
||||
|
||||
/**
|
||||
* Getting a class of the replacing Tool
|
||||
*/
|
||||
const replacingTool = this.Editor.Tools.blockTools.get(targetToolName);
|
||||
|
||||
if (!replacingTool) {
|
||||
throw new Error(`Could not convert Block. Tool «${targetToolName}» not found.`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Using Conversion Config "export" we get a stringified version of the Block data
|
||||
*/
|
||||
const exportedData = await blockToConvert.exportDataAsString();
|
||||
|
||||
/**
|
||||
* Clean exported data with replacing sanitizer config
|
||||
*/
|
||||
const cleanData: string = clean(
|
||||
exportedData,
|
||||
replacingTool.sanitizeConfig
|
||||
);
|
||||
|
||||
/**
|
||||
* Now using Conversion Config "import" we compose a new Block data
|
||||
*/
|
||||
let newBlockData = convertStringToBlockData(cleanData, replacingTool.conversionConfig);
|
||||
|
||||
/**
|
||||
* Optional data overrides.
|
||||
* Used for example, by the Multiple Toolbox Items feature, where a single Tool provides several Toolbox items with "data" overrides
|
||||
*/
|
||||
if (blockDataOverrides) {
|
||||
newBlockData = Object.assign(newBlockData, blockDataOverrides);
|
||||
}
|
||||
|
||||
return this.replace(blockToConvert, replacingTool.name, newBlockData);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets current Block Index -1 which means unknown
|
||||
* and clear highlights
|
||||
*/
|
||||
public dropPointer(): void {
|
||||
this.currentBlockIndex = -1;
|
||||
this.clearFocused();
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -758,8 +884,17 @@ export default class BlockManager extends Module {
|
|||
* we don't need to add an empty default block
|
||||
* 2) in api.blocks.clear we should add empty block
|
||||
*/
|
||||
public clear(needToAddDefaultBlock = false): void {
|
||||
this._blocks.removeAll();
|
||||
public async clear(needToAddDefaultBlock = false): Promise<void> {
|
||||
const queue = new PromiseQueue();
|
||||
|
||||
this.blocks.forEach((block) => {
|
||||
queue.add(async () => {
|
||||
await this.removeBlock(block, false);
|
||||
});
|
||||
});
|
||||
|
||||
await queue.completed;
|
||||
|
||||
this.dropPointer();
|
||||
|
||||
if (needToAddDefaultBlock) {
|
||||
|
@ -807,7 +942,7 @@ export default class BlockManager extends Module {
|
|||
});
|
||||
|
||||
block.on('didMutated', (affectedBlock: Block) => {
|
||||
return this.blockDidMutated(BlockMutationType.Changed, affectedBlock, {
|
||||
return this.blockDidMutated(BlockChangedMutationType, affectedBlock, {
|
||||
index: this.getBlockIndex(affectedBlock),
|
||||
});
|
||||
});
|
||||
|
@ -851,18 +986,25 @@ export default class BlockManager extends Module {
|
|||
*
|
||||
* @param mutationType - what happened with block
|
||||
* @param block - mutated block
|
||||
* @param details - additional data to pass with change event
|
||||
* @param detailData - additional data to pass with change event
|
||||
*/
|
||||
private blockDidMutated(mutationType: BlockMutationType, block: Block, details: Record<string, unknown> = {}): Block {
|
||||
private blockDidMutated<Type extends BlockMutationType>(mutationType: Type, block: Block, detailData: BlockMutationEventDetailWithoutTarget<Type>): Block {
|
||||
const event = new CustomEvent(mutationType, {
|
||||
detail: {
|
||||
target: new BlockAPI(block),
|
||||
...details,
|
||||
...detailData as BlockMutationEventDetailWithoutTarget<Type>,
|
||||
},
|
||||
});
|
||||
|
||||
this.Editor.ModificationsObserver.onChange(event);
|
||||
this.eventsDispatcher.emit(BlockChanged, {
|
||||
event: event as BlockMutationEventMap[Type],
|
||||
});
|
||||
|
||||
return block;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Type alias for Block Mutation event without 'target' field, used in 'blockDidMutated' method
|
||||
*/
|
||||
type BlockMutationEventDetailWithoutTarget<Type extends BlockMutationType> = Omit<BlockMutationEventMap[Type]['detail'], 'target'>;
|
||||
|
|
|
@ -321,26 +321,28 @@ export default class BlockSelection extends Module {
|
|||
}
|
||||
|
||||
/**
|
||||
* select Block
|
||||
* Select Block by its index
|
||||
*
|
||||
* @param {number?} index - Block index according to the BlockManager's indexes
|
||||
*/
|
||||
public selectBlockByIndex(index?): void {
|
||||
public selectBlockByIndex(index: number): void {
|
||||
const { BlockManager } = this.Editor;
|
||||
|
||||
/**
|
||||
* Remove previous focused Block's state
|
||||
*/
|
||||
BlockManager.clearFocused();
|
||||
const block = BlockManager.getBlockByIndex(index);
|
||||
|
||||
let block;
|
||||
|
||||
if (isNaN(index)) {
|
||||
block = BlockManager.currentBlock;
|
||||
} else {
|
||||
block = BlockManager.getBlockByIndex(index);
|
||||
if (block === undefined) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.selectBlock(block);
|
||||
}
|
||||
|
||||
/**
|
||||
* Select passed Block
|
||||
*
|
||||
* @param {Block} block - Block to select
|
||||
*/
|
||||
public selectBlock(block: Block): void {
|
||||
/** Save selection */
|
||||
this.selection.save();
|
||||
SelectionUtils.get()
|
||||
|
@ -354,6 +356,17 @@ export default class BlockSelection extends Module {
|
|||
this.Editor.InlineToolbar.close();
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove selection from passed Block
|
||||
*
|
||||
* @param {Block} block - Block to unselect
|
||||
*/
|
||||
public unselectBlock(block: Block): void {
|
||||
block.selected = false;
|
||||
|
||||
this.clearCache();
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear anyBlockSelected cache
|
||||
*/
|
||||
|
@ -432,7 +445,7 @@ export default class BlockSelection extends Module {
|
|||
/**
|
||||
* select working Block
|
||||
*/
|
||||
this.selectBlockByIndex();
|
||||
this.selectBlock(workingBlock);
|
||||
|
||||
/**
|
||||
* Enable all Blocks selection if current Block is selected
|
||||
|
|
|
@ -11,7 +11,6 @@ import Selection from '../selection';
|
|||
import Module from '../__module';
|
||||
import Block from '../block';
|
||||
import $ from '../dom';
|
||||
import * as _ from '../utils';
|
||||
|
||||
/**
|
||||
* @typedef {Caret} Caret
|
||||
|
@ -46,8 +45,17 @@ export default class Caret extends Module {
|
|||
* @returns {boolean}
|
||||
*/
|
||||
public get isAtStart(): boolean {
|
||||
const { currentBlock } = this.Editor.BlockManager;
|
||||
|
||||
/**
|
||||
* If Block does not contain inputs, treat caret as "at start"
|
||||
*/
|
||||
if (!currentBlock?.focusable) {
|
||||
return true;
|
||||
}
|
||||
|
||||
const selection = Selection.get();
|
||||
const firstNode = $.getDeepestNode(this.Editor.BlockManager.currentBlock.currentInput);
|
||||
const firstNode = $.getDeepestNode(currentBlock.currentInput);
|
||||
let focusNode = selection.focusNode;
|
||||
|
||||
/** In case lastNode is native input */
|
||||
|
@ -138,10 +146,19 @@ export default class Caret extends Module {
|
|||
* @returns {boolean}
|
||||
*/
|
||||
public get isAtEnd(): boolean {
|
||||
const { currentBlock } = this.Editor.BlockManager;
|
||||
|
||||
/**
|
||||
* If Block does not contain inputs, treat caret as "at end"
|
||||
*/
|
||||
if (!currentBlock.focusable) {
|
||||
return true;
|
||||
}
|
||||
|
||||
const selection = Selection.get();
|
||||
let focusNode = selection.focusNode;
|
||||
|
||||
const lastNode = $.getDeepestNode(this.Editor.BlockManager.currentBlock.currentInput, true);
|
||||
const lastNode = $.getDeepestNode(currentBlock.currentInput, true);
|
||||
|
||||
/** In case lastNode is native input */
|
||||
if ($.isNativeInput(lastNode)) {
|
||||
|
@ -224,7 +241,31 @@ export default class Caret extends Module {
|
|||
* @param {number} offset - caret offset regarding to the text node
|
||||
*/
|
||||
public setToBlock(block: Block, position: string = this.positions.DEFAULT, offset = 0): void {
|
||||
const { BlockManager } = this.Editor;
|
||||
const { BlockManager, BlockSelection } = this.Editor;
|
||||
|
||||
/**
|
||||
* Clear previous selection since we possible will select the new Block
|
||||
*/
|
||||
BlockSelection.clearSelection();
|
||||
|
||||
/**
|
||||
* If Block is not focusable, just select (highlight) it
|
||||
*/
|
||||
if (!block.focusable) {
|
||||
/**
|
||||
* Hide current cursor
|
||||
*/
|
||||
window.getSelection()?.removeAllRanges();
|
||||
|
||||
/**
|
||||
* Highlight Block
|
||||
*/
|
||||
BlockSelection.selectBlock(block);
|
||||
BlockManager.currentBlock = block;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
let element;
|
||||
|
||||
switch (position) {
|
||||
|
@ -255,13 +296,7 @@ export default class Caret extends Module {
|
|||
break;
|
||||
}
|
||||
|
||||
/**
|
||||
* @todo try to fix via Promises or use querySelectorAll to not to use timeout
|
||||
*/
|
||||
_.delay(() => {
|
||||
this.set(nodeToSet as HTMLElement, offset);
|
||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers
|
||||
}, 20)();
|
||||
this.set(nodeToSet as HTMLElement, offset);
|
||||
|
||||
BlockManager.setCurrentBlockByChildNode(block.holder);
|
||||
BlockManager.currentBlock.currentInput = element;
|
||||
|
@ -304,16 +339,17 @@ export default class Caret extends Module {
|
|||
* @param {number} offset - offset
|
||||
*/
|
||||
public set(element: HTMLElement, offset = 0): void {
|
||||
const scrollOffset = 30;
|
||||
const { top, bottom } = Selection.setCursor(element, offset);
|
||||
|
||||
/** If new cursor position is not visible, scroll to it */
|
||||
const { innerHeight } = window;
|
||||
|
||||
/**
|
||||
* If new cursor position is not visible, scroll to it
|
||||
*/
|
||||
if (top < 0) {
|
||||
window.scrollBy(0, top);
|
||||
}
|
||||
if (bottom > innerHeight) {
|
||||
window.scrollBy(0, bottom - innerHeight);
|
||||
window.scrollBy(0, top - scrollOffset);
|
||||
} else if (bottom > innerHeight) {
|
||||
window.scrollBy(0, bottom - innerHeight + scrollOffset);
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -387,17 +423,25 @@ export default class Caret extends Module {
|
|||
* Before moving caret, we should check if caret position is at the end of Plugins node
|
||||
* Using {@link Dom#getDeepestNode} to get a last node and match with current selection
|
||||
*
|
||||
* @returns {boolean}
|
||||
* @param {boolean} force - pass true to skip check for caret position
|
||||
*/
|
||||
public navigateNext(): boolean {
|
||||
public navigateNext(force = false): boolean {
|
||||
const { BlockManager } = this.Editor;
|
||||
const { currentBlock, nextContentfulBlock } = BlockManager;
|
||||
const { currentBlock, nextBlock } = BlockManager;
|
||||
const { nextInput } = currentBlock;
|
||||
const isAtEnd = this.isAtEnd;
|
||||
let blockToNavigate = nextBlock;
|
||||
|
||||
let nextBlock = nextContentfulBlock;
|
||||
const navigationAllowed = force || isAtEnd;
|
||||
|
||||
if (!nextBlock && !nextInput) {
|
||||
/** If next Tool`s input exists, focus on it. Otherwise set caret to the next Block */
|
||||
if (nextInput && navigationAllowed) {
|
||||
this.setToInput(nextInput, this.positions.START);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
if (blockToNavigate === null) {
|
||||
/**
|
||||
* This code allows to exit from the last non-initial tool:
|
||||
* https://github.com/codex-team/editor.js/issues/1103
|
||||
|
@ -408,7 +452,7 @@ export default class Caret extends Module {
|
|||
* 2. If there is a last block and it is non-default --> and caret not at the end <--, do nothing
|
||||
* (https://github.com/codex-team/editor.js/issues/1414)
|
||||
*/
|
||||
if (currentBlock.tool.isDefault || !isAtEnd) {
|
||||
if (currentBlock.tool.isDefault || !navigationAllowed) {
|
||||
return false;
|
||||
}
|
||||
|
||||
|
@ -416,16 +460,11 @@ export default class Caret extends Module {
|
|||
* If there is no nextBlock, but currentBlock is not default,
|
||||
* insert new default block at the end and navigate to it
|
||||
*/
|
||||
nextBlock = BlockManager.insertAtEnd();
|
||||
blockToNavigate = BlockManager.insertAtEnd() as Block;
|
||||
}
|
||||
|
||||
if (isAtEnd) {
|
||||
/** If next Tool`s input exists, focus on it. Otherwise set caret to the next Block */
|
||||
if (!nextInput) {
|
||||
this.setToBlock(nextBlock, this.positions.START);
|
||||
} else {
|
||||
this.setToInput(nextInput, this.positions.START);
|
||||
}
|
||||
if (navigationAllowed) {
|
||||
this.setToBlock(blockToNavigate, this.positions.START);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
@ -438,28 +477,27 @@ export default class Caret extends Module {
|
|||
* Before moving caret, we should check if caret position is start of the Plugins node
|
||||
* Using {@link Dom#getDeepestNode} to get a last node and match with current selection
|
||||
*
|
||||
* @returns {boolean}
|
||||
* @param {boolean} force - pass true to skip check for caret position
|
||||
*/
|
||||
public navigatePrevious(): boolean {
|
||||
const { currentBlock, previousContentfulBlock } = this.Editor.BlockManager;
|
||||
public navigatePrevious(force = false): boolean {
|
||||
const { currentBlock, previousBlock } = this.Editor.BlockManager;
|
||||
|
||||
if (!currentBlock) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const { previousInput } = currentBlock;
|
||||
const navigationAllowed = force || this.isAtStart;
|
||||
|
||||
if (!previousContentfulBlock && !previousInput) {
|
||||
return false;
|
||||
/** If previous Tool`s input exists, focus on it. Otherwise set caret to the previous Block */
|
||||
if (previousInput && navigationAllowed) {
|
||||
this.setToInput(previousInput, this.positions.END);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
if (this.isAtStart) {
|
||||
/** If previous Tool`s input exists, focus on it. Otherwise set caret to the previous Block */
|
||||
if (!previousInput) {
|
||||
this.setToBlock(previousContentfulBlock, this.positions.END);
|
||||
} else {
|
||||
this.setToInput(previousInput, this.positions.END);
|
||||
}
|
||||
if (previousBlock !== null && navigationAllowed) {
|
||||
this.setToBlock(previousBlock as Block, this.positions.END);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
@ -503,13 +541,10 @@ export default class Caret extends Module {
|
|||
|
||||
sel.expandToTag(shadowCaret as HTMLElement);
|
||||
|
||||
setTimeout(() => {
|
||||
const newRange = document.createRange();
|
||||
const newRange = document.createRange();
|
||||
|
||||
newRange.selectNode(shadowCaret);
|
||||
newRange.extractContents();
|
||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers
|
||||
}, 50);
|
||||
newRange.selectNode(shadowCaret);
|
||||
newRange.extractContents();
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -534,7 +569,7 @@ export default class Caret extends Module {
|
|||
fragment.appendChild(new Text());
|
||||
}
|
||||
|
||||
const lastChild = fragment.lastChild;
|
||||
const lastChild = fragment.lastChild as ChildNode;
|
||||
|
||||
range.deleteContents();
|
||||
range.insertNode(fragment);
|
||||
|
@ -542,7 +577,11 @@ export default class Caret extends Module {
|
|||
/** Cross-browser caret insertion */
|
||||
const newRange = document.createRange();
|
||||
|
||||
newRange.setStart(lastChild, lastChild.textContent.length);
|
||||
const nodeToSetCaret = lastChild.nodeType === Node.TEXT_NODE ? lastChild : lastChild.firstChild;
|
||||
|
||||
if (nodeToSetCaret !== null && nodeToSetCaret.textContent !== null) {
|
||||
newRange.setStart(nodeToSetCaret, nodeToSetCaret.textContent.length);
|
||||
}
|
||||
|
||||
selection.removeAllRanges();
|
||||
selection.addRange(newRange);
|
||||
|
|
|
@ -48,11 +48,11 @@ export default class CrossBlockSelection extends Module {
|
|||
}
|
||||
|
||||
/**
|
||||
* return boolean is cross block selection started
|
||||
* Return boolean is cross block selection started:
|
||||
* there should be at least 2 selected blocks
|
||||
*/
|
||||
public get isCrossBlockSelectionStarted(): boolean {
|
||||
return !!this.firstSelectedBlock &&
|
||||
!!this.lastSelectedBlock;
|
||||
return !!this.firstSelectedBlock && !!this.lastSelectedBlock && this.firstSelectedBlock !== this.lastSelectedBlock;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -130,11 +130,6 @@ export default class CrossBlockSelection extends Module {
|
|||
default:
|
||||
Caret.setToBlock(BlockManager.blocks[Math.max(fIndex, lIndex)], Caret.positions.END);
|
||||
}
|
||||
} else {
|
||||
/**
|
||||
* By default set caret at the end of the last selected block
|
||||
*/
|
||||
Caret.setToBlock(BlockManager.blocks[Math.max(fIndex, lIndex)], Caret.positions.END);
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -187,6 +182,13 @@ export default class CrossBlockSelection extends Module {
|
|||
private onMouseOver = (event: MouseEvent): void => {
|
||||
const { BlockManager, BlockSelection } = this.Editor;
|
||||
|
||||
/**
|
||||
* Probably, editor is not initialized yet
|
||||
*/
|
||||
if (event.relatedTarget === null && event.target === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
const relatedBlock = BlockManager.getBlockByChildNode(event.relatedTarget as Node) || this.lastSelectedBlock;
|
||||
const targetBlock = BlockManager.getBlockByChildNode(event.target as Node);
|
||||
|
||||
|
|
81
src/components/modules/index.ts
Normal file
|
@ -0,0 +1,81 @@
|
|||
/** ./api */
|
||||
import BlocksAPI from './api/blocks';
|
||||
import CaretAPI from './api/caret';
|
||||
import EventsAPI from './api/events';
|
||||
import I18nAPI from './api/i18n';
|
||||
import API from './api/index';
|
||||
import InlineToolbarAPI from './api/inlineToolbar';
|
||||
import ListenersAPI from './api/listeners';
|
||||
import NotifierAPI from './api/notifier';
|
||||
import ReadOnlyAPI from './api/readonly';
|
||||
import SanitizerAPI from './api/sanitizer';
|
||||
import SaverAPI from './api/saver';
|
||||
import SelectionAPI from './api/selection';
|
||||
import StylesAPI from './api/styles';
|
||||
import ToolbarAPI from './api/toolbar';
|
||||
import TooltipAPI from './api/tooltip';
|
||||
import UiAPI from './api/ui';
|
||||
|
||||
/** ./toolbar */
|
||||
import BlockSettings from './toolbar/blockSettings';
|
||||
import ConversionToolbar from './toolbar/conversion';
|
||||
import Toolbar from './toolbar/index';
|
||||
import InlineToolbar from './toolbar/inline';
|
||||
|
||||
/** . */
|
||||
import BlockEvents from './blockEvents';
|
||||
import BlockManager from './blockManager';
|
||||
import BlockSelection from './blockSelection';
|
||||
import Caret from './caret';
|
||||
import CrossBlockSelection from './crossBlockSelection';
|
||||
import DragNDrop from './dragNDrop';
|
||||
import ModificationsObserver from './modificationsObserver';
|
||||
import Paste from './paste';
|
||||
import ReadOnly from './readonly';
|
||||
import RectangleSelection from './rectangleSelection';
|
||||
import Renderer from './renderer';
|
||||
import Saver from './saver';
|
||||
import Tools from './tools';
|
||||
import UI from './ui';
|
||||
|
||||
export default {
|
||||
// API Modules
|
||||
BlocksAPI,
|
||||
CaretAPI,
|
||||
EventsAPI,
|
||||
I18nAPI,
|
||||
API,
|
||||
InlineToolbarAPI,
|
||||
ListenersAPI,
|
||||
NotifierAPI,
|
||||
ReadOnlyAPI,
|
||||
SanitizerAPI,
|
||||
SaverAPI,
|
||||
SelectionAPI,
|
||||
StylesAPI,
|
||||
ToolbarAPI,
|
||||
TooltipAPI,
|
||||
UiAPI,
|
||||
|
||||
// Toolbar Modules
|
||||
BlockSettings,
|
||||
ConversionToolbar,
|
||||
Toolbar,
|
||||
InlineToolbar,
|
||||
|
||||
// Modules
|
||||
BlockEvents,
|
||||
BlockManager,
|
||||
BlockSelection,
|
||||
Caret,
|
||||
CrossBlockSelection,
|
||||
DragNDrop,
|
||||
ModificationsObserver,
|
||||
Paste,
|
||||
ReadOnly,
|
||||
RectangleSelection,
|
||||
Renderer,
|
||||
Saver,
|
||||
Tools,
|
||||
UI,
|
||||
};
|
|
@ -1,6 +1,15 @@
|
|||
import { BlockId } from '../../../types';
|
||||
import { BlockMutationEvent, BlockMutationType } from '../../../types/events/block';
|
||||
import { ModuleConfig } from '../../types-internal/module-config';
|
||||
import Module from '../__module';
|
||||
import { BlockChanged, FakeCursorAboutToBeToggled, FakeCursorHaveBeenSet, RedactorDomChanged } from '../events';
|
||||
import * as _ from '../utils';
|
||||
|
||||
/**
|
||||
* We use map of block mutations to filter only unique events
|
||||
*/
|
||||
type UniqueBlockMutationKey = `block:${BlockId}:event:${BlockMutationType}`;
|
||||
|
||||
/**
|
||||
* Single entry point for Block mutation events
|
||||
*/
|
||||
|
@ -10,10 +19,74 @@ export default class ModificationsObserver extends Module {
|
|||
*/
|
||||
private disabled = false;
|
||||
|
||||
/**
|
||||
* Blocks wrapper mutation observer instance
|
||||
*/
|
||||
private readonly mutationObserver: MutationObserver;
|
||||
|
||||
/**
|
||||
* Timeout used to batched several events in a single onChange call
|
||||
*/
|
||||
private batchingTimeout: null | ReturnType<typeof setTimeout> = null;
|
||||
|
||||
/**
|
||||
* Array of onChange events used to batch them
|
||||
*
|
||||
* Map is used to filter duplicated events related to the same block
|
||||
*/
|
||||
private batchingOnChangeQueue = new Map<UniqueBlockMutationKey, BlockMutationEvent>();
|
||||
|
||||
/**
|
||||
* Fired onChange events will be batched by this time
|
||||
*/
|
||||
private readonly batchTime = 400;
|
||||
|
||||
/**
|
||||
* Prepare the module
|
||||
*
|
||||
* @param options - options used by the modification observer module
|
||||
* @param options.config - Editor configuration object
|
||||
* @param options.eventsDispatcher - common Editor event bus
|
||||
*/
|
||||
constructor({ config, eventsDispatcher }: ModuleConfig) {
|
||||
super({
|
||||
config,
|
||||
eventsDispatcher,
|
||||
});
|
||||
|
||||
this.mutationObserver = new MutationObserver((mutations) => {
|
||||
this.redactorChanged(mutations);
|
||||
});
|
||||
|
||||
this.eventsDispatcher.on(BlockChanged, (payload) => {
|
||||
this.particularBlockChanged(payload.event);
|
||||
});
|
||||
|
||||
/**
|
||||
* Mutex for fake cursor setting/removing operation
|
||||
*/
|
||||
this.eventsDispatcher.on(FakeCursorAboutToBeToggled, () => {
|
||||
this.disable();
|
||||
});
|
||||
|
||||
this.eventsDispatcher.on(FakeCursorHaveBeenSet, () => {
|
||||
this.enable();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables onChange event
|
||||
*/
|
||||
public enable(): void {
|
||||
this.mutationObserver.observe(
|
||||
this.Editor.UI.nodes.redactor,
|
||||
{
|
||||
childList: true,
|
||||
subtree: true,
|
||||
characterData: true,
|
||||
attributes: true,
|
||||
}
|
||||
);
|
||||
this.disabled = false;
|
||||
}
|
||||
|
||||
|
@ -21,6 +94,7 @@ export default class ModificationsObserver extends Module {
|
|||
* Disables onChange event
|
||||
*/
|
||||
public disable(): void {
|
||||
this.mutationObserver.disconnect();
|
||||
this.disabled = true;
|
||||
}
|
||||
|
||||
|
@ -29,11 +103,45 @@ export default class ModificationsObserver extends Module {
|
|||
*
|
||||
* @param event - some of our custom change events
|
||||
*/
|
||||
public onChange(event: CustomEvent): void {
|
||||
private particularBlockChanged(event: BlockMutationEvent): void {
|
||||
if (this.disabled || !_.isFunction(this.config.onChange)) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.config.onChange(this.Editor.API.methods, event);
|
||||
this.batchingOnChangeQueue.set(`block:${event.detail.target.id}:event:${event.type as BlockMutationType}`, event);
|
||||
|
||||
if (this.batchingTimeout) {
|
||||
clearTimeout(this.batchingTimeout);
|
||||
}
|
||||
|
||||
this.batchingTimeout = setTimeout(() => {
|
||||
let eventsToEmit;
|
||||
|
||||
/**
|
||||
* Ih we have only 1 event in a queue, unwrap it
|
||||
*/
|
||||
if (this.batchingOnChangeQueue.size === 1) {
|
||||
eventsToEmit = this.batchingOnChangeQueue.values().next().value;
|
||||
} else {
|
||||
eventsToEmit = Array.from(this.batchingOnChangeQueue.values());
|
||||
}
|
||||
|
||||
if (this.config.onChange) {
|
||||
this.config.onChange(this.Editor.API.methods, eventsToEmit);
|
||||
}
|
||||
|
||||
this.batchingOnChangeQueue.clear();
|
||||
}, this.batchTime);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fired on every blocks wrapper dom change
|
||||
*
|
||||
* @param mutations - mutations happened
|
||||
*/
|
||||
private redactorChanged(mutations: MutationRecord[]): void {
|
||||
this.eventsDispatcher.emit(RedactorDomChanged, {
|
||||
mutations,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
|
|
@ -346,6 +346,10 @@ export default class Paste extends Module {
|
|||
* @param tool - BlockTool object
|
||||
*/
|
||||
private getTagsConfig(tool: BlockTool): void {
|
||||
if (tool.pasteConfig === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
const tagsOrSanitizeConfigs = tool.pasteConfig.tags || [];
|
||||
const toolTags = [];
|
||||
|
||||
|
@ -387,6 +391,10 @@ export default class Paste extends Module {
|
|||
* @param tool - BlockTool object
|
||||
*/
|
||||
private getFilesConfig(tool: BlockTool): void {
|
||||
if (tool.pasteConfig === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
const { files = {} } = tool.pasteConfig;
|
||||
let { extensions, mimeTypes } = files;
|
||||
|
||||
|
@ -428,7 +436,11 @@ export default class Paste extends Module {
|
|||
* @param tool - BlockTool object
|
||||
*/
|
||||
private getPatternsConfig(tool: BlockTool): void {
|
||||
if (!tool.pasteConfig.patterns || _.isEmpty(tool.pasteConfig.patterns)) {
|
||||
if (
|
||||
tool.pasteConfig === false ||
|
||||
!tool.pasteConfig.patterns ||
|
||||
_.isEmpty(tool.pasteConfig.patterns)
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
@ -467,9 +479,14 @@ export default class Paste extends Module {
|
|||
private handlePasteEvent = async (event: ClipboardEvent): Promise<void> => {
|
||||
const { BlockManager, Toolbar } = this.Editor;
|
||||
|
||||
/**
|
||||
* When someone pasting into a block, its more stable to set current block by event target, instead of relying on current block set before
|
||||
*/
|
||||
const currentBlock = BlockManager.setCurrentBlockByChildNode(event.target as HTMLElement);
|
||||
|
||||
/** If target is native input or is not Block, use browser behaviour */
|
||||
if (
|
||||
!BlockManager.currentBlock || (this.isNativeBehaviour(event.target) && !event.clipboardData.types.includes('Files'))
|
||||
!currentBlock || (this.isNativeBehaviour(event.target) && !event.clipboardData.types.includes('Files'))
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
@ -477,14 +494,13 @@ export default class Paste extends Module {
|
|||
/**
|
||||
* If Tools is in list of errors, skip processing of paste event
|
||||
*/
|
||||
if (BlockManager.currentBlock && this.exceptionList.includes(BlockManager.currentBlock.name)) {
|
||||
if (currentBlock && this.exceptionList.includes(currentBlock.name)) {
|
||||
return;
|
||||
}
|
||||
|
||||
event.preventDefault();
|
||||
this.processDataTransfer(event.clipboardData);
|
||||
|
||||
BlockManager.clearFocused();
|
||||
Toolbar.close();
|
||||
};
|
||||
|
||||
|
@ -602,7 +618,10 @@ export default class Paste extends Module {
|
|||
break;
|
||||
}
|
||||
|
||||
const { tags: tagsOrSanitizeConfigs } = tool.pasteConfig;
|
||||
/**
|
||||
* Returns empty array if there is no paste config
|
||||
*/
|
||||
const { tags: tagsOrSanitizeConfigs } = tool.pasteConfig || { tags: [] };
|
||||
|
||||
/**
|
||||
* Reduce the tags or sanitize configs to a single array of sanitize config.
|
||||
|
|
|
@ -1,116 +1,111 @@
|
|||
import Module from '../__module';
|
||||
import * as _ from '../utils';
|
||||
import { OutputBlockData } from '../../../types';
|
||||
import BlockTool from '../tools/block';
|
||||
import type { BlockId, BlockToolData, OutputBlockData } from '../../../types';
|
||||
import type BlockTool from '../tools/block';
|
||||
import type { StubData } from '../../tools/stub';
|
||||
import Block from '../block';
|
||||
|
||||
/**
|
||||
* Editor.js Renderer Module
|
||||
*
|
||||
* @module Renderer
|
||||
* @author CodeX Team
|
||||
* @version 2.0.0
|
||||
* Module that responsible for rendering Blocks on editor initialization
|
||||
*/
|
||||
export default class Renderer extends Module {
|
||||
/**
|
||||
* @typedef {object} RendererBlocks
|
||||
* @property {string} type - tool name
|
||||
* @property {object} data - tool data
|
||||
*/
|
||||
|
||||
/**
|
||||
* @example
|
||||
* Renders passed blocks as one batch
|
||||
*
|
||||
* blocks: [
|
||||
* {
|
||||
* id : 'oDe-EVrGWA',
|
||||
* type : 'paragraph',
|
||||
* data : {
|
||||
* text : 'Hello from Codex!'
|
||||
* }
|
||||
* },
|
||||
* {
|
||||
* id : 'Ld5BJjJCHs',
|
||||
* type : 'paragraph',
|
||||
* data : {
|
||||
* text : 'Leave feedback if you like it!'
|
||||
* }
|
||||
* },
|
||||
* ]
|
||||
* @param blocksData - blocks to render
|
||||
*/
|
||||
public async render(blocksData: OutputBlockData[]): Promise<void> {
|
||||
return new Promise((resolve) => {
|
||||
const { Tools, BlockManager } = this.Editor;
|
||||
|
||||
/**
|
||||
* Make plugin blocks from array of plugin`s data
|
||||
*
|
||||
* @param {OutputBlockData[]} blocks - blocks to render
|
||||
*/
|
||||
public async render(blocks: OutputBlockData[]): Promise<void> {
|
||||
const chainData = blocks.map((block) => ({ function: (): Promise<void> => this.insertBlock(block) }));
|
||||
if (blocksData.length === 0) {
|
||||
BlockManager.insert();
|
||||
} else {
|
||||
/**
|
||||
* Create Blocks instances
|
||||
*/
|
||||
const blocks = blocksData.map(({ type: tool, data, tunes, id }) => {
|
||||
if (Tools.available.has(tool) === false) {
|
||||
_.logLabeled(`Tool «${tool}» is not found. Check 'tools' property at the Editor.js config.`, 'warn');
|
||||
|
||||
/**
|
||||
* Disable onChange callback on render to not to spam those events
|
||||
*/
|
||||
this.Editor.ModificationsObserver.disable();
|
||||
data = this.composeStubDataForTool(tool, data, id);
|
||||
tool = Tools.stubTool;
|
||||
}
|
||||
|
||||
const sequence = await _.sequence(chainData as _.ChainData[]);
|
||||
let block: Block;
|
||||
|
||||
this.Editor.ModificationsObserver.enable();
|
||||
try {
|
||||
block = BlockManager.composeBlock({
|
||||
id,
|
||||
tool,
|
||||
data,
|
||||
tunes,
|
||||
});
|
||||
} catch (error) {
|
||||
_.log(`Block «${tool}» skipped because of plugins error`, 'error', {
|
||||
data,
|
||||
error,
|
||||
});
|
||||
|
||||
this.Editor.UI.checkEmptiness();
|
||||
/**
|
||||
* If tool throws an error during render, we should render stub instead of it
|
||||
*/
|
||||
data = this.composeStubDataForTool(tool, data, id);
|
||||
tool = Tools.stubTool;
|
||||
|
||||
return sequence;
|
||||
block = BlockManager.composeBlock({
|
||||
id,
|
||||
tool,
|
||||
data,
|
||||
tunes,
|
||||
});
|
||||
}
|
||||
|
||||
return block;
|
||||
});
|
||||
|
||||
/**
|
||||
* Insert batch of Blocks
|
||||
*/
|
||||
BlockManager.insertMany(blocks);
|
||||
}
|
||||
|
||||
/**
|
||||
* Wait till browser will render inserted Blocks and resolve a promise
|
||||
*/
|
||||
window.requestIdleCallback(() => {
|
||||
resolve();
|
||||
}, { timeout: 2000 });
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get plugin instance
|
||||
* Add plugin instance to BlockManager
|
||||
* Insert block to working zone
|
||||
* Create data for the Stub Tool that will be used instead of unavailable tool
|
||||
*
|
||||
* @param {object} item - Block data to insert
|
||||
* @returns {Promise<void>}
|
||||
* @param tool - unavailable tool name to stub
|
||||
* @param data - data of unavailable block
|
||||
* @param [id] - id of unavailable block
|
||||
*/
|
||||
public async insertBlock(item: OutputBlockData): Promise<void> {
|
||||
const { Tools, BlockManager } = this.Editor;
|
||||
const { type: tool, data, tunes, id } = item;
|
||||
private composeStubDataForTool(tool: string, data: BlockToolData, id?: BlockId): StubData {
|
||||
const { Tools } = this.Editor;
|
||||
|
||||
if (Tools.available.has(tool)) {
|
||||
try {
|
||||
BlockManager.insert({
|
||||
id,
|
||||
tool,
|
||||
data,
|
||||
tunes,
|
||||
});
|
||||
} catch (error) {
|
||||
_.log(`Block «${tool}» skipped because of plugins error`, 'warn', data);
|
||||
throw Error(error);
|
||||
let title = tool;
|
||||
|
||||
if (Tools.unavailable.has(tool)) {
|
||||
const toolboxSettings = (Tools.unavailable.get(tool) as BlockTool).toolbox;
|
||||
|
||||
if (toolboxSettings !== undefined && toolboxSettings[0].title !== undefined) {
|
||||
title = toolboxSettings[0].title;
|
||||
}
|
||||
} else {
|
||||
/** If Tool is unavailable, create stub Block for it */
|
||||
const stubData = {
|
||||
savedData: {
|
||||
id,
|
||||
type: tool,
|
||||
data,
|
||||
},
|
||||
title: tool,
|
||||
};
|
||||
|
||||
if (Tools.unavailable.has(tool)) {
|
||||
const toolboxSettings = (Tools.unavailable.get(tool) as BlockTool).toolbox;
|
||||
const toolboxTitle = toolboxSettings[0]?.title;
|
||||
|
||||
stubData.title = toolboxTitle || stubData.title;
|
||||
}
|
||||
|
||||
const stub = BlockManager.insert({
|
||||
id,
|
||||
tool: Tools.stubTool,
|
||||
data: stubData,
|
||||
});
|
||||
|
||||
stub.stretched = true;
|
||||
|
||||
_.log(`Tool «${tool}» is not found. Check 'tools' property at your initial Editor.js config.`, 'warn');
|
||||
}
|
||||
|
||||
return {
|
||||
savedData: {
|
||||
id,
|
||||
type: tool,
|
||||
data,
|
||||
},
|
||||
title,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
|
|
@ -70,26 +70,11 @@ export default class Saver extends Module {
|
|||
* @returns {OutputData}
|
||||
*/
|
||||
private makeOutput(allExtractedData): OutputData {
|
||||
let totalTime = 0;
|
||||
const blocks = [];
|
||||
|
||||
_.log('[Editor.js saving]:', 'groupCollapsed');
|
||||
|
||||
allExtractedData.forEach(({ id, tool, data, tunes, time, isValid }) => {
|
||||
totalTime += time;
|
||||
|
||||
/**
|
||||
* Capitalize Tool name
|
||||
*/
|
||||
_.log(`${tool.charAt(0).toUpperCase() + tool.slice(1)}`, 'group');
|
||||
|
||||
if (isValid) {
|
||||
/** Group process info */
|
||||
_.log(data);
|
||||
_.log(undefined, 'groupEnd');
|
||||
} else {
|
||||
allExtractedData.forEach(({ id, tool, data, tunes, isValid }) => {
|
||||
if (!isValid) {
|
||||
_.log(`Block «${tool}» skipped because saved data is invalid`);
|
||||
_.log(undefined, 'groupEnd');
|
||||
|
||||
return;
|
||||
}
|
||||
|
@ -113,9 +98,6 @@ export default class Saver extends Module {
|
|||
blocks.push(output);
|
||||
});
|
||||
|
||||
_.log('Total', 'log', totalTime);
|
||||
_.log(undefined, 'groupEnd');
|
||||
|
||||
return {
|
||||
time: +new Date(),
|
||||
blocks,
|
||||
|
|
|
@ -7,13 +7,22 @@ import { I18nInternalNS } from '../../i18n/namespace-internal';
|
|||
import Flipper from '../../flipper';
|
||||
import { TunesMenuConfigItem } from '../../../../types/tools';
|
||||
import { resolveAliases } from '../../utils/resolve-aliases';
|
||||
import Popover, { PopoverEvent } from '../../utils/popover';
|
||||
import { type Popover, PopoverDesktop, PopoverMobile, PopoverItemParams, PopoverItemDefaultParams, PopoverItemType } from '../../utils/popover';
|
||||
import { PopoverEvent } from '../../utils/popover/popover.types';
|
||||
import { isMobileScreen } from '../../utils';
|
||||
import { EditorMobileLayoutToggled } from '../../events';
|
||||
import * as _ from '../../utils';
|
||||
import { IconReplace } from '@codexteam/icons';
|
||||
import { isSameBlockData } from '../../utils/blocks';
|
||||
|
||||
/**
|
||||
* HTML Elements that used for BlockSettings
|
||||
*/
|
||||
interface BlockSettingsNodes {
|
||||
wrapper: HTMLElement;
|
||||
/**
|
||||
* Block Settings wrapper. Undefined when before "make" method called
|
||||
*/
|
||||
wrapper: HTMLElement | undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -24,8 +33,6 @@ interface BlockSettingsNodes {
|
|||
export default class BlockSettings extends Module<BlockSettingsNodes> {
|
||||
/**
|
||||
* Module Events
|
||||
*
|
||||
* @returns {{opened: string, closed: string}}
|
||||
*/
|
||||
public get events(): { opened: string; closed: string } {
|
||||
return {
|
||||
|
@ -53,8 +60,12 @@ export default class BlockSettings extends Module<BlockSettingsNodes> {
|
|||
*
|
||||
* @todo remove once BlockSettings becomes standalone non-module class
|
||||
*/
|
||||
public get flipper(): Flipper {
|
||||
return this.popover?.flipper;
|
||||
public get flipper(): Flipper | undefined {
|
||||
if (this.popover === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
return 'flipper' in this.popover ? this.popover?.flipper : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -64,9 +75,9 @@ export default class BlockSettings extends Module<BlockSettingsNodes> {
|
|||
|
||||
/**
|
||||
* Popover instance. There is a util for vertical lists.
|
||||
* Null until popover is not initialized
|
||||
*/
|
||||
private popover: Popover | undefined;
|
||||
|
||||
private popover: Popover | null = null;
|
||||
|
||||
/**
|
||||
* Panel with block settings with 2 sections:
|
||||
|
@ -75,6 +86,12 @@ export default class BlockSettings extends Module<BlockSettingsNodes> {
|
|||
*/
|
||||
public make(): void {
|
||||
this.nodes.wrapper = $.make('div', [ this.CSS.settings ]);
|
||||
|
||||
if (import.meta.env.MODE === 'test') {
|
||||
this.nodes.wrapper.setAttribute('data-cy', 'block-tunes');
|
||||
}
|
||||
|
||||
this.eventsDispatcher.on(EditorMobileLayoutToggled, this.close);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -82,6 +99,8 @@ export default class BlockSettings extends Module<BlockSettingsNodes> {
|
|||
*/
|
||||
public destroy(): void {
|
||||
this.removeAllNodes();
|
||||
this.listeners.destroy();
|
||||
this.eventsDispatcher.off(EditorMobileLayoutToggled, this.close);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -89,7 +108,7 @@ export default class BlockSettings extends Module<BlockSettingsNodes> {
|
|||
*
|
||||
* @param targetBlock - near which Block we should open BlockSettings
|
||||
*/
|
||||
public open(targetBlock: Block = this.Editor.BlockManager.currentBlock): void {
|
||||
public async open(targetBlock: Block = this.Editor.BlockManager.currentBlock): Promise<void> {
|
||||
this.opened = true;
|
||||
|
||||
/**
|
||||
|
@ -101,21 +120,20 @@ export default class BlockSettings extends Module<BlockSettingsNodes> {
|
|||
/**
|
||||
* Highlight content of a Block we are working with
|
||||
*/
|
||||
targetBlock.selected = true;
|
||||
this.Editor.BlockSelection.selectBlock(targetBlock);
|
||||
this.Editor.BlockSelection.clearCache();
|
||||
|
||||
/**
|
||||
* Fill Tool's settings
|
||||
*/
|
||||
const [tunesItems, customHtmlTunesContainer] = targetBlock.getTunes();
|
||||
/** Get tool's settings data */
|
||||
const { toolTunes, commonTunes } = targetBlock.getTunes();
|
||||
|
||||
/** Tell to subscribers that block settings is opened */
|
||||
this.eventsDispatcher.emit(this.events.opened);
|
||||
this.popover = new Popover({
|
||||
|
||||
const PopoverClass = isMobileScreen() ? PopoverMobile : PopoverDesktop;
|
||||
|
||||
this.popover = new PopoverClass({
|
||||
searchable: true,
|
||||
items: tunesItems.map(tune => this.resolveTuneAliases(tune)),
|
||||
customContent: customHtmlTunesContainer,
|
||||
customContentFlippableItems: this.getControls(customHtmlTunesContainer),
|
||||
items: await this.getTunesItems(targetBlock, commonTunes, toolTunes),
|
||||
scopeElement: this.Editor.API.methods.ui.nodes.redactor,
|
||||
messages: {
|
||||
nothingFound: I18n.ui(I18nInternalNS.ui.popover, 'Nothing found'),
|
||||
|
@ -125,7 +143,7 @@ export default class BlockSettings extends Module<BlockSettingsNodes> {
|
|||
|
||||
this.popover.on(PopoverEvent.Close, this.onPopoverClose);
|
||||
|
||||
this.nodes.wrapper.append(this.popover.getElement());
|
||||
this.nodes.wrapper?.append(this.popover.getElement());
|
||||
|
||||
this.popover.show();
|
||||
}
|
||||
|
@ -133,14 +151,18 @@ export default class BlockSettings extends Module<BlockSettingsNodes> {
|
|||
/**
|
||||
* Returns root block settings element
|
||||
*/
|
||||
public getElement(): HTMLElement {
|
||||
public getElement(): HTMLElement | undefined {
|
||||
return this.nodes.wrapper;
|
||||
}
|
||||
|
||||
/**
|
||||
* Close Block Settings pane
|
||||
*/
|
||||
public close(): void {
|
||||
public close = (): void => {
|
||||
if (!this.opened) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.opened = false;
|
||||
|
||||
/**
|
||||
|
@ -160,7 +182,7 @@ export default class BlockSettings extends Module<BlockSettingsNodes> {
|
|||
* Remove highlighted content of a Block we are working with
|
||||
*/
|
||||
if (!this.Editor.CrossBlockSelection.isCrossBlockSelectionStarted && this.Editor.BlockManager.currentBlock) {
|
||||
this.Editor.BlockManager.currentBlock.selected = false;
|
||||
this.Editor.BlockSelection.unselectBlock(this.Editor.BlockManager.currentBlock);
|
||||
}
|
||||
|
||||
/** Tell to subscribers that block settings is closed */
|
||||
|
@ -172,6 +194,115 @@ export default class BlockSettings extends Module<BlockSettingsNodes> {
|
|||
this.popover.getElement().remove();
|
||||
this.popover = null;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Returns list of items to be displayed in block tunes menu.
|
||||
* Merges tool specific tunes, conversion menu and common tunes in one list in predefined order
|
||||
*
|
||||
* @param currentBlock – block we are about to open block tunes for
|
||||
* @param commonTunes – common tunes
|
||||
* @param toolTunes - tool specific tunes
|
||||
*/
|
||||
private async getTunesItems(currentBlock: Block, commonTunes: TunesMenuConfigItem[], toolTunes?: TunesMenuConfigItem[]): Promise<PopoverItemParams[]> {
|
||||
const items = [] as TunesMenuConfigItem[];
|
||||
|
||||
if (toolTunes !== undefined && toolTunes.length > 0) {
|
||||
items.push(...toolTunes);
|
||||
items.push({
|
||||
type: PopoverItemType.Separator,
|
||||
});
|
||||
}
|
||||
|
||||
const convertToItems = await this.getConvertToItems(currentBlock);
|
||||
|
||||
if (convertToItems.length > 0) {
|
||||
items.push({
|
||||
icon: IconReplace,
|
||||
title: I18n.ui(I18nInternalNS.ui.popover, 'Convert to'),
|
||||
children: {
|
||||
items: convertToItems,
|
||||
},
|
||||
});
|
||||
items.push({
|
||||
type: PopoverItemType.Separator,
|
||||
});
|
||||
}
|
||||
|
||||
items.push(...commonTunes);
|
||||
|
||||
return items.map(tune => this.resolveTuneAliases(tune));
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns list of all available conversion menu items
|
||||
*
|
||||
* @param currentBlock - block we are about to open block tunes for
|
||||
*/
|
||||
private async getConvertToItems(currentBlock: Block): Promise<PopoverItemDefaultParams[]> {
|
||||
const conversionEntries = Array.from(this.Editor.Tools.blockTools.entries());
|
||||
|
||||
const resultItems: PopoverItemDefaultParams[] = [];
|
||||
|
||||
const blockData = await currentBlock.data;
|
||||
|
||||
conversionEntries.forEach(([toolName, tool]) => {
|
||||
const conversionConfig = tool.conversionConfig;
|
||||
|
||||
/**
|
||||
* Skip tools without «import» rule specified
|
||||
*/
|
||||
if (!conversionConfig || !conversionConfig.import) {
|
||||
return;
|
||||
}
|
||||
|
||||
tool.toolbox?.forEach((toolboxItem) => {
|
||||
/**
|
||||
* Skip tools that don't pass 'toolbox' property
|
||||
*/
|
||||
if (_.isEmpty(toolboxItem) || !toolboxItem.icon) {
|
||||
return;
|
||||
}
|
||||
|
||||
let shouldSkip = false;
|
||||
|
||||
if (toolboxItem.data !== undefined) {
|
||||
/**
|
||||
* When a tool has several toolbox entries, we need to make sure we do not add
|
||||
* toolbox item with the same data to the resulting array. This helps exclude duplicates
|
||||
*/
|
||||
const hasSameData = isSameBlockData(toolboxItem.data, blockData);
|
||||
|
||||
shouldSkip = hasSameData;
|
||||
} else {
|
||||
shouldSkip = toolName === currentBlock.name;
|
||||
}
|
||||
|
||||
|
||||
if (shouldSkip) {
|
||||
return;
|
||||
}
|
||||
|
||||
resultItems.push({
|
||||
icon: toolboxItem.icon,
|
||||
title: toolboxItem.title,
|
||||
name: toolName,
|
||||
onActivate: async () => {
|
||||
const { BlockManager, BlockSelection, Caret } = this.Editor;
|
||||
|
||||
const newBlock = await BlockManager.convert(this.Editor.BlockManager.currentBlock, toolName, toolboxItem.data);
|
||||
|
||||
BlockSelection.clearSelection();
|
||||
|
||||
this.close();
|
||||
|
||||
Caret.setToBlock(newBlock, Caret.positions.END);
|
||||
},
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
return resultItems;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -181,27 +312,15 @@ export default class BlockSettings extends Module<BlockSettingsNodes> {
|
|||
this.close();
|
||||
};
|
||||
|
||||
/**
|
||||
* Returns list of buttons and inputs inside specified container
|
||||
*
|
||||
* @param container - container to query controls inside of
|
||||
*/
|
||||
private getControls(container: HTMLElement): HTMLElement[] {
|
||||
const { StylesAPI } = this.Editor;
|
||||
/** Query buttons and inputs inside tunes html */
|
||||
const controls = container.querySelectorAll<HTMLElement>(
|
||||
`.${StylesAPI.classes.settingsButton}, ${$.allInputsSelector}`
|
||||
);
|
||||
|
||||
return Array.from(controls);
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves aliases in tunes menu items
|
||||
*
|
||||
* @param item - item with resolved aliases
|
||||
*/
|
||||
private resolveTuneAliases(item: TunesMenuConfigItem): TunesMenuConfigItem {
|
||||
private resolveTuneAliases(item: TunesMenuConfigItem): PopoverItemParams {
|
||||
if (item.type === PopoverItemType.Separator || item.type === PopoverItemType.Html) {
|
||||
return item;
|
||||
}
|
||||
const result = resolveAliases(item, { label: 'title' });
|
||||
|
||||
if (item.confirmation) {
|
||||
|
|
|
@ -1,11 +1,9 @@
|
|||
import Module from '../../__module';
|
||||
import $ from '../../dom';
|
||||
import * as _ from '../../utils';
|
||||
import { SavedData } from '../../../../types/data-formats';
|
||||
import Flipper from '../../flipper';
|
||||
import I18n from '../../i18n';
|
||||
import { I18nInternalNS } from '../../i18n/namespace-internal';
|
||||
import { clean } from '../../utils/sanitizer';
|
||||
import { ToolboxConfigEntry, BlockToolData } from '../../../../types';
|
||||
|
||||
/**
|
||||
|
@ -34,6 +32,7 @@ export default class ConversionToolbar extends Module<ConversionToolbarNodes> {
|
|||
conversionTool: 'ce-conversion-tool',
|
||||
conversionToolHidden: 'ce-conversion-tool--hidden',
|
||||
conversionToolIcon: 'ce-conversion-tool__icon',
|
||||
conversionToolSecondaryLabel: 'ce-conversion-tool__secondary-label',
|
||||
|
||||
conversionToolFocused: 'ce-conversion-tool--focused',
|
||||
conversionToolActive: 'ce-conversion-tool--active',
|
||||
|
@ -179,90 +178,19 @@ export default class ConversionToolbar extends Module<ConversionToolbarNodes> {
|
|||
* For that Tools must provide import/export methods
|
||||
*
|
||||
* @param {string} replacingToolName - name of Tool which replaces current
|
||||
* @param blockDataOverrides - Block data overrides. Could be passed in case if Multiple Toolbox items specified
|
||||
* @param blockDataOverrides - If this conversion fired by the one of multiple Toolbox items, extend converted data with this item's "data" overrides
|
||||
*/
|
||||
public async replaceWithBlock(replacingToolName: string, blockDataOverrides?: BlockToolData): Promise<void> {
|
||||
/**
|
||||
* At first, we get current Block data
|
||||
*/
|
||||
const currentBlockTool = this.Editor.BlockManager.currentBlock.tool;
|
||||
const savedBlock = await this.Editor.BlockManager.currentBlock.save() as SavedData;
|
||||
const blockData = savedBlock.data;
|
||||
const { BlockManager, BlockSelection, InlineToolbar, Caret } = this.Editor;
|
||||
|
||||
/**
|
||||
* Getting a class of replacing Tool
|
||||
*/
|
||||
const replacingTool = this.Editor.Tools.blockTools.get(replacingToolName);
|
||||
const newBlock = await BlockManager.convert(this.Editor.BlockManager.currentBlock, replacingToolName, blockDataOverrides);
|
||||
|
||||
/**
|
||||
* Export property can be:
|
||||
* 1) Function — Tool defines which data to return
|
||||
* 2) String — the name of saved property
|
||||
*
|
||||
* In both cases returning value must be a string
|
||||
*/
|
||||
let exportData = '';
|
||||
const exportProp = currentBlockTool.conversionConfig.export;
|
||||
|
||||
if (_.isFunction(exportProp)) {
|
||||
exportData = exportProp(blockData);
|
||||
} else if (_.isString(exportProp)) {
|
||||
exportData = blockData[exportProp];
|
||||
} else {
|
||||
_.log('Conversion «export» property must be a string or function. ' +
|
||||
'String means key of saved data object to export. Function should export processed string to export.');
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clean exported data with replacing sanitizer config
|
||||
*/
|
||||
const cleaned: string = clean(
|
||||
exportData,
|
||||
replacingTool.sanitizeConfig
|
||||
);
|
||||
|
||||
/**
|
||||
* «import» property can be Function or String
|
||||
* function — accept imported string and compose tool data object
|
||||
* string — the name of data field to import
|
||||
*/
|
||||
let newBlockData = {};
|
||||
const importProp = replacingTool.conversionConfig.import;
|
||||
|
||||
if (_.isFunction(importProp)) {
|
||||
newBlockData = importProp(cleaned);
|
||||
} else if (_.isString(importProp)) {
|
||||
newBlockData[importProp] = cleaned;
|
||||
} else {
|
||||
_.log('Conversion «import» property must be a string or function. ' +
|
||||
'String means key of tool data to import. Function accepts a imported string and return composed tool data.');
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* If this conversion fired by the one of multiple Toolbox items,
|
||||
* extend converted data with this item's "data" overrides
|
||||
*/
|
||||
if (blockDataOverrides) {
|
||||
newBlockData = Object.assign(newBlockData, blockDataOverrides);
|
||||
}
|
||||
|
||||
this.Editor.BlockManager.replace({
|
||||
tool: replacingToolName,
|
||||
data: newBlockData,
|
||||
});
|
||||
this.Editor.BlockSelection.clearSelection();
|
||||
BlockSelection.clearSelection();
|
||||
|
||||
this.close();
|
||||
this.Editor.InlineToolbar.close();
|
||||
InlineToolbar.close();
|
||||
|
||||
_.delay(() => {
|
||||
this.Editor.Caret.setToBlock(this.Editor.BlockManager.currentBlock);
|
||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers
|
||||
}, 10)();
|
||||
Caret.setToBlock(newBlock, Caret.positions.END);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -283,7 +211,7 @@ export default class ConversionToolbar extends Module<ConversionToolbarNodes> {
|
|||
if (!conversionConfig || !conversionConfig.import) {
|
||||
return;
|
||||
}
|
||||
tool.toolbox.forEach((toolboxItem) =>
|
||||
tool.toolbox?.forEach((toolboxItem) =>
|
||||
this.addToolIfValid(name, toolboxItem)
|
||||
);
|
||||
});
|
||||
|
@ -322,6 +250,16 @@ export default class ConversionToolbar extends Module<ConversionToolbarNodes> {
|
|||
$.append(tool, icon);
|
||||
$.append(tool, $.text(I18n.t(I18nInternalNS.toolNames, toolboxItem.title || _.capitalize(toolName))));
|
||||
|
||||
const shortcut = this.Editor.Tools.blockTools.get(toolName)?.shortcut;
|
||||
|
||||
if (shortcut) {
|
||||
const shortcutEl = $.make('span', ConversionToolbar.CSS.conversionToolSecondaryLabel, {
|
||||
innerText: _.beautifyShortcut(shortcut),
|
||||
});
|
||||
|
||||
$.append(tool, shortcutEl);
|
||||
}
|
||||
|
||||
$.append(this.nodes.tools, tool);
|
||||
this.tools.push({
|
||||
name: toolName,
|
||||
|
|
|
@ -3,12 +3,14 @@ import $ from '../../dom';
|
|||
import * as _ from '../../utils';
|
||||
import I18n from '../../i18n';
|
||||
import { I18nInternalNS } from '../../i18n/namespace-internal';
|
||||
import Tooltip from '../../utils/tooltip';
|
||||
import * as tooltip from '../../utils/tooltip';
|
||||
import { ModuleConfig } from '../../../types-internal/module-config';
|
||||
import { BlockAPI } from '../../../../types';
|
||||
import Block from '../../block';
|
||||
import Toolbox, { ToolboxEvent } from '../../ui/toolbox';
|
||||
import { IconMenu, IconPlus } from '@codexteam/icons';
|
||||
import { BlockHovered } from '../../events/BlockHovered';
|
||||
import { beautifyShortcut } from '../../utils';
|
||||
import { getKeyboardKeyForCode } from '../../utils/keyboard';
|
||||
|
||||
/**
|
||||
* @todo Tab on non-empty block should open Block Settings of the hoveredBlock (not where caret is set)
|
||||
|
@ -32,12 +34,12 @@ import { IconMenu, IconPlus } from '@codexteam/icons';
|
|||
* HTML Elements used for Toolbar UI
|
||||
*/
|
||||
interface ToolbarNodes {
|
||||
wrapper: HTMLElement;
|
||||
content: HTMLElement;
|
||||
actions: HTMLElement;
|
||||
wrapper: HTMLElement | undefined;
|
||||
content: HTMLElement | undefined;
|
||||
actions: HTMLElement | undefined;
|
||||
|
||||
plusButton: HTMLElement;
|
||||
settingsToggler: HTMLElement;
|
||||
plusButton: HTMLElement | undefined;
|
||||
settingsToggler: HTMLElement | undefined;
|
||||
}
|
||||
/**
|
||||
*
|
||||
|
@ -91,11 +93,6 @@ interface ToolbarNodes {
|
|||
* @property {Element} nodes.defaultSettings - Default Settings section of Settings Panel
|
||||
*/
|
||||
export default class Toolbar extends Module<ToolbarNodes> {
|
||||
/**
|
||||
* Tooltip utility Instance
|
||||
*/
|
||||
private tooltip: Tooltip;
|
||||
|
||||
/**
|
||||
* Block near which we display the Toolbox
|
||||
*/
|
||||
|
@ -103,8 +100,9 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
|
||||
/**
|
||||
* Toolbox class instance
|
||||
* It will be created in requestIdleCallback so it can be null in some period of time
|
||||
*/
|
||||
private toolboxInstance: Toolbox;
|
||||
private toolboxInstance: Toolbox | null = null;
|
||||
|
||||
/**
|
||||
* @class
|
||||
|
@ -117,7 +115,6 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
config,
|
||||
eventsDispatcher,
|
||||
});
|
||||
this.tooltip = new Tooltip();
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -155,18 +152,27 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
* Public interface for accessing the Toolbox
|
||||
*/
|
||||
public get toolbox(): {
|
||||
opened: boolean;
|
||||
opened: boolean | undefined; // undefined is for the case when Toolbox is not initialized yet
|
||||
close: () => void;
|
||||
open: () => void;
|
||||
toggle: () => void;
|
||||
hasFocus: () => boolean;
|
||||
hasFocus: () => boolean | undefined;
|
||||
} {
|
||||
return {
|
||||
opened: this.toolboxInstance.opened,
|
||||
close: (): void => {
|
||||
this.toolboxInstance.close();
|
||||
opened: this.toolboxInstance?.opened,
|
||||
close: () => {
|
||||
this.toolboxInstance?.close();
|
||||
},
|
||||
open: (): void => {
|
||||
open: () => {
|
||||
/**
|
||||
* If Toolbox is not initialized yet, do nothing
|
||||
*/
|
||||
if (this.toolboxInstance === null) {
|
||||
_.log('toolbox.open() called before initialization is finished', 'warn');
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set current block to cover the case when the Toolbar showed near hovered Block but caret is set to another Block.
|
||||
*/
|
||||
|
@ -174,8 +180,19 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
|
||||
this.toolboxInstance.open();
|
||||
},
|
||||
toggle: (): void => this.toolboxInstance.toggle(),
|
||||
hasFocus: (): boolean => this.toolboxInstance.hasFocus(),
|
||||
toggle: () => {
|
||||
/**
|
||||
* If Toolbox is not initialized yet, do nothing
|
||||
*/
|
||||
if (this.toolboxInstance === null) {
|
||||
_.log('toolbox.toggle() called before initialization is finished', 'warn');
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
this.toolboxInstance.toggle();
|
||||
},
|
||||
hasFocus: () => this.toolboxInstance?.hasFocus(),
|
||||
};
|
||||
}
|
||||
|
||||
|
@ -203,6 +220,7 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
};
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Toggles read-only mode
|
||||
*
|
||||
|
@ -210,8 +228,10 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
*/
|
||||
public toggleReadOnly(readOnlyEnabled: boolean): void {
|
||||
if (!readOnlyEnabled) {
|
||||
this.drawUI();
|
||||
this.enableModuleBindings();
|
||||
window.requestIdleCallback(() => {
|
||||
this.drawUI();
|
||||
this.enableModuleBindings();
|
||||
}, { timeout: 2000 });
|
||||
} else {
|
||||
this.destroy();
|
||||
this.Editor.BlockSettings.destroy();
|
||||
|
@ -225,6 +245,15 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
* @param block - block to move Toolbar near it
|
||||
*/
|
||||
public moveAndOpen(block: Block = this.Editor.BlockManager.currentBlock): void {
|
||||
/**
|
||||
* Some UI elements creates inside requestIdleCallback, so the can be not ready yet
|
||||
*/
|
||||
if (this.toolboxInstance === null) {
|
||||
_.log('Can\'t open Toolbar since Editor initialization is not finished yet', 'warn');
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Close Toolbox when we move toolbar
|
||||
*/
|
||||
|
@ -290,12 +319,20 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
return;
|
||||
}
|
||||
|
||||
this.nodes.wrapper.classList.remove(this.CSS.toolbarOpened);
|
||||
this.nodes.wrapper?.classList.remove(this.CSS.toolbarOpened);
|
||||
|
||||
/** Close components */
|
||||
this.blockActions.hide();
|
||||
this.toolboxInstance.close();
|
||||
this.toolboxInstance?.close();
|
||||
this.Editor.BlockSettings.close();
|
||||
this.reset();
|
||||
}
|
||||
|
||||
/**
|
||||
* Reset the Toolbar position to prevent DOM height growth, for example after blocks deletion
|
||||
*/
|
||||
private reset(): void {
|
||||
this.nodes.wrapper.style.top = 'unset';
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -305,23 +342,23 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
* This flag allows to open Toolbar without Actions.
|
||||
*/
|
||||
private open(withBlockActions = true): void {
|
||||
_.delay(() => {
|
||||
this.nodes.wrapper.classList.add(this.CSS.toolbarOpened);
|
||||
this.nodes.wrapper.classList.add(this.CSS.toolbarOpened);
|
||||
|
||||
if (withBlockActions) {
|
||||
this.blockActions.show();
|
||||
} else {
|
||||
this.blockActions.hide();
|
||||
}
|
||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers
|
||||
}, 50)();
|
||||
if (withBlockActions) {
|
||||
this.blockActions.show();
|
||||
} else {
|
||||
this.blockActions.hide();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Draws Toolbar elements
|
||||
*/
|
||||
private make(): void {
|
||||
private async make(): Promise<void> {
|
||||
this.nodes.wrapper = $.make('div', this.CSS.toolbar);
|
||||
/**
|
||||
* @todo detect test environment and add data-cy="toolbar" to use it in tests instead of class name
|
||||
*/
|
||||
|
||||
/**
|
||||
* Make Content Zone and Actions Zone
|
||||
|
@ -347,7 +384,7 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
$.append(this.nodes.actions, this.nodes.plusButton);
|
||||
|
||||
this.readOnlyMutableListeners.on(this.nodes.plusButton, 'click', () => {
|
||||
this.tooltip.hide(true);
|
||||
tooltip.hide(true);
|
||||
this.plusButtonClicked();
|
||||
}, false);
|
||||
|
||||
|
@ -358,10 +395,10 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
|
||||
tooltipContent.appendChild(document.createTextNode(I18n.ui(I18nInternalNS.ui.toolbar.toolbox, 'Add')));
|
||||
tooltipContent.appendChild($.make('div', this.CSS.plusButtonShortcut, {
|
||||
textContent: '⇥ Tab',
|
||||
textContent: '/',
|
||||
}));
|
||||
|
||||
this.tooltip.onHover(this.nodes.plusButton, tooltipContent, {
|
||||
tooltip.onHover(this.nodes.plusButton, tooltipContent, {
|
||||
hidingDelay: 400,
|
||||
});
|
||||
|
||||
|
@ -377,13 +414,18 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
|
||||
$.append(this.nodes.actions, this.nodes.settingsToggler);
|
||||
|
||||
this.tooltip.onHover(
|
||||
this.nodes.settingsToggler,
|
||||
I18n.ui(I18nInternalNS.ui.blockTunes.toggler, 'Click to tune'),
|
||||
{
|
||||
hidingDelay: 400,
|
||||
}
|
||||
);
|
||||
const blockTunesTooltip = $.make('div');
|
||||
const blockTunesTooltipEl = $.text(I18n.ui(I18nInternalNS.ui.blockTunes.toggler, 'Click to tune'));
|
||||
const slashRealKey = await getKeyboardKeyForCode('Slash', '/');
|
||||
|
||||
blockTunesTooltip.appendChild(blockTunesTooltipEl);
|
||||
blockTunesTooltip.appendChild($.make('div', this.CSS.plusButtonShortcut, {
|
||||
textContent: beautifyShortcut(`CMD + ${slashRealKey}`),
|
||||
}));
|
||||
|
||||
tooltip.onHover(this.nodes.settingsToggler, blockTunesTooltip, {
|
||||
hidingDelay: 400,
|
||||
});
|
||||
|
||||
/**
|
||||
* Appending Toolbar components to itself
|
||||
|
@ -421,7 +463,7 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
this.Editor.UI.nodes.wrapper.classList.remove(this.CSS.openedToolboxHolderModifier);
|
||||
});
|
||||
|
||||
this.toolboxInstance.on(ToolboxEvent.BlockAdded, ({ block }: {block: BlockAPI }) => {
|
||||
this.toolboxInstance.on(ToolboxEvent.BlockAdded, ({ block }) => {
|
||||
const { BlockManager, Caret } = this.Editor;
|
||||
const newBlock = BlockManager.getBlockById(block.id);
|
||||
|
||||
|
@ -438,9 +480,10 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
}
|
||||
});
|
||||
|
||||
return this.toolboxInstance.make();
|
||||
return this.toolboxInstance.getElement();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Handler for Plus Button
|
||||
*/
|
||||
|
@ -451,7 +494,7 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
*/
|
||||
this.Editor.BlockManager.currentBlock = this.hoveredBlock;
|
||||
|
||||
this.toolboxInstance.toggle();
|
||||
this.toolboxInstance?.toggle();
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -473,11 +516,11 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
|
||||
this.settingsTogglerClicked();
|
||||
|
||||
if (this.toolboxInstance.opened) {
|
||||
if (this.toolboxInstance?.opened) {
|
||||
this.toolboxInstance.close();
|
||||
}
|
||||
|
||||
this.tooltip.hide(true);
|
||||
tooltip.hide(true);
|
||||
}, true);
|
||||
|
||||
/**
|
||||
|
@ -489,11 +532,11 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
/**
|
||||
* Subscribe to the 'block-hovered' event
|
||||
*/
|
||||
this.eventsDispatcher.on(this.Editor.UI.events.blockHovered, (data: {block: Block}) => {
|
||||
this.eventsDispatcher.on(BlockHovered, (data) => {
|
||||
/**
|
||||
* Do not move toolbar if Block Settings or Toolbox opened
|
||||
*/
|
||||
if (this.Editor.BlockSettings.opened || this.toolboxInstance.opened) {
|
||||
if (this.Editor.BlockSettings.opened || this.toolboxInstance?.opened) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
@ -546,7 +589,7 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
/**
|
||||
* Make Toolbar
|
||||
*/
|
||||
this.make();
|
||||
void this.make();
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -558,6 +601,5 @@ export default class Toolbar extends Module<ToolbarNodes> {
|
|||
if (this.toolboxInstance) {
|
||||
this.toolboxInstance.destroy();
|
||||
}
|
||||
this.tooltip.destroy();
|
||||
}
|
||||
}
|
||||
|
|
|
@ -7,7 +7,7 @@ import Flipper from '../../flipper';
|
|||
import I18n from '../../i18n';
|
||||
import { I18nInternalNS } from '../../i18n/namespace-internal';
|
||||
import Shortcuts from '../../utils/shortcuts';
|
||||
import Tooltip from '../../utils/tooltip';
|
||||
import * as tooltip from '../../utils/tooltip';
|
||||
import { ModuleConfig } from '../../../types-internal/module-config';
|
||||
import InlineTool from '../../tools/inline';
|
||||
import { CommonInternalSettings } from '../../tools/base';
|
||||
|
@ -17,16 +17,16 @@ import { IconChevronDown } from '@codexteam/icons';
|
|||
* Inline Toolbar elements
|
||||
*/
|
||||
interface InlineToolbarNodes {
|
||||
wrapper: HTMLElement;
|
||||
togglerAndButtonsWrapper: HTMLElement;
|
||||
buttons: HTMLElement;
|
||||
conversionToggler: HTMLElement;
|
||||
conversionTogglerContent: HTMLElement;
|
||||
wrapper: HTMLElement | undefined;
|
||||
togglerAndButtonsWrapper: HTMLElement | undefined;
|
||||
buttons: HTMLElement | undefined;
|
||||
conversionToggler: HTMLElement | undefined;
|
||||
conversionTogglerContent: HTMLElement | undefined;
|
||||
/**
|
||||
* Zone below the buttons where Tools can create additional actions by 'renderActions()' method
|
||||
* For example, input for the 'link' tool or textarea for the 'comment' tool
|
||||
*/
|
||||
actions: HTMLElement;
|
||||
actions: HTMLElement | undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -97,10 +97,6 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
*/
|
||||
private flipper: Flipper = null;
|
||||
|
||||
/**
|
||||
* Tooltip utility Instance
|
||||
*/
|
||||
private tooltip: Tooltip;
|
||||
/**
|
||||
* @class
|
||||
* @param moduleConfiguration - Module Configuration
|
||||
|
@ -112,7 +108,6 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
config,
|
||||
eventsDispatcher,
|
||||
});
|
||||
this.tooltip = new Tooltip();
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -122,7 +117,9 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
*/
|
||||
public toggleReadOnly(readOnlyEnabled: boolean): void {
|
||||
if (!readOnlyEnabled) {
|
||||
this.make();
|
||||
window.requestIdleCallback(() => {
|
||||
this.make();
|
||||
}, { timeout: 2000 });
|
||||
} else {
|
||||
this.destroy();
|
||||
this.Editor.ConversionToolbar.destroy();
|
||||
|
@ -141,66 +138,21 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
* Avoid to use it just for closing IT, better call .close() clearly.
|
||||
* @param [needToShowConversionToolbar] - pass false to not to show Conversion Toolbar
|
||||
*/
|
||||
public tryToShow(needToClose = false, needToShowConversionToolbar = true): void {
|
||||
if (!this.allowedToShow()) {
|
||||
if (needToClose) {
|
||||
this.close();
|
||||
}
|
||||
public async tryToShow(needToClose = false, needToShowConversionToolbar = true): Promise<void> {
|
||||
if (needToClose) {
|
||||
this.close();
|
||||
}
|
||||
|
||||
if (!this.allowedToShow()) {
|
||||
return;
|
||||
}
|
||||
|
||||
await this.addToolsFiltered(needToShowConversionToolbar);
|
||||
this.move();
|
||||
this.open(needToShowConversionToolbar);
|
||||
this.Editor.Toolbar.close();
|
||||
}
|
||||
|
||||
/**
|
||||
* Move Toolbar to the selected text
|
||||
*/
|
||||
public move(): void {
|
||||
const selectionRect = SelectionUtils.rect as DOMRect;
|
||||
const wrapperOffset = this.Editor.UI.nodes.wrapper.getBoundingClientRect();
|
||||
const newCoords = {
|
||||
x: selectionRect.x - wrapperOffset.left,
|
||||
y: selectionRect.y +
|
||||
selectionRect.height -
|
||||
// + window.scrollY
|
||||
wrapperOffset.top +
|
||||
this.toolbarVerticalMargin,
|
||||
};
|
||||
|
||||
/**
|
||||
* If we know selections width, place InlineToolbar to center
|
||||
*/
|
||||
if (selectionRect.width) {
|
||||
newCoords.x += Math.floor(selectionRect.width / 2);
|
||||
}
|
||||
|
||||
/**
|
||||
* Inline Toolbar has -50% translateX, so we need to check real coords to prevent overflowing
|
||||
*/
|
||||
const realLeftCoord = newCoords.x - this.width / 2;
|
||||
const realRightCoord = newCoords.x + this.width / 2;
|
||||
|
||||
/**
|
||||
* By default, Inline Toolbar has top-corner at the center
|
||||
* We are adding a modifiers for to move corner to the left or right
|
||||
*/
|
||||
this.nodes.wrapper.classList.toggle(
|
||||
this.CSS.inlineToolbarLeftOriented,
|
||||
realLeftCoord < this.Editor.UI.contentRect.left
|
||||
);
|
||||
|
||||
this.nodes.wrapper.classList.toggle(
|
||||
this.CSS.inlineToolbarRightOriented,
|
||||
realRightCoord > this.Editor.UI.contentRect.right
|
||||
);
|
||||
|
||||
this.nodes.wrapper.style.left = Math.floor(newCoords.x) + 'px';
|
||||
this.nodes.wrapper.style.top = Math.floor(newCoords.y) + 'px';
|
||||
}
|
||||
|
||||
/**
|
||||
* Hides Inline Toolbar
|
||||
*/
|
||||
|
@ -229,63 +181,23 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
}
|
||||
});
|
||||
|
||||
this.reset();
|
||||
this.opened = false;
|
||||
|
||||
this.flipper.deactivate();
|
||||
this.Editor.ConversionToolbar.close();
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows Inline Toolbar
|
||||
*
|
||||
* @param [needToShowConversionToolbar] - pass false to not to show Conversion Toolbar
|
||||
*/
|
||||
public open(needToShowConversionToolbar = true): void {
|
||||
if (this.opened) {
|
||||
return;
|
||||
}
|
||||
/**
|
||||
* Filter inline-tools and show only allowed by Block's Tool
|
||||
*/
|
||||
this.addToolsFiltered();
|
||||
|
||||
/**
|
||||
* Show Inline Toolbar
|
||||
*/
|
||||
this.nodes.wrapper.classList.add(this.CSS.inlineToolbarShowed);
|
||||
|
||||
this.buttonsList = this.nodes.buttons.querySelectorAll(`.${this.CSS.inlineToolButton}`);
|
||||
this.opened = true;
|
||||
|
||||
if (needToShowConversionToolbar && this.Editor.ConversionToolbar.hasTools()) {
|
||||
/**
|
||||
* Change Conversion Dropdown content for current tool
|
||||
*/
|
||||
this.setConversionTogglerContent();
|
||||
} else {
|
||||
/**
|
||||
* hide Conversion Dropdown with there are no tools
|
||||
*/
|
||||
this.nodes.conversionToggler.hidden = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get currently visible buttons to pass it to the Flipper
|
||||
*/
|
||||
let visibleTools = Array.from(this.buttonsList);
|
||||
|
||||
visibleTools.unshift(this.nodes.conversionToggler);
|
||||
visibleTools = visibleTools.filter((tool) => !(tool as HTMLElement).hidden);
|
||||
|
||||
this.flipper.activate(visibleTools as HTMLElement[]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if node is contained by Inline Toolbar
|
||||
*
|
||||
* @param {Node} node — node to check
|
||||
*/
|
||||
public containsNode(node: Node): boolean {
|
||||
if (this.nodes.wrapper === undefined) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return this.nodes.wrapper.contains(node);
|
||||
}
|
||||
|
||||
|
@ -302,7 +214,6 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
}
|
||||
|
||||
this.removeAllNodes();
|
||||
this.tooltip.destroy();
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -313,6 +224,11 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
this.CSS.inlineToolbar,
|
||||
...(this.isRtl ? [ this.Editor.UI.CSS.editorRtlFix ] : []),
|
||||
]);
|
||||
|
||||
if (import.meta.env.MODE === 'test') {
|
||||
this.nodes.wrapper.setAttribute('data-cy', 'inline-toolbar');
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a different wrapper for toggler and buttons.
|
||||
*/
|
||||
|
@ -359,8 +275,11 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
|
||||
/**
|
||||
* Recalculate initial width with all buttons
|
||||
* We use RIC to prevent forced layout during editor initialization to make it faster
|
||||
*/
|
||||
this.recalculateWidth();
|
||||
window.requestAnimationFrame(() => {
|
||||
this.recalculateWidth();
|
||||
});
|
||||
|
||||
/**
|
||||
* Allow to leaf buttons by arrows / tab
|
||||
|
@ -369,6 +288,74 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
this.enableFlipper();
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows Inline Toolbar
|
||||
*/
|
||||
private open(): void {
|
||||
if (this.opened) {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Show Inline Toolbar
|
||||
*/
|
||||
this.nodes.wrapper.classList.add(this.CSS.inlineToolbarShowed);
|
||||
|
||||
this.buttonsList = this.nodes.buttons.querySelectorAll(`.${this.CSS.inlineToolButton}`);
|
||||
this.opened = true;
|
||||
|
||||
/**
|
||||
* Get currently visible buttons to pass it to the Flipper
|
||||
*/
|
||||
let visibleTools = Array.from(this.buttonsList);
|
||||
|
||||
visibleTools.unshift(this.nodes.conversionToggler);
|
||||
visibleTools = visibleTools.filter((tool) => !(tool as HTMLElement).hidden);
|
||||
|
||||
this.flipper.activate(visibleTools as HTMLElement[]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Move Toolbar to the selected text
|
||||
*/
|
||||
private move(): void {
|
||||
const selectionRect = SelectionUtils.rect as DOMRect;
|
||||
const wrapperOffset = this.Editor.UI.nodes.wrapper.getBoundingClientRect();
|
||||
const newCoords = {
|
||||
x: selectionRect.x - wrapperOffset.x,
|
||||
y: selectionRect.y +
|
||||
selectionRect.height -
|
||||
// + window.scrollY
|
||||
wrapperOffset.top +
|
||||
this.toolbarVerticalMargin,
|
||||
};
|
||||
|
||||
const realRightCoord = newCoords.x + this.width + wrapperOffset.x;
|
||||
|
||||
/**
|
||||
* Prevent InlineToolbar from overflowing the content zone on the right side
|
||||
*/
|
||||
if (realRightCoord > this.Editor.UI.contentRect.right) {
|
||||
newCoords.x = this.Editor.UI.contentRect.right - this.width - wrapperOffset.x;
|
||||
}
|
||||
|
||||
this.nodes.wrapper.style.left = Math.floor(newCoords.x) + 'px';
|
||||
this.nodes.wrapper.style.top = Math.floor(newCoords.y) + 'px';
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear orientation classes and reset position
|
||||
*/
|
||||
private reset(): void {
|
||||
this.nodes.wrapper.classList.remove(
|
||||
this.CSS.inlineToolbarLeftOriented,
|
||||
this.CSS.inlineToolbarRightOriented
|
||||
);
|
||||
|
||||
this.nodes.wrapper.style.left = '0';
|
||||
this.nodes.wrapper.style.top = '0';
|
||||
}
|
||||
|
||||
/**
|
||||
* Need to show Inline Toolbar or not
|
||||
*/
|
||||
|
@ -440,6 +427,10 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
|
||||
this.nodes.togglerAndButtonsWrapper.appendChild(this.nodes.conversionToggler);
|
||||
|
||||
if (import.meta.env.MODE === 'test') {
|
||||
this.nodes.conversionToggler.setAttribute('data-cy', 'conversion-toggler');
|
||||
}
|
||||
|
||||
this.listeners.on(this.nodes.conversionToggler, 'click', () => {
|
||||
this.Editor.ConversionToolbar.toggle((conversionToolbarOpened) => {
|
||||
/**
|
||||
|
@ -460,7 +451,7 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
});
|
||||
|
||||
if (_.isMobileScreen() === false ) {
|
||||
this.tooltip.onHover(this.nodes.conversionToggler, I18n.ui(I18nInternalNS.ui.inlineToolbar.converter, 'Convert to'), {
|
||||
tooltip.onHover(this.nodes.conversionToggler, I18n.ui(I18nInternalNS.ui.inlineToolbar.converter, 'Convert to'), {
|
||||
placement: 'top',
|
||||
hidingDelay: 100,
|
||||
});
|
||||
|
@ -511,8 +502,10 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
|
||||
/**
|
||||
* Append only allowed Tools
|
||||
*
|
||||
* @param {boolean} needToShowConversionToolbar - pass false to not to show Conversion Toolbar (e.g. for Footnotes-like tools)
|
||||
*/
|
||||
private addToolsFiltered(): void {
|
||||
private async addToolsFiltered(needToShowConversionToolbar = true): Promise<void> {
|
||||
const currentSelection = SelectionUtils.get();
|
||||
const currentBlock = this.Editor.BlockManager.getBlock(currentSelection.anchorNode as HTMLElement);
|
||||
|
||||
|
@ -527,6 +520,18 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
this.addTool(tool);
|
||||
});
|
||||
|
||||
if (needToShowConversionToolbar && this.Editor.ConversionToolbar.hasTools()) {
|
||||
/**
|
||||
* Change Conversion Dropdown content for current tool
|
||||
*/
|
||||
await this.setConversionTogglerContent();
|
||||
} else {
|
||||
/**
|
||||
* hide Conversion Dropdown with there are no tools
|
||||
*/
|
||||
this.nodes.conversionToggler.hidden = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Recalculate width because some buttons can be hidden
|
||||
*/
|
||||
|
@ -589,7 +594,7 @@ export default class InlineToolbar extends Module<InlineToolbarNodes> {
|
|||
}
|
||||
|
||||
if (_.isMobileScreen() === false ) {
|
||||
this.tooltip.onHover(button, tooltipContent, {
|
||||
tooltip.onHover(button, tooltipContent, {
|
||||
placement: 'top',
|
||||
hidingDelay: 100,
|
||||
});
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
import Paragraph from '../../tools/paragraph/dist/bundle';
|
||||
import Paragraph from '@editorjs/paragraph';
|
||||
import Module from '../__module';
|
||||
import * as _ from '../utils';
|
||||
import { SanitizerConfig, ToolConfig, ToolConstructable, ToolSettings } from '../../../types';
|
||||
|
|
|
@ -13,6 +13,10 @@ import Block from '../block';
|
|||
import Flipper from '../flipper';
|
||||
import { mobileScreenBreakpoint } from '../utils';
|
||||
|
||||
import styles from '../../styles/main.css?inline';
|
||||
import { BlockHovered } from '../events/BlockHovered';
|
||||
import { selectionChangeDebounceTimeout } from '../constants';
|
||||
import { EditorMobileLayoutToggled } from '../events';
|
||||
/**
|
||||
* HTML Elements used for UI
|
||||
*/
|
||||
|
@ -20,7 +24,6 @@ interface UINodes {
|
|||
holder: HTMLElement;
|
||||
wrapper: HTMLElement;
|
||||
redactor: HTMLElement;
|
||||
loader: HTMLElement;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -40,15 +43,6 @@ interface UINodes {
|
|||
* @property {Element} nodes.redactor - <ce-redactor>
|
||||
*/
|
||||
export default class UI extends Module<UINodes> {
|
||||
/**
|
||||
* Events could be emitted by this module.
|
||||
*/
|
||||
public get events(): { blockHovered: string } {
|
||||
return {
|
||||
blockHovered: 'block-hovered',
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Editor.js UI CSS class names
|
||||
*
|
||||
|
@ -56,14 +50,13 @@ export default class UI extends Module<UINodes> {
|
|||
*/
|
||||
public get CSS(): {
|
||||
editorWrapper: string; editorWrapperNarrow: string; editorZone: string; editorZoneHidden: string;
|
||||
editorLoader: string; editorEmpty: string; editorRtlFix: string;
|
||||
editorEmpty: string; editorRtlFix: string;
|
||||
} {
|
||||
return {
|
||||
editorWrapper: 'codex-editor',
|
||||
editorWrapperNarrow: 'codex-editor--narrow',
|
||||
editorZone: 'codex-editor__redactor',
|
||||
editorZoneHidden: 'codex-editor__redactor--hidden',
|
||||
editorLoader: 'codex-editor__loader',
|
||||
editorEmpty: 'codex-editor--empty',
|
||||
editorRtlFix: 'codex-editor--rtl',
|
||||
};
|
||||
|
@ -122,23 +115,6 @@ export default class UI extends Module<UINodes> {
|
|||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers
|
||||
}, 200);
|
||||
|
||||
/**
|
||||
* Adds loader to editor while content is not ready
|
||||
*/
|
||||
public addLoader(): void {
|
||||
this.nodes.loader = $.make('div', this.CSS.editorLoader);
|
||||
this.nodes.wrapper.prepend(this.nodes.loader);
|
||||
this.nodes.redactor.classList.add(this.CSS.editorZoneHidden);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes loader when content has loaded
|
||||
*/
|
||||
public removeLoader(): void {
|
||||
this.nodes.loader.remove();
|
||||
this.nodes.redactor.classList.remove(this.CSS.editorZoneHidden);
|
||||
}
|
||||
|
||||
/**
|
||||
* Making main interface
|
||||
*/
|
||||
|
@ -146,18 +122,13 @@ export default class UI extends Module<UINodes> {
|
|||
/**
|
||||
* Detect mobile version
|
||||
*/
|
||||
this.checkIsMobile();
|
||||
this.setIsMobile();
|
||||
|
||||
/**
|
||||
* Make main UI elements
|
||||
*/
|
||||
this.make();
|
||||
|
||||
/**
|
||||
* Loader for rendering process
|
||||
*/
|
||||
this.addLoader();
|
||||
|
||||
/**
|
||||
* Load and append CSS
|
||||
*/
|
||||
|
@ -181,12 +152,20 @@ export default class UI extends Module<UINodes> {
|
|||
*/
|
||||
if (!readOnlyEnabled) {
|
||||
/**
|
||||
* Unbind all events
|
||||
* Postpone events binding to the next tick to make sure all ui elements are ready
|
||||
*/
|
||||
this.enableModuleBindings();
|
||||
window.requestIdleCallback(() => {
|
||||
/**
|
||||
* Bind events for the UI elements
|
||||
*/
|
||||
this.enableModuleBindings();
|
||||
}, {
|
||||
timeout: 2000,
|
||||
});
|
||||
} else {
|
||||
/**
|
||||
* Bind events for the UI elements
|
||||
* Unbind all events
|
||||
*
|
||||
*/
|
||||
this.disableModuleBindings();
|
||||
}
|
||||
|
@ -256,10 +235,21 @@ export default class UI extends Module<UINodes> {
|
|||
}
|
||||
|
||||
/**
|
||||
* Check for mobile mode and cache a result
|
||||
* Check for mobile mode and save the result
|
||||
*/
|
||||
private checkIsMobile(): void {
|
||||
this.isMobile = window.innerWidth < mobileScreenBreakpoint;
|
||||
private setIsMobile(): void {
|
||||
const isMobile = window.innerWidth < mobileScreenBreakpoint;
|
||||
|
||||
if (isMobile !== this.isMobile) {
|
||||
/**
|
||||
* Dispatch global event
|
||||
*/
|
||||
this.eventsDispatcher.emit(EditorMobileLayoutToggled, {
|
||||
isEnabled: this.isMobile,
|
||||
});
|
||||
}
|
||||
|
||||
this.isMobile = isMobile;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -284,6 +274,8 @@ export default class UI extends Module<UINodes> {
|
|||
|
||||
/**
|
||||
* If Editor has injected into the narrow container, enable Narrow Mode
|
||||
*
|
||||
* @todo Forced layout. Get rid of this feature
|
||||
*/
|
||||
if (this.nodes.holder.offsetWidth < this.contentRect.width) {
|
||||
this.nodes.wrapper.classList.add(this.CSS.editorWrapperNarrow);
|
||||
|
@ -306,7 +298,6 @@ export default class UI extends Module<UINodes> {
|
|||
* Load CSS
|
||||
*/
|
||||
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
||||
const styles = require('../../styles/main.css');
|
||||
const styleTagId = 'editor-js-styles';
|
||||
|
||||
/**
|
||||
|
@ -324,6 +315,15 @@ export default class UI extends Module<UINodes> {
|
|||
textContent: styles.toString(),
|
||||
});
|
||||
|
||||
/**
|
||||
* If user enabled Content Security Policy, he can pass nonce through the config
|
||||
*
|
||||
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/nonce
|
||||
*/
|
||||
if (this.config.style && !_.isEmpty(this.config.style) && this.config.style.nonce) {
|
||||
tag.setAttribute('nonce', this.config.style.nonce);
|
||||
}
|
||||
|
||||
/**
|
||||
* Append styles at the top of HEAD tag
|
||||
*/
|
||||
|
@ -340,11 +340,17 @@ export default class UI extends Module<UINodes> {
|
|||
|
||||
this.readOnlyMutableListeners.on(this.nodes.redactor, 'mousedown', (event: MouseEvent | TouchEvent) => {
|
||||
this.documentTouched(event);
|
||||
}, true);
|
||||
}, {
|
||||
capture: true,
|
||||
passive: true,
|
||||
});
|
||||
|
||||
this.readOnlyMutableListeners.on(this.nodes.redactor, 'touchstart', (event: MouseEvent | TouchEvent) => {
|
||||
this.documentTouched(event);
|
||||
}, true);
|
||||
}, {
|
||||
capture: true,
|
||||
passive: true,
|
||||
});
|
||||
|
||||
this.readOnlyMutableListeners.on(document, 'keydown', (event: KeyboardEvent) => {
|
||||
this.documentKeydown(event);
|
||||
|
@ -357,9 +363,11 @@ export default class UI extends Module<UINodes> {
|
|||
/**
|
||||
* Handle selection change to manipulate Inline Toolbar appearance
|
||||
*/
|
||||
this.readOnlyMutableListeners.on(document, 'selectionchange', () => {
|
||||
const selectionChangeDebounced = _.debounce(() => {
|
||||
this.selectionChanged();
|
||||
}, true);
|
||||
}, selectionChangeDebounceTimeout);
|
||||
|
||||
this.readOnlyMutableListeners.on(document, 'selectionchange', selectionChangeDebounced, true);
|
||||
|
||||
this.readOnlyMutableListeners.on(window, 'resize', () => {
|
||||
this.resizeDebouncer();
|
||||
|
@ -402,7 +410,7 @@ export default class UI extends Module<UINodes> {
|
|||
|
||||
blockHoveredEmitted = hoveredBlock;
|
||||
|
||||
this.eventsDispatcher.emit(this.events.blockHovered, {
|
||||
this.eventsDispatcher.emit(BlockHovered, {
|
||||
block: this.Editor.BlockManager.getBlockByChildNode(hoveredBlock),
|
||||
});
|
||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers
|
||||
|
@ -430,7 +438,7 @@ export default class UI extends Module<UINodes> {
|
|||
/**
|
||||
* Detect mobile version
|
||||
*/
|
||||
this.checkIsMobile();
|
||||
this.setIsMobile();
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -445,6 +453,7 @@ export default class UI extends Module<UINodes> {
|
|||
break;
|
||||
|
||||
case _.keyCodes.BACKSPACE:
|
||||
case _.keyCodes.DELETE:
|
||||
this.backspacePressed(event);
|
||||
break;
|
||||
|
||||
|
@ -508,7 +517,9 @@ export default class UI extends Module<UINodes> {
|
|||
if (BlockSelection.anyBlockSelected && !Selection.isSelectionExists) {
|
||||
const selectionPositionIndex = BlockManager.removeSelectedBlocks();
|
||||
|
||||
Caret.setToBlock(BlockManager.insertDefaultBlockAtIndex(selectionPositionIndex, true), Caret.positions.START);
|
||||
const newBlock = BlockManager.insertDefaultBlockAtIndex(selectionPositionIndex, true);
|
||||
|
||||
Caret.setToBlock(newBlock, Caret.positions.START);
|
||||
|
||||
/** Clear selection */
|
||||
BlockSelection.clearSelection(event);
|
||||
|
@ -538,7 +549,7 @@ export default class UI extends Module<UINodes> {
|
|||
|
||||
if (this.Editor.Toolbar.toolbox.opened) {
|
||||
this.Editor.Toolbar.toolbox.close();
|
||||
this.Editor.Caret.setToBlock(this.Editor.BlockManager.currentBlock);
|
||||
this.Editor.Caret.setToBlock(this.Editor.BlockManager.currentBlock, this.Editor.Caret.positions.END);
|
||||
} else if (this.Editor.BlockSettings.opened) {
|
||||
this.Editor.BlockSettings.close();
|
||||
} else if (this.Editor.ConversionToolbar.opened) {
|
||||
|
@ -557,6 +568,11 @@ export default class UI extends Module<UINodes> {
|
|||
*/
|
||||
private enterPressed(event: KeyboardEvent): void {
|
||||
const { BlockManager, BlockSelection } = this.Editor;
|
||||
|
||||
if (this.someToolbarOpened) {
|
||||
return;
|
||||
}
|
||||
|
||||
const hasPointerToBlock = BlockManager.currentBlockIndex >= 0;
|
||||
|
||||
/**
|
||||
|
@ -592,12 +608,11 @@ export default class UI extends Module<UINodes> {
|
|||
*/
|
||||
const newBlock = this.Editor.BlockManager.insert();
|
||||
|
||||
this.Editor.Caret.setToBlock(newBlock);
|
||||
|
||||
/**
|
||||
* And highlight
|
||||
* Prevent default enter behaviour to prevent adding a new line (<div><br></div>) to the inserted block
|
||||
*/
|
||||
this.Editor.BlockManager.highlightCurrentNode();
|
||||
event.preventDefault();
|
||||
this.Editor.Caret.setToBlock(newBlock);
|
||||
|
||||
/**
|
||||
* Move toolbar and show plus button because new Block is empty
|
||||
|
@ -645,8 +660,8 @@ export default class UI extends Module<UINodes> {
|
|||
* But allow clicking inside Block Settings.
|
||||
* Also, do not process clicks on the Block Settings Toggler, because it has own click listener
|
||||
*/
|
||||
const isClickedInsideBlockSettings = this.Editor.BlockSettings.nodes.wrapper.contains(target);
|
||||
const isClickedInsideBlockSettingsToggler = this.Editor.Toolbar.nodes.settingsToggler.contains(target);
|
||||
const isClickedInsideBlockSettings = this.Editor.BlockSettings.nodes.wrapper?.contains(target);
|
||||
const isClickedInsideBlockSettingsToggler = this.Editor.Toolbar.nodes.settingsToggler?.contains(target);
|
||||
const doNotProcess = isClickedInsideBlockSettings || isClickedInsideBlockSettingsToggler;
|
||||
|
||||
if (this.Editor.BlockSettings.opened && !doNotProcess) {
|
||||
|
@ -691,15 +706,7 @@ export default class UI extends Module<UINodes> {
|
|||
* Select clicked Block as Current
|
||||
*/
|
||||
try {
|
||||
/**
|
||||
* Renew Current Block
|
||||
*/
|
||||
this.Editor.BlockManager.setCurrentBlockByChildNode(clickedNode);
|
||||
|
||||
/**
|
||||
* Highlight Current Node
|
||||
*/
|
||||
this.Editor.BlockManager.highlightCurrentNode();
|
||||
} catch (e) {
|
||||
/**
|
||||
* If clicked outside first-level Blocks and it is not RectSelection, set Caret to the last empty Block
|
||||
|
@ -726,17 +733,10 @@ export default class UI extends Module<UINodes> {
|
|||
* - otherwise, add a new empty Block and set a Caret to that
|
||||
*/
|
||||
private redactorClicked(event: MouseEvent): void {
|
||||
const { BlockSelection } = this.Editor;
|
||||
|
||||
if (!Selection.isCollapsed) {
|
||||
return;
|
||||
}
|
||||
|
||||
const stopPropagation = (): void => {
|
||||
event.stopImmediatePropagation();
|
||||
event.stopPropagation();
|
||||
};
|
||||
|
||||
/**
|
||||
* case when user clicks on anchor element
|
||||
* if it is clicked via ctrl key, then we open new window with url
|
||||
|
@ -745,7 +745,8 @@ export default class UI extends Module<UINodes> {
|
|||
const ctrlKey = event.metaKey || event.ctrlKey;
|
||||
|
||||
if ($.isAnchor(element) && ctrlKey) {
|
||||
stopPropagation();
|
||||
event.stopImmediatePropagation();
|
||||
event.stopPropagation();
|
||||
|
||||
const href = element.getAttribute('href');
|
||||
const validUrl = _.getValidUrl(href);
|
||||
|
@ -755,10 +756,22 @@ export default class UI extends Module<UINodes> {
|
|||
return;
|
||||
}
|
||||
|
||||
this.processBottomZoneClick(event);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if user clicks on the Editor's bottom zone:
|
||||
* - set caret to the last block
|
||||
* - or add new empty block
|
||||
*
|
||||
* @param event - click event
|
||||
*/
|
||||
private processBottomZoneClick(event: MouseEvent): void {
|
||||
const lastBlock = this.Editor.BlockManager.getBlockByIndex(-1);
|
||||
|
||||
const lastBlockBottomCoord = $.offset(lastBlock.holder).bottom;
|
||||
const clickedCoord = event.pageY;
|
||||
|
||||
const { BlockSelection } = this.Editor;
|
||||
const isClickedBottom = event.target instanceof Element &&
|
||||
event.target.isEqualNode(this.nodes.redactor) &&
|
||||
/**
|
||||
|
@ -772,7 +785,8 @@ export default class UI extends Module<UINodes> {
|
|||
lastBlockBottomCoord < clickedCoord;
|
||||
|
||||
if (isClickedBottom) {
|
||||
stopPropagation();
|
||||
event.stopImmediatePropagation();
|
||||
event.stopPropagation();
|
||||
|
||||
const { BlockManager, Caret, Toolbar } = this.Editor;
|
||||
|
||||
|
@ -860,9 +874,6 @@ export default class UI extends Module<UINodes> {
|
|||
|
||||
const isNeedToShowConversionToolbar = clickedOutsideBlockContent !== true;
|
||||
|
||||
/**
|
||||
* @todo add debounce
|
||||
*/
|
||||
this.Editor.InlineToolbar.tryToShow(true, isNeedToShowConversionToolbar);
|
||||
}
|
||||
}
|
||||
|
|
|
@ -136,3 +136,27 @@ if (!Element.prototype.scrollIntoViewIfNeeded) {
|
|||
}
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* RequestIdleCallback polyfill (shims)
|
||||
*
|
||||
* @see https://developer.chrome.com/blog/using-requestidlecallback/
|
||||
* @param cb - callback to be executed when the browser is idle
|
||||
*/
|
||||
window.requestIdleCallback = window.requestIdleCallback || function (cb) {
|
||||
const start = Date.now();
|
||||
|
||||
return setTimeout(function () {
|
||||
cb({
|
||||
didTimeout: false,
|
||||
timeRemaining: function () {
|
||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers
|
||||
return Math.max(0, 50 - (Date.now() - start));
|
||||
},
|
||||
});
|
||||
}, 1);
|
||||
};
|
||||
|
||||
window.cancelIdleCallback = window.cancelIdleCallback || function (id) {
|
||||
clearTimeout(id);
|
||||
};
|
||||
|
|
|
@ -225,7 +225,7 @@ export default class SelectionUtils {
|
|||
*
|
||||
* @param selection - Selection object to get Range from
|
||||
*/
|
||||
public static getRangeFromSelection(selection: Selection): Range {
|
||||
public static getRangeFromSelection(selection: Selection): Range | null {
|
||||
return selection && selection.rangeCount ? selection.getRangeAt(0) : null;
|
||||
}
|
||||
|
||||
|
@ -353,24 +353,47 @@ export default class SelectionUtils {
|
|||
}
|
||||
|
||||
/**
|
||||
* Adds fake cursor to the current range
|
||||
* Check if current range exists and belongs to container
|
||||
*
|
||||
* @param [container] - if passed cursor will be added only if container contains current range
|
||||
* @param container - where range should be
|
||||
*/
|
||||
public static addFakeCursor(container?: HTMLElement): void {
|
||||
public static isRangeInsideContainer(container: HTMLElement): boolean {
|
||||
const range = SelectionUtils.range;
|
||||
|
||||
if (range === null) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return container.contains(range.startContainer);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds fake cursor to the current range
|
||||
*/
|
||||
public static addFakeCursor(): void {
|
||||
const range = SelectionUtils.range;
|
||||
|
||||
if (range === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
const fakeCursor = $.make('span', 'codex-editor__fake-cursor');
|
||||
|
||||
fakeCursor.dataset.mutationFree = 'true';
|
||||
|
||||
if (!range || (container && !container.contains(range.startContainer))) {
|
||||
return;
|
||||
}
|
||||
|
||||
range.collapse();
|
||||
range.insertNode(fakeCursor);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if passed element contains a fake cursor
|
||||
*
|
||||
* @param el - where to check
|
||||
*/
|
||||
public static isFakeCursorInsideContainer(el: HTMLElement): boolean {
|
||||
return $.find(el, `.codex-editor__fake-cursor`) !== null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes fake cursor from a container
|
||||
*
|
||||
|
@ -379,7 +402,11 @@ export default class SelectionUtils {
|
|||
public static removeFakeCursor(container: HTMLElement = document.body): void {
|
||||
const fakeCursor = $.find(container, `.codex-editor__fake-cursor`);
|
||||
|
||||
fakeCursor && fakeCursor.remove();
|
||||
if (!fakeCursor) {
|
||||
return;
|
||||
}
|
||||
|
||||
fakeCursor.remove();
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
@ -136,7 +136,7 @@ export default class BlockTool extends BaseTool<IBlockTool> {
|
|||
/**
|
||||
* Returns Tool conversion configuration
|
||||
*/
|
||||
public get conversionConfig(): ConversionConfig {
|
||||
public get conversionConfig(): ConversionConfig | undefined {
|
||||
return this.constructable[InternalBlockToolSettings.ConversionConfig];
|
||||
}
|
||||
|
||||
|
@ -158,7 +158,7 @@ export default class BlockTool extends BaseTool<IBlockTool> {
|
|||
* Returns Tool paste configuration
|
||||
*/
|
||||
public get pasteConfig(): PasteConfig {
|
||||
return this.constructable[InternalBlockToolSettings.PasteConfig] || {};
|
||||
return this.constructable[InternalBlockToolSettings.PasteConfig] ?? {};
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
@ -3,11 +3,15 @@ import { BlockToolAPI } from '../block';
|
|||
import Shortcuts from '../utils/shortcuts';
|
||||
import BlockTool from '../tools/block';
|
||||
import ToolsCollection from '../tools/collection';
|
||||
import { API, BlockToolData, ToolboxConfigEntry, PopoverItem } from '../../../types';
|
||||
import { API, BlockToolData, ToolboxConfigEntry, PopoverItemParams, BlockAPI } from '../../../types';
|
||||
import EventsDispatcher from '../utils/events';
|
||||
import Popover, { PopoverEvent } from '../utils/popover';
|
||||
import I18n from '../i18n';
|
||||
import { I18nInternalNS } from '../i18n/namespace-internal';
|
||||
import { PopoverEvent } from '../utils/popover/popover.types';
|
||||
import Listeners from '../utils/listeners';
|
||||
import Dom from '../dom';
|
||||
import { Popover, PopoverDesktop, PopoverMobile } from '../utils/popover';
|
||||
import { EditorMobileLayoutToggled } from '../events';
|
||||
|
||||
/**
|
||||
* @todo the first Tab on the Block — focus Plus Button, the second — focus Block Tunes Toggler, the third — focus next Block
|
||||
|
@ -33,6 +37,19 @@ export enum ToolboxEvent {
|
|||
BlockAdded = 'toolbox-block-added',
|
||||
}
|
||||
|
||||
/**
|
||||
* Events fired by the Toolbox
|
||||
*
|
||||
* Event name -> payload
|
||||
*/
|
||||
export interface ToolboxEventMap {
|
||||
[ToolboxEvent.Opened]: undefined;
|
||||
[ToolboxEvent.Closed]: undefined;
|
||||
[ToolboxEvent.BlockAdded]: {
|
||||
block: BlockAPI
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Available i18n dict keys that should be passed to the constructor
|
||||
*/
|
||||
|
@ -45,7 +62,7 @@ type ToolboxTextLabelsKeys = 'filter' | 'nothingFound';
|
|||
*
|
||||
* @implements {EventsDispatcher} with some events, see {@link ToolboxEvent}
|
||||
*/
|
||||
export default class Toolbox extends EventsDispatcher<ToolboxEvent> {
|
||||
export default class Toolbox extends EventsDispatcher<ToolboxEventMap> {
|
||||
/**
|
||||
* Returns True if Toolbox is Empty and nothing to show
|
||||
*
|
||||
|
@ -62,6 +79,11 @@ export default class Toolbox extends EventsDispatcher<ToolboxEvent> {
|
|||
*/
|
||||
public opened = false;
|
||||
|
||||
/**
|
||||
* Listeners util instance
|
||||
*/
|
||||
protected listeners: Listeners = new Listeners();
|
||||
|
||||
/**
|
||||
* Editor API
|
||||
*/
|
||||
|
@ -69,8 +91,9 @@ export default class Toolbox extends EventsDispatcher<ToolboxEvent> {
|
|||
|
||||
/**
|
||||
* Popover instance. There is a util for vertical lists.
|
||||
* Null until initialized
|
||||
*/
|
||||
private popover: Popover | undefined;
|
||||
private popover: Popover | null = null;
|
||||
|
||||
/**
|
||||
* List of Tools available. Some of them will be shown in the Toolbox
|
||||
|
@ -86,17 +109,15 @@ export default class Toolbox extends EventsDispatcher<ToolboxEvent> {
|
|||
* Current module HTML Elements
|
||||
*/
|
||||
private nodes: {
|
||||
toolbox: HTMLElement | null;
|
||||
} = {
|
||||
toolbox: null,
|
||||
};
|
||||
toolbox: HTMLElement;
|
||||
} ;
|
||||
|
||||
/**
|
||||
* CSS styles
|
||||
*
|
||||
* @returns {Object<string, string>}
|
||||
*/
|
||||
private static get CSS(): { [name: string]: string } {
|
||||
private static get CSS(): {
|
||||
toolbox: string;
|
||||
} {
|
||||
return {
|
||||
toolbox: 'ce-toolbox',
|
||||
};
|
||||
|
@ -115,32 +136,26 @@ export default class Toolbox extends EventsDispatcher<ToolboxEvent> {
|
|||
this.api = api;
|
||||
this.tools = tools;
|
||||
this.i18nLabels = i18nLabels;
|
||||
|
||||
this.enableShortcuts();
|
||||
|
||||
this.nodes = {
|
||||
toolbox: Dom.make('div', Toolbox.CSS.toolbox),
|
||||
};
|
||||
|
||||
this.initPopover();
|
||||
|
||||
if (import.meta.env.MODE === 'test') {
|
||||
this.nodes.toolbox.setAttribute('data-cy', 'toolbox');
|
||||
}
|
||||
|
||||
this.api.events.on(EditorMobileLayoutToggled, this.handleMobileLayoutToggle);
|
||||
}
|
||||
|
||||
/**
|
||||
* Makes the Toolbox
|
||||
* Returns root block settings element
|
||||
*/
|
||||
public make(): Element {
|
||||
this.popover = new Popover({
|
||||
scopeElement: this.api.ui.nodes.redactor,
|
||||
searchable: true,
|
||||
messages: {
|
||||
nothingFound: this.i18nLabels.nothingFound,
|
||||
search: this.i18nLabels.filter,
|
||||
},
|
||||
items: this.toolboxItemsToBeDisplayed,
|
||||
});
|
||||
|
||||
this.popover.on(PopoverEvent.Close, this.onPopoverClose);
|
||||
|
||||
/**
|
||||
* Enable tools shortcuts
|
||||
*/
|
||||
this.enableShortcuts();
|
||||
|
||||
this.nodes.toolbox = this.popover.getElement();
|
||||
this.nodes.toolbox.classList.add(Toolbox.CSS.toolbox);
|
||||
|
||||
public getElement(): HTMLElement | null {
|
||||
return this.nodes.toolbox;
|
||||
}
|
||||
|
||||
|
@ -148,7 +163,11 @@ export default class Toolbox extends EventsDispatcher<ToolboxEvent> {
|
|||
* Returns true if the Toolbox has the Flipper activated and the Flipper has selected button
|
||||
*/
|
||||
public hasFocus(): boolean | undefined {
|
||||
return this.popover?.hasFocus();
|
||||
if (this.popover === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
return 'hasFocus' in this.popover ? this.popover.hasFocus() : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -159,11 +178,12 @@ export default class Toolbox extends EventsDispatcher<ToolboxEvent> {
|
|||
|
||||
if (this.nodes && this.nodes.toolbox) {
|
||||
this.nodes.toolbox.remove();
|
||||
this.nodes.toolbox = null;
|
||||
}
|
||||
|
||||
this.removeAllShortcuts();
|
||||
this.popover?.off(PopoverEvent.Close, this.onPopoverClose);
|
||||
this.listeners.destroy();
|
||||
this.api.events.off(EditorMobileLayoutToggled, this.handleMobileLayoutToggle);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -209,6 +229,50 @@ export default class Toolbox extends EventsDispatcher<ToolboxEvent> {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Destroys existing popover instance and contructs the new one.
|
||||
*/
|
||||
public handleMobileLayoutToggle = (): void => {
|
||||
this.destroyPopover();
|
||||
this.initPopover();
|
||||
};
|
||||
|
||||
/**
|
||||
* Creates toolbox popover and appends it inside wrapper element
|
||||
*/
|
||||
private initPopover(): void {
|
||||
const PopoverClass = _.isMobileScreen() ? PopoverMobile : PopoverDesktop;
|
||||
|
||||
this.popover = new PopoverClass({
|
||||
scopeElement: this.api.ui.nodes.redactor,
|
||||
searchable: true,
|
||||
messages: {
|
||||
nothingFound: this.i18nLabels.nothingFound,
|
||||
search: this.i18nLabels.filter,
|
||||
},
|
||||
items: this.toolboxItemsToBeDisplayed,
|
||||
});
|
||||
|
||||
this.popover.on(PopoverEvent.Close, this.onPopoverClose);
|
||||
this.nodes.toolbox?.append(this.popover.getElement());
|
||||
}
|
||||
|
||||
/**
|
||||
* Destroys popover instance and removes it from DOM
|
||||
*/
|
||||
private destroyPopover(): void {
|
||||
if (this.popover !== null) {
|
||||
this.popover.hide();
|
||||
this.popover.off(PopoverEvent.Close, this.onPopoverClose);
|
||||
this.popover.destroy();
|
||||
this.popover = null;
|
||||
}
|
||||
|
||||
if (this.nodes.toolbox !== null) {
|
||||
this.nodes.toolbox.innerHTML = '';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handles popover close event
|
||||
*/
|
||||
|
@ -239,11 +303,11 @@ export default class Toolbox extends EventsDispatcher<ToolboxEvent> {
|
|||
* Returns list of items that will be displayed in toolbox
|
||||
*/
|
||||
@_.cacheable
|
||||
private get toolboxItemsToBeDisplayed(): PopoverItem[] {
|
||||
private get toolboxItemsToBeDisplayed(): PopoverItemParams[] {
|
||||
/**
|
||||
* Maps tool data to popover item structure
|
||||
*/
|
||||
const toPopoverItem = (toolboxItem: ToolboxConfigEntry, tool: BlockTool): PopoverItem => {
|
||||
const toPopoverItem = (toolboxItem: ToolboxConfigEntry, tool: BlockTool): PopoverItemParams => {
|
||||
return {
|
||||
icon: toolboxItem.icon,
|
||||
title: I18n.t(I18nInternalNS.toolNames, toolboxItem.title || _.capitalize(tool.name)),
|
||||
|
@ -256,7 +320,7 @@ export default class Toolbox extends EventsDispatcher<ToolboxEvent> {
|
|||
};
|
||||
|
||||
return this.toolsToBeDisplayed
|
||||
.reduce<PopoverItem[]>((result, tool) => {
|
||||
.reduce<PopoverItemParams[]>((result, tool) => {
|
||||
if (Array.isArray(tool.toolbox)) {
|
||||
tool.toolbox.forEach(item => {
|
||||
result.push(toPopoverItem(item, tool));
|
||||
|
@ -292,8 +356,26 @@ export default class Toolbox extends EventsDispatcher<ToolboxEvent> {
|
|||
Shortcuts.add({
|
||||
name: shortcut,
|
||||
on: this.api.ui.nodes.redactor,
|
||||
handler: (event: KeyboardEvent) => {
|
||||
handler: async (event: KeyboardEvent) => {
|
||||
event.preventDefault();
|
||||
|
||||
const currentBlockIndex = this.api.blocks.getCurrentBlockIndex();
|
||||
const currentBlock = this.api.blocks.getBlockByIndex(currentBlockIndex);
|
||||
|
||||
/**
|
||||
* Try to convert current Block to shortcut's tool
|
||||
* If conversion is not possible, insert a new Block below
|
||||
*/
|
||||
if (currentBlock) {
|
||||
try {
|
||||
const newBlock = await this.api.blocks.convert(currentBlock.id, toolName);
|
||||
|
||||
this.api.caret.setToBlock(newBlock, 'end');
|
||||
|
||||
return;
|
||||
} catch (error) {}
|
||||
}
|
||||
|
||||
this.insertNewBlock(toolName);
|
||||
},
|
||||
});
|
||||
|
|
|
@ -56,6 +56,7 @@ export const keyCodes = {
|
|||
RIGHT: 39,
|
||||
DELETE: 46,
|
||||
META: 91,
|
||||
SLASH: 191,
|
||||
};
|
||||
|
||||
/**
|
||||
|
@ -311,6 +312,7 @@ export function isPrintableKey(keyCode: number): boolean {
|
|||
* @param {Function} success - success callback
|
||||
* @param {Function} fallback - callback that fires in case of errors
|
||||
* @returns {Promise}
|
||||
* @deprecated use PromiseQueue.ts instead
|
||||
*/
|
||||
export async function sequence(
|
||||
chains: ChainData[],
|
||||
|
|
21
src/components/utils/api.ts
Normal file
|
@ -0,0 +1,21 @@
|
|||
import type { BlockAPI } from '../../../types/api/block';
|
||||
import { EditorModules } from '../../types-internal/editor-modules';
|
||||
import Block from '../block';
|
||||
|
||||
/**
|
||||
* Returns Block instance by passed Block index or Block id
|
||||
*
|
||||
* @param attribute - either BlockAPI or Block id or Block index
|
||||
* @param editor - Editor instance
|
||||
*/
|
||||
export function resolveBlock(attribute: BlockAPI | BlockAPI['id'] | number, editor: EditorModules): Block | undefined {
|
||||
if (typeof attribute === 'number') {
|
||||
return editor.BlockManager.getBlockByIndex(attribute);
|
||||
}
|
||||
|
||||
if (typeof attribute === 'string') {
|
||||
return editor.BlockManager.getBlockById(attribute);
|
||||
}
|
||||
|
||||
return editor.BlockManager.getBlockById(attribute.id);
|
||||
}
|
25
src/components/utils/bem.ts
Normal file
|
@ -0,0 +1,25 @@
|
|||
const ELEMENT_DELIMITER = '__';
|
||||
const MODIFIER_DELIMITER = '--';
|
||||
|
||||
/**
|
||||
* Utility function that allows to construct class names from block and element names
|
||||
*
|
||||
* @example bem('ce-popover)() -> 'ce-popover'
|
||||
* @example bem('ce-popover)('container') -> 'ce-popover__container'
|
||||
* @example bem('ce-popover)('container', 'hidden') -> 'ce-popover__container--hidden'
|
||||
* @example bem('ce-popover)(null, 'hidden') -> 'ce-popover--hidden'
|
||||
* @param blockName - string with block name
|
||||
* @param elementName - string with element name
|
||||
* @param modifier - modifier to be appended
|
||||
*/
|
||||
export function bem(blockName: string) {
|
||||
return (elementName?: string | null, modifier?: string) => {
|
||||
const className = [blockName, elementName]
|
||||
.filter(x => !!x)
|
||||
.join(ELEMENT_DELIMITER);
|
||||
|
||||
return [className, modifier]
|
||||
.filter(x => !!x)
|
||||
.join(MODIFIER_DELIMITER);
|
||||
};
|
||||
}
|