1 |
|
2 |
|
3 | ## API Report File for "@atlaskit/editor-plugin-text-formatting"
|
4 |
|
5 | > Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
|
6 | > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
7 |
|
8 | ### Table of contents
|
9 |
|
10 | - [Main Entry Types](#main-entry-types)
|
11 | - [Peer Dependencies](#peer-dependencies)
|
12 |
|
13 | ### Main Entry Types
|
14 |
|
15 |
|
16 |
|
17 | ```ts
|
18 | import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
|
19 | import type { EditorCommand } from '@atlaskit/editor-common/types';
|
20 | import type { InputMethodBasic } from '@atlaskit/editor-common/types';
|
21 | import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
|
22 | import type { OptionalPlugin } from '@atlaskit/editor-common/types';
|
23 | import type { TextFormattingOptions } from '@atlaskit/editor-common/types';
|
24 | import type { TextFormattingState } from '@atlaskit/editor-common/types';
|
25 |
|
26 | // @public (undocumented)
|
27 | export type TextFormattingPlugin = NextEditorPlugin<
|
28 | 'textFormatting',
|
29 | {
|
30 | pluginConfiguration: TextFormattingOptions | undefined;
|
31 | dependencies: [OptionalPlugin<typeof analyticsPlugin>];
|
32 | commands: {
|
33 | toggleSuperscript: ToggleMarkEditorCommand;
|
34 | toggleSubscript: ToggleMarkEditorCommand;
|
35 | toggleStrike: ToggleMarkEditorCommand;
|
36 | toggleCode: ToggleMarkEditorCommand;
|
37 | toggleUnderline: ToggleMarkEditorCommand;
|
38 | toggleEm: ToggleMarkEditorCommand;
|
39 | toggleStrong: ToggleMarkEditorCommand;
|
40 | };
|
41 | sharedState: TextFormattingState | undefined;
|
42 | }
|
43 | >;
|
44 |
|
45 | // @public
|
46 | export const textFormattingPlugin: TextFormattingPlugin;
|
47 |
|
48 | // @public (undocumented)
|
49 | export type ToggleMarkEditorCommand = (
|
50 | inputMethod: InputMethodBasic,
|
51 | ) => EditorCommand;
|
52 |
|
53 | // (No @packageDocumentation comment for this package)
|
54 | ```
|
55 |
|
56 |
|
57 |
|
58 | ### Peer Dependencies
|
59 |
|
60 |
|
61 |
|
62 | ```json
|
63 | {
|
64 | "react": "^16.8.0"
|
65 | }
|
66 | ```
|
67 |
|
68 |
|