@atlaskit/editor-plugin-placeholder-text 0.1.0

package/dist/types/types.d.ts

@@ -0,0 +1,22 @@
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
+import type { showPlaceholderFloatingToolbar } from './actions';
+export interface PlaceholderTextOptions {
+    allowInserting?: boolean;
+}
+export interface PlaceholderTextPluginState {
+    showInsertPanelAt: number | null;
+    allowInserting: boolean;
+}
+export type PlaceholderTextPlugin = NextEditorPlugin<'placeholderText', {
+    dependencies: [
+        OptionalPlugin<typeof analyticsPlugin>,
+        OptionalPlugin<TypeAheadPlugin>
+    ];
+    pluginConfiguration: PlaceholderTextOptions;
+    sharedState: PlaceholderTextPluginState | undefined;
+    actions: {
+        showPlaceholderFloatingToolbar: typeof showPlaceholderFloatingToolbar;
+    };
+}>;

package/dist/types/ui/FloatingToolbar/index.d.ts

@@ -0,0 +1,28 @@
+/** @jsx jsx */
+import { PureComponent } from 'react';
+import { jsx } from '@emotion/react';
+export type Coordinates = {
+    left?: number;
+    right?: number;
+    top?: number;
+    bottom?: number;
+};
+export type PositionOffset = Coordinates;
+export interface Props {
+    zIndex?: number;
+    className?: string;
+    target?: HTMLElement;
+    popupsMountPoint?: HTMLElement;
+    popupsBoundariesElement?: HTMLElement;
+    offset?: number[];
+    fitWidth?: number;
+    fitHeight?: number;
+    absoluteOffset?: PositionOffset;
+    alignX?: 'left' | 'center' | 'right';
+    alignY?: 'bottom' | 'top';
+    onPositionCalculated?: (position: Coordinates) => Coordinates;
+}
+export { handlePositionCalculatedWith, getOffsetParent, getNearestNonTextNode, } from './utils';
+export default class FloatingToolbar extends PureComponent<Props, unknown> {
+    render(): jsx.JSX.Element | null;
+}

package/dist/types/ui/FloatingToolbar/styles.d.ts

@@ -0,0 +1 @@
+export declare const container: (height?: number) => import("@emotion/react").SerializedStyles;

package/dist/types/ui/FloatingToolbar/utils.d.ts

@@ -0,0 +1,18 @@
+export declare const getOffsetParent: (editorViewDom: HTMLElement, popupsMountPoint?: HTMLElement) => HTMLElement;
+export declare const getNearestNonTextNode: (node: Node) => HTMLElement;
+export declare const handlePositionCalculatedWith: (offsetParent: HTMLElement, node: Node, getCurrentFixedCoordinates: () => {
+    top?: number;
+    left?: number;
+    bottom?: number;
+    right?: number;
+}) => (position: {
+    top?: number;
+    left?: number;
+    bottom?: number;
+    right?: number;
+}) => {
+    top?: number | undefined;
+    left?: number | undefined;
+    bottom?: number | undefined;
+    right?: number | undefined;
+};

package/dist/types/ui/PlaceholderFloatingToolbar/index.d.ts

@@ -0,0 +1,25 @@
+import React from 'react';
+import type { WrappedComponentProps } from 'react-intl-next';
+import type { Coordinates } from '../FloatingToolbar';
+export declare const messages: {
+    placeholderTextPlaceholder: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export interface Props {
+    getNodeFromPos: (pos: number) => Node;
+    getFixedCoordinatesFromPos: (pos: number) => Coordinates;
+    insertPlaceholder: (value: string) => void;
+    hidePlaceholderFloatingToolbar: () => void;
+    setFocusInEditor: () => void;
+    showInsertPanelAt: number;
+    editorViewDOM: HTMLElement;
+    popupsMountPoint?: HTMLElement;
+    popupsBoundariesElement?: HTMLElement;
+}
+declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps<"intl">>> & {
+    WrappedComponent: React.ComponentType<Props & WrappedComponentProps<"intl">>;
+};
+export default _default;

package/dist/types-ts4.5/actions.d.ts

@@ -0,0 +1,4 @@
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare const showPlaceholderFloatingToolbar: (state: EditorState, dispatch: (tr: Transaction) => void) => boolean;
+export declare const insertPlaceholderTextAtSelection: (value: string) => (state: EditorState, dispatch: (tr: Transaction) => void) => boolean;
+export declare const hidePlaceholderFloatingToolbar: (state: EditorState, dispatch: (tr: Transaction) => void) => boolean;

package/dist/types-ts4.5/fake-text-cursor/cursor.d.ts

@@ -0,0 +1,30 @@
+import type { Node, ResolvedPos } from '@atlaskit/editor-prosemirror/model';
+import { Slice } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState, SelectionBookmark, Transaction } from '@atlaskit/editor-prosemirror/state';
+import { Selection } from '@atlaskit/editor-prosemirror/state';
+import type { Mappable } from '@atlaskit/editor-prosemirror/transform';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+export declare class FakeTextCursorBookmark {
+    pos: undefined | number;
+    visible: boolean;
+    constructor(pos: number);
+    map(mapping: Mappable): FakeTextCursorBookmark;
+    resolve(doc: Node): Selection;
+}
+export declare class FakeTextCursorSelection extends Selection {
+    constructor($pos: ResolvedPos);
+    map(doc: Node, mapping: Mappable): Selection;
+    static content(): Slice;
+    eq(other: Selection): boolean;
+    toJSON(): {
+        type: string;
+        pos: number;
+    };
+    static fromJSON(doc: Node, json: {
+        pos: number;
+    }): Selection;
+    getBookmark(): SelectionBookmark;
+}
+export declare const addFakeTextCursor: (state: EditorState, dispatch: (tr: Transaction) => void) => void;
+export declare const removeFakeTextCursor: (state: EditorState, dispatch: (tr: Transaction) => void) => void;
+export declare const drawFakeTextCursor: (state: EditorState) => DecorationSet | null;

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

