@atlaskit/editor-core 187.38.2 → 187.38.3

package/dist/es2019/plugins/placeholder/index.js

@@ -1,123 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { browser, isEmptyDocument, bracketTyped } from '@atlaskit/editor-common/utils';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { DecorationSet, Decoration } from '@atlaskit/editor-prosemirror/view';
-export const pluginKey = new PluginKey('placeholderPlugin');
-function getPlaceholderState(editorState) {
-  return pluginKey.getState(editorState);
-}
-export const placeholderTestId = 'placeholder-test-id';
-export function createPlaceholderDecoration(editorState, placeholderText, pos = 1) {
-  const placeholderDecoration = document.createElement('span');
-  let placeholderNodeWithText = placeholderDecoration;
-  placeholderDecoration.setAttribute('data-testid', placeholderTestId);
-  placeholderDecoration.className = 'placeholder-decoration';
-
-  // PM sets contenteditable to false on Decorations so Firefox doesn't display the flashing cursor
-  // So adding an extra span which will contain the placeholder text
-  if (browser.gecko) {
-    const placeholderNode = document.createElement('span');
-    placeholderNode.setAttribute('contenteditable', 'true'); // explicitly overriding the default Decoration behaviour
-    placeholderDecoration.appendChild(placeholderNode);
-    placeholderNodeWithText = placeholderNode;
-  }
-  placeholderNodeWithText.textContent = placeholderText || ' ';
-
-  // ME-2289 Tapping on backspace in empty editor hides and displays the keyboard
-  // Add a editable buff node as the cursor moving forward is inevitable
-  // when backspace in GBoard composition
-  if (browser.android && browser.chrome) {
-    const buffNode = document.createElement('span');
-    buffNode.setAttribute('class', 'placeholder-android');
-    buffNode.setAttribute('contenteditable', 'true');
-    buffNode.textContent = ' ';
-    placeholderDecoration.appendChild(buffNode);
-  }
-  return DecorationSet.create(editorState.doc, [Decoration.widget(pos, placeholderDecoration, {
-    side: 0,
-    key: 'placeholder'
-  })]);
-}
-function setPlaceHolderState(placeholderText, pos) {
-  return {
-    hasPlaceholder: true,
-    placeholderText,
-    pos: pos ? pos : 1
-  };
-}
-const emptyPlaceholder = {
-  hasPlaceholder: false
-};
-function createPlaceHolderStateFrom(isEditorFocused, editorState, isTypeAheadOpen, defaultPlaceholderText, bracketPlaceholderText) {
-  if (isTypeAheadOpen !== null && isTypeAheadOpen !== void 0 && isTypeAheadOpen(editorState)) {
-    return emptyPlaceholder;
-  }
-  if (defaultPlaceholderText && isEmptyDocument(editorState.doc)) {
-    return setPlaceHolderState(defaultPlaceholderText);
-  }
-  if (bracketPlaceholderText && bracketTyped(editorState) && isEditorFocused) {
-    const {
-      $from
-    } = editorState.selection;
-    // Space is to account for positioning of the bracket
-    const bracketHint = '  ' + bracketPlaceholderText;
-    return setPlaceHolderState(bracketHint, $from.pos - 1);
-  }
-  return emptyPlaceholder;
-}
-export function createPlugin(defaultPlaceholderText, bracketPlaceholderText, api) {
-  if (!defaultPlaceholderText && !bracketPlaceholderText) {
-    return;
-  }
-  return new SafePlugin({
-    key: pluginKey,
-    state: {
-      init: (_, state) => {
-        var _api$focus, _api$focus$sharedStat;
-        return createPlaceHolderStateFrom(Boolean(api === null || api === void 0 ? void 0 : (_api$focus = api.focus) === null || _api$focus === void 0 ? void 0 : (_api$focus$sharedStat = _api$focus.sharedState.currentState()) === null || _api$focus$sharedStat === void 0 ? void 0 : _api$focus$sharedStat.hasFocus), state, api === null || api === void 0 ? void 0 : api.typeAhead.actions.isOpen, defaultPlaceholderText, bracketPlaceholderText);
-      },
-      apply: (tr, _oldPluginState, _oldEditorState, newEditorState) => {
-        var _api$focus2, _api$focus2$sharedSta;
-        const meta = tr.getMeta(pluginKey);
-        const isEditorFocused = Boolean(api === null || api === void 0 ? void 0 : (_api$focus2 = api.focus) === null || _api$focus2 === void 0 ? void 0 : (_api$focus2$sharedSta = _api$focus2.sharedState.currentState()) === null || _api$focus2$sharedSta === void 0 ? void 0 : _api$focus2$sharedSta.hasFocus);
-        if (meta) {
-          if (meta.removePlaceholder) {
-            return emptyPlaceholder;
-          }
-          if (meta.applyPlaceholderIfEmpty) {
-            return createPlaceHolderStateFrom(isEditorFocused, newEditorState, api === null || api === void 0 ? void 0 : api.typeAhead.actions.isOpen, defaultPlaceholderText, bracketPlaceholderText);
-          }
-        }
-        return createPlaceHolderStateFrom(isEditorFocused, newEditorState, api === null || api === void 0 ? void 0 : api.typeAhead.actions.isOpen, defaultPlaceholderText, bracketPlaceholderText);
-      }
-    },
-    props: {
-      decorations(editorState) {
-        var _api$composition;
-        const {
-          hasPlaceholder,
-          placeholderText,
-          pos
-        } = getPlaceholderState(editorState);
-        const compositionPluginState = api === null || api === void 0 ? void 0 : (_api$composition = api.composition) === null || _api$composition === void 0 ? void 0 : _api$composition.sharedState.currentState();
-        if (hasPlaceholder && placeholderText && pos !== undefined && !(compositionPluginState !== null && compositionPluginState !== void 0 && compositionPluginState.isComposing)) {
-          return createPlaceholderDecoration(editorState, placeholderText, pos);
-        }
-        return;
-      }
-    }
-  });
-}
-const placeholderPlugin = ({
-  config: options,
-  api
-}) => ({
-  name: 'placeholder',
-  pmPlugins() {
-    return [{
-      name: 'placeholder',
-      plugin: () => createPlugin(options && options.placeholder, options && options.placeholderBracketHint, api)
-    }];
-  }
-});
-export default placeholderPlugin;

