@atlaskit/editor-plugin-type-ahead 0.1.1 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-type-ahead
 
+## 0.3.0
+
+### Minor Changes
+
+- [`ef0c2a89c72`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ef0c2a89c72) - Add isTypeAheadOpen action to type-ahead plugin. Decouple placeholder plugin from editor-core.
+
+## 0.2.0
+
+### Minor Changes
+
+- [`ad3c5c21079`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ad3c5c21079) - Updating all plugins with minor version to correct issue with semver.
+
 ## 0.1.1
 
 ### Patch Changes

package/README.md

@@ -1,9 +1,30 @@
-# EditorPluginTypeAhead
+# Editor plugin type ahead
 
-Type-ahead plugin for @atlaskit/editor-core
+Type ahead plugin for @atlaskit/editor-core
+
+**Note:** This component is designed for internal Atlassian development.
+External contributors will be able to use this component but will not be able to submit issues.
+
+## Install
+---
+- **Install** - *yarn add @atlaskit/editor-plugin-type-ahead*
+- **npm** - [@atlaskit/editor-plugin-type-ahead](https://www.npmjs.com/package/@atlaskit/editor-plugin-type-ahead)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-type-ahead)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-type-ahead/dist/)
 
 ## Usage
+---
+**Internal use only**
+
+@atlaskit/editor-plugin-type-ahead is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
+
+Direct use of this component is not supported.
 
-`import { TypeAheadPlugin } from @atlaskit/editor-plugin-type-ahead';`
+Please see [Atlaskit - Editor plugin type ahead](https://atlaskit.atlassian.com/packages/editor/editor-plugin-type-ahead) for documentation and examples for this package.
 
-Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-type-ahead).
+## Support
+---
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+## License
+---
+ Please see [Atlassian Frontend - License](https://developer.atlassian.com/cloud/framework/atlassian-frontend/#license) for more licensing information.

package/dist/types/types.d.ts

@@ -1,6 +1,7 @@
 import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { EditorCommand, NextEditorPlugin, TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 export type TypeAheadInputMethod = INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBOARD | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR;
 type Props = {
     triggerHandler: TypeAheadHandler;
@@ -12,8 +13,15 @@ export type TypeAheadPluginOptions = {
     createAnalyticsEvent?: CreateUIAnalyticsEvent;
 };
 type OpenTypeAheadAtCursorType = (props: Props) => EditorCommand;
+/**
+ * Type ahead plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export type TypeAheadPlugin = NextEditorPlugin<'typeAhead', {
     pluginConfiguration: TypeAheadPluginOptions | undefined;
+    actions: {
+        isOpen: (editorState: EditorState) => boolean;
+    };
     commands: {
         openTypeAheadAtCursor: OpenTypeAheadAtCursorType;
     };

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

@@ -1,6 +1,7 @@
 import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { EditorCommand, NextEditorPlugin, TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 export type TypeAheadInputMethod = INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBOARD | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR;
 type Props = {
     triggerHandler: TypeAheadHandler;
@@ -12,8 +13,15 @@ export type TypeAheadPluginOptions = {
     createAnalyticsEvent?: CreateUIAnalyticsEvent;
 };
 type OpenTypeAheadAtCursorType = (props: Props) => EditorCommand;
+/**
+ * Type ahead plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export type TypeAheadPlugin = NextEditorPlugin<'typeAhead', {
     pluginConfiguration: TypeAheadPluginOptions | undefined;
+    actions: {
+        isOpen: (editorState: EditorState) => boolean;
+    };
     commands: {
         openTypeAheadAtCursor: OpenTypeAheadAtCursorType;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-type-ahead",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Type-ahead plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -8,7 +8,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "atlassian": {
-    "team": "Editor",
+    "team": "Editor: Lego",
     "releaseModel": "continuous",
     "singleton": true
   },
@@ -31,7 +31,8 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^74.52.0",
+    "@atlaskit/editor-common": "^74.56.0",
+    "@atlaskit/editor-prosemirror": "1.1.0",
     "@babel/runtime": "^7.0.0"
   },
   "peerDependencies": {

package/report.api.md

@@ -17,6 +17,7 @@
 ```ts
 import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import type { EditorCommand } from '@atlaskit/editor-common/types';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { TypeAheadHandler } from '@atlaskit/editor-common/types';
@@ -38,11 +39,14 @@ export type TypeAheadInputMethod =
   | INPUT_METHOD.QUICK_INSERT
   | INPUT_METHOD.TOOLBAR;
 
-// @public (undocumented)
+// @public
 export type TypeAheadPlugin = NextEditorPlugin<
   'typeAhead',
   {
     pluginConfiguration: TypeAheadPluginOptions | undefined;
+    actions: {
+      isOpen: (editorState: EditorState) => boolean;
+    };
     commands: {
       openTypeAheadAtCursor: OpenTypeAheadAtCursorType;
     };

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

@@ -0,0 +1,46 @@
+## API Report File for "@atlaskit/editor-plugin-type-ahead"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import type { EditorCommand } from '@atlaskit/editor-common/types';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { TypeAheadHandler } from '@atlaskit/editor-common/types';
+
+// @public (undocumented)
+type OpenTypeAheadAtCursorType = (props: Props) => EditorCommand;
+
+// @public (undocumented)
+type Props = {
+    triggerHandler: TypeAheadHandler;
+    inputMethod: TypeAheadInputMethod;
+    query?: string;
+};
+
+// @public (undocumented)
+export type TypeAheadInputMethod = INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBOARD | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR;
+
+// @public
+export type TypeAheadPlugin = NextEditorPlugin<'typeAhead', {
+    pluginConfiguration: TypeAheadPluginOptions | undefined;
+    actions: {
+        isOpen: (editorState: EditorState) => boolean;
+    };
+    commands: {
+        openTypeAheadAtCursor: OpenTypeAheadAtCursorType;
+    };
+}>;
+
+// @public (undocumented)
+export type TypeAheadPluginOptions = {
+    isMobile?: boolean;
+    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```