@dxos/react-ui-editor 0.3.11-main.8a2cfe6 → 0.3.11-main.8a9dd1e

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.
Files changed (73) hide show
  1. package/dist/lib/browser/index.mjs +305 -385
  2. package/dist/lib/browser/index.mjs.map +4 -4
  3. package/dist/lib/browser/meta.json +1 -1
  4. package/dist/types/src/components/TextEditor/MarkdownEditor.stories.d.ts +6 -2
  5. package/dist/types/src/components/TextEditor/MarkdownEditor.stories.d.ts.map +1 -1
  6. package/dist/types/src/components/TextEditor/TextEditor.d.ts +12 -17
  7. package/dist/types/src/components/TextEditor/TextEditor.d.ts.map +1 -1
  8. package/dist/types/src/components/TextEditor/TextEditor.stories.d.ts +6 -6
  9. package/dist/types/src/components/TextEditor/TextEditor.stories.d.ts.map +1 -1
  10. package/dist/types/src/components/TextEditor/comments.stories.d.ts +26 -0
  11. package/dist/types/src/components/TextEditor/comments.stories.d.ts.map +1 -0
  12. package/dist/types/src/components/TextEditor/yjs.stories.d.ts +1 -1
  13. package/dist/types/src/extensions/autocomplete.d.ts.map +1 -1
  14. package/dist/types/src/extensions/automerge/cursor.d.ts +1 -1
  15. package/dist/types/src/extensions/automerge/cursor.d.ts.map +1 -1
  16. package/dist/types/src/extensions/automerge/index.d.ts +1 -0
  17. package/dist/types/src/extensions/automerge/index.d.ts.map +1 -1
  18. package/dist/types/src/extensions/code.d.ts.map +1 -1
  19. package/dist/types/src/extensions/comments.d.ts +6 -2
  20. package/dist/types/src/extensions/comments.d.ts.map +1 -1
  21. package/dist/types/src/{util → extensions}/cursor.d.ts +9 -1
  22. package/dist/types/src/extensions/cursor.d.ts.map +1 -0
  23. package/dist/types/src/extensions/index.d.ts +1 -0
  24. package/dist/types/src/extensions/index.d.ts.map +1 -1
  25. package/dist/types/src/extensions/markdown/highlight.d.ts.map +1 -1
  26. package/dist/types/src/extensions/tasklist.d.ts +5 -1
  27. package/dist/types/src/extensions/tasklist.d.ts.map +1 -1
  28. package/dist/types/src/extensions/yjs/cursor.d.ts +1 -1
  29. package/dist/types/src/extensions/yjs/cursor.d.ts.map +1 -1
  30. package/dist/types/src/hooks/useTextModel.d.ts +0 -5
  31. package/dist/types/src/hooks/useTextModel.d.ts.map +1 -1
  32. package/dist/types/src/hooks/yjs.d.ts.map +1 -1
  33. package/dist/types/src/index.d.ts +2 -0
  34. package/dist/types/src/index.d.ts.map +1 -1
  35. package/dist/types/src/styles/markdown.d.ts.map +1 -1
  36. package/dist/types/src/themes/default.d.ts.map +1 -1
  37. package/dist/types/src/util.d.ts.map +1 -0
  38. package/package.json +24 -23
  39. package/src/components/TextEditor/MarkdownEditor.stories.tsx +19 -16
  40. package/src/components/TextEditor/TextEditor.stories.tsx +12 -46
  41. package/src/components/TextEditor/TextEditor.tsx +68 -64
  42. package/src/components/TextEditor/comments.stories.tsx +329 -0
  43. package/src/extensions/autocomplete.ts +18 -17
  44. package/src/extensions/automerge/automerge.ts +2 -2
  45. package/src/extensions/automerge/cursor.ts +2 -1
  46. package/src/extensions/automerge/index.ts +1 -0
  47. package/src/extensions/awareness.ts +25 -32
  48. package/src/extensions/code.ts +10 -2
  49. package/src/extensions/comments.ts +86 -116
  50. package/src/extensions/cursor.ts +46 -0
  51. package/src/extensions/hr.ts +2 -2
  52. package/src/extensions/image.ts +2 -2
  53. package/src/extensions/index.ts +1 -0
  54. package/src/extensions/link.ts +4 -4
  55. package/src/extensions/markdown/highlight.ts +0 -8
  56. package/src/extensions/table.ts +6 -3
  57. package/src/extensions/tasklist.ts +53 -77
  58. package/src/extensions/yjs/cursor.ts +2 -1
  59. package/src/extensions/yjs/yjs.test.ts +1 -1
  60. package/src/extensions/yjs/yjs.ts +2 -2
  61. package/src/hooks/useTextModel.ts +4 -7
  62. package/src/hooks/yjs.ts +1 -23
  63. package/src/index.ts +2 -0
  64. package/src/styles/markdown.ts +0 -2
  65. package/src/themes/default.ts +17 -50
  66. package/dist/types/src/util/cursor.d.ts.map +0 -1
  67. package/dist/types/src/util/index.d.ts +0 -3
  68. package/dist/types/src/util/index.d.ts.map +0 -1
  69. package/dist/types/src/util/util.d.ts.map +0 -1
  70. package/src/util/cursor.ts +0 -29
  71. package/src/util/index.ts +0 -6
  72. /package/dist/types/src/{util/util.d.ts → util.d.ts} +0 -0
  73. /package/src/{util/util.ts → util.ts} +0 -0
