@markweave/react 0.6.0 → 0.7.1
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/LICENSE +21 -21
- package/README.md +39 -37
- package/dist/index.js +869 -858
- package/dist/types/MarkweaveEditor.d.ts +3 -1
- package/dist/types/MarkweaveEditor.d.ts.map +1 -1
- package/dist/types/create-editor-extensions.d.ts +2 -0
- package/dist/types/create-editor-extensions.d.ts.map +1 -1
- package/dist/types/index.d.ts +1 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/ui/slash-command/SlashCommandMenu.d.ts.map +1 -1
- package/dist/types/ui/table/TableControls.d.ts.map +1 -1
- package/package.json +8 -6
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2026 Refinex-Space
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Refinex-Space
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,43 +1,45 @@
|
|
|
1
|
-
# @markweave/react
|
|
2
|
-
|
|
3
|
-
React adapter for Markweave.
|
|
4
|
-
|
|
5
|
-
Full guide: [React Integration](https://github.com/Refinex-Space/markweave/blob/main/docs/guides/react-integration.md) | [React 接入手册](https://github.com/Refinex-Space/markweave/blob/main/docs/guides/react-integration-zh-cn.md)
|
|
6
|
-
|
|
7
|
-
```sh
|
|
8
|
-
pnpm add @markweave/react
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
```tsx
|
|
12
|
-
import { MarkweaveEditor } from "@markweave/react";
|
|
13
|
-
import "@markweave/react/styles.css";
|
|
14
|
-
|
|
15
|
-
export function Editor() {
|
|
16
|
-
return <MarkweaveEditor defaultContent="# Hello Markweave" />;
|
|
17
|
-
}
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
React and React DOM remain peer dependencies and should come from the host app.
|
|
21
|
-
|
|
22
|
-
The built-in outline uses `innerTocPlacement="container"` by default, keeping it vertically centered in the visual viewport while symmetric TOC gutters keep the writing column centered. It hides automatically in a narrow editor container to preserve readable content width.
|
|
23
|
-
|
|
24
|
-
Version 0.3.5 keeps this fixed positioning and resolver-backed first-screen image loading compatible with Electron 21 / Chromium 106 hosts.
|
|
25
|
-
|
|
26
|
-
## Host-Driven AI Edit Review
|
|
27
|
-
|
|
1
|
+
# @markweave/react
|
|
2
|
+
|
|
3
|
+
React adapter for Markweave.
|
|
4
|
+
|
|
5
|
+
Full guide: [React Integration](https://github.com/Refinex-Space/markweave/blob/main/docs/guides/react-integration.md) | [React 接入手册](https://github.com/Refinex-Space/markweave/blob/main/docs/guides/react-integration-zh-cn.md)
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
pnpm add @markweave/react
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
```tsx
|
|
12
|
+
import { MarkweaveEditor } from "@markweave/react";
|
|
13
|
+
import "@markweave/react/styles.css";
|
|
14
|
+
|
|
15
|
+
export function Editor() {
|
|
16
|
+
return <MarkweaveEditor defaultContent="# Hello Markweave" />;
|
|
17
|
+
}
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
React and React DOM remain peer dependencies and should come from the host app.
|
|
21
|
+
|
|
22
|
+
The built-in outline uses `innerTocPlacement="container"` by default, keeping it vertically centered in the visual viewport while symmetric TOC gutters keep the writing column centered. It hides automatically in a narrow editor container to preserve readable content width.
|
|
23
|
+
|
|
24
|
+
Version 0.3.5 keeps this fixed positioning and resolver-backed first-screen image loading compatible with Electron 21 / Chromium 106 hosts.
|
|
25
|
+
|
|
26
|
+
## Host-Driven AI Edit Review
|
|
27
|
+
|
|
28
28
|
Version 0.5.0 exposes lazy selection snapshots plus explicit selection, block, and document AI edit scopes through `MarkweaveAiEditController`. Multi-scope proposals provide count/navigation, global decisions, and staged per-hunk decisions before one atomic settlement, without Markweave sending provider requests or receiving credentials.
|
|
29
|
-
|
|
30
|
-
```tsx
|
|
31
|
-
import { useState } from "react";
|
|
32
|
-
import { MarkweaveEditor, type MarkweaveAiEditController } from "@markweave/react";
|
|
33
|
-
|
|
34
|
-
const [aiEdit, setAiEdit] = useState<MarkweaveAiEditController | null>(null);
|
|
35
|
-
|
|
36
|
-
<MarkweaveEditor onAiEditControllerChange={setAiEdit} />;
|
|
37
|
-
```
|
|
38
|
-
|
|
29
|
+
|
|
30
|
+
```tsx
|
|
31
|
+
import { useState } from "react";
|
|
32
|
+
import { MarkweaveEditor, type MarkweaveAiEditController } from "@markweave/react";
|
|
33
|
+
|
|
34
|
+
const [aiEdit, setAiEdit] = useState<MarkweaveAiEditController | null>(null);
|
|
35
|
+
|
|
36
|
+
<MarkweaveEditor onAiEditControllerChange={setAiEdit} />;
|
|
37
|
+
```
|
|
38
|
+
|
|
39
39
|
The callback receives a controller after editor creation and `null` before teardown or recreation. See the full integration guide for `captureSelection`, cumulative streaming, default/headless controls, conflicts, acceptance, and error handling.
|
|
40
40
|
|
|
41
41
|
## Command Registry And Host Extensions
|
|
42
42
|
|
|
43
43
|
Version 0.6.0 adds `commandGroups`, `commands`, `builtinCommands`, `editorExtensions`, `onCommandControllerChange`, and `onCommandError`. The stable command controller executes the same async command path as Slash; host extensions are additive-only creation-time schema code and require a keyed remount when changed. See the full command/extension protocol for result placement, cancellation, conflicts, the 1 MiB result cap, and Tiptap 3.27.x compatibility.
|
|
44
|
+
|
|
45
|
+
Version 0.7.0 adds `tableCapabilities`, a synchronous per-table resolver for Markweave-owned structure, formatting, copy, and table-AI operations. It receives readonly table and ancestor descriptors and fails closed on resolver errors.
|