@atlaskit/editor-plugin-user-preferences
Version:
UserPreferences plugin for @atlaskit/editor-core
83 lines (82 loc) • 4.29 kB
JavaScript
import _defineProperty from "@babel/runtime/helpers/defineProperty";
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
import { useResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
import { clearOverrideUserPreference as _clearOverrideUserPreference, overrideUserPreference as _overrideUserPreference, updateUserPreference as _updateUserPreference } from './pm-plugins/commands';
import { createPlugin, userPreferencesPluginKey } from './pm-plugins/main';
import { useDocumentVisibilityWatcher } from './ui/useDocumentVisibilityWatcher';
import { useUserPreferencesInitListener } from './ui/useUserPreferencesInitListener';
import { useUserPreferencesUpdateListener } from './ui/useUserPreferencesUpdateListener';
export var userPreferencesPlugin = function userPreferencesPlugin(_ref) {
var config = _ref.config,
api = _ref.api;
var userPreferencesProvider = config.userPreferencesProvider;
return {
name: 'userPreferences',
pmPlugins: function pmPlugins() {
return [{
name: 'userPreferencesPlugin',
plugin: function plugin() {
return createPlugin(config, api);
}
}];
},
actions: {
updateUserPreference: function updateUserPreference(key, value) {
var _api$analytics;
return _updateUserPreference({
key: key,
value: value,
userPreferencesProvider: userPreferencesProvider,
editorAnalyticsApi: api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions
});
},
getUserPreferences: function getUserPreferences() {
if (!userPreferencesProvider) {
return config.initialUserPreferences;
}
return userPreferencesProvider.getPreferences();
}
},
commands: {
overrideUserPreference: function overrideUserPreference(key, value) {
return _overrideUserPreference({
key: key,
value: value
});
},
clearOverrideUserPreference: function clearOverrideUserPreference(key) {
return _clearOverrideUserPreference({
key: key
});
}
},
getSharedState: function getSharedState(editorState) {
if (!editorState) {
return null;
}
if (expValEquals('platform_editor_user_preference_override', 'isEnabled', true)) {
var state = userPreferencesPluginKey.getState(editorState);
// state can return undefined if the plugin hasn't been registered
if (!state) {
return null;
} else if (!state.overrides || Object.keys(state.overrides).length === 0) {
return state;
}
return _objectSpread(_objectSpread({}, state), {}, {
preferences: _objectSpread(_objectSpread({}, state.preferences), state.overrides)
});
}
return userPreferencesPluginKey.getState(editorState);
},
usePluginHook: function usePluginHook(_ref2) {
var editorView = _ref2.editorView;
var _useResolvedUserPrefe = useResolvedUserPreferences(userPreferencesProvider),
resolvedUserPreferences = _useResolvedUserPrefe.resolvedUserPreferences;
useUserPreferencesUpdateListener(editorView, resolvedUserPreferences);
useDocumentVisibilityWatcher(userPreferencesProvider);
useUserPreferencesInitListener(Boolean(userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.isInitialized), resolvedUserPreferences, api);
}
};
};