@atlaskit/editor-plugin-list
Version:
List plugin for @atlaskit/editor-core
106 lines (100 loc) • 6.21 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 { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD, OUTDENT_SCENARIOS } from '@atlaskit/editor-common/analytics';
import { getCommonListAnalyticsAttributes } from '@atlaskit/editor-common/lists';
import { PassiveTransaction } from '@atlaskit/editor-common/preset';
import { isBulletList } from '@atlaskit/editor-common/utils';
import { closeHistory } from '@atlaskit/prosemirror-history';
import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
import { moveSelectedListItems } from '../actions/move-selected-list-items';
import { outdentListItemsSelected as outdentListAction } from '../actions/outdent-list-items-selected';
import { getRestartListsAttributes } from '../utils/analytics';
import { findFirstParentListNode } from '../utils/find';
import { isInsideListItem, isInsideTableCell } from '../utils/selection';
/**
* Handler for flexible list outdentation.
* Lifts items independently and cleans up wrapper structures.
*/
var handleOutdentListItems = function handleOutdentListItems(tr, editorAnalyticsAPI, inputMethod) {
var _findFirstParentListN;
moveSelectedListItems(tr, -1);
// If no changes were made, handle based on context
if (!tr.docChanged) {
// If inside table cell and can't outdent list, then let it handle by table keymap
return !isInsideTableCell(tr) ? new PassiveTransaction() : null;
}
// Determine the action subject ID from the parent list type
var $from = tr.selection.$from;
var currentListNode = (_findFirstParentListN = findFirstParentListNode($from)) === null || _findFirstParentListN === void 0 ? void 0 : _findFirstParentListN.node;
var actionSubjectId = currentListNode && isBulletList(currentListNode) ? ACTION_SUBJECT_ID.FORMAT_LIST_BULLET : ACTION_SUBJECT_ID.FORMAT_LIST_NUMBER;
// Get restart list attributes for analytics
var restartListsAttributes = {};
var _getRestartListsAttri = getRestartListsAttributes(tr),
outdentScenario = _getRestartListsAttri.outdentScenario,
splitListStartNumber = _getRestartListsAttri.splitListStartNumber;
if (outdentScenario === OUTDENT_SCENARIOS.SPLIT_LIST) {
restartListsAttributes.outdentScenario = outdentScenario;
restartListsAttributes.splitListStartNumber = splitListStartNumber;
}
// Attach analytics event with flexibleIndentation attribute
editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent({
action: ACTION.OUTDENTED,
actionSubject: ACTION_SUBJECT.LIST,
actionSubjectId: actionSubjectId,
eventType: EVENT_TYPE.TRACK,
attributes: _objectSpread(_objectSpread(_objectSpread({}, getCommonListAnalyticsAttributes(tr)), restartListsAttributes), {}, {
inputMethod: inputMethod
})
})(tr);
return tr;
};
export var outdentList = function outdentList(editorAnalyticsAPI) {
return function () {
var inputMethod = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : INPUT_METHOD.KEYBOARD;
return function (_ref) {
var tr = _ref.tr;
if (!isInsideListItem(tr)) {
return null;
}
var $from = tr.selection.$from;
var parentListNode = findFirstParentListNode($from);
if (!parentListNode) {
// Even though this is a non-operation, we don't want to send this event to the browser. Because if we return false, the browser will move the focus to another place
return new PassiveTransaction();
}
// Save the history, so it could undo/revert to the same state before the outdent, see https://product-fabric.atlassian.net/browse/ED-14753
closeHistory(tr);
// Route to new or original implementation based on feature flag
if (expValEquals('platform_editor_flexible_list_indentation', 'isEnabled', true)) {
return handleOutdentListItems(tr, editorAnalyticsAPI, inputMethod);
}
var actionSubjectId = isBulletList(parentListNode.node) ? ACTION_SUBJECT_ID.FORMAT_LIST_BULLET : ACTION_SUBJECT_ID.FORMAT_LIST_NUMBER;
var customTr = tr;
outdentListAction(customTr);
if (!customTr || !customTr.docChanged) {
// Even though this is a non-operation, we don't want to send this event to the browser. Because if we return false, the browser will move the focus to another place
// If inside table cell and can't outdent list, then let it handle by table keymap
return !isInsideTableCell(customTr) ? new PassiveTransaction() : null;
}
var restartListsAttributes = {};
var _getRestartListsAttri2 = getRestartListsAttributes(customTr),
outdentScenario = _getRestartListsAttri2.outdentScenario,
splitListStartNumber = _getRestartListsAttri2.splitListStartNumber;
if (outdentScenario === OUTDENT_SCENARIOS.SPLIT_LIST) {
restartListsAttributes.outdentScenario = outdentScenario;
restartListsAttributes.splitListStartNumber = splitListStartNumber;
}
editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent({
action: ACTION.OUTDENTED,
actionSubject: ACTION_SUBJECT.LIST,
actionSubjectId: actionSubjectId,
eventType: EVENT_TYPE.TRACK,
attributes: _objectSpread(_objectSpread(_objectSpread({}, getCommonListAnalyticsAttributes(customTr)), restartListsAttributes), {}, {
inputMethod: inputMethod
})
})(customTr);
return customTr;
};
};
};