@@ -0,0 +1,2 @@
+export { default as placeholderTextPlugin } from './plugin';
+export type { PlaceholderTextPlugin, PlaceholderTextPluginState, PlaceholderTextOptions, } from './types';

package/dist/types-ts4.5/placeholder-text-nodeview.d.ts

@@ -0,0 +1,17 @@
+import type { getPosHandler } from '@atlaskit/editor-common/react-node-view';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { EditorView, NodeView } from '@atlaskit/editor-prosemirror/view';
+type PmMutationRecord = MutationRecord | {
+    type: 'selection';
+    target: Element;
+};
+export declare class PlaceholderTextNodeView implements NodeView {
+    private readonly node;
+    private readonly view;
+    private readonly getPos;
+    readonly dom: Node;
+    constructor(node: PMNode, view: EditorView, getPos: getPosHandler);
+    stopEvent(e: Event): boolean;
+    ignoreMutation(record: PmMutationRecord): boolean;
+}
+export {};

package/dist/types-ts4.5/plugin-key.d.ts

@@ -0,0 +1,3 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { PlaceholderTextPluginState } from './types';
+export declare const pluginKey: PluginKey<PlaceholderTextPluginState>;

package/dist/types-ts4.5/plugin.d.ts

@@ -0,0 +1,7 @@
+import type { Dispatch } from '@atlaskit/editor-common/event-dispatcher';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { PlaceholderTextOptions, PlaceholderTextPlugin, PlaceholderTextPluginState } from './types';
+export declare function createPlugin(dispatch: Dispatch<PlaceholderTextPluginState>, options: PlaceholderTextOptions, api: ExtractInjectionAPI<PlaceholderTextPlugin> | undefined): SafePlugin | undefined;
+declare const placeholderTextPlugin: PlaceholderTextPlugin;
+export default placeholderTextPlugin;

package/dist/types-ts4.5/selection-utils.d.ts

@@ -0,0 +1,2 @@
+import type { Selection } from '@atlaskit/editor-prosemirror/state';
+export declare const isSelectionAtPlaceholder: (selection: Selection) => boolean;

package/dist/types-ts4.5/styles.d.ts

@@ -0,0 +1 @@
+export declare const placeholderTextStyles: import("@emotion/react").SerializedStyles;

package/dist/types-ts4.5/types.d.ts

@@ -0,0 +1,22 @@
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
+import type { showPlaceholderFloatingToolbar } from './actions';
+export interface PlaceholderTextOptions {
+    allowInserting?: boolean;
+}
+export interface PlaceholderTextPluginState {
+    showInsertPanelAt: number | null;
+    allowInserting: boolean;
+}
+export type PlaceholderTextPlugin = NextEditorPlugin<'placeholderText', {
+    dependencies: [
+        OptionalPlugin<typeof analyticsPlugin>,
+        OptionalPlugin<TypeAheadPlugin>
+    ];
+    pluginConfiguration: PlaceholderTextOptions;
+    sharedState: PlaceholderTextPluginState | undefined;
+    actions: {
+        showPlaceholderFloatingToolbar: typeof showPlaceholderFloatingToolbar;
+    };
+}>;

package/dist/types-ts4.5/ui/FloatingToolbar/index.d.ts

