@atlaskit/editor-plugin-type-ahead 13.2.1 → 13.2.3

package/dist/types/ui/InputQuery.d.ts

@@ -9,6 +9,7 @@ import type { TypeAheadItem } from '@atlaskit/editor-common/types';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { CloseSelectionOptions } from '../pm-plugins/constants';
 type InputQueryProps = {
+    activeDescendantId?: string;
     cancel: (props: {
         addPrefixTrigger: boolean;
         forceFocusOnEditor: boolean;
@@ -17,15 +18,22 @@ type InputQueryProps = {
     }) => void;
     editorView: EditorView;
     forceFocus: boolean;
-    items: TypeAheadItem[];
+    /**
+     * @private
+     * @deprecated Pass `optionCount` instead.
+     */
+    items?: TypeAheadItem[];
+    listId?: string;
     onItemSelect: (mode: SelectItemMode) => void;
     onQueryChange: (query: string) => void;
     onQueryFocus: () => void;
     onUndoRedo?: (inputType: 'historyUndo' | 'historyRedo') => boolean;
+    optionCount?: number;
     reopenQuery?: string;
     selectNextItem: () => void;
     selectPreviousItem: () => void;
+    shouldKeepOpenOnRegisteredMenu?: boolean;
     triggerQueryPrefix: string;
 };
-export declare const InputQuery: React.MemoExoticComponent<({ triggerQueryPrefix, cancel, onQueryChange, onItemSelect, selectNextItem, selectPreviousItem, forceFocus, reopenQuery, onQueryFocus, onUndoRedo, editorView, items, }: InputQueryProps) => jsx.JSX.Element>;
+export declare const InputQuery: React.MemoExoticComponent<({ activeDescendantId, triggerQueryPrefix, cancel, onQueryChange, onItemSelect, selectNextItem, selectPreviousItem, forceFocus, reopenQuery, onQueryFocus, onUndoRedo, editorView, items, listId, optionCount, shouldKeepOpenOnRegisteredMenu, }: InputQueryProps) => jsx.JSX.Element>;
 export {};

package/dist/types/ui/hooks/use-load-items.d.ts

@@ -2,4 +2,4 @@ import type { IntlShape } from 'react-intl';
 import type { ExtractInjectionAPI, TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { TypeAheadPlugin } from '../../typeAheadPluginType';
-export declare const useLoadItems: (triggerHandler: TypeAheadHandler, editorView: EditorView, query: string, showViewMore?: boolean, api?: ExtractInjectionAPI<TypeAheadPlugin> | undefined, intl?: IntlShape) => Array<TypeAheadItem>;
+export declare const useLoadItems: (triggerHandler: TypeAheadHandler, editorView: EditorView, query: string, showViewMore?: boolean, api?: ExtractInjectionAPI<TypeAheadPlugin> | undefined, intl?: IntlShape, enabled?: boolean) => Array<TypeAheadItem>;

package/dist/types/ui/registered-menu/PassThrough.d.ts

@@ -0,0 +1,2 @@
+import type React from 'react';
+export declare const PassThrough: ({ children }: React.PropsWithChildren) => React.ReactNode;

package/dist/types/ui/registered-menu/RegisteredTypeAheadMenu.d.ts

@@ -0,0 +1,30 @@
+import React from 'react';
+import type { ExtractInjectionAPI, TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { CloseSelectionOptions } from '../../pm-plugins/constants';
+import type { TypeAheadPlugin } from '../../typeAheadPluginType';
+import type { TypeAheadSurface } from './typeAheadSurfaces';
+type Props = {
+    anchorElement: HTMLElement;
+    api: ExtractInjectionAPI<TypeAheadPlugin> | undefined;
+    cancel: (params: {
+        addPrefixTrigger: boolean;
+        forceFocusOnEditor: boolean;
+        setSelectionAt: CloseSelectionOptions;
+        text: string;
+    }) => void;
+    editorView: EditorView;
+    forceFocus: boolean;
+    onClose: () => void;
+    onUndoRedo?: (inputType: 'historyUndo' | 'historyRedo') => boolean;
+    popupsBoundariesElement?: HTMLElement;
+    popupsMountPoint?: HTMLElement;
+    popupsScrollableElement?: HTMLElement;
+    query: string;
+    reopenQuery?: string;
+    setQuery: (query: string) => void;
+    surface: TypeAheadSurface;
+    triggerHandler: TypeAheadHandler;
+};
+export declare const RegisteredTypeAheadMenu: ({ anchorElement, api, cancel, editorView, forceFocus, onClose, onUndoRedo, popupsBoundariesElement, popupsMountPoint, popupsScrollableElement, query, reopenQuery, setQuery, surface, triggerHandler, }: Props) => React.JSX.Element;
+export {};

package/dist/types/ui/registered-menu/TypeAheadContext.d.ts

@@ -0,0 +1,14 @@
+import type { Context } from 'react';
+import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { ExtractInjectionAPI, TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { TypeAheadPlugin } from '../../typeAheadPluginType';
+export type TypeAheadContextValue = {
+    api: ExtractInjectionAPI<TypeAheadPlugin> | undefined;
+    editorView: EditorView;
+    inputMethod: INPUT_METHOD.QUICK_INSERT;
+    onClose: () => void;
+    query: string;
+    triggerHandler: TypeAheadHandler;
+};
+export declare const TypeAheadContext: Context<TypeAheadContextValue | null>;

package/dist/types/ui/registered-menu/TypeAheadItemRow.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import type { RegisterMenuItem } from '@atlaskit/editor-ui-control-model/types';
+import type { TypeAheadItemComponent } from './typeAheadMenuTypes';
+export declare const TypeAheadItemRow: ({ isSelected, itemIndex, Item, listId, onItemHover, registration, }: {
+    isSelected: boolean;
+    Item: TypeAheadItemComponent;
+    itemIndex: number;
+    listId: string;
+    onItemHover: (itemIndex: number) => void;
+    registration: RegisterMenuItem;
+}) => React.JSX.Element;

package/dist/types/ui/registered-menu/TypeAheadProvider.d.ts

@@ -0,0 +1,3 @@
+import type { Provider } from 'react';
+import type { TypeAheadContextValue } from './TypeAheadContext';
+export declare const TypeAheadProvider: Provider<TypeAheadContextValue | null>;

package/dist/types/ui/registered-menu/buildTypeAheadMenuModel.d.ts

@@ -0,0 +1,7 @@
+import type { SurfaceIdentifier } from '@atlaskit/editor-ui-control-model/surface-renderer/types';
+import type { RegisterComponent, RegisterMenuItem } from '@atlaskit/editor-ui-control-model/types';
+export type TypeAheadMenuModel = {
+    items: RegisterMenuItem[];
+    root: RegisterComponent | undefined;
+};
+export declare const buildTypeAheadMenuModel: (components: RegisterComponent[], rootComponent: SurfaceIdentifier) => TypeAheadMenuModel;

package/dist/types/ui/registered-menu/getTypeAheadItemId.d.ts

@@ -0,0 +1 @@
+export declare const getTypeAheadItemId: (listId: string, itemIndex: number) => string;

package/dist/types/ui/registered-menu/quick-insert/TypeAheadQuickInsertItem.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import type { TypeAheadItemRenderProps } from '../typeAheadMenuTypes';
+export declare const TypeAheadQuickInsertItem: ({ id, isSelected, onMouseMove, registration, }: TypeAheadItemRenderProps) => React.JSX.Element;

package/dist/types/ui/registered-menu/quick-insert/TypeAheadQuickInsertProvider.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const TypeAheadQuickInsertProvider: ({ children, }: React.PropsWithChildren) => React.JSX.Element;

package/dist/types/ui/registered-menu/typeAheadMenuTypes.d.ts

@@ -0,0 +1,9 @@
+import type React from 'react';
+import type { RegisterMenuItem } from '@atlaskit/editor-ui-control-model/types';
+export type TypeAheadItemRenderProps = {
+    id: string;
+    isSelected: boolean;
+    onMouseMove: () => void;
+    registration: RegisterMenuItem;
+};
+export type TypeAheadItemComponent = React.ComponentType<TypeAheadItemRenderProps>;

package/dist/types/ui/registered-menu/typeAheadSurfaces.d.ts

@@ -0,0 +1,17 @@
+import type React from 'react';
+import type { MessageDescriptor } from 'react-intl';
+import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import { TypeAheadAvailableNodes } from '@atlaskit/editor-common/type-ahead';
+import type { TypeAheadItemComponent } from './typeAheadMenuTypes';
+export type TypeAheadSurface = {
+    inputMethod: INPUT_METHOD.QUICK_INSERT;
+    Item: TypeAheadItemComponent;
+    listIdPrefix: string;
+    listLabel: MessageDescriptor;
+    Provider: React.ComponentType<React.PropsWithChildren>;
+    root: {
+        key: string;
+        type: 'menu';
+    };
+};
+export declare const getTypeAheadSurface: (id?: TypeAheadAvailableNodes) => TypeAheadSurface | undefined;

package/dist/types/ui/registered-menu/useTypeAheadContext.d.ts

@@ -0,0 +1,2 @@
+import type { TypeAheadContextValue } from './TypeAheadContext';
+export declare const useTypeAheadContext: () => TypeAheadContextValue;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-type-ahead",
-	"version": "13.2.1",
+	"version": "13.2.3",
 	"description": "Type-ahead plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -21,22 +21,25 @@
 	],
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^56.4.0",
+		"@atlaskit/adf-schema": "^56.5.0",
 		"@atlaskit/editor-plugin-analytics": "^12.1.0",
 		"@atlaskit/editor-plugin-connectivity": "^12.1.0",
 		"@atlaskit/editor-plugin-context-panel": "^14.1.0",
 		"@atlaskit/editor-plugin-metrics": "^13.1.0",
+		"@atlaskit/editor-plugin-ui-control-registry": "^6.1.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@atlaskit/editor-shared-styles": "^4.0.0",
+		"@atlaskit/editor-ui-control-model": "^2.4.0",
 		"@atlaskit/feature-gate-js-client": "^6.0.0",
 		"@atlaskit/heading": "^7.0.0",
 		"@atlaskit/insm": "^1.2.0",
 		"@atlaskit/menu": "^9.2.0",
+		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.1.0",
 		"@atlaskit/primitives": "^22.2.0",
 		"@atlaskit/prosemirror-history": "^1.1.0",
 		"@atlaskit/prosemirror-input-rules": "^4.0.0",
-		"@atlaskit/tmp-editor-statsig": "^136.0.0",
+		"@atlaskit/tmp-editor-statsig": "^137.0.0",
 		"@atlaskit/tokens": "^16.3.0",
 		"@atlaskit/visually-hidden": "^4.2.0",
 		"@babel/runtime": "^7.0.0",
@@ -48,12 +51,13 @@
 		"w3c-keyname": "^2.1.8"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^116.48.0",
+		"@atlaskit/editor-common": "^116.51.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},
 	"devDependencies": {
+		"@atlassian/testing-library": "^0.11.0",
 		"@testing-library/react": "^16.3.0",
 		"@types/react-virtualized": "^9.18.12",
 		"react": "^19.2.0",