quilt-core 0.2.2 → 0.2.3
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 +48 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,34 @@
|
|
|
2
2
|
|
|
3
3
|
Framework-independent layout JSON, validation, commands, and subscriptions. No DOM or React dependency. MIT licensed; ships ESM, TypeScript declarations, and sources for editor navigation.
|
|
4
4
|
|
|
5
|
+
<!-- shared-overview:start -->
|
|
6
|
+
|
|
7
|
+
Quilt is a TypeScript library for split panes, tab groups, and popout windows.
|
|
8
|
+
It provides a framework-independent layout model, a DOM renderer, and React bindings.
|
|
9
|
+
Applications supply pane content and manage their own data and storage.
|
|
10
|
+
|
|
11
|
+
- Nested horizontal and vertical splits, with minimum and maximum pane sizes.
|
|
12
|
+
- Tab groups with configurable orientation, appearance, and per-pane permissions.
|
|
13
|
+
- CSS theme tokens and typed theme presets.
|
|
14
|
+
- Versioned JSON for layout and workspace settings.
|
|
15
|
+
- Same-origin popout windows that return their panes when closed.
|
|
16
|
+
- Keyboard navigation, optional shortcuts, and optional close confirmation.
|
|
17
|
+
|
|
18
|
+
## Demos
|
|
19
|
+
|
|
20
|
+
- [Vanilla TypeScript](https://quilt-layouts.vercel.app/vanilla.html)
|
|
21
|
+
- [React](https://quilt-layouts.vercel.app/react.html)
|
|
22
|
+
- [Theme builder](https://quilt-layouts.vercel.app/themes.html) — customize, export, and import theme JSON
|
|
23
|
+
- [Electron desktop downloads](https://quilt-layouts.vercel.app/electron.html) for macOS, Windows, and Ubuntu/Debian
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
See [screenshots and controls](https://github.com/niko-dellic/quilt/blob/main/docs/showcase.md) or the [application examples](https://github.com/niko-dellic/quilt/blob/main/examples/README.md).
|
|
28
|
+
The desktop application contains the same vanilla and React demos and runs offline.
|
|
29
|
+
Demo builds have no trusted developer certificate; see the [installation notes](https://github.com/niko-dellic/quilt/blob/main/docs/desktop-release.md).
|
|
30
|
+
|
|
31
|
+
<!-- shared-overview:end -->
|
|
32
|
+
|
|
5
33
|
## Install
|
|
6
34
|
|
|
7
35
|
```sh
|
|
@@ -23,7 +51,11 @@ const store = new LayoutStore(
|
|
|
23
51
|
const unsubscribe = store.subscribe(({ action, layout }) => {
|
|
24
52
|
console.log(action, JSON.stringify(layout));
|
|
25
53
|
});
|
|
26
|
-
store.split('main', 'horizontal', {
|
|
54
|
+
store.split('main', 'horizontal', {
|
|
55
|
+
id: 'preview',
|
|
56
|
+
type: 'preview',
|
|
57
|
+
title: 'Preview',
|
|
58
|
+
});
|
|
27
59
|
console.log(validate(store.export())); // []
|
|
28
60
|
unsubscribe();
|
|
29
61
|
store.dispose();
|
|
@@ -34,3 +66,18 @@ store.dispose();
|
|
|
34
66
|
Development and verification use Node 24; browser use requires modern JavaScript support including `structuredClone`. This package needs no stylesheet or host element. The `quilt-vanilla` DOM adapter and `quilt-react` binding provide views. Application data and persistence remain application-owned.
|
|
35
67
|
|
|
36
68
|
See [API documentation](https://github.com/niko-dellic/quilt/blob/main/docs/api.md) and [migration notes](https://github.com/niko-dellic/quilt/blob/main/docs/migration.md).
|
|
69
|
+
|
|
70
|
+
<!-- shared-docs:start -->
|
|
71
|
+
|
|
72
|
+
## Documentation
|
|
73
|
+
|
|
74
|
+
- [Configuration and API](https://github.com/niko-dellic/quilt/blob/main/docs/api.md)
|
|
75
|
+
- [Themes and tab bars](https://github.com/niko-dellic/quilt/blob/main/docs/theming.md)
|
|
76
|
+
- [Registration, React context, persistence, and close confirmation](https://github.com/niko-dellic/quilt/blob/main/docs/integration.md)
|
|
77
|
+
- [Pane and window lifecycle](https://github.com/niko-dellic/quilt/blob/main/docs/lifecycle.md)
|
|
78
|
+
- [Application examples](https://github.com/niko-dellic/quilt/blob/main/examples/README.md)
|
|
79
|
+
- [0.2.1 upgrade checklist](https://github.com/niko-dellic/quilt/blob/main/docs/migration.md)
|
|
80
|
+
- [Local packages and consumer integration](https://github.com/niko-dellic/quilt/blob/main/docs/packaging.md)
|
|
81
|
+
- [Changelog](https://github.com/niko-dellic/quilt/blob/main/CHANGELOG.md)
|
|
82
|
+
|
|
83
|
+
<!-- shared-docs:end -->
|