@@ -0,0 +1,28 @@
+/** @jsx jsx */
+import { PureComponent } from 'react';
+import { jsx } from '@emotion/react';
+export type Coordinates = {
+    left?: number;
+    right?: number;
+    top?: number;
+    bottom?: number;
+};
+export type PositionOffset = Coordinates;
+export interface Props {
+    zIndex?: number;
+    className?: string;
+    target?: HTMLElement;
+    popupsMountPoint?: HTMLElement;
+    popupsBoundariesElement?: HTMLElement;
+    offset?: number[];
+    fitWidth?: number;
+    fitHeight?: number;
+    absoluteOffset?: PositionOffset;
+    alignX?: 'left' | 'center' | 'right';
+    alignY?: 'bottom' | 'top';
+    onPositionCalculated?: (position: Coordinates) => Coordinates;
+}
+export { handlePositionCalculatedWith, getOffsetParent, getNearestNonTextNode, } from './utils';
+export default class FloatingToolbar extends PureComponent<Props, unknown> {
+    render(): jsx.JSX.Element | null;
+}

package/dist/types-ts4.5/ui/FloatingToolbar/styles.d.ts

@@ -0,0 +1 @@
+export declare const container: (height?: number) => import("@emotion/react").SerializedStyles;

package/dist/types-ts4.5/ui/FloatingToolbar/utils.d.ts

@@ -0,0 +1,18 @@
+export declare const getOffsetParent: (editorViewDom: HTMLElement, popupsMountPoint?: HTMLElement) => HTMLElement;
+export declare const getNearestNonTextNode: (node: Node) => HTMLElement;
+export declare const handlePositionCalculatedWith: (offsetParent: HTMLElement, node: Node, getCurrentFixedCoordinates: () => {
+    top?: number;
+    left?: number;
+    bottom?: number;
+    right?: number;
+}) => (position: {
+    top?: number;
+    left?: number;
+    bottom?: number;
+    right?: number;
+}) => {
+    top?: number | undefined;
+    left?: number | undefined;
+    bottom?: number | undefined;
+    right?: number | undefined;
+};

package/dist/types-ts4.5/ui/PlaceholderFloatingToolbar/index.d.ts

