@atlaskit/editor-common
Version:
A package that contains common classes and components for editor and renderer
162 lines (156 loc) • 6.45 kB
JavaScript
import _typeof from "@babel/runtime/helpers/typeof";
import _defineProperty from "@babel/runtime/helpers/defineProperty";
import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
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 { useLayoutEffect, useMemo, useRef, useState } from 'react';
import debounce from 'lodash/debounce';
// Ignored via go/ees005
// eslint-disable-next-line @typescript-eslint/no-explicit-any
/**
*
* Directly map object values
*
* @private
* @param object The object to transform
* @param mapFunction The function to map an old value to new one
* @returns Object with the same key but transformed values
*
*/
function mapValues(object, mapFunction) {
return Object.entries(object).reduce(function (acc, _ref) {
var _ref2 = _slicedToArray(_ref, 2),
key = _ref2[0],
value = _ref2[1];
return _objectSpread(_objectSpread({}, acc), {}, _defineProperty({}, key, mapFunction(value)));
}, {});
}
// When we use the `useSharedPluginStateWithSelector` example: `useSharedPluginStateWithSelector(api, ['width'], selector)`
// it will re-render every time the component re-renders as the array "['width']" is seen as an update.
// This hook is used to prevent re-renders due to this.
function useStaticPlugins(plugins) {
// eslint-disable-next-line react-hooks/exhaustive-deps
return useMemo(function () {
return plugins;
}, []);
}
/**
*
* ⚠️⚠️⚠️ This is a debounced hook ⚠️⚠️⚠️
* If the plugins you are listening to generate multiple shared states while the user is typing,
* your React Component will get only the last one.
*
* Used to return the current plugin state of input dependencies.
*
* @example
* Example in plugin:
*
* ```typescript
* function selector(states: NamedPluginStatesFromInjectionAPI<API, ['dog']>) {
* return {
* title: states.dogState?.title,
* }
* }
*
* function ExampleContent({ api }: Props) {
* const { title } = useSharedPluginStateWithSelector(
* api,
* ['dog'],
* selector
* )
* return <p>{ title }</p>
* }
*
* ```
*
* @param injectionApi Plugin injection API from `NextEditorPlugin`
* @param plugins Plugin names to get the shared plugin state for
* @param selector A function that takes the shared states of the plugins and returns a subset of a plugin state.
* @returns A corresponding object, the keys are names of the plugin with `State` appended,
* the values are the shared state exposed by that plugin.
*/
export function useSharedPluginStateWithSelector(injectionApi, plugins, selector) {
var pluginNames = useStaticPlugins(plugins);
var selectorRef = useRef(selector);
// Create a memoized object containing the named plugins
var namedExternalPlugins = useMemo(function () {
return pluginNames.reduce(function (acc, pluginName) {
return _objectSpread(_objectSpread({}, acc), {}, _defineProperty({}, "".concat(String(pluginName), "State"), injectionApi === null || injectionApi === void 0 ? void 0 : injectionApi[pluginName]));
}, {});
}, [injectionApi, pluginNames]);
return useSharedPluginStateInternal(namedExternalPlugins, selectorRef);
}
function useSharedPluginStateInternal(externalPlugins, selector) {
var refStates = useRef(mapValues(externalPlugins, function (value) {
return value === null || value === void 0 ? void 0 : value.sharedState.currentState();
}));
var _useState = useState(function () {
return selector.current(refStates.current);
}),
_useState2 = _slicedToArray(_useState, 2),
pluginStates = _useState2[0],
setPluginState = _useState2[1];
var mounted = useRef(false);
useLayoutEffect(function () {
var debouncedPluginStateUpdate = debounce(function () {
setPluginState(function (currentPluginStates) {
var nextStates = selector.current(_objectSpread({}, refStates.current));
if (shallowEqual(nextStates, currentPluginStates)) {
return currentPluginStates;
}
return nextStates;
});
});
// If we re-render this hook due to a change in the external
// plugins we need to push a state update to ensure we have
// the most current state.
if (mounted.current) {
refStates.current = mapValues(externalPlugins, function (value) {
return value === null || value === void 0 ? void 0 : value.sharedState.currentState();
});
debouncedPluginStateUpdate();
}
var unsubs = Object.entries(externalPlugins).map(function (_ref3) {
var _ref4 = _slicedToArray(_ref3, 2),
pluginKey = _ref4[0],
externalPlugin = _ref4[1];
return externalPlugin === null || externalPlugin === void 0 ? void 0 : externalPlugin.sharedState.onChange(function (_ref5) {
var nextSharedState = _ref5.nextSharedState,
prevSharedState = _ref5.prevSharedState;
if (prevSharedState === nextSharedState) {
return;
}
refStates.current[pluginKey] = nextSharedState;
debouncedPluginStateUpdate();
});
});
mounted.current = true;
return function () {
refStates.current = {};
unsubs.forEach(function (cb) {
return cb === null || cb === void 0 ? void 0 : cb();
});
};
}, [externalPlugins, selector]);
return pluginStates;
}
function shallowEqual(objA, objB) {
if (objA === objB) {
return true;
}
if (_typeof(objA) !== 'object' || objA === null || _typeof(objB) !== 'object' || objB === null) {
return false;
}
var keysA = Object.keys(objA);
var keysB = Object.keys(objB);
if (keysA.length !== keysB.length) {
return false;
}
for (var _i = 0, _keysA = keysA; _i < _keysA.length; _i++) {
var key = _keysA[_i];
if (objA[key] !== objB[key]) {
return false;
}
}
return true;
}