@atlaskit/editor-plugin-rule 30.0.1 → 30.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # @atlaskit/editor-plugin-rule
2
2
 
3
+ ## 30.0.2
4
+
5
+ ### Patch Changes
6
+
7
+ - [`8632ab245f251`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8632ab245f251) -
8
+ [ux] [EDITOR-8977] introduce rule node view to update the selected state for dividers behind
9
+ `platform_editor_lovability_dividers`
10
+ - Updated dependencies
11
+
3
12
  ## 30.0.1
4
13
 
5
14
  ### Patch Changes
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.RuleNodeView = void 0;
8
+ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
9
+ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
10
+ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
11
+ var _bindEventListener = require("bind-event-listener");
12
+ var _model = require("@atlaskit/editor-prosemirror/model");
13
+ var ruleNodeViewAttribute = 'data-rule-node-view';
14
+ var RuleNodeView = exports.RuleNodeView = /*#__PURE__*/function () {
15
+ function RuleNodeView(node, view) {
16
+ var _this = this;
17
+ (0, _classCallCheck2.default)(this, RuleNodeView);
18
+ // when there is only 1 rule node on the page and it is not editable, clicking on it does not focus the editor and Cmd+C/ Ctrl+C shortcut will not work. this mouse down listener adds focus to the editor.
19
+ (0, _defineProperty2.default)(this, "handleMousedown", function () {
20
+ if (!_this.view.hasFocus()) {
21
+ _this.view.focus();
22
+ }
23
+ });
24
+ this.node = node;
25
+ this.view = view;
26
+ var dom = this.view.dom.ownerDocument.createElement('div');
27
+ this.dom = dom;
28
+ dom.setAttribute(ruleNodeViewAttribute, '');
29
+ dom.setAttribute('contenteditable', 'inherit');
30
+ this.unbindMousedown = (0, _bindEventListener.bind)(dom, {
31
+ type: 'mousedown',
32
+ listener: this.handleMousedown
33
+ });
34
+ this.update(node);
35
+ }
36
+ return (0, _createClass2.default)(RuleNodeView, [{
37
+ key: "update",
38
+ value: function update(node) {
39
+ if (node.type !== this.node.type) {
40
+ return false;
41
+ }
42
+ if (this.dom.firstChild && node.sameMarkup(this.node)) {
43
+ this.node = node;
44
+ return true;
45
+ }
46
+ var toDOM = node.type.spec.toDOM;
47
+ if (!toDOM) {
48
+ return false;
49
+ }
50
+ var _DOMSerializer$render = _model.DOMSerializer.renderSpec(this.view.dom.ownerDocument, toDOM(node)),
51
+ dom = _DOMSerializer$render.dom;
52
+ if (dom instanceof HTMLElement) {
53
+ dom.contentEditable = 'false';
54
+ }
55
+ if (this.dom.firstChild) {
56
+ this.dom.replaceChild(dom, this.dom.firstChild);
57
+ } else {
58
+ this.dom.appendChild(dom);
59
+ }
60
+ this.node = node;
61
+ return true;
62
+ }
63
+ }, {
64
+ key: "ignoreMutation",
65
+ value: function ignoreMutation() {
66
+ return true;
67
+ }
68
+ }, {
69
+ key: "destroy",
70
+ value: function destroy() {
71
+ this.unbindMousedown();
72
+ }
73
+ }]);
74
+ }();
@@ -0,0 +1,36 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = exports.createPlugin = void 0;
7
+ var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
8
+ var _selection = require("@atlaskit/editor-common/selection");
9
+ var _RuleNodeView = require("../node-views/RuleNodeView");
10
+ var selectRuleOnClick = (0, _selection.createSelectionClickHandler)(['rule'], function (target) {
11
+ return !!target.closest('[data-rule-node-view]');
12
+ }, {
13
+ useLongPressSelection: false
14
+ });
15
+ var createPlugin = exports.createPlugin = function createPlugin() {
16
+ return new _safePlugin.SafePlugin({
17
+ props: {
18
+ nodeViews: {
19
+ rule: function rule(node, view) {
20
+ return new _RuleNodeView.RuleNodeView(node, view);
21
+ }
22
+ },
23
+ handleClickOn: function handleClickOn(view) {
24
+ for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
25
+ args[_key - 1] = arguments[_key];
26
+ }
27
+ var handled = selectRuleOnClick.apply(void 0, [view].concat(args));
28
+ if (handled && view.editable) {
29
+ view.focus();
30
+ }
31
+ return handled;
32
+ }
33
+ }
34
+ });
35
+ };
36
+ var _default = exports.default = createPlugin;
@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
6
6
  });
