All files / roosterjs-content-model-plugins/lib/autoFormat/horizontalLine checkAndInsertHorizontalLine.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
1x
 
 
 
 
 
 
 
1x
 
 
 
 
 
 
 
 
 
 
 
1x
 
 
 
 
 
 
 
 
1x
 
 
 
 
 
 
 
1x
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1x
 
 
 
 
10x
10x
10x
 
10x
 
 
 
 
 
 
 
 
 
 
 
1x
5x
 
 
5x
10x
 
 
 
5x
1x
 
 
4x
19x
12x
6x
3x
3x
3x
 
12x
 
 
 
 
 
 
 
 
 
import { formatTextSegmentBeforeSelectionMarker } from 'roosterjs-content-model-api';
import type {
    ContentModelDividerFormat,
    FormatContentModelContext,
    IEditor,
    KeyDownEvent,
    ShallowMutableContentModelDocument,
} from 'roosterjs-content-model-types';
import {
    addBlock,
    ChangeSource,
    createContentModelDocument,
    createDivider,
    mergeModel,
} from 'roosterjs-content-model-dom';
 
/**
 * @internal
 */
export type HorizontalLineTriggerCharacter = '-' | '=' | '_' | '*' | '~' | '#';
const HorizontalLineTriggerCharacters: HorizontalLineTriggerCharacter[] = [
    '-',
    '=',
    '_',
    '*',
    '~',
    '#',
];
 
const commonStyles: ContentModelDividerFormat = {
    width: '98%',
    display: 'inline-block',
};
 
const HorizontalLineStyles: Map<
    HorizontalLineTriggerCharacter,
    ContentModelDividerFormat
> = new Map([
    [
        '-',
        {
            borderTop: '1px none',
            borderRight: '1px none',
            borderBottom: '1px solid',
            borderLeft: '1px none',
            ...commonStyles,
        },
    ],
    [
        '=',
        {
            borderTop: '3pt double',
            borderRight: '3pt none',
            borderBottom: '3pt none',
            borderLeft: '3pt none',
            ...commonStyles,
        },
    ],
    [
        '_',
        {
            borderTop: '1px solid',
            borderRight: '1px none',
            borderBottom: '1px solid',
            borderLeft: '1px none',
            ...commonStyles,
        },
    ],
    [
        '*',
        {
            borderTop: '1px none',
            borderRight: '1px none',
            borderBottom: '3px dotted',
            borderLeft: '1px none',
            ...commonStyles,
        },
    ],
    [
        '~',
        {
            borderTop: '1px none',
            borderRight: '1px none',
            borderBottom: '1px solid',
            borderLeft: '1px none',
            ...commonStyles,
        },
    ],
    [
        '#',
        {
            borderTop: '3pt double',
            borderRight: '3pt none',
            borderBottom: '3pt double',
            borderLeft: '3pt none',
            ...commonStyles,
        },
    ],
]);
 
/**
 * @internal exported only for unit test
 *
 * Create a horizontal line and insert it into the model
 *
 * @param model the model to insert horizontal line into
 * @param context the formatting context
 */
export function insertHorizontalLineIntoModel(
    model: ShallowMutableContentModelDocument,
    context: FormatContentModelContext,
    triggerChar: HorizontalLineTriggerCharacter
) {
    const hr = createDivider('hr', HorizontalLineStyles.get(triggerChar));
    const doc = createContentModelDocument();
    addBlock(doc, hr);
 
    mergeModel(model, doc, context);
}
 
/**
 * @internal
 *
 * Check if the current line should be formatted as horizontal line, and insert horizontal line if needed
 *
 * @param editor The editor to check and insert horizontal line
 * @param event The keydown event
 * @returns True if horizontal line is inserted, otherwise false
 */
export function checkAndInsertHorizontalLine(editor: IEditor, event: KeyDownEvent) {
    return formatTextSegmentBeforeSelectionMarker(
        editor,
        (model, _, para, __, context) => {
            const allText = para.segments.reduce(
                (acc, segment) => (segment.segmentType === 'Text' ? acc + segment.text : acc),
                ''
            );
            // At least 3 characters are needed to trigger horizontal line
            if (allText.length < 3) {
                return false;
            }
 
            return HorizontalLineTriggerCharacters.some(triggerCharacter => {
                const shouldFormat = allText.split('').every(char => char === triggerCharacter);
                if (shouldFormat) {
                    para.segments = para.segments.filter(s => s.segmentType != 'Text');
                    insertHorizontalLineIntoModel(model, context, triggerCharacter);
                    event.rawEvent.preventDefault();
                    context.canUndoByBackspace = true;
                }
                return shouldFormat;
            });
        },
        {
            changeSource: ChangeSource.AutoFormat,
            apiName: 'autoHorizontalLine',
        }
    );
}