UNPKG

@atlaskit/editor-plugin-type-ahead

Version:

Type-ahead plugin for @atlaskit/editor-core

bitbucket.org/atlassian/atlassian-frontend-mirror

43 lines (31 loc) • 2.33 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# Editor Plugin Type Ahead 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. ## Overview The Type Ahead plugin provides intelligent autocomplete and suggestion functionality for the Atlassian Editor. It enables users to quickly find and insert content through keyboard-triggered suggestions, supporting multiple input methods and handler registrations. ## Key features - **Autocomplete suggestions** - Display intelligent suggestions based on user input with configurable handlers - **Multiple input methods** - Support for various trigger methods including keyboard, menu, quick insert, and toolbar - **Item selection and insertion** - Handle item selection with customizable insertion logic - **Error handling** - Graceful error handling with error fallback UI states - **Mobile support** - Optimized support for mobile environments with platform-specific features - **Performance monitoring** - Built-in statistics tracking for autocomplete interactions ## 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. Please see [Atlaskit - Editor plugin type ahead](https://atlaskit.atlassian.com/packages/editor/editor-plugin-type-ahead) for documentation and examples for this package. ## 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://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.