import React from 'react';

import { AtlassianInternalWarning, code, md } from '@atlaskit/docs';
// eslint-disable-next-line @atlassian/tangerine/import/entry-points
import { createEditorUseOnlyNotice } from '@atlaskit/editor-common/doc-utils';
import { token } from '@atlaskit/tokens';

// eslint-disable-next-line @typescript-eslint/no-explicit-any -- md template from @atlaskit/docs
const _default_1: any = md`

${createEditorUseOnlyNotice('Editor Plugin User Preferences', [
	{ name: 'Editor Core', link: '/packages/editor/editor-core' },
])}


  ${
		(
			// eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
			<div style={{ marginTop: token('space.100') }}>
				<AtlassianInternalWarning />
			</div>
		)
	}

  This package includes the user preferences plugin used by \`@atlaskit/editor-core\`.

  ## Usage
---

The \`dependencies\`, \`configuration\`, \`state\`, \`actions\`, and \`commands\` of the plugin are defined
below:

${code`
type UserPreferencesPluginOptions = {
  /**
   * The initial user preferences to be used when the userPreferencesProvider is not available.
   * Otherwise, will default to the userPreferencesProvider's initial preferences.
   */
  initialUserPreferences?: ResolvedUserPreferences;
  /**
   * The user preferences provider to be used to get and set user preferences.
   * When not provided, user preferences will not be persisted.
   */
  userPreferencesProvider?: UserPreferencesProvider;
};

type PrefKey = keyof UserPreferences;
type ResolvedPrefKey = keyof ResolvedUserPreferences;
type UserPreferencesSharedState = {
  preferences: ResolvedUserPreferences;
};

type UserPreferencesPlugin = NextEditorPlugin<
  'userPreferences',
  {
    actions: {
      getUserPreferences: () => ResolvedUserPreferences | undefined;
      updateUserPreference: (
        key: PrefKey,
        value: ResolvedUserPreferences[PrefKey],
      ) => EditorCommand;
    };
    dependencies: [OptionalPlugin<AnalyticsPlugin>];
    pluginConfiguration: UserPreferencesPluginOptions;
    sharedState: UserPreferencesSharedState;
  }
>;
`}


  ## 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.
`;
export default _default_1;