@atlaskit/editor-plugin-highlight 3.0.18 → 3.0.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/types/editor-commands/palette.d.ts +1 -1
  3. package/dist/types/highlightPluginType.d.ts +6 -6
  4. package/dist/types/ui/FloatingToolbarHighlightColor.d.ts +1 -1
  5. package/dist/types/ui/PrimaryToolbarHighlightColor.d.ts +4 -4
  6. package/dist/types/ui/shared/PaletteDropdown.d.ts +5 -5
  7. package/dist/types/ui/shared/useDropdownEvents.d.ts +1 -1
  8. package/dist/types-ts4.5/editor-commands/palette.d.ts +1 -1
  9. package/dist/types-ts4.5/highlightPluginType.d.ts +6 -6
  10. package/dist/types-ts4.5/ui/FloatingToolbarHighlightColor.d.ts +1 -1
  11. package/dist/types-ts4.5/ui/PrimaryToolbarHighlightColor.d.ts +4 -4
  12. package/dist/types-ts4.5/ui/shared/PaletteDropdown.d.ts +5 -5
  13. package/dist/types-ts4.5/ui/shared/useDropdownEvents.d.ts +1 -1
  14. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @atlaskit/editor-plugin-highlight
2
2
 
3
+ ## 3.0.19
4
+
5
+ ### Patch Changes
6
+
7
+ - [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
8
+ Sorted type and interface props to improve Atlaskit docs
9
+ - Updated dependencies
10
+
3
11
  ## 3.0.18
4
12
 
5
13
  ### Patch Changes
package/dist/types/editor-commands/palette.d.ts CHANGED
@@ -5,6 +5,6 @@ export declare const togglePalette: (api: ExtractInjectionAPI<HighlightPlugin>)
5
5
  inputMethod: INPUT_METHOD;
6
6
  }) => Command;
7
7
  export declare const setPalette: (api: ExtractInjectionAPI<HighlightPlugin>) => ({ isPaletteOpen, inputMethod, }: {
8
- isPaletteOpen: boolean;
9
8
  inputMethod: INPUT_METHOD;
9
+ isPaletteOpen: boolean;
10
10
  }) => Command;
package/dist/types/highlightPluginType.d.ts CHANGED
@@ -8,6 +8,12 @@ import type { ToolbarPlugin } from '@atlaskit/editor-plugin-toolbar';
8
8
  import type { UserPreferencesPlugin } from '@atlaskit/editor-plugin-user-preferences';
9
9
  import type { HighlightPluginState } from './pm-plugins/main';
