@atlaskit/editor-plugin-placeholder-text 3.1.6 → 3.1.7

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-placeholder-text
 
+## 3.1.7
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
 ## 3.1.6
 
 ### Patch Changes

package/dist/types/placeholderTextPluginType.d.ts

@@ -12,18 +12,18 @@ export interface PlaceholderTextPluginOptions {
  */
 export type PlaceholderTextOptions = PlaceholderTextPluginOptions;
 export interface PlaceholderTextPluginState {
-    showInsertPanelAt: number | null;
     allowInserting: boolean;
+    showInsertPanelAt: number | null;
 }
 export type PlaceholderTextPluginDependencies = [
     OptionalPlugin<typeof analyticsPlugin>,
     OptionalPlugin<TypeAheadPlugin>
 ];
 export type PlaceholderTextPlugin = NextEditorPlugin<'placeholderText', {
-    dependencies: PlaceholderTextPluginDependencies;
-    pluginConfiguration: PlaceholderTextPluginOptions;
-    sharedState: PlaceholderTextPluginState | undefined;
     actions: {
         showPlaceholderFloatingToolbar: typeof showPlaceholderFloatingToolbar;
     };
+    dependencies: PlaceholderTextPluginDependencies;
+    pluginConfiguration: PlaceholderTextPluginOptions;
+    sharedState: PlaceholderTextPluginState | undefined;
 }>;

package/dist/types/pm-plugins/placeholder-text-nodeview.d.ts

@@ -2,8 +2,8 @@ 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: Node;
+    type: 'selection';
 };
 export declare class PlaceholderTextNodeView implements NodeView {
     private readonly node;

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

@@ -5,25 +5,25 @@
 import React from 'react';
 import { jsx } from '@emotion/react';
 export type Coordinates = {
+    bottom?: number;
     left?: number;
     right?: number;
     top?: number;
-    bottom?: number;
 };
 export type PositionOffset = Coordinates;
 export interface Props {
-    children?: React.ReactNode;
-    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';
+    children?: React.ReactNode;
+    className?: string;
+    fitHeight?: number;
+    fitWidth?: number;
+    offset?: number[];
     onPositionCalculated?: (position: Coordinates) => Coordinates;
+    popupsBoundariesElement?: HTMLElement;
+    popupsMountPoint?: HTMLElement;
+    target?: HTMLElement;
+    zIndex?: number;
 }
 export default function FloatingToolbar({ children, target, offset, fitWidth, fitHeight, onPositionCalculated, popupsMountPoint, popupsBoundariesElement, className, absoluteOffset, alignX, alignY, zIndex, }: Props): jsx.JSX.Element | null;

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

@@ -1,18 +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;
+    left?: number;
     right?: number;
-}) => (position: {
     top?: number;
-    left?: number;
+}) => (position: {
     bottom?: number;
+    left?: number;
     right?: number;
-}) => {
     top?: number;
-    left?: number;
+}) => {
     bottom?: number;
+    left?: number;
     right?: number;
+    top?: number;
 };

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

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

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

@@ -12,18 +12,18 @@ export interface PlaceholderTextPluginOptions {
  */
 export type PlaceholderTextOptions = PlaceholderTextPluginOptions;
 export interface PlaceholderTextPluginState {
-    showInsertPanelAt: number | null;
     allowInserting: boolean;
+    showInsertPanelAt: number | null;
 }
 export type PlaceholderTextPluginDependencies = [
     OptionalPlugin<typeof analyticsPlugin>,
     OptionalPlugin<TypeAheadPlugin>
 ];
 export type PlaceholderTextPlugin = NextEditorPlugin<'placeholderText', {
-    dependencies: PlaceholderTextPluginDependencies;
-    pluginConfiguration: PlaceholderTextPluginOptions;
-    sharedState: PlaceholderTextPluginState | undefined;
     actions: {
         showPlaceholderFloatingToolbar: typeof showPlaceholderFloatingToolbar;
     };
+    dependencies: PlaceholderTextPluginDependencies;
+    pluginConfiguration: PlaceholderTextPluginOptions;
+    sharedState: PlaceholderTextPluginState | undefined;
 }>;

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

@@ -2,8 +2,8 @@ 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: Node;
+    type: 'selection';
 };
 export declare class PlaceholderTextNodeView implements NodeView {
     private readonly node;

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

@@ -5,25 +5,25 @@
 import React from 'react';
 import { jsx } from '@emotion/react';
 export type Coordinates = {
+    bottom?: number;
     left?: number;
     right?: number;
     top?: number;
-    bottom?: number;
 };
 export type PositionOffset = Coordinates;
 export interface Props {
-    children?: React.ReactNode;
-    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';
+    children?: React.ReactNode;
+    className?: string;
+    fitHeight?: number;
+    fitWidth?: number;
+    offset?: number[];
     onPositionCalculated?: (position: Coordinates) => Coordinates;
+    popupsBoundariesElement?: HTMLElement;
+    popupsMountPoint?: HTMLElement;
+    target?: HTMLElement;
+    zIndex?: number;
 }
 export default function FloatingToolbar({ children, target, offset, fitWidth, fitHeight, onPositionCalculated, popupsMountPoint, popupsBoundariesElement, className, absoluteOffset, alignX, alignY, zIndex, }: Props): jsx.JSX.Element | null;

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

@@ -1,18 +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;
+    left?: number;
     right?: number;
-}) => (position: {
     top?: number;
-    left?: number;
+}) => (position: {
     bottom?: number;
+    left?: number;
     right?: number;
-}) => {
     top?: number;
-    left?: number;
+}) => {
     bottom?: number;
+    left?: number;
     right?: number;
+    top?: number;
 };

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-placeholder-text",
-	"version": "3.1.6",
+	"version": "3.1.7",
 	"description": "placeholder text plugin for @atlaskit/editor-core",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -39,7 +39,7 @@
 		"@emotion/react": "^11.7.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.26.0",
+		"@atlaskit/editor-common": "^107.28.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
@@ -47,9 +47,8 @@
 	"devDependencies": {
 		"@af/visual-regression": "workspace:^",
 		"@atlaskit/analytics-next": "^11.1.0",
-		"@atlaskit/editor-plugin-floating-toolbar": "^5.1.0",
+		"@atlaskit/editor-plugin-floating-toolbar": "^5.2.0",
 		"@atlaskit/ssr": "workspace:^",
-		"@atlaskit/visual-regression": "workspace:^",
 		"@testing-library/react": "^13.4.0",
 		"wait-for-expect": "^1.2.0"
 	},