@estiva-app/ui 0.82.1 → 0.83.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.
- package/dist/BlockNodes.d.ts +16 -5
- package/dist/BlockNodes.d.ts.map +1 -1
- package/dist/DocumentEditor.d.ts +5 -4
- package/dist/DocumentEditor.d.ts.map +1 -1
- package/dist/LinkPlaces.d.ts +51 -0
- package/dist/LinkPlaces.d.ts.map +1 -0
- package/dist/ReferenceMenu.d.ts.map +1 -1
- package/dist/editor.d.ts +1 -0
- package/dist/editor.d.ts.map +1 -1
- package/dist/editor.js +253 -123
- package/dist/editor.js.map +4 -4
- package/dist/linked.examples.d.ts.map +1 -1
- package/package.json +1 -1
- package/registry.json +62 -11
- package/src/BlockNodes.tsx +36 -9
- package/src/DocumentEditor.mdx +7 -2
- package/src/DocumentEditor.stories.tsx +101 -15
- package/src/DocumentEditor.test.tsx +49 -0
- package/src/DocumentEditor.tsx +17 -10
- package/src/LinkPlaces.mdx +59 -0
- package/src/LinkPlaces.stories.tsx +60 -0
- package/src/LinkPlaces.test.ts +134 -0
- package/src/LinkPlaces.ts +169 -0
- package/src/ReferenceCards.mdx +4 -0
- package/src/ReferenceMenu.mdx +32 -24
- package/src/ReferenceMenu.stories.tsx +15 -16
- package/src/ReferenceMenu.test.tsx +161 -57
- package/src/ReferenceMenu.tsx +48 -44
- package/src/editor.ts +1 -0
- package/src/linked.examples.ts +4 -3
- package/src/pages.test.ts +2 -2
- package/src/registry/registry.test.ts +6 -6
- package/stories/Choosing.mdx +3 -2
package/dist/BlockNodes.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { ComponentType } from 'react';
|
|
2
2
|
import { Extension, Node } from '@tiptap/core';
|
|
3
3
|
import { type Transaction } from '@tiptap/pm/state';
|
|
4
|
+
import { type LinkPlace } from './LinkPlaces';
|
|
4
5
|
/**
|
|
5
6
|
* `id` on every block, carried as the `blockId` attribute.
|
|
6
7
|
*
|
|
@@ -48,6 +49,14 @@ export declare const BlockId: Extension<any, any>;
|
|
|
48
49
|
export interface ReferenceViewProps {
|
|
49
50
|
uri: string;
|
|
50
51
|
href?: string;
|
|
52
|
+
/**
|
|
53
|
+
* Where it sits, so how it draws: `chip` in a sentence, `row` alone on its
|
|
54
|
+
* line, `card` in the row's place (`LinkPlaces`, §13.3). Always `chip` in an
|
|
55
|
+
* editor without `LinkPlaces`.
|
|
56
|
+
*/
|
|
57
|
+
place?: LinkPlace;
|
|
58
|
+
/** Being edited: a click opens its menu rather than it, so a row or card shows no hover preview. */
|
|
59
|
+
editing?: boolean;
|
|
51
60
|
}
|
|
52
61
|
export interface ReferenceNodeOptions {
|
|
53
62
|
/**
|
|
@@ -64,11 +73,13 @@ export interface ReferenceNodeOptions {
|
|
|
64
73
|
* is also how deleting one works. `marks` carries the run's other marks, so a
|
|
65
74
|
* bold reference comes back bold.
|
|
66
75
|
*
|
|
67
|
-
* `embed` is the card its writer chose
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
76
|
+
* `embed` is the card its writer chose — `detailed`, drawn in the row's place
|
|
77
|
+
* when the reference is alone on its line, or null for its row (SPEC §13.3, "A
|
|
78
|
+
* reference's card"; older writers wrote `compact`, which draws the row) — and
|
|
79
|
+
* `extra` every key of the mark this version does not know. Both are declared
|
|
80
|
+
* so that ProseMirror keeps them: an undeclared attribute is dropped when the
|
|
81
|
+
* node is made, and the card with it. With `LinkPlaces`, the view is told where
|
|
82
|
+
* the reference sits (`place`) and draws its chip, row or card.
|
|
72
83
|
*
|
|
73
84
|
* `href` makes it a **URL chip**: an app URL that reads as the chip of what it
|
|
74
85
|
* names, and is that URL on the wire (§13.3). `uri` is what it names, filled in
|
package/dist/BlockNodes.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BlockNodes.d.ts","sourceRoot":"","sources":["../src/BlockNodes.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAc,MAAM,OAAO,CAAA;AACtD,OAAO,EAAE,SAAS,EAAa,IAAI,EAAe,MAAM,cAAc,CAAA;AAEtE,OAAO,EAAuC,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAA;
|
|
1
|
+
{"version":3,"file":"BlockNodes.d.ts","sourceRoot":"","sources":["../src/BlockNodes.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAc,MAAM,OAAO,CAAA;AACtD,OAAO,EAAE,SAAS,EAAa,IAAI,EAAe,MAAM,cAAc,CAAA;AAEtE,OAAO,EAAuC,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAMxF,OAAO,EAAW,KAAK,SAAS,EAAE,MAAM,cAAc,CAAA;AA4QtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,eAAO,MAAM,OAAO,qBA+ClB,CAAA;AAKF,gHAAgH;AAChH,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;OAIG;IACH,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,oGAAoG;IACpG,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,IAAI,EAAE,aAAa,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAA;CAC/C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,aAAa,iCA6ExB,CAAA;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,YAAY,gBAqBvB,CAAA;AAgBF,uEAAuE;AACvE,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC,8FAA8F;IAC9F,IAAI,EAAE,aAAa,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAA;CAChD;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc,kCAqCzB,CAAA;AAIF;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAEjE;AAsFD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,SAAS,qBA+EpB,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,qBAkBlB,CAAA"}
|
package/dist/DocumentEditor.d.ts
CHANGED
|
@@ -101,12 +101,13 @@ export interface DocumentEditorProps {
|
|
|
101
101
|
onCommentOnSelection?: (anchor: SelectionAnchor) => void;
|
|
102
102
|
/** The app's rows in a block's handle menu, after the editing ones: Copy link, Comment. */
|
|
103
103
|
blockRows?: (block: HandleBlock) => ReactNode;
|
|
104
|
-
/**
|
|
104
|
+
/**
|
|
105
|
+
* Draws a link: the app's own, which resolves what it names — its chip, its
|
|
106
|
+
* row or its card in the row's place, as `place` says (§13.3).
|
|
107
|
+
*/
|
|
105
108
|
referenceView?: ComponentType<ReferenceViewProps>;
|
|
106
109
|
/** Draws a placed file: the app's own card. */
|
|
107
110
|
attachmentView?: ComponentType<AttachmentViewProps>;
|
|
108
|
-
/** Drawn after the text: the cards chips ask for, as the app draws them. */
|
|
109
|
-
cards?: (editor: Editor | null) => ReactNode;
|
|
110
111
|
/** Around everything the editor draws: the app's providers, which may read the editor. */
|
|
111
112
|
wrap?: (children: ReactNode, editor: Editor | null) => ReactNode;
|
|
112
113
|
/** The editor, once it is there, and `null` as it goes. */
|
|
@@ -134,5 +135,5 @@ export interface DocumentEditorProps {
|
|
|
134
135
|
* why: https://github.com/estiva-app/estiva-docs/blob/main/decisions/every-app-edits-a-document-with-one-shared-editor.md
|
|
135
136
|
* why: https://github.com/estiva-app/estiva-docs/blob/main/decisions/the-block-editor-kit-lives-in-protocol-and-ui.md
|
|
136
137
|
*/
|
|
137
|
-
export declare function DocumentEditor({ value, format, codec, onCommit, label, placeholder, readOnly, changedBy, onLeftUnsaved, hold, holdKey, references, mentions, linkChips, upload, readMarkdown, table, onCommentOnSelection, blockRows, referenceView, attachmentView,
|
|
138
|
+
export declare function DocumentEditor({ value, format, codec, onCommit, label, placeholder, readOnly, changedBy, onLeftUnsaved, hold, holdKey, references, mentions, linkChips, upload, readMarkdown, table, onCommentOnSelection, blockRows, referenceView, attachmentView, wrap, onEditor, extensions, }: DocumentEditorProps): import("react").JSX.Element;
|
|
138
139
|
//# sourceMappingURL=DocumentEditor.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DocumentEditor.d.ts","sourceRoot":"","sources":["../src/DocumentEditor.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA4C,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAA;AACpG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEhD,OAAO,EAA4C,KAAK,MAAM,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;AAGvG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,EAA6F,KAAK,mBAAmB,EAAE,KAAK,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAG3K,OAAO,EAAwC,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAChG,OAAO,EAAgF,KAAK,aAAa,EAAE,KAAK,gBAAgB,EAAwC,MAAM,oBAAoB,CAAA;AAKlM,OAAO,EAAa,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAU9D;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,WAAW,CAAA;IACpD,0EAA0E;IAC1E,KAAK,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CACvE;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,mEAAmE;IACnE,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAA;IACzC,mDAAmD;IACnD,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAA;IAC9B,oHAAoH;IACpH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,MAAM,GAAG,SAAS,KAAK,MAAM,IAAI,CAAA;IACrE,0FAA0F;IAC1F,KAAK,EAAE,MAAM,OAAO,CAAA;CACrB;AAED,4DAA4D;AAC5D,MAAM,WAAW,kBAAkB;IACjC,0FAA0F;IAC1F,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,SAAS,gBAAgB,EAAE,CAAA;IACxD,yHAAyH;IACzH,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI,CAAA;IAChD,sBAAsB;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAA;IACpB,sEAAsE;IACtE,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB;AAED,qDAAqD;AACrD,MAAM,WAAW,gBAAgB;IAC/B,0DAA0D;IAC1D,MAAM,EAAE,MAAM,SAAS,aAAa,EAAE,CAAA;IACtC,oGAAoG;IACpG,KAAK,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,MAAM,GAAG,IAAI,CAAA;CAChD;AAED,MAAM,WAAW,mBAAmB;IAClC,6GAA6G;IAC7G,KAAK,EAAE,MAAM,CAAA;IACb,wDAAwD;IACxD,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,aAAa,CAAA;IACpB;;;;OAIG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,SAAS,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAA;IAC9G,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAA;IACb,wCAAwC;IACxC,WAAW,CAAC,EAAE,SAAS,CAAA;IACvB,oGAAoG;IACpG,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,wFAAwF;IACxF,SAAS,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IACnC,qFAAqF;IACrF,aAAa,CAAC,EAAE,MAAM,IAAI,CAAA;IAC1B,uEAAuE;IACvE,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAC/B,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,gBAAgB,CAAA;IAC3B,yEAAyE;IACzE,SAAS,CAAC,EAAE,gBAAgB,CAAA;IAC5B,uHAAuH;IACvH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACzD,yGAAyG;IACzG,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,WAAW,GAAG,SAAS,CAAA;IACxD,+BAA+B;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,mHAAmH;IACnH,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAA;IACxD,2FAA2F;IAC3F,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,SAAS,CAAA;IAC7C
|
|
1
|
+
{"version":3,"file":"DocumentEditor.d.ts","sourceRoot":"","sources":["../src/DocumentEditor.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA4C,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAA;AACpG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEhD,OAAO,EAA4C,KAAK,MAAM,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;AAGvG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,EAA6F,KAAK,mBAAmB,EAAE,KAAK,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAG3K,OAAO,EAAwC,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAChG,OAAO,EAAgF,KAAK,aAAa,EAAE,KAAK,gBAAgB,EAAwC,MAAM,oBAAoB,CAAA;AAKlM,OAAO,EAAa,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAU9D;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,WAAW,CAAA;IACpD,0EAA0E;IAC1E,KAAK,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CACvE;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,mEAAmE;IACnE,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAA;IACzC,mDAAmD;IACnD,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAA;IAC9B,oHAAoH;IACpH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,MAAM,GAAG,SAAS,KAAK,MAAM,IAAI,CAAA;IACrE,0FAA0F;IAC1F,KAAK,EAAE,MAAM,OAAO,CAAA;CACrB;AAED,4DAA4D;AAC5D,MAAM,WAAW,kBAAkB;IACjC,0FAA0F;IAC1F,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,SAAS,gBAAgB,EAAE,CAAA;IACxD,yHAAyH;IACzH,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI,CAAA;IAChD,sBAAsB;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAA;IACpB,sEAAsE;IACtE,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB;AAED,qDAAqD;AACrD,MAAM,WAAW,gBAAgB;IAC/B,0DAA0D;IAC1D,MAAM,EAAE,MAAM,SAAS,aAAa,EAAE,CAAA;IACtC,oGAAoG;IACpG,KAAK,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,MAAM,GAAG,IAAI,CAAA;CAChD;AAED,MAAM,WAAW,mBAAmB;IAClC,6GAA6G;IAC7G,KAAK,EAAE,MAAM,CAAA;IACb,wDAAwD;IACxD,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,aAAa,CAAA;IACpB;;;;OAIG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,SAAS,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAA;IAC9G,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAA;IACb,wCAAwC;IACxC,WAAW,CAAC,EAAE,SAAS,CAAA;IACvB,oGAAoG;IACpG,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,wFAAwF;IACxF,SAAS,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IACnC,qFAAqF;IACrF,aAAa,CAAC,EAAE,MAAM,IAAI,CAAA;IAC1B,uEAAuE;IACvE,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAC/B,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,gBAAgB,CAAA;IAC3B,yEAAyE;IACzE,SAAS,CAAC,EAAE,gBAAgB,CAAA;IAC5B,uHAAuH;IACvH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACzD,yGAAyG;IACzG,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,WAAW,GAAG,SAAS,CAAA;IACxD,+BAA+B;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,mHAAmH;IACnH,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAA;IACxD,2FAA2F;IAC3F,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,SAAS,CAAA;IAC7C;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAAA;IACjD,+CAA+C;IAC/C,cAAc,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAA;IACnD,0FAA0F;IAC1F,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,KAAK,SAAS,CAAA;IAChE,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAA;IAC1C,wCAAwC;IACxC,UAAU,CAAC,EAAE,SAAS,YAAY,EAAE,CAAA;CACrC;AAcD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,cAAc,CAAC,EAC7B,KAAK,EACL,MAAM,EACN,KAAK,EACL,QAAQ,EACR,KAAK,EACL,WAAW,EACX,QAAgB,EAChB,SAAgB,EAChB,aAAa,EACb,IAAI,EACJ,OAAO,EACP,UAAU,EACV,QAAQ,EACR,SAAS,EACT,MAAM,EACN,YAAY,EACZ,KAAY,EACZ,oBAAoB,EACpB,SAAS,EACT,aAAa,EACb,cAAc,EACd,IAAI,EACJ,QAAQ,EACR,UAAe,GAChB,EAAE,mBAAmB,+BA+WrB"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Where a reference in a block document sits, and so how it draws — SPEC §13.3,
|
|
3
|
+
* "A reference's card" (C22, C24): its chip in a sentence, its row alone on its
|
|
4
|
+
* line, and its card in the row's place when its writer chose one.
|
|
5
|
+
*
|
|
6
|
+
* The rule is the protocol's (`documentLineDrawOf` in `@estiva-app/protocol`),
|
|
7
|
+
* read here off the editor's own tree so it can be asked on every keystroke
|
|
8
|
+
* without writing the document out. `linkPlaces.test.ts` runs the same
|
|
9
|
+
* documents through both and holds them to one answer.
|
|
10
|
+
*
|
|
11
|
+
* - **Alone on its line**: a top-level paragraph, or a list item's, whose line
|
|
12
|
+
* (up to a hard break) holds this reference and nothing but spaces besides.
|
|
13
|
+
* A heading, a quote, a callout and a table cell are sentences, and so is
|
|
14
|
+
* anything inside a block this rule does not name.
|
|
15
|
+
* - **A marker around it** (bold, italic, code…) makes it a sentence.
|
|
16
|
+
* - **A person or a Folder** alone on its line stays a chip.
|
|
17
|
+
* - **Its card** is `embed` `detailed`; anything else (none, `compact`, a value
|
|
18
|
+
* this version does not know) draws the row.
|
|
19
|
+
*
|
|
20
|
+
* `LinkPlaces` puts each reference's place on a node decoration, which
|
|
21
|
+
* `ReferenceNode`'s view reads and hands to the app's view as `place`.
|
|
22
|
+
*
|
|
23
|
+
* why: https://github.com/estiva-app/estiva-docs/blob/main/decisions/a-link-on-words-counts-toward-the-card.md
|
|
24
|
+
* why: https://github.com/estiva-app/estiva-docs/blob/main/decisions/a-lone-links-chip-menu-offers-row-or-card.md
|
|
25
|
+
*/
|
|
26
|
+
import { Extension } from '@tiptap/core';
|
|
27
|
+
import type { Node as PmNode } from '@tiptap/pm/model';
|
|
28
|
+
import { Decoration } from '@tiptap/pm/view';
|
|
29
|
+
/** How a reference draws: its chip, its row, or its card in the row's place. */
|
|
30
|
+
export type LinkPlace = 'chip' | 'row' | 'card';
|
|
31
|
+
/**
|
|
32
|
+
* Whether what `uri` names stays a chip alone on its line: a person (`npub`,
|
|
33
|
+
* `nprofile`) or a Folder (an `naddr` of kind 39000).
|
|
34
|
+
*/
|
|
35
|
+
export declare function staysChip(uri: string): boolean;
|
|
36
|
+
/** How the reference node at `pos` draws. Anything that is not a reference with a `uri` draws as a chip. */
|
|
37
|
+
export declare function linkPlaceAt(doc: PmNode, pos: number): LinkPlace;
|
|
38
|
+
/** Every reference that does not draw as its chip, with its place. */
|
|
39
|
+
export declare function linkPlaces(doc: PmNode): {
|
|
40
|
+
pos: number;
|
|
41
|
+
size: number;
|
|
42
|
+
place: Exclude<LinkPlace, 'chip'>;
|
|
43
|
+
}[];
|
|
44
|
+
/** The place a node view's decorations give it; `chip` without one. */
|
|
45
|
+
export declare function placeOf(decorations: readonly Decoration[] | undefined): LinkPlace;
|
|
46
|
+
/**
|
|
47
|
+
* Marks each reference that draws as its row or its card, for `ReferenceNode`'s
|
|
48
|
+
* view. Without it every reference is a chip, as in a message's box.
|
|
49
|
+
*/
|
|
50
|
+
export declare const LinkPlaces: Extension<any, any>;
|
|
51
|
+
//# sourceMappingURL=LinkPlaces.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"LinkPlaces.d.ts","sourceRoot":"","sources":["../src/LinkPlaces.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,KAAK,EAAE,IAAI,IAAI,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAEtD,OAAO,EAAE,UAAU,EAAiB,MAAM,iBAAiB,CAAA;AAE3D,gFAAgF;AAChF,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;AA+C/C;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAI9C;AAsBD,4GAA4G;AAC5G,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,CAW/D;AAED,sEAAsE;AACtE,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;CAAE,EAAE,CAS1G;AAED,uEAAuE;AACvE,wBAAgB,OAAO,CAAC,WAAW,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,GAAG,SAAS,CAMjF;AAID;;;GAGG;AACH,eAAO,MAAM,UAAU,qBAmBrB,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ReferenceMenu.d.ts","sourceRoot":"","sources":["../src/ReferenceMenu.tsx"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ReferenceMenu.d.ts","sourceRoot":"","sources":["../src/ReferenceMenu.tsx"],"names":[],"mappings":"AA8BA,OAAO,EAAE,SAAS,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAA;AAErD,OAAO,EAAmD,KAAK,WAAW,EAAoB,MAAM,kBAAkB,CAAA;AA2HtH,+GAA+G;AAC/G,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAE/D;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAMvE;AAWD,8DAA8D;AAC9D,eAAO,MAAM,aAAa,qBAuExB,CAAA;AASF,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CACtB;AAED,qGAAqG;AACrG,wBAAgB,iBAAiB,CAAC,EAAE,MAAM,EAAE,EAAE,sBAAsB,+BAwFnE"}
|
package/dist/editor.d.ts
CHANGED
|
@@ -22,6 +22,7 @@ export { PersonMention, UrgentPersonMention, PersonReference, CaptionedReference
|
|
|
22
22
|
export { BlockId, Checklist, Callout, isChecklistTick, UnknownBlock, ReferenceNode, AttachmentNode, type ReferenceNodeOptions, type ReferenceViewProps, type AttachmentNodeOptions, type AttachmentViewProps, } from './BlockNodes';
|
|
23
23
|
export { ReferenceCards, useReferenceCards, referenceAtSelection, referenceCardPlacements, setReferenceCard, setReferenceCardAt, type ReferenceCard, type ReferenceCardLayout, type ReferenceCardSlot, } from './ReferenceCards';
|
|
24
24
|
export { LinkChips, findLinkChips, refreshLinkChips, type LinkChipsOptions, type PastedRange } from './LinkChips';
|
|
25
|
+
export { LinkPlaces, linkPlaceAt, staysChip, type LinkPlace } from './LinkPlaces';
|
|
25
26
|
export { ReferenceMenu, ReferenceMenuView, isReferenceMenuOpen, referenceMenuClick, type ReferenceMenuViewProps } from './ReferenceMenu';
|
|
26
27
|
export { DocumentEditor, type DocumentEditorProps, type DocumentCodec, type DocumentReferences, type DocumentMentions, type HeldTyping, } from './DocumentEditor';
|
|
27
28
|
//# sourceMappingURL=editor.d.ts.map
|
package/dist/editor.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"editor.d.ts","sourceRoot":"","sources":["../src/editor.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,KAAK,MAAM,EAAE,KAAK,eAAe,EAAE,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAA;AACnL,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,sBAAsB,EAAE,KAAK,eAAe,EAAE,MAAM,cAAc,CAAA;AACpG,OAAO,EACL,UAAU,EACV,cAAc,EACd,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,YAAY,GAClB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,UAAU,EAAE,KAAK,eAAe,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAA;AACtF,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,iBAAiB,EACjB,SAAS,EACT,KAAK,aAAa,EAClB,KAAK,wBAAwB,EAC7B,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,eAAe,GACrB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,KAAK,mBAAmB,EAAE,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAC5H,OAAO,EAAE,cAAc,EAAE,KAAK,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AAC7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AACtH,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,WAAW,EACX,SAAS,EACT,cAAc,EACd,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,SAAS,GACf,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,iBAAiB,EAAE,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,KAAK,wBAAwB,EAAE,MAAM,uBAAuB,CAAA;AACtL,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,UAAU,EACV,aAAa,EACb,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,WAAW,EACX,WAAW,EACX,mBAAmB,EACnB,OAAO,EACP,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,oBAAoB,EACzB,KAAK,QAAQ,EACb,KAAK,SAAS,EACd,KAAK,UAAU,GAChB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EACL,OAAO,EACP,SAAS,EACT,OAAO,EACP,eAAe,EACf,YAAY,EACZ,aAAa,EACb,cAAc,EACd,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,GACzB,MAAM,cAAc,CAAA;AACrB,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,oBAAoB,EACpB,uBAAuB,EACvB,gBAAgB,EAChB,kBAAkB,EAClB,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,gBAAgB,EAAE,KAAK,gBAAgB,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAA;AACjH,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,KAAK,sBAAsB,EAAE,MAAM,iBAAiB,CAAA;AACxI,OAAO,EACL,cAAc,EACd,KAAK,mBAAmB,EACxB,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,UAAU,GAChB,MAAM,kBAAkB,CAAA"}
|
|
1
|
+
{"version":3,"file":"editor.d.ts","sourceRoot":"","sources":["../src/editor.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,KAAK,MAAM,EAAE,KAAK,eAAe,EAAE,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAA;AACnL,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,sBAAsB,EAAE,KAAK,eAAe,EAAE,MAAM,cAAc,CAAA;AACpG,OAAO,EACL,UAAU,EACV,cAAc,EACd,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,YAAY,GAClB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,UAAU,EAAE,KAAK,eAAe,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAA;AACtF,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,iBAAiB,EACjB,SAAS,EACT,KAAK,aAAa,EAClB,KAAK,wBAAwB,EAC7B,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,eAAe,GACrB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,KAAK,mBAAmB,EAAE,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAC5H,OAAO,EAAE,cAAc,EAAE,KAAK,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AAC7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AACtH,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,WAAW,EACX,SAAS,EACT,cAAc,EACd,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,SAAS,GACf,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,iBAAiB,EAAE,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,KAAK,wBAAwB,EAAE,MAAM,uBAAuB,CAAA;AACtL,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,UAAU,EACV,aAAa,EACb,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,WAAW,EACX,WAAW,EACX,mBAAmB,EACnB,OAAO,EACP,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,oBAAoB,EACzB,KAAK,QAAQ,EACb,KAAK,SAAS,EACd,KAAK,UAAU,GAChB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EACL,OAAO,EACP,SAAS,EACT,OAAO,EACP,eAAe,EACf,YAAY,EACZ,aAAa,EACb,cAAc,EACd,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,GACzB,MAAM,cAAc,CAAA;AACrB,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,oBAAoB,EACpB,uBAAuB,EACvB,gBAAgB,EAChB,kBAAkB,EAClB,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,gBAAgB,EAAE,KAAK,gBAAgB,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAA;AACjH,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,SAAS,EAAE,MAAM,cAAc,CAAA;AACjF,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,KAAK,sBAAsB,EAAE,MAAM,iBAAiB,CAAA;AACxI,OAAO,EACL,cAAc,EACd,KAAK,mBAAmB,EACxB,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,UAAU,GAChB,MAAM,kBAAkB,CAAA"}
|