@gravity-ui/markdown-editor 13.10.0 → 13.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -47,6 +47,10 @@ export interface Editor extends Receiver<EventMap>, CommonEditor {
47
47
  export declare type MarkupConfig = {
48
48
  /** Additional extensions for codemirror instance. */
49
49
  extensions?: CreateCodemirrorParams['extensions'];
50
+ /** Can be used to disable some of the default extensions */
51
+ disabledExtensions?: CreateCodemirrorParams['disabledExtensions'];
52
+ /** Additional keymaps for codemirror instance */
53
+ keymaps?: CreateCodemirrorParams['keymaps'];
50
54
  /**
51
55
  * Additional language data for markdown language in codemirror.
52
56
  * Can be used to configure additional autocompletions and others.
@@ -157,6 +157,8 @@ class EditorImpl extends event_emitter_1.SafeEventEmitter {
157
157
  uploadHandler: this.fileUploadHandler,
158
158
  needImgDimms: this.needToSetDimensionsForUploadedImages,
159
159
  extensions: tslib_1.__classPrivateFieldGet(this, _EditorImpl_markupConfig, "f").extensions,
160
+ disabledExtensions: tslib_1.__classPrivateFieldGet(this, _EditorImpl_markupConfig, "f").disabledExtensions,
161
+ keymaps: tslib_1.__classPrivateFieldGet(this, _EditorImpl_markupConfig, "f").keymaps,
160
162
  yfmLangOptions: { languageData: tslib_1.__classPrivateFieldGet(this, _EditorImpl_markupConfig, "f").languageData },
161
163
  receiver: this,
162
164
  })), "f");
@@ -1,5 +1,5 @@
1
1
  import type { Extension, StateCommand } from '@codemirror/state';
2
- import { EditorView, EditorViewConfig } from '@codemirror/view';
2
+ import { EditorView, EditorViewConfig, KeyBinding } from '@codemirror/view';
3
3
  import { EventMap } from '../../bundle/Editor';
4
4
  import { ReactRenderStorage } from '../../extensions';
5
5
  import { Receiver } from '../../utils';
@@ -18,6 +18,10 @@ export declare type CreateCodemirrorParams = {
18
18
  uploadHandler?: FileUploadHandler;
19
19
  needImgDimms?: boolean;
20
20
  extensions?: Extension[];
21
+ disabledExtensions?: {
22
+ history?: boolean;
23
+ };
24
+ keymaps?: readonly KeyBinding[];
21
25
  receiver?: Receiver<EventMap>;
22
26
  yfmLangOptions?: YfmLangOptions;
23
27
  };
@@ -16,65 +16,56 @@ const react_facet_1 = require("./react-facet");
16
16
  const plugin_1 = require("./search-plugin/plugin");
17
17
  const yfm_1 = require("./yfm");
18
18
  function createCodemirror(params) {
19
- const { doc, placeholderText, reactRenderer, onCancel, onScroll, onSubmit, onChange, onDocChange, extensions: extraExtensions, receiver, yfmLangOptions, } = params;
20
- const extensions = [
21
- gravity_1.gravityTheme,
22
- (0, view_1.placeholder)(placeholderText),
23
- (0, commands_1.history)(),
24
- (0, language_1.syntaxHighlighting)(gravity_1.gravityHighlightStyle),
25
- view_1.keymap.of([
26
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Bold), run: withLogger(action_names_1.ActionName.bold, commands_2.toggleBold) },
27
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Italic), run: withLogger(action_names_1.ActionName.italic, commands_2.toggleItalic) },
28
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Strike), run: withLogger(action_names_1.ActionName.strike, commands_2.toggleStrikethrough) },
29
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Underline), run: withLogger(action_names_1.ActionName.underline, commands_2.toggleUnderline) },
30
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Link), run: withLogger(action_names_1.ActionName.link, commands_2.insertLink) },
31
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Heading1), run: withLogger(action_names_1.ActionName.heading1, commands_2.toH1) },
32
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Heading2), run: withLogger(action_names_1.ActionName.heading2, commands_2.toH2) },
33
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Heading3), run: withLogger(action_names_1.ActionName.heading3, commands_2.toH3) },
34
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Heading4), run: withLogger(action_names_1.ActionName.heading4, commands_2.toH4) },
35
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Heading5), run: withLogger(action_names_1.ActionName.heading5, commands_2.toH5) },
36
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Heading6), run: withLogger(action_names_1.ActionName.heading6, commands_2.toH6) },
37
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Code), run: withLogger(action_names_1.ActionName.code_inline, commands_2.wrapToInlineCode) },
38
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.CodeBlock), run: withLogger(action_names_1.ActionName.code_block, commands_2.wrapToCodeBlock) },
39
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Cut), run: withLogger(action_names_1.ActionName.yfm_cut, commands_2.wrapToYfmCut) },
40
- { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Note), run: withLogger(action_names_1.ActionName.yfm_note, commands_2.wrapToYfmNote) },
41
- {
42
- key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Cancel),
43
- preventDefault: true,
44
- run: () => {
45
- onCancel();
46
- return true;
47
- },
48
- },
49
- {
50
- key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Submit),
51
- preventDefault: true,
52
- run: () => {
53
- onSubmit();
54
- return true;
55
- },
19
+ const { doc, placeholderText, reactRenderer, onCancel, onScroll, onSubmit, onChange, onDocChange, extensions: extraExtensions, disabledExtensions = {}, keymaps = [], receiver, yfmLangOptions, } = params;
20
+ const extensions = [gravity_1.gravityTheme, (0, view_1.placeholder)(placeholderText)];
21
+ if (!disabledExtensions.history) {
22
+ extensions.push((0, commands_1.history)());
23
+ }
24
+ extensions.push((0, language_1.syntaxHighlighting)(gravity_1.gravityHighlightStyle), view_1.keymap.of([
25
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Bold), run: withLogger(action_names_1.ActionName.bold, commands_2.toggleBold) },
26
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Italic), run: withLogger(action_names_1.ActionName.italic, commands_2.toggleItalic) },
27
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Strike), run: withLogger(action_names_1.ActionName.strike, commands_2.toggleStrikethrough) },
28
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Underline), run: withLogger(action_names_1.ActionName.underline, commands_2.toggleUnderline) },
29
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Link), run: withLogger(action_names_1.ActionName.link, commands_2.insertLink) },
30
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Heading1), run: withLogger(action_names_1.ActionName.heading1, commands_2.toH1) },
31
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Heading2), run: withLogger(action_names_1.ActionName.heading2, commands_2.toH2) },
32
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Heading3), run: withLogger(action_names_1.ActionName.heading3, commands_2.toH3) },
33
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Heading4), run: withLogger(action_names_1.ActionName.heading4, commands_2.toH4) },
34
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Heading5), run: withLogger(action_names_1.ActionName.heading5, commands_2.toH5) },
35
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Heading6), run: withLogger(action_names_1.ActionName.heading6, commands_2.toH6) },
36
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Code), run: withLogger(action_names_1.ActionName.code_inline, commands_2.wrapToInlineCode) },
37
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.CodeBlock), run: withLogger(action_names_1.ActionName.code_block, commands_2.wrapToCodeBlock) },
38
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Cut), run: withLogger(action_names_1.ActionName.yfm_cut, commands_2.wrapToYfmCut) },
39
+ { key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Note), run: withLogger(action_names_1.ActionName.yfm_note, commands_2.wrapToYfmNote) },
40
+ {
41
+ key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Cancel),
42
+ preventDefault: true,
43
+ run: () => {
44
+ onCancel();
45
+ return true;
56
46
  },
57
- { key: 'Tab', preventDefault: true, run: commands_1.insertTab },
58
- commands_1.indentWithTab,
59
- ...commands_1.defaultKeymap,
60
- ...commands_1.historyKeymap,
61
- ]),
62
- (0, autocomplete_1.autocompletion)(),
63
- (0, yfm_1.yfmLang)(yfmLangOptions),
64
- react_facet_1.ReactRendererFacet.of(reactRenderer),
65
- pairing_chars_1.PairingCharactersExtension,
66
- view_1.EditorView.lineWrapping,
67
- view_1.EditorView.contentAttributes.of({ spellcheck: 'true' }),
68
- view_1.EditorView.domEventHandlers({
69
- scroll(event) {
70
- onScroll(event);
47
+ },
48
+ {
49
+ key: shortcuts_1.formatter.toCM(shortcuts_1.Action.Submit),
50
+ preventDefault: true,
51
+ run: () => {
52
+ onSubmit();
53
+ return true;
71
54
  },
72
- }),
73
- (0, plugin_1.SearchPanelPlugin)({
74
- anchorSelector: '.g-md-search-anchor',
75
- receiver,
76
- }),
77
- ];
55
+ },
56
+ { key: 'Tab', preventDefault: true, run: commands_1.insertTab },
57
+ commands_1.indentWithTab,
58
+ ...commands_1.defaultKeymap,
59
+ ...(disabledExtensions.history ? [] : commands_1.historyKeymap),
60
+ ...keymaps,
61
+ ]), (0, autocomplete_1.autocompletion)(), (0, yfm_1.yfmLang)(yfmLangOptions), react_facet_1.ReactRendererFacet.of(reactRenderer), pairing_chars_1.PairingCharactersExtension, view_1.EditorView.lineWrapping, view_1.EditorView.contentAttributes.of({ spellcheck: 'true' }), view_1.EditorView.domEventHandlers({
62
+ scroll(event) {
63
+ onScroll(event);
64
+ },
65
+ }), (0, plugin_1.SearchPanelPlugin)({
66
+ anchorSelector: '.g-md-search-anchor',
67
+ receiver,
68
+ }));
78
69
  if (params.uploadHandler) {
79
70
  extensions.push(files_upload_facet_1.FileUploadHandlerFacet.of({
80
71
  fn: params.uploadHandler,
@@ -2,4 +2,4 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
4
  /** During build process, the current version will be injected here */
5
- exports.VERSION = typeof '13.10.0' !== 'undefined' ? '13.10.0' : 'unknown';
5
+ exports.VERSION = typeof '13.11.0' !== 'undefined' ? '13.11.0' : 'unknown';
@@ -47,6 +47,10 @@ export interface Editor extends Receiver<EventMap>, CommonEditor {
47
47
  export declare type MarkupConfig = {
48
48
  /** Additional extensions for codemirror instance. */
49
49
  extensions?: CreateCodemirrorParams['extensions'];
50
+ /** Can be used to disable some of the default extensions */
51
+ disabledExtensions?: CreateCodemirrorParams['disabledExtensions'];
52
+ /** Additional keymaps for codemirror instance */
53
+ keymaps?: CreateCodemirrorParams['keymaps'];
50
54
  /**
51
55
  * Additional language data for markdown language in codemirror.
52
56
  * Can be used to configure additional autocompletions and others.
@@ -154,6 +154,8 @@ export class EditorImpl extends SafeEventEmitter {
154
154
  uploadHandler: this.fileUploadHandler,
155
155
  needImgDimms: this.needToSetDimensionsForUploadedImages,
156
156
  extensions: __classPrivateFieldGet(this, _EditorImpl_markupConfig, "f").extensions,
157
+ disabledExtensions: __classPrivateFieldGet(this, _EditorImpl_markupConfig, "f").disabledExtensions,
158
+ keymaps: __classPrivateFieldGet(this, _EditorImpl_markupConfig, "f").keymaps,
157
159
  yfmLangOptions: { languageData: __classPrivateFieldGet(this, _EditorImpl_markupConfig, "f").languageData },
158
160
  receiver: this,
159
161
  })), "f");
@@ -1,5 +1,5 @@
1
1
  import type { Extension, StateCommand } from '@codemirror/state';
2
- import { EditorView, EditorViewConfig } from '@codemirror/view';
2
+ import { EditorView, EditorViewConfig, KeyBinding } from '@codemirror/view';
3
3
  import { EventMap } from '../../bundle/Editor';
4
4
  import { ReactRenderStorage } from '../../extensions';
5
5
  import { Receiver } from '../../utils';
@@ -18,6 +18,10 @@ export declare type CreateCodemirrorParams = {
18
18
  uploadHandler?: FileUploadHandler;
19
19
  needImgDimms?: boolean;
20
20
  extensions?: Extension[];
21
+ disabledExtensions?: {
22
+ history?: boolean;
23
+ };
24
+ keymaps?: readonly KeyBinding[];
21
25
  receiver?: Receiver<EventMap>;
22
26
  yfmLangOptions?: YfmLangOptions;
23
27
  };
@@ -13,65 +13,56 @@ import { ReactRendererFacet } from './react-facet';
13
13
  import { SearchPanelPlugin } from './search-plugin/plugin';
14
14
  import { yfmLang } from './yfm';
15
15
  export function createCodemirror(params) {
16
- const { doc, placeholderText, reactRenderer, onCancel, onScroll, onSubmit, onChange, onDocChange, extensions: extraExtensions, receiver, yfmLangOptions, } = params;
17
- const extensions = [
18
- gravityTheme,
19
- placeholder(placeholderText),
20
- history(),
21
- syntaxHighlighting(gravityHighlightStyle),
22
- keymap.of([
23
- { key: f.toCM(A.Bold), run: withLogger(ActionName.bold, toggleBold) },
24
- { key: f.toCM(A.Italic), run: withLogger(ActionName.italic, toggleItalic) },
25
- { key: f.toCM(A.Strike), run: withLogger(ActionName.strike, toggleStrikethrough) },
26
- { key: f.toCM(A.Underline), run: withLogger(ActionName.underline, toggleUnderline) },
27
- { key: f.toCM(A.Link), run: withLogger(ActionName.link, insertLink) },
28
- { key: f.toCM(A.Heading1), run: withLogger(ActionName.heading1, toH1) },
29
- { key: f.toCM(A.Heading2), run: withLogger(ActionName.heading2, toH2) },
30
- { key: f.toCM(A.Heading3), run: withLogger(ActionName.heading3, toH3) },
31
- { key: f.toCM(A.Heading4), run: withLogger(ActionName.heading4, toH4) },
32
- { key: f.toCM(A.Heading5), run: withLogger(ActionName.heading5, toH5) },
33
- { key: f.toCM(A.Heading6), run: withLogger(ActionName.heading6, toH6) },
34
- { key: f.toCM(A.Code), run: withLogger(ActionName.code_inline, wrapToInlineCode) },
35
- { key: f.toCM(A.CodeBlock), run: withLogger(ActionName.code_block, wrapToCodeBlock) },
36
- { key: f.toCM(A.Cut), run: withLogger(ActionName.yfm_cut, wrapToYfmCut) },
37
- { key: f.toCM(A.Note), run: withLogger(ActionName.yfm_note, wrapToYfmNote) },
38
- {
39
- key: f.toCM(A.Cancel),
40
- preventDefault: true,
41
- run: () => {
42
- onCancel();
43
- return true;
44
- },
45
- },
46
- {
47
- key: f.toCM(A.Submit),
48
- preventDefault: true,
49
- run: () => {
50
- onSubmit();
51
- return true;
52
- },
16
+ const { doc, placeholderText, reactRenderer, onCancel, onScroll, onSubmit, onChange, onDocChange, extensions: extraExtensions, disabledExtensions = {}, keymaps = [], receiver, yfmLangOptions, } = params;
17
+ const extensions = [gravityTheme, placeholder(placeholderText)];
18
+ if (!disabledExtensions.history) {
19
+ extensions.push(history());
20
+ }
21
+ extensions.push(syntaxHighlighting(gravityHighlightStyle), keymap.of([
22
+ { key: f.toCM(A.Bold), run: withLogger(ActionName.bold, toggleBold) },
23
+ { key: f.toCM(A.Italic), run: withLogger(ActionName.italic, toggleItalic) },
24
+ { key: f.toCM(A.Strike), run: withLogger(ActionName.strike, toggleStrikethrough) },
25
+ { key: f.toCM(A.Underline), run: withLogger(ActionName.underline, toggleUnderline) },
26
+ { key: f.toCM(A.Link), run: withLogger(ActionName.link, insertLink) },
27
+ { key: f.toCM(A.Heading1), run: withLogger(ActionName.heading1, toH1) },
28
+ { key: f.toCM(A.Heading2), run: withLogger(ActionName.heading2, toH2) },
29
+ { key: f.toCM(A.Heading3), run: withLogger(ActionName.heading3, toH3) },
30
+ { key: f.toCM(A.Heading4), run: withLogger(ActionName.heading4, toH4) },
31
+ { key: f.toCM(A.Heading5), run: withLogger(ActionName.heading5, toH5) },
32
+ { key: f.toCM(A.Heading6), run: withLogger(ActionName.heading6, toH6) },
33
+ { key: f.toCM(A.Code), run: withLogger(ActionName.code_inline, wrapToInlineCode) },
34
+ { key: f.toCM(A.CodeBlock), run: withLogger(ActionName.code_block, wrapToCodeBlock) },
35
+ { key: f.toCM(A.Cut), run: withLogger(ActionName.yfm_cut, wrapToYfmCut) },
36
+ { key: f.toCM(A.Note), run: withLogger(ActionName.yfm_note, wrapToYfmNote) },
37
+ {
38
+ key: f.toCM(A.Cancel),
39
+ preventDefault: true,
40
+ run: () => {
41
+ onCancel();
42
+ return true;
53
43
  },
54
- { key: 'Tab', preventDefault: true, run: insertTab },
55
- indentWithTab,
56
- ...defaultKeymap,
57
- ...historyKeymap,
58
- ]),
59
- autocompletion(),
60
- yfmLang(yfmLangOptions),
61
- ReactRendererFacet.of(reactRenderer),
62
- PairingCharactersExtension,
63
- EditorView.lineWrapping,
64
- EditorView.contentAttributes.of({ spellcheck: 'true' }),
65
- EditorView.domEventHandlers({
66
- scroll(event) {
67
- onScroll(event);
44
+ },
45
+ {
46
+ key: f.toCM(A.Submit),
47
+ preventDefault: true,
48
+ run: () => {
49
+ onSubmit();
50
+ return true;
68
51
  },
69
- }),
70
- SearchPanelPlugin({
71
- anchorSelector: '.g-md-search-anchor',
72
- receiver,
73
- }),
74
- ];
52
+ },
53
+ { key: 'Tab', preventDefault: true, run: insertTab },
54
+ indentWithTab,
55
+ ...defaultKeymap,
56
+ ...(disabledExtensions.history ? [] : historyKeymap),
57
+ ...keymaps,
58
+ ]), autocompletion(), yfmLang(yfmLangOptions), ReactRendererFacet.of(reactRenderer), PairingCharactersExtension, EditorView.lineWrapping, EditorView.contentAttributes.of({ spellcheck: 'true' }), EditorView.domEventHandlers({
59
+ scroll(event) {
60
+ onScroll(event);
61
+ },
62
+ }), SearchPanelPlugin({
63
+ anchorSelector: '.g-md-search-anchor',
64
+ receiver,
65
+ }));
75
66
  if (params.uploadHandler) {
76
67
  extensions.push(FileUploadHandlerFacet.of({
77
68
  fn: params.uploadHandler,
@@ -1,2 +1,2 @@
1
1
  /** During build process, the current version will be injected here */
2
- export const VERSION = typeof '13.10.0' !== 'undefined' ? '13.10.0' : 'unknown';
2
+ export const VERSION = typeof '13.11.0' !== 'undefined' ? '13.11.0' : 'unknown';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gravity-ui/markdown-editor",
3
- "version": "13.10.0",
3
+ "version": "13.11.0",
4
4
  "description": "Markdown wysiwyg and markup editor",
5
5
  "license": "MIT",
6
6
  "repository": {