package/dist/esm/plugins/placeholder/index.js

@@ -1,124 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { browser, isEmptyDocument, bracketTyped } from '@atlaskit/editor-common/utils';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { DecorationSet, Decoration } from '@atlaskit/editor-prosemirror/view';
-export var pluginKey = new PluginKey('placeholderPlugin');
-function getPlaceholderState(editorState) {
-  return pluginKey.getState(editorState);
-}
-export var placeholderTestId = 'placeholder-test-id';
-export function createPlaceholderDecoration(editorState, placeholderText) {
-  var pos = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 1;
-  var placeholderDecoration = document.createElement('span');
-  var placeholderNodeWithText = placeholderDecoration;
-  placeholderDecoration.setAttribute('data-testid', placeholderTestId);
-  placeholderDecoration.className = 'placeholder-decoration';
-
-  // PM sets contenteditable to false on Decorations so Firefox doesn't display the flashing cursor
-  // So adding an extra span which will contain the placeholder text
-  if (browser.gecko) {
-    var placeholderNode = document.createElement('span');
-    placeholderNode.setAttribute('contenteditable', 'true'); // explicitly overriding the default Decoration behaviour
-    placeholderDecoration.appendChild(placeholderNode);
-    placeholderNodeWithText = placeholderNode;
-  }
-  placeholderNodeWithText.textContent = placeholderText || ' ';
-
-  // ME-2289 Tapping on backspace in empty editor hides and displays the keyboard
-  // Add a editable buff node as the cursor moving forward is inevitable
-  // when backspace in GBoard composition
-  if (browser.android && browser.chrome) {
-    var buffNode = document.createElement('span');
-    buffNode.setAttribute('class', 'placeholder-android');
-    buffNode.setAttribute('contenteditable', 'true');
-    buffNode.textContent = ' ';
-    placeholderDecoration.appendChild(buffNode);
-  }
-  return DecorationSet.create(editorState.doc, [Decoration.widget(pos, placeholderDecoration, {
-    side: 0,
-    key: 'placeholder'
-  })]);
-}
-function setPlaceHolderState(placeholderText, pos) {
-  return {
-    hasPlaceholder: true,
-    placeholderText: placeholderText,
-    pos: pos ? pos : 1
-  };
-}
-var emptyPlaceholder = {
-  hasPlaceholder: false
-};
-function createPlaceHolderStateFrom(isEditorFocused, editorState, isTypeAheadOpen, defaultPlaceholderText, bracketPlaceholderText) {
-  if (isTypeAheadOpen !== null && isTypeAheadOpen !== void 0 && isTypeAheadOpen(editorState)) {
-    return emptyPlaceholder;
-  }
-  if (defaultPlaceholderText && isEmptyDocument(editorState.doc)) {
-    return setPlaceHolderState(defaultPlaceholderText);
-  }
-  if (bracketPlaceholderText && bracketTyped(editorState) && isEditorFocused) {
-    var $from = editorState.selection.$from;
-    // Space is to account for positioning of the bracket
-    var bracketHint = '  ' + bracketPlaceholderText;
-    return setPlaceHolderState(bracketHint, $from.pos - 1);
-  }
-  return emptyPlaceholder;
-}
-export function createPlugin(defaultPlaceholderText, bracketPlaceholderText, api) {
-  if (!defaultPlaceholderText && !bracketPlaceholderText) {
-    return;
-  }
-  return new SafePlugin({
-    key: pluginKey,
-    state: {
-      init: function init(_, state) {
-        var _api$focus, _api$focus$sharedStat;
-        return createPlaceHolderStateFrom(Boolean(api === null || api === void 0 ? void 0 : (_api$focus = api.focus) === null || _api$focus === void 0 ? void 0 : (_api$focus$sharedStat = _api$focus.sharedState.currentState()) === null || _api$focus$sharedStat === void 0 ? void 0 : _api$focus$sharedStat.hasFocus), state, api === null || api === void 0 ? void 0 : api.typeAhead.actions.isOpen, defaultPlaceholderText, bracketPlaceholderText);
-      },
-      apply: function apply(tr, _oldPluginState, _oldEditorState, newEditorState) {
-        var _api$focus2, _api$focus2$sharedSta;
-        var meta = tr.getMeta(pluginKey);
-        var isEditorFocused = Boolean(api === null || api === void 0 ? void 0 : (_api$focus2 = api.focus) === null || _api$focus2 === void 0 ? void 0 : (_api$focus2$sharedSta = _api$focus2.sharedState.currentState()) === null || _api$focus2$sharedSta === void 0 ? void 0 : _api$focus2$sharedSta.hasFocus);
-        if (meta) {
-          if (meta.removePlaceholder) {
-            return emptyPlaceholder;
-          }
-          if (meta.applyPlaceholderIfEmpty) {
-            return createPlaceHolderStateFrom(isEditorFocused, newEditorState, api === null || api === void 0 ? void 0 : api.typeAhead.actions.isOpen, defaultPlaceholderText, bracketPlaceholderText);
-          }
-        }
-        return createPlaceHolderStateFrom(isEditorFocused, newEditorState, api === null || api === void 0 ? void 0 : api.typeAhead.actions.isOpen, defaultPlaceholderText, bracketPlaceholderText);
-      }
-    },
-    props: {
-      decorations: function decorations(editorState) {
-        var _api$composition;
-        var _getPlaceholderState = getPlaceholderState(editorState),
-          hasPlaceholder = _getPlaceholderState.hasPlaceholder,
-          placeholderText = _getPlaceholderState.placeholderText,
-          pos = _getPlaceholderState.pos;
-        var compositionPluginState = api === null || api === void 0 ? void 0 : (_api$composition = api.composition) === null || _api$composition === void 0 ? void 0 : _api$composition.sharedState.currentState();
-        if (hasPlaceholder && placeholderText && pos !== undefined && !(compositionPluginState !== null && compositionPluginState !== void 0 && compositionPluginState.isComposing)) {
-          return createPlaceholderDecoration(editorState, placeholderText, pos);
-        }
-        return;
-      }
-    }
-  });
-}
-var placeholderPlugin = function placeholderPlugin(_ref) {
-  var options = _ref.config,
-    api = _ref.api;
-  return {
-    name: 'placeholder',
-    pmPlugins: function pmPlugins() {
-      return [{
-        name: 'placeholder',
-        plugin: function plugin() {
-          return createPlugin(options && options.placeholder, options && options.placeholderBracketHint, api);
-        }
-      }];
-    }
-  };
-};
-export default placeholderPlugin;

