@atlaskit/editor-plugin-indentation
Version:
Indentation plugin for @atlaskit/editor-core
67 lines (49 loc) • 1.8 kB
Markdown
<!-- API Report Version: 2.3 -->
## API Report File for "@atlaskit/editor-plugin-indentation"
> Do not edit this file. This report is auto-generated using
> [API Extractor](https://api-extractor.com/).
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
### Table of contents
- [Main Entry Types](#main-entry-types)
- [Peer Dependencies](#peer-dependencies)
### Main Entry Types
<!--SECTION START: Main Entry Types-->
```ts
import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
import type { Command } from '@atlaskit/editor-common/types';
import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
import type { OptionalPlugin } from '@atlaskit/editor-common/types';
// @public (undocumented)
type IndentationInputMethod = INPUT_METHOD.KEYBOARD | INPUT_METHOD.TOOLBAR;
// @public (undocumented)
export type IndentationPlugin = NextEditorPlugin<
'indentation',
{
dependencies: [OptionalPlugin<AnalyticsPlugin>];
actions: {
indentParagraphOrHeading: (inputMethod: IndentationInputMethod) => Command;
outdentParagraphOrHeading: (inputMethod: IndentationInputMethod) => Command;
};
sharedState: IndentationPluginSharedState | undefined;
}
>;
// @public (undocumented)
export const indentationPlugin: IndentationPlugin;
// @public (undocumented)
type IndentationPluginSharedState = {
isIndentationAllowed: boolean;
indentDisabled: boolean;
outdentDisabled: boolean;
};
// (No @packageDocumentation comment for this package)
```
<!--SECTION END: Main Entry Types-->
### Peer Dependencies
<!--SECTION START: Peer Dependencies-->
```json
{
"react": "^16.8.0"
}
```
<!--SECTION END: Peer Dependencies-->