@atlaskit/editor-plugin-text-color
Version:
Text color plugin for @atlaskit/editor-core
84 lines (63 loc) • 2.04 kB
Markdown
<!-- API Report Version: 2.3 -->
## API Report File for "@atlaskit/editor-plugin-text-color"
> 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 { NextEditorPlugin } from '@atlaskit/editor-common/types';
import type { OptionalPlugin } from '@atlaskit/editor-common/types';
import type { PaletteColor } from '@atlaskit/editor-common/ui-color';
// @public (undocumented)
type Config = TextColorPluginConfig | boolean;
// @public (undocumented)
type TextColorDefaultColor = {
color: string;
label: string;
};
// @public (undocumented)
export type TextColorPlugin = NextEditorPlugin<
'textColor',
{
pluginConfiguration: Config | undefined;
dependencies: TextColorPluginDependencies;
actions: {
changeColor: (color: string) => Command;
};
sharedState: TextColorPluginState | undefined;
}
>;
// @public (undocumented)
export const textColorPlugin: TextColorPlugin;
// @public (undocumented)
export interface TextColorPluginConfig {
// (undocumented)
defaultColor?: TextColorDefaultColor;
}
// @public (undocumented)
type TextColorPluginDependencies = [OptionalPlugin<AnalyticsPlugin>];
// @public (undocumented)
export type TextColorPluginState = {
palette: Array<PaletteColor>;
defaultColor: string;
disabled?: boolean;
color: null | string;
};
// (No @packageDocumentation comment for this package)
```
<!--SECTION END: Main Entry Types-->
### Peer Dependencies
<!--SECTION START: Peer Dependencies-->
```json
{
"react": "^16.8.0",
"react-intl": "npm:react-intl@^5.18.1"
}
```
<!--SECTION END: Peer Dependencies-->