@lyfie/luthor 2.3.3 → 2.3.4
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 +60 -6
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,23 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/lyfie-app/luthor/main/apps/web/public/luthor-logo-horizontal.png" alt="Luthor" width="360" />
|
|
3
|
+
<h1>@lyfie/luthor</h1>
|
|
4
|
+
<p><strong>Plug-and-play rich text editor presets for React, powered by Luthor Headless + Lexical.</strong></p>
|
|
5
|
+
</div>
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
<div align="center">
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/@lyfie/luthor)
|
|
10
|
+
[](https://www.npmjs.com/package/@lyfie/luthor)
|
|
11
|
+
[](https://bundlephobia.com/package/@lyfie/luthor)
|
|
12
|
+
[](https://www.npmjs.com/package/@lyfie/luthor)
|
|
13
|
+
[](https://github.com/lyfie-app/luthor/blob/main/LICENSE)
|
|
14
|
+
[](https://github.com/lyfie-app/luthor/commits/main)
|
|
15
|
+
|
|
16
|
+
</div>
|
|
17
|
+
|
|
18
|
+
<p align="center">
|
|
19
|
+
:rocket: Ship fast | :control_knobs: Customize deeply | :white_check_mark: Production-ready presets
|
|
20
|
+
</p>
|
|
4
21
|
|
|
5
22
|
## Install
|
|
6
23
|
|
|
@@ -8,7 +25,7 @@ Plug-and-play preset package built on top of `@lyfie/luthor-headless`.
|
|
|
8
25
|
pnpm add @lyfie/luthor react react-dom
|
|
9
26
|
```
|
|
10
27
|
|
|
11
|
-
## Usage
|
|
28
|
+
## Quick Usage
|
|
12
29
|
|
|
13
30
|
```tsx
|
|
14
31
|
import { ExtensiveEditor } from "@lyfie/luthor";
|
|
@@ -19,7 +36,44 @@ export function App() {
|
|
|
19
36
|
}
|
|
20
37
|
```
|
|
21
38
|
|
|
22
|
-
##
|
|
39
|
+
## What You Get
|
|
40
|
+
|
|
41
|
+
- :sparkles: `ExtensiveEditor` with rich defaults and polished UX
|
|
42
|
+
- :toolbox: Built-in toolbars, slash commands, floating actions, source mode
|
|
43
|
+
- :framed_picture: Media and embed workflows (image, iframe, YouTube)
|
|
44
|
+
- :shield: TypeScript-first APIs and reusable preset architecture
|
|
45
|
+
- :twisted_rightwards_arrows: Headless escape hatch via `headless` re-export
|
|
46
|
+
|
|
47
|
+
## Presets Included
|
|
48
|
+
|
|
49
|
+
- `ExtensiveEditor`
|
|
50
|
+
- `SimpleTextEditor`
|
|
51
|
+
- `RichTextBoxEditor`
|
|
52
|
+
- `ChatWindowEditor`
|
|
53
|
+
- `EmailComposeEditor`
|
|
54
|
+
- `MDTextEditor`
|
|
55
|
+
- `NotionLikeEditor`
|
|
56
|
+
- `HeadlessEditorPreset`
|
|
57
|
+
- `NotesEditor`
|
|
58
|
+
|
|
59
|
+
## Compatibility
|
|
60
|
+
|
|
61
|
+
- React: `^18.0.0 || ^19.0.0`
|
|
62
|
+
- React DOM: `^18.0.0 || ^19.0.0`
|
|
63
|
+
- Lexical family: `^0.40.0`
|
|
64
|
+
|
|
65
|
+
## Documentation
|
|
66
|
+
|
|
67
|
+
- Docs landing: [luthor.fyi/docs/getting-started/luthor](https://www.luthor.fyi/docs/getting-started/luthor)
|
|
68
|
+
- Presets docs: [luthor.fyi/docs/luthor/presets](https://www.luthor.fyi/docs/luthor/presets)
|
|
69
|
+
- User guide (repo): [documentation/user/luthor/getting-started.md](https://github.com/lyfie-app/luthor/blob/main/documentation/user/luthor/getting-started.md)
|
|
70
|
+
- Presets/config: [documentation/user/luthor/presets-and-configuration.md](https://github.com/lyfie-app/luthor/blob/main/documentation/user/luthor/presets-and-configuration.md)
|
|
71
|
+
- Extensive editor guide: [documentation/user/luthor/extensive-editor.md](https://github.com/lyfie-app/luthor/blob/main/documentation/user/luthor/extensive-editor.md)
|
|
72
|
+
|
|
73
|
+
## Need Headless Control?
|
|
74
|
+
|
|
75
|
+
Use [`@lyfie/luthor-headless`](https://www.npmjs.com/package/@lyfie/luthor-headless) when you want total UI and extension composition control.
|
|
76
|
+
|
|
77
|
+
## License
|
|
23
78
|
|
|
24
|
-
|
|
25
|
-
- https://luthor-editor.vercel.app/docs/luthor/presets/
|
|
79
|
+
MIT (c) Luthor Team
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lyfie/luthor",
|
|
3
|
-
"version": "2.3.
|
|
3
|
+
"version": "2.3.4",
|
|
4
4
|
"description": "Luthor presets and plug-and-play configuration for the headless editor",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"private": false,
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
"@lexical/table": "^0.40.0",
|
|
58
58
|
"@lexical/utils": "^0.40.0",
|
|
59
59
|
"lexical": "^0.40.0",
|
|
60
|
-
"@lyfie/luthor-headless": "2.3.
|
|
60
|
+
"@lyfie/luthor-headless": "2.3.4"
|
|
61
61
|
},
|
|
62
62
|
"devDependencies": {
|
|
63
63
|
"@types/node": "^20.19.33",
|