@layout-lib/react 0.1.1 → 0.2.0
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 +4 -3
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ export function App() {
|
|
|
24
24
|
```
|
|
25
25
|
|
|
26
26
|
<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>G</kbd> shows or hides the grid.
|
|
27
|
-
<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>
|
|
27
|
+
<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> hides the settings panel outright, or brings it back. The panel's own button just folds it.
|
|
28
28
|
|
|
29
29
|
## Next.js (App Router)
|
|
30
30
|
|
|
@@ -48,7 +48,7 @@ export default function RootLayout({ children }) {
|
|
|
48
48
|
|
|
49
49
|
## Theming the panel
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
Ten built-in themes, plus `auto` (the default), which follows the operating system live: `dark`, `light`, `midnight`, `slate`, `solar`, `mono`, `blue`, `pink`, `red`, `green`.
|
|
52
52
|
|
|
53
53
|
```tsx
|
|
54
54
|
<LayoutGrid theme="midnight" />
|
|
@@ -81,11 +81,12 @@ Every colour can be replaced on top of the theme. Anything you leave out keeps t
|
|
|
81
81
|
| `palette` | `{}` | Override any panel colour. |
|
|
82
82
|
| `panel` | `true` | Mount the settings panel. |
|
|
83
83
|
| `panelOpen` | `true` | Start with the panel unfolded. |
|
|
84
|
+
| `panelShown` | `true` | Start with the panel on screen. |
|
|
84
85
|
| `baseline` | `8` | Vertical rhythm in px, or `false`. |
|
|
85
86
|
| `color` | `"#ff3b6b"` | Grid colour. |
|
|
86
87
|
| `opacity` | `0.12` | Column opacity. |
|
|
87
88
|
| `toggleKey` | `"g"` | Toggle key, with Ctrl + Shift. |
|
|
88
|
-
| `panelKey` | `"p"` | Panel
|
|
89
|
+
| `panelKey` | `"p"` | Panel hide key, with Ctrl + Shift. |
|
|
89
90
|
| `persist` | `true` | Remember tweaks in `localStorage`. |
|
|
90
91
|
| `storageKey` | `"layout-lib:overlay"` | Storage key. |
|
|
91
92
|
| `zIndex` | `2147483000` | Above everything, by default. |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@layout-lib/react",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Responsive layout grid overlay for React, Next.js and Vite.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
],
|
|
19
19
|
"sideEffects": false,
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@layout-lib/core": "0.
|
|
21
|
+
"@layout-lib/core": "0.2.0"
|
|
22
22
|
},
|
|
23
23
|
"peerDependencies": {
|
|
24
24
|
"react": ">=18"
|