7
7
  exports.rulePlugin = void 0;
8
8
  var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
9
+ var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
9
10
  var _react = _interopRequireDefault(require("react"));
10
11
  var _rule = require("@atlaskit/adf-schema/rule");
11
12
  var _enums = require("@atlaskit/editor-common/analytics/types/enums");
@@ -16,6 +17,7 @@ var _fg = require("@atlaskit/platform-feature-flags/fg");
16
17
  var _commands = require("./pm-plugins/commands");
17
18
  var _inputRule = _interopRequireDefault(require("./pm-plugins/input-rule"));
18
19
  var _keymap = _interopRequireDefault(require("./pm-plugins/keymap"));
20
+ var _main = _interopRequireDefault(require("./pm-plugins/main"));
19
21
  var _getRuleQuickInsertComponents = require("./ui/quick-insert/getRuleQuickInsertComponents");
20
22
  var _toolbar = require("./ui/toolbar");
21
23
  function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -45,7 +47,10 @@ var rulePlugin = exports.rulePlugin = function rulePlugin(_ref) {
45
47
  insertHorizontalRule: (0, _commands.insertHorizontalRule)(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions)
46
48
  },
47
49
  pmPlugins: function pmPlugins() {
48
- return [{
50
+ return [].concat((0, _toConsumableArray2.default)((0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_lovability_dividers') ? [{
51
+ name: 'ruleNodeView',
52
+ plugin: _main.default
53
+ }] : []), [{
49
54
  name: 'ruleInputRule',
50
55
  plugin: function plugin(_ref2) {
51
56
  var _api$analytics2;
@@ -58,7 +63,7 @@ var rulePlugin = exports.rulePlugin = function rulePlugin(_ref) {
58
63
  var _api$analytics3;
59
64
  return (0, _keymap.default)(api === null || api === void 0 || (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 ? void 0 : _api$analytics3.actions);
60
65
  }
61
- }];
66
+ }]);
62
67
  },
63
68
  pluginsOptions: _objectSpread(_objectSpread({}, (0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_lovability_dividers') ? {
64
69
  floatingToolbar: function floatingToolbar(state, intl) {
@@ -0,0 +1,57 @@
1
+ import _defineProperty from "@babel/runtime/helpers/defineProperty";
2
+ import { bind } from 'bind-event-listener';
3
+ import { DOMSerializer } from '@atlaskit/editor-prosemirror/model';
4
+ const ruleNodeViewAttribute = 'data-rule-node-view';
5
+ export class RuleNodeView {
6
+ constructor(node, view) {
7
+ // when there is only 1 rule node on the page and it is not editable, clicking on it does not focus the editor and Cmd+C/ Ctrl+C shortcut will not work. this mouse down listener adds focus to the editor.
8
+ _defineProperty(this, "handleMousedown", () => {
9
+ if (!this.view.hasFocus()) {
10
+ this.view.focus();
11
+ }
12
+ });
13
+ this.node = node;
14
+ this.view = view;
15
+ const dom = this.view.dom.ownerDocument.createElement('div');
16
+ this.dom = dom;
17
+ dom.setAttribute(ruleNodeViewAttribute, '');
18
+ dom.setAttribute('contenteditable', 'inherit');
19
+ this.unbindMousedown = bind(dom, {
20
+ type: 'mousedown',
21
+ listener: this.handleMousedown
22
+ });
23
+ this.update(node);
24
+ }
25
+ update(node) {
26
+ if (node.type !== this.node.type) {
27
+ return false;
28
+ }
29
+ if (this.dom.firstChild && node.sameMarkup(this.node)) {
30
+ this.node = node;
31
+ return true;
32
+ }
33
+ const toDOM = node.type.spec.toDOM;
34
+ if (!toDOM) {
35
+ return false;
36
+ }
37
+ const {
38
+ dom
39
+ } = DOMSerializer.renderSpec(this.view.dom.ownerDocument, toDOM(node));
40
+ if (dom instanceof HTMLElement) {
41
+ dom.contentEditable = 'false';
42
+ }
43
+ if (this.dom.firstChild) {
44
+ this.dom.replaceChild(dom, this.dom.firstChild);
45
+ } else {
46
+ this.dom.appendChild(dom);
47
+ }
48
+ this.node = node;
49
+ return true;
50
+ }
51
+ ignoreMutation() {
52
+ return true;
53
+ }
54
+ destroy() {
55
+ this.unbindMousedown();
56
+ }
57
+ }
@@ -0,0 +1,21 @@
1
+ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
2
+ import { createSelectionClickHandler } from '@atlaskit/editor-common/selection';
3
+ import { RuleNodeView } from '../node-views/RuleNodeView';
4
+ const selectRuleOnClick = createSelectionClickHandler(['rule'], target => !!target.closest('[data-rule-node-view]'), {
5
+ useLongPressSelection: false
6
+ });
7
+ export const createPlugin = () => new SafePlugin({
8
+ props: {
9
+ nodeViews: {
10
+ rule: (node, view) => new RuleNodeView(node, view)
11
+ },
12
+ handleClickOn(view, ...args) {
13
+ const handled = selectRuleOnClick(view, ...args);
14
+ if (handled && view.editable) {
15
+ view.focus();
16
+ }
17
+ return handled;
18
+ }
19
+ }
20
+ });
21
+ export default createPlugin;
@@ -12,6 +12,7 @@ import inputRulePlugin from './pm-plugins/input-rule';
12
12
  // Ignored via go/ees005
13
13
  // eslint-disable-next-line import/no-named-as-default
14
14
  import keymapPlugin from './pm-plugins/keymap';
15
+ import ruleNodeViewPlugin from './pm-plugins/main';
15
16
  import { getRuleQuickInsertComponents } from './ui/quick-insert/getRuleQuickInsertComponents';
16
17
  import { getToolbarConfig } from './ui/toolbar';
17
18
  export const rulePlugin = ({
@@ -37,7 +38,10 @@ export const rulePlugin = ({
37
38
  insertHorizontalRule: insertHorizontalRule(api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions)
38
39
  },
39
40
  pmPlugins() {
40
- return [{
41
+ return [...(isExperimentEnabled('platform_editor_lovability_dividers') ? [{
42
+ name: 'ruleNodeView',
43
+ plugin: ruleNodeViewPlugin
44
+ }] : []), {
41
45
  name: 'ruleInputRule',
42
46
  plugin: ({
43
47
  schema
@@ -0,0 +1,67 @@
1
+ import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
2
+ import _createClass from "@babel/runtime/helpers/createClass";
3
+ import _defineProperty from "@babel/runtime/helpers/defineProperty";
4
+ import { bind } from 'bind-event-listener';
5
+ import { DOMSerializer } from '@atlaskit/editor-prosemirror/model';
6
+ var ruleNodeViewAttribute = 'data-rule-node-view';
7
+ export var RuleNodeView = /*#__PURE__*/function () {
8
+ function RuleNodeView(node, view) {
9
+ var _this = this;
10
+ _classCallCheck(this, RuleNodeView);
11
+ // when there is only 1 rule node on the page and it is not editable, clicking on it does not focus the editor and Cmd+C/ Ctrl+C shortcut will not work. this mouse down listener adds focus to the editor.
12
+ _defineProperty(this, "handleMousedown", function () {
13
+ if (!_this.view.hasFocus()) {
14
+ _this.view.focus();
15
+ }
16
+ });
17
+ this.node = node;
18
+ this.view = view;
19
+ var dom = this.view.dom.ownerDocument.createElement('div');
20
+ this.dom = dom;
21
+ dom.setAttribute(ruleNodeViewAttribute, '');
22
+ dom.setAttribute('contenteditable', 'inherit');
23
+ this.unbindMousedown = bind(dom, {
24
+ type: 'mousedown',
25
+ listener: this.handleMousedown
26
+ });
27
+ this.update(node);
28
+ }
29
+ return _createClass(RuleNodeView, [{
30
+ key: "update",
31
+ value: function update(node) {
32
+ if (node.type !== this.node.type) {
33
+ return false;
34
+ }
35
+ if (this.dom.firstChild && node.sameMarkup(this.node)) {
36
+ this.node = node;
37
+ return true;
38
+ }
39
+ var toDOM = node.type.spec.toDOM;
40
+ if (!toDOM) {
41
+ return false;
42
+ }
43
+ var _DOMSerializer$render = DOMSerializer.renderSpec(this.view.dom.ownerDocument, toDOM(node)),
44
+ dom = _DOMSerializer$render.dom;
45
+ if (dom instanceof HTMLElement) {
46
+ dom.contentEditable = 'false';
47
+ }
48
+ if (this.dom.firstChild) {
49
+ this.dom.replaceChild(dom, this.dom.firstChild);
50
+ } else {
51
+ this.dom.appendChild(dom);
52
+ }
53
+ this.node = node;
54
+ return true;
55
+ }
56
+ }, {
57
+ key: "ignoreMutation",
58
+ value: function ignoreMutation() {
59
+ return true;
60
+ }
61
+ }, {
62
+ key: "destroy",
63
+ value: function destroy() {
64
+ this.unbindMousedown();
65
+ }
66
+ }]);
67
+ }();
@@ -0,0 +1,30 @@
1
+ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
2
+ import { createSelectionClickHandler } from '@atlaskit/editor-common/selection';
3
+ import { RuleNodeView } from '../node-views/RuleNodeView';
4
+ var selectRuleOnClick = createSelectionClickHandler(['rule'], function (target) {
5
+ return !!target.closest('[data-rule-node-view]');
6
+ }, {
7
+ useLongPressSelection: false
8
+ });
9
+ export var createPlugin = function createPlugin() {
10
+ return new SafePlugin({
11
+ props: {
12
+ nodeViews: {
13
+ rule: function rule(node, view) {
14
+ return new RuleNodeView(node, view);
15
+ }
16
+ },
17
+ handleClickOn: function handleClickOn(view) {
18
+ for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
19
+ args[_key - 1] = arguments[_key];
20
+ }
21
+ var handled = selectRuleOnClick.apply(void 0, [view].concat(args));
22
+ if (handled && view.editable) {
23
+ view.focus();
24
+ }
25
+ return handled;
26
+ }
27
+ }
28
+ });
29
+ };
30
+ export default createPlugin;
@@ -1,4 +1,5 @@
1
1
  import _defineProperty from "@babel/runtime/helpers/defineProperty";
2
+ import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
2
3
  function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
3
4
  function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
4
5
  import React from 'react';
@@ -15,6 +16,7 @@ import inputRulePlugin from './pm-plugins/input-rule';
15
16
  // Ignored via go/ees005
16
17
  // eslint-disable-next-line import/no-named-as-default
17
18
  import keymapPlugin from './pm-plugins/keymap';
19
+ import ruleNodeViewPlugin from './pm-plugins/main';
18
20
  import { getRuleQuickInsertComponents } from './ui/quick-insert/getRuleQuickInsertComponents';
19
21
  import { getToolbarConfig } from './ui/toolbar';
20
22
  export var rulePlugin = function rulePlugin(_ref) {
@@ -39,7 +41,10 @@ export var rulePlugin = function rulePlugin(_ref) {
39
41
  insertHorizontalRule: insertHorizontalRule(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions)
40
42
  },
41
43
  pmPlugins: function pmPlugins() {
42
- return [{
44
+ return [].concat(_toConsumableArray(isExperimentEnabled('platform_editor_lovability_dividers') ? [{
45
+ name: 'ruleNodeView',
46
+ plugin: ruleNodeViewPlugin
47
+ }] : []), [{
43
48
  name: 'ruleInputRule',
44
49
  plugin: function plugin(_ref2) {
45
50
  var _api$analytics2;
@@ -52,7 +57,7 @@ export var rulePlugin = function rulePlugin(_ref) {
52
57
  var _api$analytics3;
53
58
  return keymapPlugin(api === null || api === void 0 || (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 ? void 0 : _api$analytics3.actions);
54
59
  }
55
- }];
60
+ }]);
56
61
  },
57
62
  pluginsOptions: _objectSpread(_objectSpread({}, isExperimentEnabled('platform_editor_lovability_dividers') ? {
58
63
  floatingToolbar: function floatingToolbar(state, intl) {
@@ -0,0 +1,13 @@
1
+ import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
2
+ import type { EditorView, NodeView } from '@atlaskit/editor-prosemirror/view';
3
+ export declare class RuleNodeView implements NodeView {
4
+ dom: Node;
5
+ private node;
6
+ private readonly view;
7
+ private readonly handleMousedown;
8
+ private readonly unbindMousedown;
9
+ constructor(node: PMNode, view: EditorView);
10
+ update(node: PMNode): boolean;
11
+ ignoreMutation(): boolean;
12
+ destroy(): void;
13
+ }
@@ -0,0 +1,3 @@
1
+ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
2
+ export declare const createPlugin: () => SafePlugin;
3
+ export default createPlugin;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-rule",
3
- "version": "30.0.1",
3
+ "version": "30.0.2",
4
4
  "description": "Rule plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -37,6 +37,7 @@
37
37
  "@atlaskit/tokens": "^20.9.0",
38
38
  "@babel/runtime": "^7.0.0",
39
39
  "@compiled/react": "^1.0.2",
40
+ "bind-event-listener": "^3.0.0",
40
41
  "react-intl": "^7.0.0"
41
42
  },
42
43
  "peerDependencies": {