@atlaskit/editor-plugin-list
Version:
List plugin for @atlaskit/editor-core
63 lines (60 loc) • 2.5 kB
JavaScript
import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } 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/closeHistory';
import { moveSelectedListItems } from '../actions/move-selected-list-items';
import { findFirstParentListNode } from '../utils/find';
import { isInsideListItem, isInsideTableCell } from '../utils/selection';
/**
* Handler for flexible list outdentation.
* Lifts items independently and cleans up wrapper structures.
*/
const 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
const {
selection: {
$from
}
} = tr;
const currentListNode = (_findFirstParentListN = findFirstParentListNode($from)) === null || _findFirstParentListN === void 0 ? void 0 : _findFirstParentListN.node;
const actionSubjectId = currentListNode && isBulletList(currentListNode) ? ACTION_SUBJECT_ID.FORMAT_LIST_BULLET : ACTION_SUBJECT_ID.FORMAT_LIST_NUMBER;
// Attach analytics event with flexibleIndentation attribute
editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.attachAnalyticsEvent({
action: ACTION.OUTDENTED,
actionSubject: ACTION_SUBJECT.LIST,
actionSubjectId,
eventType: EVENT_TYPE.TRACK,
attributes: {
...getCommonListAnalyticsAttributes(tr),
inputMethod
}
})(tr);
return tr;
};
export const outdentList = editorAnalyticsAPI => (inputMethod = INPUT_METHOD.KEYBOARD) => {
return function ({
tr
}) {
if (!isInsideListItem(tr)) {
return null;
}
const {
$from
} = tr.selection;
const parentListNode = findFirstParentListNode($from);
if (!parentListNode) {
// Keep focus in the editor when there is no parent list to outdent.
return new PassiveTransaction();
}
closeHistory(tr);
return handleOutdentListItems(tr, editorAnalyticsAPI, inputMethod);
};
};