10
10
  export type HighlightPlugin = NextEditorPlugin<'highlight', {
11
+ commands: {
12
+ changeColor: ({ color }: {
13
+ color: string;
14
+ inputMethod: INPUT_METHOD;
15
+ }) => EditorCommand;
16
+ };
11
17
  dependencies: [
12
18
  OptionalPlugin<AnalyticsPlugin>,
13
19
  OptionalPlugin<TextFormattingPlugin>,
@@ -17,10 +23,4 @@ export type HighlightPlugin = NextEditorPlugin<'highlight', {
17
23
  OptionalPlugin<UserPreferencesPlugin>
18
24
  ];
19
25
  sharedState: HighlightPluginState | undefined;
20
- commands: {
21
- changeColor: ({ color }: {
22
- color: string;
23
- inputMethod: INPUT_METHOD;
24
- }) => EditorCommand;
25
- };
26
26
  }>;
package/dist/types/ui/FloatingToolbarHighlightColor.d.ts CHANGED
@@ -5,8 +5,8 @@ import { type EditorView } from '@atlaskit/editor-prosemirror/view';
5
5
  import type { HighlightPlugin } from '../highlightPluginType';
6
6
  type FloatingToolbarHighlightColorProps = {
7
7
  dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
8
- pluginInjectionApi: ExtractInjectionAPI<HighlightPlugin> | undefined;
9
8
  editorView: EditorView | undefined;
9
+ pluginInjectionApi: ExtractInjectionAPI<HighlightPlugin> | undefined;
10
10
  } & WrappedComponentProps;
11
11
  export declare const FloatingToolbarHighlightColorWithIntl: import("react").FC<import("react-intl-next").WithIntlProps<FloatingToolbarHighlightColorProps>> & {
12
12
  WrappedComponent: import("react").ComponentType<FloatingToolbarHighlightColorProps>;
package/dist/types/ui/PrimaryToolbarHighlightColor.d.ts CHANGED
@@ -3,13 +3,13 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
3
3
  import { type EditorView } from '@atlaskit/editor-prosemirror/view';
4
4
  import type { HighlightPlugin } from '../highlightPluginType';
5
5
  type PrimaryToolbarHighlightColorProps = {
6
- popupsMountPoint?: HTMLElement;
7
- popupsBoundariesElement?: HTMLElement;
8
- popupsScrollableElement?: HTMLElement;
9
6
  disabled: boolean;
7
+ editorView: EditorView;
10
8
  isToolbarReducedSpacing: boolean;
11
9
  pluginInjectionApi: ExtractInjectionAPI<HighlightPlugin> | undefined;
12
- editorView: EditorView;
10
+ popupsBoundariesElement?: HTMLElement;
11
+ popupsMountPoint?: HTMLElement;
12
+ popupsScrollableElement?: HTMLElement;
13
13
  } & WrappedComponentProps;
14
14
  export declare const PrimaryToolbarHighlightColorWithIntl: import("react").FC<import("react-intl-next").WithIntlProps<PrimaryToolbarHighlightColorProps>> & {
15
15
  WrappedComponent: import("react").ComponentType<PrimaryToolbarHighlightColorProps>;
package/dist/types/ui/shared/PaletteDropdown.d.ts CHANGED
@@ -1,14 +1,14 @@
1
1
  import React from 'react';
2
2
  import { type WithOutsideClickProps } from '@atlaskit/editor-common/ui';
3
3
  type PaletteDropdownProps = {
4
- popupsMountPoint?: HTMLElement;
4
+ activeColor: string | null;
5
+ isOpen: boolean;
6
+ isOpenedByKeyboard: boolean;
7
+ onColorChange: (color: string) => void;
5
8
  popupsBoundariesElement?: HTMLElement;
9
+ popupsMountPoint?: HTMLElement;
6
10
  popupsScrollableElement?: HTMLElement;
7
- isOpen: boolean;
8
- activeColor: string | null;
9
11
  trigger: React.ReactElement;
10
- onColorChange: (color: string) => void;
11
- isOpenedByKeyboard: boolean;
12
12
  } & WithOutsideClickProps;
13
13
  export declare const PaletteDropdown: (props: PaletteDropdownProps) => React.JSX.Element;
14
14
  export {};
package/dist/types/ui/shared/useDropdownEvents.d.ts CHANGED
@@ -3,9 +3,9 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
3
3
  import type { ToolbarButtonRef } from '@atlaskit/editor-common/ui-menu';
4
4
  import type { HighlightPlugin } from '../../highlightPluginType';
5
5
  type UseDropdownEventArgs = {
6
- setIsDropdownOpen: (isOpen: boolean) => void;
7
6
  isDropdownOpen: boolean;
8
7
  pluginInjectionApi: ExtractInjectionAPI<HighlightPlugin> | undefined;
8
+ setIsDropdownOpen: (isOpen: boolean) => void;
9
9
  toolbarItemRef: React.RefObject<ToolbarButtonRef>;
10
10
  };
11
11
  export declare const useDropdownEvents: (args: UseDropdownEventArgs) => {
package/dist/types-ts4.5/editor-commands/palette.d.ts CHANGED
@@ -5,6 +5,6 @@ export declare const togglePalette: (api: ExtractInjectionAPI<HighlightPlugin>)
5
5
  inputMethod: INPUT_METHOD;
6
6
  }) => Command;
7
7
  export declare const setPalette: (api: ExtractInjectionAPI<HighlightPlugin>) => ({ isPaletteOpen, inputMethod, }: {
8
- isPaletteOpen: boolean;
9
8
  inputMethod: INPUT_METHOD;
9
+ isPaletteOpen: boolean;
10
10
  }) => Command;
package/dist/types-ts4.5/highlightPluginType.d.ts CHANGED
@@ -8,6 +8,12 @@ import type { ToolbarPlugin } from '@atlaskit/editor-plugin-toolbar';
8
8
  import type { UserPreferencesPlugin } from '@atlaskit/editor-plugin-user-preferences';
9
9
  import type { HighlightPluginState } from './pm-plugins/main';
10
10
  export type HighlightPlugin = NextEditorPlugin<'highlight', {
11
+ commands: {
12
+ changeColor: ({ color }: {
13
+ color: string;
14
+ inputMethod: INPUT_METHOD;
15
+ }) => EditorCommand;
16
+ };
11
17
  dependencies: [
12
18
  OptionalPlugin<AnalyticsPlugin>,
13
19
  OptionalPlugin<TextFormattingPlugin>,
@@ -17,10 +23,4 @@ export type HighlightPlugin = NextEditorPlugin<'highlight', {
17
23
  OptionalPlugin<UserPreferencesPlugin>
18
24
  ];
19
25
  sharedState: HighlightPluginState | undefined;
20
- commands: {
21
- changeColor: ({ color }: {
22
- color: string;
23
- inputMethod: INPUT_METHOD;
24
- }) => EditorCommand;
25
- };
26
26
  }>;
package/dist/types-ts4.5/ui/FloatingToolbarHighlightColor.d.ts CHANGED
@@ -5,8 +5,8 @@ import { type EditorView } from '@atlaskit/editor-prosemirror/view';
5
5
  import type { HighlightPlugin } from '../highlightPluginType';
6
6
  type FloatingToolbarHighlightColorProps = {
7
7
  dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
8
- pluginInjectionApi: ExtractInjectionAPI<HighlightPlugin> | undefined;
9
8
  editorView: EditorView | undefined;
9
+ pluginInjectionApi: ExtractInjectionAPI<HighlightPlugin> | undefined;
10
10
  } & WrappedComponentProps;
11
11
  export declare const FloatingToolbarHighlightColorWithIntl: import("react").FC<import("react-intl-next").WithIntlProps<FloatingToolbarHighlightColorProps>> & {
12
12
  WrappedComponent: import("react").ComponentType<FloatingToolbarHighlightColorProps>;
package/dist/types-ts4.5/ui/PrimaryToolbarHighlightColor.d.ts CHANGED
@@ -3,13 +3,13 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
3
3
  import { type EditorView } from '@atlaskit/editor-prosemirror/view';
4
4
  import type { HighlightPlugin } from '../highlightPluginType';
5
5
  type PrimaryToolbarHighlightColorProps = {
6
- popupsMountPoint?: HTMLElement;
7
- popupsBoundariesElement?: HTMLElement;
8
- popupsScrollableElement?: HTMLElement;
9
6
  disabled: boolean;
7
+ editorView: EditorView;
10
8
  isToolbarReducedSpacing: boolean;
11
9
  pluginInjectionApi: ExtractInjectionAPI<HighlightPlugin> | undefined;
12
- editorView: EditorView;
10
+ popupsBoundariesElement?: HTMLElement;
11
+ popupsMountPoint?: HTMLElement;
12
+ popupsScrollableElement?: HTMLElement;
13
13
  } & WrappedComponentProps;
14
14
  export declare const PrimaryToolbarHighlightColorWithIntl: import("react").FC<import("react-intl-next").WithIntlProps<PrimaryToolbarHighlightColorProps>> & {
15
15
  WrappedComponent: import("react").ComponentType<PrimaryToolbarHighlightColorProps>;
package/dist/types-ts4.5/ui/shared/PaletteDropdown.d.ts CHANGED
@@ -1,14 +1,14 @@
1
1
  import React from 'react';
2
2
  import { type WithOutsideClickProps } from '@atlaskit/editor-common/ui';
3
3
  type PaletteDropdownProps = {
4
- popupsMountPoint?: HTMLElement;
4
+ activeColor: string | null;
5
+ isOpen: boolean;
6
+ isOpenedByKeyboard: boolean;
7
+ onColorChange: (color: string) => void;
5
8
  popupsBoundariesElement?: HTMLElement;
9
+ popupsMountPoint?: HTMLElement;
6
10
  popupsScrollableElement?: HTMLElement;
7
- isOpen: boolean;
8
- activeColor: string | null;
9
11
  trigger: React.ReactElement;
10
- onColorChange: (color: string) => void;
11
- isOpenedByKeyboard: boolean;
12
12
  } & WithOutsideClickProps;
13
13
  export declare const PaletteDropdown: (props: PaletteDropdownProps) => React.JSX.Element;
14
14
  export {};
package/dist/types-ts4.5/ui/shared/useDropdownEvents.d.ts CHANGED
@@ -3,9 +3,9 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
3
3
  import type { ToolbarButtonRef } from '@atlaskit/editor-common/ui-menu';
4
4
  import type { HighlightPlugin } from '../../highlightPluginType';
5
5
  type UseDropdownEventArgs = {
6
- setIsDropdownOpen: (isOpen: boolean) => void;
7
6
  isDropdownOpen: boolean;
8
7
  pluginInjectionApi: ExtractInjectionAPI<HighlightPlugin> | undefined;
8
+ setIsDropdownOpen: (isOpen: boolean) => void;
9
9
  toolbarItemRef: React.RefObject<ToolbarButtonRef>;
10
10
  };
11
11
  export declare const useDropdownEvents: (args: UseDropdownEventArgs) => {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-highlight",
3
- "version": "3.0.18",
3
+ "version": "3.0.19",
4
4
  "description": "Highlight plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",