@atlaskit/editor-plugin-user-preferences
Version:
UserPreferences plugin for @atlaskit/editor-core
18 lines (17 loc) • 1 kB
TypeScript
import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics/api';
import type { EditorCommand } from '@atlaskit/editor-common/types/editor-command';
import type { UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences-provider';
import type { ResolvedUserPreferences, UserPreferences } from '@atlaskit/editor-common/user-preferences/user-preferences';
export declare const overrideUserPreference: ({ key, value, }: {
key: keyof ResolvedUserPreferences;
value: ResolvedUserPreferences[typeof key];
}) => EditorCommand;
export declare const clearOverrideUserPreference: ({ key }: {
key: keyof ResolvedUserPreferences;
}) => EditorCommand;
export declare const updateUserPreference: ({ key, value, userPreferencesProvider, editorAnalyticsApi, }: {
editorAnalyticsApi?: EditorAnalyticsAPI | undefined;
key: keyof UserPreferences;
userPreferencesProvider?: UserPreferencesProvider;
value: ResolvedUserPreferences[typeof key];
}) => EditorCommand;