@petrarca/sonnet-shell 0.1.1 → 0.1.2
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 +25 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# @petrarca/sonnet-shell
|
|
2
|
+
|
|
3
|
+
Application shell, layout, and navigation for the Petrarca Sonnet component library.
|
|
4
|
+
|
|
5
|
+
## What's included
|
|
6
|
+
|
|
7
|
+
**AppShell** -- Full application shell with icon rail, top bar, side pane, sub-navigation, command menu, and confirm dialogs.
|
|
8
|
+
|
|
9
|
+
**Imperative API** -- Shell capabilities exposed as simple function calls: `notification.success()`, `panel.open()`, `navigation.go()`, `dialog.confirm()`, `fullscreen.enter()`.
|
|
10
|
+
|
|
11
|
+
**Module registry** -- Register application modules with navigation, routes, and search providers. The shell renders the navigation and routes automatically.
|
|
12
|
+
|
|
13
|
+
**Auth components** (subpath: `@petrarca/sonnet-shell/auth`) -- Login, ProtectedRoute, and TenantSelection components with prop-driven auth configuration. No auth logic baked in -- the host app provides the auth state.
|
|
14
|
+
|
|
15
|
+
## Install
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
pnpm add @petrarca/sonnet-shell @petrarca/sonnet-ui @petrarca/sonnet-core
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Peer dependencies: `react`, `react-dom`, `react-router-dom`, `tailwindcss`.
|
|
22
|
+
|
|
23
|
+
## License
|
|
24
|
+
|
|
25
|
+
Apache 2.0
|
package/package.json
CHANGED