package/dist/types/plugins/placeholder/index.d.ts

@@ -1,22 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import type { NextEditorPlugin, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { FocusPlugin } from '@atlaskit/editor-plugin-focus';
-import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
-export declare const pluginKey: PluginKey<any>;
-import type { CompositionPlugin } from '@atlaskit/editor-plugin-composition';
-export declare const placeholderTestId = "placeholder-test-id";
-export declare function createPlaceholderDecoration(editorState: EditorState, placeholderText: string, pos?: number): DecorationSet;
-export declare function createPlugin(defaultPlaceholderText?: string, bracketPlaceholderText?: string, api?: ExtractInjectionAPI<PlaceholderPlugin>): SafePlugin | undefined;
-export interface PlaceholderPluginOptions {
-    placeholder?: string;
-    placeholderBracketHint?: string;
-}
-type PlaceholderPlugin = NextEditorPlugin<'placeholder', {
-    pluginConfiguration: PlaceholderPluginOptions | undefined;
-    dependencies: [FocusPlugin, CompositionPlugin, TypeAheadPlugin];
-}>;
-declare const placeholderPlugin: PlaceholderPlugin;
-export default placeholderPlugin;

package/dist/types-ts4.5/plugins/placeholder/index.d.ts

@@ -1,26 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import type { NextEditorPlugin, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { FocusPlugin } from '@atlaskit/editor-plugin-focus';
-import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
-export declare const pluginKey: PluginKey<any>;
-import type { CompositionPlugin } from '@atlaskit/editor-plugin-composition';
-export declare const placeholderTestId = "placeholder-test-id";
-export declare function createPlaceholderDecoration(editorState: EditorState, placeholderText: string, pos?: number): DecorationSet;
-export declare function createPlugin(defaultPlaceholderText?: string, bracketPlaceholderText?: string, api?: ExtractInjectionAPI<PlaceholderPlugin>): SafePlugin | undefined;
-export interface PlaceholderPluginOptions {
-    placeholder?: string;
-    placeholderBracketHint?: string;
-}
-type PlaceholderPlugin = NextEditorPlugin<'placeholder', {
-    pluginConfiguration: PlaceholderPluginOptions | undefined;
-    dependencies: [
-        FocusPlugin,
-        CompositionPlugin,
-        TypeAheadPlugin
-    ];
-}>;
-declare const placeholderPlugin: PlaceholderPlugin;
-export default placeholderPlugin;