@invana/editor 0.0.27 → 0.0.29
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/README.md +35 -0
- package/package.json +5 -5
package/README.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# @invana/editor
|
|
2
|
+
|
|
3
|
+
Code and markdown editing surfaces built on CodeMirror 6.
|
|
4
|
+
|
|
5
|
+
This is the one kind of thing that gets its own package: a component needing a heavy external JS
|
|
6
|
+
library. Everything buildable from React, Radix and the existing deps lives in `@invana/ui`
|
|
7
|
+
instead, so consumers that only want a button never pay for an editor.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pnpm add @invana/editor
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Peer dependencies: `@invana/ui`, `@invana/styling`, `react`, `react-dom`. CodeMirror 6
|
|
14
|
+
(`@codemirror/state`, `@codemirror/view`, `@codemirror/commands`, `@codemirror/language`,
|
|
15
|
+
`@codemirror/legacy-modes`) ships as a direct dependency.
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
import { CodeBlock, MarkdownEditorBlock } from '@invana/editor';
|
|
21
|
+
|
|
22
|
+
<CodeBlock value={source} language="python" />;
|
|
23
|
+
|
|
24
|
+
<MarkdownEditorBlock value={notes} onChange={setNotes} />;
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Exports
|
|
28
|
+
|
|
29
|
+
- `CodeBlock` — read-oriented code display
|
|
30
|
+
- `MarkdownEditorBlock` — markdown editing surface
|
|
31
|
+
- `useCodeMirror` — the hook both are built on, for composing your own surface
|
|
32
|
+
|
|
33
|
+
## License
|
|
34
|
+
|
|
35
|
+
MIT © Ravi Raja Merugu
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@invana/editor",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.29",
|
|
4
4
|
"description": "Invana Design System - Code and markdown editing surfaces (CodeMirror 6)",
|
|
5
5
|
"homepage": "https://github.com/invana/design-kit#readme",
|
|
6
6
|
"type": "module",
|
|
@@ -40,8 +40,8 @@
|
|
|
40
40
|
"peerDependencies": {
|
|
41
41
|
"react": "^18 || ^19",
|
|
42
42
|
"react-dom": "^18 || ^19",
|
|
43
|
-
"@invana/
|
|
44
|
-
"@invana/
|
|
43
|
+
"@invana/ui": "0.0.29",
|
|
44
|
+
"@invana/styling": "0.0.29"
|
|
45
45
|
},
|
|
46
46
|
"dependencies": {
|
|
47
47
|
"@codemirror/commands": "^6.10.3",
|
|
@@ -57,8 +57,8 @@
|
|
|
57
57
|
"react-dom": "^19.2.7",
|
|
58
58
|
"tsup": "^8.5.1",
|
|
59
59
|
"typescript": "~5.9.3",
|
|
60
|
-
"@invana/styling": "0.0.
|
|
61
|
-
"@invana/ui": "0.0.
|
|
60
|
+
"@invana/styling": "0.0.29",
|
|
61
|
+
"@invana/ui": "0.0.29"
|
|
62
62
|
},
|
|
63
63
|
"scripts": {
|
|
64
64
|
"build": "tsup",
|