@@ -1 +1 @@
1
- {"version":3,"file":"yjs.d.ts","sourceRoot":"","sources":["../../../../src/hooks/yjs.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAE5C,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,KAAK,CAAC;AAI/B,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAKrD,OAAO,EAAE,KAAK,WAAW,EAA0B,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGlG,eAAO,MAAM,cAAc,8BAA+B,iBAAiB,KAAG,WAyC7E,CAAC;AAOF;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,UAAU,CAAC,GAAG,CAAC;IACrD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAe;IAC1C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;gBAEtB,EACV,KAAK,EACL,GAAG,EACH,OAAO,EACP,SAAS,GACV,EAAE;QACD,KAAK,EAAE,KAAK,CAAC;QACb,GAAG,EAAE,GAAG,CAAC;QACT,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC;KAC1B;IA4BD,IAAI,SAAS,IAAI,EAAE,CAAC,SAAS,CAE5B;IAED,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,mBAAmB;IAS3B,OAAO,CAAC,YAAY;IAoCpB,OAAO,CAAC,mBAAmB;CAG5B"}
1
+ {"version":3,"file":"yjs.d.ts","sourceRoot":"","sources":["../../../../src/hooks/yjs.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC5C,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,KAAK,CAAC;AAI/B,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAIrD,OAAO,EAAE,KAAK,WAAW,EAAc,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGtF,eAAO,MAAM,cAAc,8BAA+B,iBAAiB,KAAG,WAqB7E,CAAC;AAOF;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,UAAU,CAAC,GAAG,CAAC;IACrD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAe;IAC1C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;gBAEtB,EACV,KAAK,EACL,GAAG,EACH,OAAO,EACP,SAAS,GACV,EAAE;QACD,KAAK,EAAE,KAAK,CAAC;QACb,GAAG,EAAE,GAAG,CAAC;QACT,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC;KAC1B;IA4BD,IAAI,SAAS,IAAI,EAAE,CAAC,SAAS,CAE5B;IAED,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,mBAAmB;IAS3B,OAAO,CAAC,YAAY;IAoCpB,OAAO,CAAC,mBAAmB;CAG5B"}
@@ -1,9 +1,11 @@
1
1
  export { TextKind } from '@dxos/protocols/proto/dxos/echo/model/text';
2
2
  export { Doc, YText, YXmlFragment } from '@dxos/text-model';
3
3
  export { type Extension } from '@codemirror/state';
4
+ export { type EditorView } from '@codemirror/view';
4
5
  export * from './components';
5
6
  export * from './extensions';
6
7
  export * from './hooks';
7
8
  export { getToken } from './styles';
8
9
  export * from './themes';
10
+ export * from './util';
9
11
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,4CAA4C,CAAC;AACtE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEnD,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,cAAc,UAAU,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,4CAA4C,CAAC;AACtE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../../src/styles/markdown.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAIjD,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,CAOnD,CAAC;AAEF,eAAO,MAAM,OAAO,UAAW,YAAY,aAAa,OAAO,WAG9D,CAAC;AAEF,eAAO,MAAM,IAAI,2CAA2C,CAAC;AAC7D,eAAO,MAAM,KAAK,2CAA2C,CAAC;AAE9D,eAAO,MAAM,IAAI,QAAmE,CAAC;AAErF,eAAO,MAAM,SAAS,UAAU,CAAC;AAEjC,eAAO,MAAM,IAAI,cAAc,CAAC;AAChC,eAAO,MAAM,MAAM,WAAW,CAAC;AAC/B,eAAO,MAAM,aAAa,iBAAiB,CAAC;AAE5C,eAAO,MAAM,IAAI,mEAAmE,CAAC;AACrF,eAAO,MAAM,QAAQ,+BAA+B,CAAC;AACrD,eAAO,MAAM,SAAS,kDAAkD,CAAC;AAEzE,eAAO,MAAM,SAAS,QAAmB,CAAC;AAG1C,eAAO,MAAM,UAAU,QAAsF,CAAC;AAG9G,eAAO,MAAM,cAAc,0GAC8E,CAAC;AAG1G,eAAO,MAAM,aAAa,wHAC6F,CAAC;AACxH,eAAO,MAAM,WAAW,+IACkH,CAAC;AAE3I,eAAO,MAAM,QAAQ,gDAAgD,CAAC"}
1
+ {"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../../src/styles/markdown.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAIjD,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,CAOnD,CAAC;AAEF,eAAO,MAAM,OAAO,UAAW,YAAY,aAAa,OAAO,WAG9D,CAAC;AAEF,eAAO,MAAM,IAAI,2CAA2C,CAAC;AAC7D,eAAO,MAAM,KAAK,2CAA2C,CAAC;AAE9D,eAAO,MAAM,IAAI,QAAmE,CAAC;AAErF,eAAO,MAAM,SAAS,UAAU,CAAC;AAEjC,eAAO,MAAM,IAAI,cAAc,CAAC;AAChC,eAAO,MAAM,MAAM,WAAW,CAAC;AAC/B,eAAO,MAAM,aAAa,iBAAiB,CAAC;AAE5C,eAAO,MAAM,IAAI,mEAAmE,CAAC;AACrF,eAAO,MAAM,QAAQ,+BAA+B,CAAC;AACrD,eAAO,MAAM,SAAS,kDAAkD,CAAC;AAEzE,eAAO,MAAM,SAAS,QAAmB,CAAC;AAE1C,eAAO,MAAM,UAAU,QAAsF,CAAC;AAE9G,eAAO,MAAM,cAAc,0GAC8E,CAAC;AAG1G,eAAO,MAAM,aAAa,wHAC6F,CAAC;AACxH,eAAO,MAAM,WAAW,+IACkH,CAAC;AAE3I,eAAO,MAAM,QAAQ,gDAAgD,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../../../../src/themes/default.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,WAAW,EAAU,MAAM,WAAW,CAAC;AAKrD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,EAAE,WAoQ1B,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,WAOvB,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,WAK3B,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,WAOvB,CAAC"}
1
+ {"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../../../../src/themes/default.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,WAAW,EAAU,MAAM,WAAW,CAAC;AAKrD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,EAAE,WAiO1B,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,WAOvB,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,WAO3B,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,WAOvB,CAAC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/util.ts"],"names":[],"mappings":"AAMA;;GAEG;AAEH,eAAO,MAAM,eAAe,kCAOR,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dxos/react-ui-editor",
3
- "version": "0.3.11-main.8a2cfe6",
3
+ "version": "0.3.11-main.8a9dd1e",
4
4
  "description": "Document editing experience within a DXOS shell.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
@@ -15,7 +15,7 @@
15
15
  "dependencies": {
16
16
  "@codemirror/autocomplete": "^6.11.1",
17
17
  "@codemirror/commands": "^6.3.2",
18
- "@codemirror/lang-markdown": "^6.2.3",
18
+ "@codemirror/lang-markdown": "^6.2.4",
19
19
  "@codemirror/language": "^6.9.3",
20
20
  "@codemirror/language-data": "^6.3.1",
21
21
  "@codemirror/lint": "^6.4.2",
@@ -38,20 +38,20 @@
38
38
  "y-codemirror.next": "^0.3.2",
39
39
  "y-protocols": "^1.0.5",
40
40
  "yjs": "^13.6.10",
41
- "@dxos/async": "0.3.11-main.8a2cfe6",
42
- "@dxos/automerge": "0.3.11-main.8a2cfe6",
43
- "@dxos/context": "0.3.11-main.8a2cfe6",
44
- "@dxos/display-name": "0.3.11-main.8a2cfe6",
45
- "@dxos/invariant": "0.3.11-main.8a2cfe6",
46
- "@dxos/echo-schema": "0.3.11-main.8a2cfe6",
47
- "@dxos/protocols": "0.3.11-main.8a2cfe6",
48
- "@dxos/log": "0.3.11-main.8a2cfe6",
49
- "@dxos/react-async": "0.3.11-main.8a2cfe6",
50
- "@dxos/debug": "0.3.11-main.8a2cfe6",
51
- "@dxos/react-ui": "0.3.11-main.8a2cfe6",
52
- "@dxos/react-ui-theme": "0.3.11-main.8a2cfe6",
53
- "@dxos/util": "0.3.11-main.8a2cfe6",
54
- "@dxos/text-model": "0.3.11-main.8a2cfe6"
41
+ "@dxos/async": "0.3.11-main.8a9dd1e",
42
+ "@dxos/automerge": "0.3.11-main.8a9dd1e",
43
+ "@dxos/debug": "0.3.11-main.8a9dd1e",
44
+ "@dxos/display-name": "0.3.11-main.8a9dd1e",
45
+ "@dxos/context": "0.3.11-main.8a9dd1e",
46
+ "@dxos/echo-schema": "0.3.11-main.8a9dd1e",
47
+ "@dxos/invariant": "0.3.11-main.8a9dd1e",
48
+ "@dxos/log": "0.3.11-main.8a9dd1e",
49
+ "@dxos/protocols": "0.3.11-main.8a9dd1e",
50
+ "@dxos/react-ui-theme": "0.3.11-main.8a9dd1e",
51
+ "@dxos/react-ui": "0.3.11-main.8a9dd1e",
52
+ "@dxos/util": "0.3.11-main.8a9dd1e",
53
+ "@dxos/text-model": "0.3.11-main.8a9dd1e",
54
+ "@dxos/react-async": "0.3.11-main.8a9dd1e"
55
55
  },
56
56
  "devDependencies": {
57
57
  "@automerge/automerge-repo-network-broadcastchannel": "^1.0.19",
@@ -67,18 +67,19 @@
67
67
  "deepsignal": "1.4.0-shallow.0",
68
68
  "react": "^18.2.0",
69
69
  "react-dom": "^18.2.0",
70
- "@dxos/config": "0.3.11-main.8a2cfe6",
71
- "@dxos/echo-typegen": "0.3.11-main.8a2cfe6",
72
- "@dxos/react-client": "0.3.11-main.8a2cfe6",
73
- "@dxos/echo-signals": "0.3.11-main.8a2cfe6",
74
- "@dxos/react-ui": "0.3.11-main.8a2cfe6",
75
- "@dxos/storybook-utils": "0.3.11-main.8a2cfe6"
70
+ "@dxos/config": "0.3.11-main.8a9dd1e",
71
+ "@dxos/echo-typegen": "0.3.11-main.8a9dd1e",
72
+ "@dxos/echo-signals": "0.3.11-main.8a9dd1e",
73
+ "@dxos/keyboard": "0.3.11-main.8a9dd1e",
74
+ "@dxos/react-client": "0.3.11-main.8a9dd1e",
75
+ "@dxos/react-ui": "0.3.11-main.8a9dd1e",
76
+ "@dxos/storybook-utils": "0.3.11-main.8a9dd1e"
76
77
  },
77
78
  "peerDependencies": {
78
79
  "@phosphor-icons/react": "^2.0.5",
79
80
  "react": "^18.2.0",
80
81
  "react-dom": "^18.2.0",
81
- "@dxos/react-client": "0.3.11-main.8a2cfe6"
82
+ "@dxos/react-client": "0.3.11-main.8a9dd1e"
82
83
  },
83
84
  "publishConfig": {
84
85
  "access": "public"
@@ -8,15 +8,16 @@ import { EditorView } from '@codemirror/view';
8
8
  import { faker } from '@faker-js/faker';
9
9
  import { ArrowSquareOut } from '@phosphor-icons/react';
10
10
  import defaultsDeep from 'lodash.defaultsdeep';
11
- import React, { type FC, StrictMode, useRef, useState } from 'react';
11
+ import React, { type FC, StrictMode, useState } from 'react';
12
12
  import { createRoot } from 'react-dom/client';
13
13
 
14
14
  import { TextObject } from '@dxos/echo-schema';
15
+ import { keySymbols, parseShortcut } from '@dxos/keyboard';
15
16
  import { PublicKey } from '@dxos/keys';
16
17
  import { fixedInsetFlexLayout, getSize, groupSurface, mx } from '@dxos/react-ui-theme';
17
18
  import { withTheme } from '@dxos/storybook-utils';
18
19
 
19
- import { MarkdownEditor, type TextEditorProps, type TextEditorRef } from './TextEditor';
20
+ import { MarkdownEditor, type TextEditorProps } from './TextEditor';
20
21
  import {
21
22
  autocomplete,
22
23
  blast,
@@ -182,15 +183,15 @@ const Key: FC<{ char: string }> = ({ char }) => (
182
183
  </span>
183
184
  );
184
185
 
185
- const onCommentsHover: CommentsOptions['onHover'] = (el) => {
186
+ const onCommentsHover: CommentsOptions['onHover'] = (el, shortcut) => {
186
187
  createRoot(el).render(
187
188
  <StrictMode>
188
189
  <div className='flex items-center gap-2 px-2 py-2 bg-neutral-700 text-white text-xs rounded'>
189
190
  <div>Create comment</div>
190
- {/* TODO(burdon): Unify shortcuts. */}
191
191
  <div className='flex gap-1'>
192
- <Key char='⌘' />
193
- <Key char="'" />
192
+ {keySymbols(parseShortcut(shortcut)).map((char) => (
193
+ <Key key={char} char={char} />
194
+ ))}
194
195
  </div>
195
196
  </div>
196
197
  </StrictMode>,
@@ -201,7 +202,7 @@ const onRenderLink: LinkOptions['onRender'] = (el, url) => {
201
202
  createRoot(el).render(
202
203
  <StrictMode>
203
204
  <a href={url} target='_blank' rel='noreferrer' className={hover}>
204
- <ArrowSquareOut weight='bold' className={mx(getSize(4), 'inline-block leading-none mis-1 mb-1')} />
205
+ <ArrowSquareOut weight='bold' className={mx(getSize(4), 'inline-block leading-none mis-1 mb-[2px]')} />
205
206
  </a>
206
207
  </StrictMode>,
207
208
  );
@@ -213,7 +214,6 @@ type StoryProps = {
213
214
  } & Pick<TextEditorProps, 'comments' | 'readonly' | 'extensions' | 'slots'>;
214
215
 
215
216
  const Story = ({ text, automerge, ...props }: StoryProps) => {
216
- const ref = useRef<TextEditorRef>(null);
217
217
  const [item] = useState({ text: new TextObject(text, undefined, undefined, { automerge }) });
218
218
  const model = useTextModel({ text: item.text });
219
219
  if (!model) {
@@ -222,10 +222,9 @@ const Story = ({ text, automerge, ...props }: StoryProps) => {
222
222
 
223
223
  return (
224
224
  <div className={mx(fixedInsetFlexLayout, groupSurface)}>
225
- <div className='flex justify-center overflow-y-scroll'>
226
- <div className='flex flex-col w-[800px] py-16'>
227
- <MarkdownEditor ref={ref} model={model} {...props} />
228
- <div className='flex shrink-0 h-[300px]'></div>
225
+ <div className='flex h-full justify-center'>
226
+ <div className='flex flex-col h-full w-[800px]'>
227
+ <MarkdownEditor model={model} {...props} />
229
228
  </div>
230
229
  </div>
231
230
  </div>
@@ -265,6 +264,10 @@ export const Large = {
265
264
  render: () => <Story text={str('# Large Document', '', large)} extensions={[]} />,
266
265
  };
267
266
 
267
+ export const Empty = {
268
+ render: () => <Story />,
269
+ };
270
+
268
271
  export const NoExtensions = {
269
272
  render: () => <Story text={document} />,
270
273
  };
@@ -347,18 +350,18 @@ export const Mention = {
347
350
 
348
351
  export const Comments = {
349
352
  render: () => {
350
- const [commentsStates, setCommentStates] = useState<CommentRange[]>([]);
353
+ const [commentRanges, setCommentRanges] = useState<CommentRange[]>([]);
351
354
 
352
355
  return (
353
356
  <Story
354
357
  text={str('# Comments', '', text.paragraphs, text.footer)}
355
- comments={commentsStates}
358
+ comments={commentRanges}
356
359
  extensions={[
357
360
  comments({
358
361
  onHover: onCommentsHover,
359
- onCreate: (relPos) => {
362
+ onCreate: (range) => {
360
363
  const id = PublicKey.random().toHex();
361
- setCommentStates((comments) => [...comments, { id, cursor: relPos }]);
364
+ setCommentRanges((commentRanges) => [...commentRanges, { id, cursor: range }]);
362
365
  return id;
363
366
  },
364
367
  onSelect: (state) => {
@@ -4,17 +4,15 @@
4
4
 
5
5
  import '@dxosTheme';
6
6
 
7
- import defaultsDeep from 'lodash.defaultsdeep';
8
- import React, { useRef, useState } from 'react';
7
+ import React, { useState } from 'react';
9
8
 
10
9
  import { TextObject } from '@dxos/echo-schema';
11
10
  import { fixedInsetFlexLayout, groupSurface, mx } from '@dxos/react-ui-theme';
12
11
  import { withTheme } from '@dxos/storybook-utils';
13
12
 
14
- import { defaultSlots, TextEditor, type TextEditorProps, type TextEditorRef, type TextEditorSlots } from './TextEditor';
13
+ import { TextEditor, type TextEditorProps } from './TextEditor';
15
14
  import { listener } from '../../extensions';
16
15
  import { useTextModel } from '../../hooks';
17
- import { textTheme } from '../../themes';
18
16
 
19
17
  const initialText = [
20
18
  '# TextEditor',
@@ -30,8 +28,7 @@ const Story = ({
30
28
  text,
31
29
  automerge,
32
30
  ...props
33
- }: { text?: string; automerge?: boolean } & Pick<TextEditorProps, 'extensions' | 'slots'>) => {
34
- const ref = useRef<TextEditorRef>(null);
31
+ }: { text?: string; automerge?: boolean } & Pick<TextEditorProps, 'extensions' | 'placeholder' | 'slots'>) => {
35
32
  const [item] = useState({ text: new TextObject(text, undefined, undefined, { automerge }) });
36
33
  const model = useTextModel({ text: item.text });
37
34
  if (!model) {
@@ -40,10 +37,9 @@ const Story = ({
40
37
 
41
38
  return (
42
39
  <div className={mx(fixedInsetFlexLayout, groupSurface)}>
43
- <div className='flex justify-center overflow-y-scroll'>
40
+ <div className='flex justify-center'>
44
41
  <div className='flex flex-col w-[800px] py-16'>
45
- <TextEditor ref={ref} model={model} {...props} />
46
- <div className='flex shrink-0 h-[300px]'></div>
42
+ <TextEditor model={model} {...props} />
47
43
  </div>
48
44
  </div>
49
45
  </div>
@@ -58,49 +54,19 @@ export default {
58
54
  };
59
55
 
60
56
  export const Default = {
61
- render: () => (
62
- <Story
63
- slots={defaultsDeep(
64
- { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
65
- defaultSlots,
66
- )}
67
- />
68
- ),
69
- };
70
-
71
- export const Listener = {
72
- render: () => (
73
- <Story
74
- slots={defaultsDeep(
75
- { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
76
- defaultSlots,
77
- )}
78
- extensions={[listener({ onChange: (text) => console.log(text) })]}
79
- />
80
- ),
57
+ render: () => <Story placeholder='Enter text...' />,
81
58
  };
82
59
 
83
60
  export const Text = {
84
- render: () => (
85
- <Story
86
- text={initialText}
87
- slots={defaultsDeep(
88
- { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
89
- defaultSlots,
90
- )}
91
- />
92
- ),
61
+ render: () => <Story text={initialText} placeholder='Enter text...' />,
93
62
  };
94
63
 
95
64
  export const Automerge = {
65
+ render: () => <Story text={initialText} placeholder='Enter text...' automerge />,
66
+ };
67
+
68
+ export const Listener = {
96
69
  render: () => (
97
- <Story
98
- automerge
99
- text={initialText}
100
- slots={defaultsDeep(
101
- { editor: { theme: textTheme, placeholder: 'Enter text...' } } satisfies TextEditorSlots,
102
- defaultSlots,
103
- )}
104
- />
70
+ <Story placeholder='Enter text...' extensions={[listener({ onChange: (text) => console.log(text) })]} />
105
71
  ),
106
72
  };
@@ -15,6 +15,7 @@ import React, {
15
15
  useEffect,
16
16
  useImperativeHandle,
17
17
  useState,
18
+ useRef,
18
19
  } from 'react';
19
20
 
20
21
  import { generateName } from '@dxos/display-name';
@@ -34,48 +35,53 @@ export type CursorInfo = {
34
35
  to: number;
35
36
  line: number;
36
37
  lines: number;
38
+ length: number;
37
39
  after?: string;
38
40
  };
39
41
 
40
- export type TextEditorRef = {
41
- root: HTMLDivElement | null;
42
- state?: EditorState;
43
- view?: EditorView;
44
- };
45
-
46
42
  export type TextEditorSlots = {
47
43
  root?: Omit<ComponentProps<'div'>, 'ref'>;
48
- editor?: {
49
- className?: string;
50
- placeholder?: string;
51
- spellCheck?: boolean;
52
- tabIndex?: number;
53
- theme?: ThemeStyles;
54
- };
44
+ // editor?: {
45
+ // className?: string;
46
+ // };
55
47
  };
56
48
 
49
+ // TODO(burdon): Spellcheck?
57
50
  export type TextEditorProps = {
58
51
  model: EditorModel;
52
+ focus?: boolean;
53
+ selection?: { anchor: number; head?: number };
59
54
  readonly?: boolean; // TODO(burdon): Move into model.
60
55
  comments?: CommentRange[]; // TODO(burdon): Move into extension.
61
56
  extensions?: Extension[];
62
57
  editorMode?: EditorMode;
58
+ placeholder?: string;
59
+ theme?: ThemeStyles;
63
60
  slots?: TextEditorSlots;
64
61
  };
65
62
 
66
63
  /**
67
64
  * Base text editor.
68
- * NOTE: Rather than adding properties, try to create extensions that can be reused.
69
65
  */
70
- export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
71
- ({ model, readonly, comments, extensions = [], editorMode, slots = defaultSlots }, forwardedRef) => {
72
- const { themeMode } = useThemeContext();
66
+ export const BaseTextEditor = forwardRef<EditorView, TextEditorProps>(
67
+ (
68
+ { model, focus, selection, readonly, comments, extensions = [], editorMode, theme, slots = defaultSlots },
69
+ forwardedRef,
70
+ ) => {
73
71
  const tabsterDOMAttribute = useFocusableGroup({ tabBehavior: 'limited' });
74
- const [root, setRoot] = useState<HTMLDivElement | null>(null);
75
- const [{ state = undefined, view = undefined } = {}, setEditor] = useState<
76
- { state?: EditorState; view?: EditorView } | undefined
77
- >();
78
- useImperativeHandle(forwardedRef, () => ({ root, state, view }), [view, state, root]);
72
+ const { themeMode } = useThemeContext();
73
+
74
+ // The editor view ref should only be used as an escape hatch.
75
+ const rootRef = useRef<HTMLDivElement>(null);
76
+ const [view, setView] = useState<EditorView | null>(null);
77
+ useImperativeHandle<EditorView | null, EditorView | null>(forwardedRef, () => view, [view]);
78
+
79
+ // Focus.
80
+ useEffect(() => {
81
+ if (view && focus) {
82
+ view.focus();
83
+ }
84
+ }, [view, focus]);
79
85
 
80
86
  // TODO(burdon): Factor out as extension.
81
87
  const { awareness, peer } = model;
@@ -91,7 +97,7 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
91
97
 
92
98
  // TODO(burdon): Factor out as extension.
93
99
  useEffect(() => {
94
- if (view && comments?.length) {
100
+ if (view && comments !== undefined) {
95
101
  view.dispatch({
96
102
  effects: setCommentRange.of({ model, comments }),
97
103
  });
@@ -99,14 +105,15 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
99
105
  }, [view, comments]);
100
106
 
101
107
  useEffect(() => {
102
- if (!root) {
108
+ if (!model || !rootRef.current) {
103
109
  return;
104
110
  }
105
111
 
106
- // TODO(burdon): Remember cursor position.
107
112
  // https://codemirror.net/docs/ref/#state.EditorStateConfig
108
113
  const state = EditorState.create({
109
114
  doc: model.text(),
115
+ // TODO(burdon): Composer should store and set selection when switching documents.
116
+ selection,
110
117
  extensions: [
111
118
  readonly && EditorState.readOnly.of(readonly),
112
119
 
@@ -116,7 +123,7 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
116
123
  // Theme.
117
124
  // TODO(burdon): Make theme configurable.
118
125
  EditorView.baseTheme(defaultTheme),
119
- EditorView.theme(slots?.editor?.theme ?? {}),
126
+ EditorView.theme(theme ?? {}),
120
127
  EditorView.darkTheme.of(themeMode === 'dark'),
121
128
 
122
129
  // Storage and replication.
@@ -131,36 +138,35 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
131
138
  // If the new state is derived from the old state, it will likely not be visible other than the cursor resetting.
132
139
  // Ideally this should not happen except when changing between text objects.
133
140
  view?.destroy();
134
- setEditor({
141
+ const newView = new EditorView({
142
+ parent: rootRef.current,
135
143
  state,
136
- view: new EditorView({
137
- state,
138
- parent: root,
139
- // NOTE: Uncomment to spy on all transactions.
140
- // https://codemirror.net/docs/ref/#view.EditorView.dispatch
141
- // dispatch: (transaction, view) => {
142
- // view.update([transaction]);
143
- // },
144
- }),
144
+ // NOTE: Uncomment to spy on all transactions.
145
+ // https://codemirror.net/docs/ref/#view.EditorView.dispatch
146
+ // dispatch: (transaction, view) => {
147
+ // view.update([transaction]);
148
+ // },
145
149
  });
146
150
 
151
+ setView(newView);
147
152
  return () => {
148
- view?.destroy();
149
- setEditor(undefined);
153
+ newView?.destroy();
154
+ setView(null);
150
155
  };
151
- }, [root, model, readonly, editorMode, themeMode]);
156
+ }, [rootRef, model, readonly, editorMode, themeMode]);
152
157
 
153
158
  const handleKeyUp = useCallback(
154
159
  (event: KeyboardEvent) => {
155
160
  const { key, altKey, shiftKey, metaKey, ctrlKey } = event;
156
161
  switch (key) {
157
- case 'Enter': {
158
- view?.contentDOM.focus();
159
- break;
160
- }
162
+ // TODO(burdon): Is this required (for vim mode?)
163
+ // case 'Enter': {
164
+ // view?.contentDOM.focus();
165
+ // break;
166
+ // }
161
167
 
162
168
  case 'Escape': {
163
- editorMode === 'vim' && (altKey || shiftKey || metaKey || ctrlKey) && root?.focus();
169
+ editorMode === 'vim' && (altKey || shiftKey || metaKey || ctrlKey) && rootRef.current?.focus();
164
170
  break;
165
171
  }
166
172
  }
@@ -171,42 +177,46 @@ export const BaseTextEditor = forwardRef<TextEditorRef, TextEditorProps>(
171
177
  return (
172
178
  <div
173
179
  key={model.id}
174
- ref={setRoot}
180
+ role='none'
181
+ ref={rootRef}
175
182
  tabIndex={0}
176
- {...slots?.root}
177
- {...(editorMode !== 'vim' && tabsterDOMAttribute)}
178
183
  onKeyUp={handleKeyUp}
184
+ {...slots.root}
185
+ {...(editorMode !== 'vim' && tabsterDOMAttribute)}
179
186
  />
180
187
  );
181
188
  },
182
189
  );
183
190
 
184
- export const TextEditor = forwardRef<TextEditorRef, TextEditorProps>(
185
- ({ readonly, extensions = [], slots: _slots, ...props }, forwardedRef) => {
191
+ export const TextEditor = forwardRef<EditorView, TextEditorProps>(
192
+ ({ readonly, placeholder, extensions = [], theme = textTheme, slots, ...props }, forwardedRef) => {
186
193
  const { themeMode } = useThemeContext();
187
- const slots = defaultsDeep({}, _slots, defaultTextSlots);
194
+ const updatedSlots = defaultsDeep({}, slots, defaultTextSlots);
188
195
  return (
189
196
  <BaseTextEditor
190
197
  ref={forwardedRef}
191
198
  readonly={readonly}
192
- extensions={[basicBundle({ readonly, themeMode, placeholder: slots?.editor?.placeholder }), ...extensions]}
193
- slots={slots}
199
+ extensions={[basicBundle({ readonly, themeMode, placeholder }), ...extensions]}
200
+ theme={theme}
201
+ slots={updatedSlots}
194
202
  {...props}
195
203
  />
196
204
  );
197
205
  },
198
206
  );
199
207
 
200
- export const MarkdownEditor = forwardRef<TextEditorRef, TextEditorProps>(
201
- ({ readonly, extensions = [], slots: _slots, ...props }, forwardedRef) => {
208
+ // TODO(burdon): Remove (Just provide bundle, slots).
209
+ export const MarkdownEditor = forwardRef<EditorView, TextEditorProps>(
210
+ ({ readonly, placeholder, extensions = [], theme = markdownTheme, slots, ...props }, forwardedRef) => {
202
211
  const { themeMode } = useThemeContext();
203
- const slots = defaultsDeep({}, _slots, defaultMarkdownSlots);
212
+ const updatedSlots = defaultsDeep({}, slots, defaultMarkdownSlots);
204
213
  return (
205
214
  <BaseTextEditor
206
215
  ref={forwardedRef}
207
216
  readonly={readonly}
208
- extensions={[markdownBundle({ readonly, themeMode, placeholder: slots?.editor?.placeholder }), ...extensions]}
209
- slots={slots}
217
+ extensions={[markdownBundle({ readonly, themeMode, placeholder }), ...extensions]}
218
+ theme={theme}
219
+ slots={updatedSlots}
210
220
  {...props}
211
221
  />
212
222
  );
@@ -215,20 +225,14 @@ export const MarkdownEditor = forwardRef<TextEditorRef, TextEditorProps>(
215
225
 
216
226
  export const defaultSlots: TextEditorSlots = {
217
227
  root: {
218
- className: mx('p-2', inputSurface),
228
+ className: mx('p-2 overflow-y-auto', inputSurface),
219
229
  },
220
230
  };
221
231
 
222
232
  export const defaultTextSlots: TextEditorSlots = {
223
233
  ...defaultSlots,
224
- editor: {
225
- theme: textTheme,
226
- },
227
234
  };
228
235
 
229
236
  export const defaultMarkdownSlots: TextEditorSlots = {
230
237
  ...defaultSlots,
231
- editor: {
232
- theme: markdownTheme,
233
- },
234
238
  };