@@ -0,0 +1,25 @@
+import React from 'react';
+import type { WrappedComponentProps } from 'react-intl-next';
+import type { Coordinates } from '../FloatingToolbar';
+export declare const messages: {
+    placeholderTextPlaceholder: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export interface Props {
+    getNodeFromPos: (pos: number) => Node;
+    getFixedCoordinatesFromPos: (pos: number) => Coordinates;
+    insertPlaceholder: (value: string) => void;
+    hidePlaceholderFloatingToolbar: () => void;
+    setFocusInEditor: () => void;
+    showInsertPanelAt: number;
+    editorViewDOM: HTMLElement;
+    popupsMountPoint?: HTMLElement;
+    popupsBoundariesElement?: HTMLElement;
+}
+declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps<"intl">>> & {
+    WrappedComponent: React.ComponentType<Props & WrappedComponentProps<"intl">>;
+};
+export default _default;

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@atlaskit/editor-plugin-placeholder-text",
+  "version": "0.1.0",
+  "description": "placeholder text plugin for @atlaskit/editor-core",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "module:es2019": "dist/es2019/index.js",
+  "types": "dist/types/index.d.ts",
+  "sideEffects": false,
+  "atlaskit:src": "src/index.ts",
+  "atlassian": {
+    "team": "Editor: Scarlet",
+    "inPublicMirror": false,
+    "releaseModel": "continuous"
+  },
+  "dependencies": {
+    "@atlaskit/adf-schema": "^32.0.0",
+    "@atlaskit/editor-common": "^76.18.0",
+    "@atlaskit/editor-plugin-analytics": "^0.3.0",
+    "@atlaskit/editor-plugin-type-ahead": "^0.7.0",
+    "@atlaskit/editor-prosemirror": "1.1.0",
+    "@atlaskit/editor-shared-styles": "^2.8.0",
+    "@atlaskit/icon": "^21.12.0",
+    "@atlaskit/theme": "^12.6.0",
+    "@atlaskit/tokens": "^1.28.0",
+    "@babel/runtime": "^7.0.0",
+    "@emotion/react": "^11.7.1"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0",
+    "react-intl-next": "npm:react-intl@^5.18.1"
+  },
+  "devDependencies": {
+    "@af/visual-regression": "*",
+    "@atlaskit/analytics-next": "^9.1.0",
+    "@atlaskit/editor-plugin-floating-toolbar": "^0.7.0",
+    "@atlaskit/ssr": "*",
+    "@atlaskit/visual-regression": "*",
+    "@atlaskit/webdriver-runner": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "@testing-library/react": "^12.1.5",
+    "react-dom": "^16.8.0",
+    "typescript": "~4.9.5",
+    "wait-for-expect": "^1.2.0"
+  },
+  "techstack": {
+    "@atlassian/frontend": {
+      "import-structure": [
+        "atlassian-conventions"
+      ],
+      "circular-dependencies": [
+        "file-and-folder-level"
+      ]
+    },
+    "@repo/internal": {
+      "dom-events": "use-bind-event-listener",
+      "analytics": [
+        "analytics-next"
+      ],
+      "design-tokens": [
+        "color"
+      ],
+      "theming": [
+        "react-context"
+      ],
+      "ui-components": [
+        "lite-mode"
+      ],
+      "deprecation": [
+        "no-deprecated-imports"
+      ],
+      "styling": [
+        "static",
+        "emotion"
+      ],
+      "imports": [
+        "import-no-extraneous-disable-for-examples-and-docs"
+      ]
+    }
+  },
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
+  "af:exports": {
+    ".": "./src/index.ts",
+    "./styles": "./src/styles.ts"
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
+}

package/report.api.md

@@ -0,0 +1,80 @@
+<!-- API Report Version: 2.3 -->
+
+## API Report File for "@atlaskit/editor-plugin-placeholder-text"
+
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
+
+```ts
+import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
+
+// @public (undocumented)
+export interface PlaceholderTextOptions {
+  // (undocumented)
+  allowInserting?: boolean;
+}
+
+// @public (undocumented)
+export type PlaceholderTextPlugin = NextEditorPlugin<
+  'placeholderText',
+  {
+    dependencies: [
+      OptionalPlugin<typeof analyticsPlugin>,
+      OptionalPlugin<TypeAheadPlugin>,
+    ];
+    pluginConfiguration: PlaceholderTextOptions;
+    sharedState: PlaceholderTextPluginState | undefined;
+    actions: {
+      showPlaceholderFloatingToolbar: typeof showPlaceholderFloatingToolbar;
+    };
+  }
+>;
+
+// @public (undocumented)
+export const placeholderTextPlugin: PlaceholderTextPlugin;
+
+// @public (undocumented)
+export interface PlaceholderTextPluginState {
+  // (undocumented)
+  allowInserting: boolean;
+  // (undocumented)
+  showInsertPanelAt: null | number;
+}
+
+// @public (undocumented)
+const showPlaceholderFloatingToolbar: (
+  state: EditorState,
+  dispatch: (tr: Transaction) => void,
+) => boolean;
+
+// (No @packageDocumentation comment for this package)
+```
+
+<!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{
+  "react": "^16.8.0",
+  "react-intl-next": "npm:react-intl@^5.18.1"
+}
+```
+
+<!--SECTION END: Peer Dependencies-->

package/styles/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/editor-plugin-placeholder-text/styles",
+  "main": "../dist/cjs/styles.js",
+  "module": "../dist/esm/styles.js",
+  "module:es2019": "../dist/es2019/styles.js",
+  "sideEffects": false,
+  "types": "../dist/types/styles.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "../dist/types-ts4.5/styles.d.ts"
+      ]
+    }
+  }
+}

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,49 @@
+## API Report File for "@atlaskit/editor-plugin-placeholder-text"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
+
+// @public (undocumented)
+export interface PlaceholderTextOptions {
+    // (undocumented)
+    allowInserting?: boolean;
+}
+
+// @public (undocumented)
+export type PlaceholderTextPlugin = NextEditorPlugin<'placeholderText', {
+    dependencies: [
+    OptionalPlugin<typeof analyticsPlugin>,
+    OptionalPlugin<TypeAheadPlugin>
+    ];
+    pluginConfiguration: PlaceholderTextOptions;
+    sharedState: PlaceholderTextPluginState | undefined;
+    actions: {
+        showPlaceholderFloatingToolbar: typeof showPlaceholderFloatingToolbar;
+    };
+}>;
+
+// @public (undocumented)
+export const placeholderTextPlugin: PlaceholderTextPlugin;
+
+// @public (undocumented)
+export interface PlaceholderTextPluginState {
+    // (undocumented)
+    allowInserting: boolean;
+    // (undocumented)
+    showInsertPanelAt: null | number;
+}
+
+// @public (undocumented)
+const showPlaceholderFloatingToolbar: (state: EditorState, dispatch: (tr: Transaction) => void) => boolean;
+
+// (No @packageDocumentation comment for this package)
+
+```