shelving 1.314.1 → 1.315.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/docs/icon/AddIcon/AddIcon.md +8 -0
- package/docs/icon/AddIcon.md +8 -0
- package/docs/icon/CloseIcon/CloseIcon.md +8 -0
- package/docs/icon/CloseIcon.md +8 -0
- package/docs/icon/ErrorIcon/ErrorIcon.md +8 -0
- package/docs/icon/ErrorIcon.md +8 -0
- package/docs/icon/ExitFullscreenIcon/ExitFullscreenIcon.md +8 -0
- package/docs/icon/ExitFullscreenIcon.md +8 -0
- package/docs/icon/FullscreenIcon/FullscreenIcon.md +8 -0
- package/docs/icon/FullscreenIcon.md +8 -0
- package/docs/icon/InfoIcon/InfoIcon.md +8 -0
- package/docs/icon/InfoIcon.md +8 -0
- package/docs/icon/MenuIcon/MenuIcon.md +8 -0
- package/docs/icon/MenuIcon.md +8 -0
- package/docs/icon/RetryIcon/RetryIcon.md +8 -0
- package/docs/icon/RetryIcon.md +8 -0
- package/docs/icon/RightIcon/RightIcon.md +8 -0
- package/docs/icon/RightIcon.md +8 -0
- package/docs/icon/SubmitIcon/SubmitIcon.md +8 -0
- package/docs/icon/SubmitIcon.md +8 -0
- package/docs/icon/SuccessIcon/SuccessIcon.md +8 -0
- package/docs/icon/SuccessIcon.md +8 -0
- package/docs/icon/UpIcon/UpIcon.md +8 -0
- package/docs/icon/UpIcon.md +8 -0
- package/docs/icon/WarningIcon/WarningIcon.md +8 -0
- package/docs/icon/WarningIcon.md +8 -0
- package/docs/index.md +13 -0
- package/docs/llms-full.txt +328 -3
- package/docs/llms.txt +13 -0
- package/docs/ui/DialogCloseButton.md +1 -1
- package/docs/ui/Icon.md +2 -2
- package/icon/AddIcon.d.ts +9 -0
- package/icon/AddIcon.js +7 -0
- package/icon/CloseIcon.d.ts +9 -0
- package/icon/CloseIcon.js +7 -0
- package/icon/ErrorIcon.d.ts +9 -0
- package/icon/ErrorIcon.js +7 -0
- package/icon/ExitFullscreenIcon.d.ts +9 -0
- package/icon/ExitFullscreenIcon.js +7 -0
- package/icon/FullscreenIcon.d.ts +9 -0
- package/icon/FullscreenIcon.js +7 -0
- package/icon/InfoIcon.d.ts +9 -0
- package/icon/InfoIcon.js +7 -0
- package/icon/MenuIcon.d.ts +9 -0
- package/icon/MenuIcon.js +7 -0
- package/icon/RetryIcon.d.ts +9 -0
- package/icon/RetryIcon.js +7 -0
- package/icon/RightIcon.d.ts +9 -0
- package/icon/RightIcon.js +7 -0
- package/icon/SubmitIcon.d.ts +9 -0
- package/icon/SubmitIcon.js +7 -0
- package/icon/SuccessIcon.d.ts +9 -0
- package/icon/SuccessIcon.js +7 -0
- package/icon/UpIcon.d.ts +9 -0
- package/icon/UpIcon.js +7 -0
- package/icon/WarningIcon.d.ts +9 -0
- package/icon/WarningIcon.js +7 -0
- package/package.json +2 -1
- package/ui/block/Details.js +2 -2
- package/ui/block/Details.tsx +2 -2
- package/ui/button/FullscreenButton.js +3 -2
- package/ui/button/FullscreenButton.tsx +3 -2
- package/ui/button/RetryButton.js +2 -2
- package/ui/button/RetryButton.tsx +2 -2
- package/ui/button/SubmitButton.js +2 -2
- package/ui/button/SubmitButton.tsx +2 -2
- package/ui/dialog/Dialog.js +2 -2
- package/ui/dialog/Dialog.tsx +2 -2
- package/ui/input/ArrayInput.js +5 -4
- package/ui/input/ArrayInput.tsx +5 -4
- package/ui/input/DictionaryInput.js +5 -4
- package/ui/input/DictionaryInput.tsx +5 -4
- package/ui/input/ImageInput.js +2 -2
- package/ui/input/ImageInput.tsx +2 -2
- package/ui/layout/SidebarLayout.js +3 -2
- package/ui/layout/SidebarLayout.tsx +3 -2
- package/ui/misc/Icon.d.ts +1 -1
- package/ui/misc/Icon.js +10 -7
- package/ui/misc/Icon.md +1 -1
- package/ui/misc/Icon.tsx +10 -7
- package/ui/tree/TreeBreadcrumbs.js +2 -2
- package/ui/tree/TreeBreadcrumbs.tsx +3 -3
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# AddIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { AddIcon } from "shelving/icon/AddIcon";`
|
|
5
|
+
|
|
6
|
+
Icon to add an item, e.g. the add button on `<ArrayInput>` and `<DictionaryInput>`.
|
|
7
|
+
- Default is the Heroicons `PlusIcon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/AddIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# CloseIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { CloseIcon } from "shelving/icon/CloseIcon";`
|
|
5
|
+
|
|
6
|
+
Icon to close or remove something, e.g. the close button on `<Dialog>` and the remove buttons on inputs.
|
|
7
|
+
- Default is the Heroicons `XMarkIcon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/CloseIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# shelving/icon/CloseIcon
|
|
2
|
+
|
|
3
|
+
- Kind: module
|
|
4
|
+
- Import: `import { … } from "shelving/icon/CloseIcon";`
|
|
5
|
+
|
|
6
|
+
## Constants
|
|
7
|
+
|
|
8
|
+
- [CloseIcon](CloseIcon/CloseIcon.md): Icon to close or remove something, e.g. the close button on <Dialog> and the remove buttons on inputs.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# ErrorIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { ErrorIcon } from "shelving/icon/ErrorIcon";`
|
|
5
|
+
|
|
6
|
+
Icon for `status="error"` in `<Icon>`.
|
|
7
|
+
- Default is the Heroicons `XCircleIcon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/ErrorIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# ExitFullscreenIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { ExitFullscreenIcon } from "shelving/icon/ExitFullscreenIcon";`
|
|
5
|
+
|
|
6
|
+
Icon to exit fullscreen, used in `<FullscreenButton>`.
|
|
7
|
+
- Default is the Heroicons `ArrowsPointingInIcon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/ExitFullscreenIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# FullscreenIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { FullscreenIcon } from "shelving/icon/FullscreenIcon";`
|
|
5
|
+
|
|
6
|
+
Icon to enter fullscreen, used in `<FullscreenButton>`.
|
|
7
|
+
- Default is the Heroicons `ArrowsPointingOutIcon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/FullscreenIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# InfoIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { InfoIcon } from "shelving/icon/InfoIcon";`
|
|
5
|
+
|
|
6
|
+
Icon for `status="info"` (the default) in `<Icon>`.
|
|
7
|
+
- Default is the Heroicons `InformationCircleIcon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/InfoIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# MenuIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { MenuIcon } from "shelving/icon/MenuIcon";`
|
|
5
|
+
|
|
6
|
+
Icon to open a menu, e.g. the menu button on `<SidebarLayout>`.
|
|
7
|
+
- Default is the Heroicons `Bars3Icon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/MenuIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# RetryIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { RetryIcon } from "shelving/icon/RetryIcon";`
|
|
5
|
+
|
|
6
|
+
Icon for `<RetryButton>`.
|
|
7
|
+
- Default is the Heroicons `ArrowPathIcon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/RetryIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# RightIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { RightIcon } from "shelving/icon/RightIcon";`
|
|
5
|
+
|
|
6
|
+
Chevron that points right, e.g. the separator in `<TreeBreadcrumbs>`.
|
|
7
|
+
- Default is the Heroicons `ChevronRightIcon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/RightIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# SubmitIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { SubmitIcon } from "shelving/icon/SubmitIcon";`
|
|
5
|
+
|
|
6
|
+
Icon for the default `<SubmitButton>`.
|
|
7
|
+
- Default is the Heroicons `ArrowRightIcon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/SubmitIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# SuccessIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { SuccessIcon } from "shelving/icon/SuccessIcon";`
|
|
5
|
+
|
|
6
|
+
Icon for `status="success"` in `<Icon>`.
|
|
7
|
+
- Default is the Heroicons `CheckCircleIcon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/SuccessIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# UpIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { UpIcon } from "shelving/icon/UpIcon";`
|
|
5
|
+
|
|
6
|
+
Chevron that points up, e.g. the open and close arrow on `<Details>`.
|
|
7
|
+
- Default is the Heroicons `ChevronUpIcon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/UpIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# WarningIcon
|
|
2
|
+
|
|
3
|
+
- Kind: constant
|
|
4
|
+
- Import: `import { WarningIcon } from "shelving/icon/WarningIcon";`
|
|
5
|
+
|
|
6
|
+
Icon for `status="warning"` and `status="danger"` in `<Icon>`.
|
|
7
|
+
- Default is the Heroicons `ExclamationTriangleIcon`.
|
|
8
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/WarningIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
package/docs/index.md
CHANGED
|
@@ -49,6 +49,19 @@ See [Releases](https://github.com/dhoulb/shelving/releases) on GitHub.
|
|
|
49
49
|
- [shelving/error](error.md): Typed error classes for system and transport failures.
|
|
50
50
|
- [shelving/extract](extract.md): Turn a folder of source files into a navigable tree of documentation. extract is the engine behind the Shelving documentation site itself.
|
|
51
51
|
- [shelving/firebase](firebase.md): FirestoreProvider — a Cloud Firestore DBProvider that talks directly to the Firestore REST API using fetch.
|
|
52
|
+
- [shelving/icon/AddIcon](icon/AddIcon.md)
|
|
53
|
+
- [shelving/icon/CloseIcon](icon/CloseIcon.md)
|
|
54
|
+
- [shelving/icon/ErrorIcon](icon/ErrorIcon.md)
|
|
55
|
+
- [shelving/icon/ExitFullscreenIcon](icon/ExitFullscreenIcon.md)
|
|
56
|
+
- [shelving/icon/FullscreenIcon](icon/FullscreenIcon.md)
|
|
57
|
+
- [shelving/icon/InfoIcon](icon/InfoIcon.md)
|
|
58
|
+
- [shelving/icon/MenuIcon](icon/MenuIcon.md)
|
|
59
|
+
- [shelving/icon/RetryIcon](icon/RetryIcon.md)
|
|
60
|
+
- [shelving/icon/RightIcon](icon/RightIcon.md)
|
|
61
|
+
- [shelving/icon/SubmitIcon](icon/SubmitIcon.md)
|
|
62
|
+
- [shelving/icon/SuccessIcon](icon/SuccessIcon.md)
|
|
63
|
+
- [shelving/icon/UpIcon](icon/UpIcon.md)
|
|
64
|
+
- [shelving/icon/WarningIcon](icon/WarningIcon.md)
|
|
52
65
|
- [shelving/markup](markup.md): A rule-based Markdown renderer that turns user-facing text into React nodes.
|
|
53
66
|
- [shelving/react](react.md): React hooks and context helpers for integrating Shelving shelving/store, async sequences, and API/DB providers into React components. The module is built on useSyncExternalStore and standard React patterns — no magic, no global state.
|
|
54
67
|
- [shelving/schema](schema.md): Schema validation for TypeScript. A Schema<T> describes how to coerce and validate an unknown value into a typed T. Schemas are the foundation of shelving — database collections, API endpoints, and form handlers all build on them.
|
package/docs/llms-full.txt
CHANGED
|
@@ -49,6 +49,19 @@ See [Releases](https://github.com/dhoulb/shelving/releases) on GitHub.
|
|
|
49
49
|
- [shelving/error](error.md): Typed error classes for system and transport failures.
|
|
50
50
|
- [shelving/extract](extract.md): Turn a folder of source files into a navigable tree of documentation. extract is the engine behind the Shelving documentation site itself.
|
|
51
51
|
- [shelving/firebase](firebase.md): FirestoreProvider — a Cloud Firestore DBProvider that talks directly to the Firestore REST API using fetch.
|
|
52
|
+
- [shelving/icon/AddIcon](icon/AddIcon.md)
|
|
53
|
+
- [shelving/icon/CloseIcon](icon/CloseIcon.md)
|
|
54
|
+
- [shelving/icon/ErrorIcon](icon/ErrorIcon.md)
|
|
55
|
+
- [shelving/icon/ExitFullscreenIcon](icon/ExitFullscreenIcon.md)
|
|
56
|
+
- [shelving/icon/FullscreenIcon](icon/FullscreenIcon.md)
|
|
57
|
+
- [shelving/icon/InfoIcon](icon/InfoIcon.md)
|
|
58
|
+
- [shelving/icon/MenuIcon](icon/MenuIcon.md)
|
|
59
|
+
- [shelving/icon/RetryIcon](icon/RetryIcon.md)
|
|
60
|
+
- [shelving/icon/RightIcon](icon/RightIcon.md)
|
|
61
|
+
- [shelving/icon/SubmitIcon](icon/SubmitIcon.md)
|
|
62
|
+
- [shelving/icon/SuccessIcon](icon/SuccessIcon.md)
|
|
63
|
+
- [shelving/icon/UpIcon](icon/UpIcon.md)
|
|
64
|
+
- [shelving/icon/WarningIcon](icon/WarningIcon.md)
|
|
52
65
|
- [shelving/markup](markup.md): A rule-based Markdown renderer that turns user-facing text into React nodes.
|
|
53
66
|
- [shelving/react](react.md): React hooks and context helpers for integrating Shelving shelving/store, async sequences, and API/DB providers into React components. The module is built on useSyncExternalStore and standard React patterns — no magic, no global state.
|
|
54
67
|
- [shelving/schema](schema.md): Schema validation for TypeScript. A Schema<T> describes how to coerce and validate an unknown value into a typed T. Schemas are the foundation of shelving — database collections, API endpoints, and form handlers all build on them.
|
|
@@ -9457,6 +9470,318 @@ toData({ num: { integerValue: "123" } }) // { num: 123 }
|
|
|
9457
9470
|
```
|
|
9458
9471
|
|
|
9459
9472
|
|
|
9473
|
+
---
|
|
9474
|
+
|
|
9475
|
+
# shelving/icon/AddIcon
|
|
9476
|
+
|
|
9477
|
+
- Kind: module
|
|
9478
|
+
- Import: `import { … } from "shelving/icon/AddIcon";`
|
|
9479
|
+
|
|
9480
|
+
## Constants
|
|
9481
|
+
|
|
9482
|
+
- [AddIcon](icon/AddIcon/AddIcon.md): Icon to add an item, e.g. the add button on <ArrayInput> and <DictionaryInput>.
|
|
9483
|
+
|
|
9484
|
+
|
|
9485
|
+
---
|
|
9486
|
+
|
|
9487
|
+
# AddIcon
|
|
9488
|
+
|
|
9489
|
+
- Kind: constant
|
|
9490
|
+
- Import: `import { AddIcon } from "shelving/icon/AddIcon";`
|
|
9491
|
+
|
|
9492
|
+
Icon to add an item, e.g. the add button on `<ArrayInput>` and `<DictionaryInput>`.
|
|
9493
|
+
- Default is the Heroicons `PlusIcon`.
|
|
9494
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/AddIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9495
|
+
|
|
9496
|
+
|
|
9497
|
+
---
|
|
9498
|
+
|
|
9499
|
+
# shelving/icon/CloseIcon
|
|
9500
|
+
|
|
9501
|
+
- Kind: module
|
|
9502
|
+
- Import: `import { … } from "shelving/icon/CloseIcon";`
|
|
9503
|
+
|
|
9504
|
+
## Constants
|
|
9505
|
+
|
|
9506
|
+
- [CloseIcon](icon/CloseIcon/CloseIcon.md): Icon to close or remove something, e.g. the close button on <Dialog> and the remove buttons on inputs.
|
|
9507
|
+
|
|
9508
|
+
|
|
9509
|
+
---
|
|
9510
|
+
|
|
9511
|
+
# CloseIcon
|
|
9512
|
+
|
|
9513
|
+
- Kind: constant
|
|
9514
|
+
- Import: `import { CloseIcon } from "shelving/icon/CloseIcon";`
|
|
9515
|
+
|
|
9516
|
+
Icon to close or remove something, e.g. the close button on `<Dialog>` and the remove buttons on inputs.
|
|
9517
|
+
- Default is the Heroicons `XMarkIcon`.
|
|
9518
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/CloseIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9519
|
+
|
|
9520
|
+
|
|
9521
|
+
---
|
|
9522
|
+
|
|
9523
|
+
# shelving/icon/ErrorIcon
|
|
9524
|
+
|
|
9525
|
+
- Kind: module
|
|
9526
|
+
- Import: `import { … } from "shelving/icon/ErrorIcon";`
|
|
9527
|
+
|
|
9528
|
+
## Constants
|
|
9529
|
+
|
|
9530
|
+
- [ErrorIcon](icon/ErrorIcon/ErrorIcon.md): Icon for status="error" in <Icon>.
|
|
9531
|
+
|
|
9532
|
+
|
|
9533
|
+
---
|
|
9534
|
+
|
|
9535
|
+
# ErrorIcon
|
|
9536
|
+
|
|
9537
|
+
- Kind: constant
|
|
9538
|
+
- Import: `import { ErrorIcon } from "shelving/icon/ErrorIcon";`
|
|
9539
|
+
|
|
9540
|
+
Icon for `status="error"` in `<Icon>`.
|
|
9541
|
+
- Default is the Heroicons `XCircleIcon`.
|
|
9542
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/ErrorIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9543
|
+
|
|
9544
|
+
|
|
9545
|
+
---
|
|
9546
|
+
|
|
9547
|
+
# shelving/icon/ExitFullscreenIcon
|
|
9548
|
+
|
|
9549
|
+
- Kind: module
|
|
9550
|
+
- Import: `import { … } from "shelving/icon/ExitFullscreenIcon";`
|
|
9551
|
+
|
|
9552
|
+
## Constants
|
|
9553
|
+
|
|
9554
|
+
- [ExitFullscreenIcon](icon/ExitFullscreenIcon/ExitFullscreenIcon.md): Icon to exit fullscreen, used in <FullscreenButton>.
|
|
9555
|
+
|
|
9556
|
+
|
|
9557
|
+
---
|
|
9558
|
+
|
|
9559
|
+
# ExitFullscreenIcon
|
|
9560
|
+
|
|
9561
|
+
- Kind: constant
|
|
9562
|
+
- Import: `import { ExitFullscreenIcon } from "shelving/icon/ExitFullscreenIcon";`
|
|
9563
|
+
|
|
9564
|
+
Icon to exit fullscreen, used in `<FullscreenButton>`.
|
|
9565
|
+
- Default is the Heroicons `ArrowsPointingInIcon`.
|
|
9566
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/ExitFullscreenIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9567
|
+
|
|
9568
|
+
|
|
9569
|
+
---
|
|
9570
|
+
|
|
9571
|
+
# shelving/icon/FullscreenIcon
|
|
9572
|
+
|
|
9573
|
+
- Kind: module
|
|
9574
|
+
- Import: `import { … } from "shelving/icon/FullscreenIcon";`
|
|
9575
|
+
|
|
9576
|
+
## Constants
|
|
9577
|
+
|
|
9578
|
+
- [FullscreenIcon](icon/FullscreenIcon/FullscreenIcon.md): Icon to enter fullscreen, used in <FullscreenButton>.
|
|
9579
|
+
|
|
9580
|
+
|
|
9581
|
+
---
|
|
9582
|
+
|
|
9583
|
+
# FullscreenIcon
|
|
9584
|
+
|
|
9585
|
+
- Kind: constant
|
|
9586
|
+
- Import: `import { FullscreenIcon } from "shelving/icon/FullscreenIcon";`
|
|
9587
|
+
|
|
9588
|
+
Icon to enter fullscreen, used in `<FullscreenButton>`.
|
|
9589
|
+
- Default is the Heroicons `ArrowsPointingOutIcon`.
|
|
9590
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/FullscreenIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9591
|
+
|
|
9592
|
+
|
|
9593
|
+
---
|
|
9594
|
+
|
|
9595
|
+
# shelving/icon/InfoIcon
|
|
9596
|
+
|
|
9597
|
+
- Kind: module
|
|
9598
|
+
- Import: `import { … } from "shelving/icon/InfoIcon";`
|
|
9599
|
+
|
|
9600
|
+
## Constants
|
|
9601
|
+
|
|
9602
|
+
- [InfoIcon](icon/InfoIcon/InfoIcon.md): Icon for status="info" (the default) in <Icon>.
|
|
9603
|
+
|
|
9604
|
+
|
|
9605
|
+
---
|
|
9606
|
+
|
|
9607
|
+
# InfoIcon
|
|
9608
|
+
|
|
9609
|
+
- Kind: constant
|
|
9610
|
+
- Import: `import { InfoIcon } from "shelving/icon/InfoIcon";`
|
|
9611
|
+
|
|
9612
|
+
Icon for `status="info"` (the default) in `<Icon>`.
|
|
9613
|
+
- Default is the Heroicons `InformationCircleIcon`.
|
|
9614
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/InfoIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9615
|
+
|
|
9616
|
+
|
|
9617
|
+
---
|
|
9618
|
+
|
|
9619
|
+
# shelving/icon/MenuIcon
|
|
9620
|
+
|
|
9621
|
+
- Kind: module
|
|
9622
|
+
- Import: `import { … } from "shelving/icon/MenuIcon";`
|
|
9623
|
+
|
|
9624
|
+
## Constants
|
|
9625
|
+
|
|
9626
|
+
- [MenuIcon](icon/MenuIcon/MenuIcon.md): Icon to open a menu, e.g. the menu button on <SidebarLayout>.
|
|
9627
|
+
|
|
9628
|
+
|
|
9629
|
+
---
|
|
9630
|
+
|
|
9631
|
+
# MenuIcon
|
|
9632
|
+
|
|
9633
|
+
- Kind: constant
|
|
9634
|
+
- Import: `import { MenuIcon } from "shelving/icon/MenuIcon";`
|
|
9635
|
+
|
|
9636
|
+
Icon to open a menu, e.g. the menu button on `<SidebarLayout>`.
|
|
9637
|
+
- Default is the Heroicons `Bars3Icon`.
|
|
9638
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/MenuIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9639
|
+
|
|
9640
|
+
|
|
9641
|
+
---
|
|
9642
|
+
|
|
9643
|
+
# shelving/icon/RetryIcon
|
|
9644
|
+
|
|
9645
|
+
- Kind: module
|
|
9646
|
+
- Import: `import { … } from "shelving/icon/RetryIcon";`
|
|
9647
|
+
|
|
9648
|
+
## Constants
|
|
9649
|
+
|
|
9650
|
+
- [RetryIcon](icon/RetryIcon/RetryIcon.md): Icon for <RetryButton>.
|
|
9651
|
+
|
|
9652
|
+
|
|
9653
|
+
---
|
|
9654
|
+
|
|
9655
|
+
# RetryIcon
|
|
9656
|
+
|
|
9657
|
+
- Kind: constant
|
|
9658
|
+
- Import: `import { RetryIcon } from "shelving/icon/RetryIcon";`
|
|
9659
|
+
|
|
9660
|
+
Icon for `<RetryButton>`.
|
|
9661
|
+
- Default is the Heroicons `ArrowPathIcon`.
|
|
9662
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/RetryIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9663
|
+
|
|
9664
|
+
|
|
9665
|
+
---
|
|
9666
|
+
|
|
9667
|
+
# shelving/icon/RightIcon
|
|
9668
|
+
|
|
9669
|
+
- Kind: module
|
|
9670
|
+
- Import: `import { … } from "shelving/icon/RightIcon";`
|
|
9671
|
+
|
|
9672
|
+
## Constants
|
|
9673
|
+
|
|
9674
|
+
- [RightIcon](icon/RightIcon/RightIcon.md): Chevron that points right, e.g. the separator in <TreeBreadcrumbs>.
|
|
9675
|
+
|
|
9676
|
+
|
|
9677
|
+
---
|
|
9678
|
+
|
|
9679
|
+
# RightIcon
|
|
9680
|
+
|
|
9681
|
+
- Kind: constant
|
|
9682
|
+
- Import: `import { RightIcon } from "shelving/icon/RightIcon";`
|
|
9683
|
+
|
|
9684
|
+
Chevron that points right, e.g. the separator in `<TreeBreadcrumbs>`.
|
|
9685
|
+
- Default is the Heroicons `ChevronRightIcon`.
|
|
9686
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/RightIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9687
|
+
|
|
9688
|
+
|
|
9689
|
+
---
|
|
9690
|
+
|
|
9691
|
+
# shelving/icon/SubmitIcon
|
|
9692
|
+
|
|
9693
|
+
- Kind: module
|
|
9694
|
+
- Import: `import { … } from "shelving/icon/SubmitIcon";`
|
|
9695
|
+
|
|
9696
|
+
## Constants
|
|
9697
|
+
|
|
9698
|
+
- [SubmitIcon](icon/SubmitIcon/SubmitIcon.md): Icon for the default <SubmitButton>.
|
|
9699
|
+
|
|
9700
|
+
|
|
9701
|
+
---
|
|
9702
|
+
|
|
9703
|
+
# SubmitIcon
|
|
9704
|
+
|
|
9705
|
+
- Kind: constant
|
|
9706
|
+
- Import: `import { SubmitIcon } from "shelving/icon/SubmitIcon";`
|
|
9707
|
+
|
|
9708
|
+
Icon for the default `<SubmitButton>`.
|
|
9709
|
+
- Default is the Heroicons `ArrowRightIcon`.
|
|
9710
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/SubmitIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9711
|
+
|
|
9712
|
+
|
|
9713
|
+
---
|
|
9714
|
+
|
|
9715
|
+
# shelving/icon/SuccessIcon
|
|
9716
|
+
|
|
9717
|
+
- Kind: module
|
|
9718
|
+
- Import: `import { … } from "shelving/icon/SuccessIcon";`
|
|
9719
|
+
|
|
9720
|
+
## Constants
|
|
9721
|
+
|
|
9722
|
+
- [SuccessIcon](icon/SuccessIcon/SuccessIcon.md): Icon for status="success" in <Icon>.
|
|
9723
|
+
|
|
9724
|
+
|
|
9725
|
+
---
|
|
9726
|
+
|
|
9727
|
+
# SuccessIcon
|
|
9728
|
+
|
|
9729
|
+
- Kind: constant
|
|
9730
|
+
- Import: `import { SuccessIcon } from "shelving/icon/SuccessIcon";`
|
|
9731
|
+
|
|
9732
|
+
Icon for `status="success"` in `<Icon>`.
|
|
9733
|
+
- Default is the Heroicons `CheckCircleIcon`.
|
|
9734
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/SuccessIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9735
|
+
|
|
9736
|
+
|
|
9737
|
+
---
|
|
9738
|
+
|
|
9739
|
+
# shelving/icon/UpIcon
|
|
9740
|
+
|
|
9741
|
+
- Kind: module
|
|
9742
|
+
- Import: `import { … } from "shelving/icon/UpIcon";`
|
|
9743
|
+
|
|
9744
|
+
## Constants
|
|
9745
|
+
|
|
9746
|
+
- [UpIcon](icon/UpIcon/UpIcon.md): Chevron that points up, e.g. the open and close arrow on <Details>.
|
|
9747
|
+
|
|
9748
|
+
|
|
9749
|
+
---
|
|
9750
|
+
|
|
9751
|
+
# UpIcon
|
|
9752
|
+
|
|
9753
|
+
- Kind: constant
|
|
9754
|
+
- Import: `import { UpIcon } from "shelving/icon/UpIcon";`
|
|
9755
|
+
|
|
9756
|
+
Chevron that points up, e.g. the open and close arrow on `<Details>`.
|
|
9757
|
+
- Default is the Heroicons `ChevronUpIcon`.
|
|
9758
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/UpIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9759
|
+
|
|
9760
|
+
|
|
9761
|
+
---
|
|
9762
|
+
|
|
9763
|
+
# shelving/icon/WarningIcon
|
|
9764
|
+
|
|
9765
|
+
- Kind: module
|
|
9766
|
+
- Import: `import { … } from "shelving/icon/WarningIcon";`
|
|
9767
|
+
|
|
9768
|
+
## Constants
|
|
9769
|
+
|
|
9770
|
+
- [WarningIcon](icon/WarningIcon/WarningIcon.md): Icon for status="warning" and status="danger" in <Icon>.
|
|
9771
|
+
|
|
9772
|
+
|
|
9773
|
+
---
|
|
9774
|
+
|
|
9775
|
+
# WarningIcon
|
|
9776
|
+
|
|
9777
|
+
- Kind: constant
|
|
9778
|
+
- Import: `import { WarningIcon } from "shelving/icon/WarningIcon";`
|
|
9779
|
+
|
|
9780
|
+
Icon for `status="warning"` and `status="danger"` in `<Icon>`.
|
|
9781
|
+
- Default is the Heroicons `ExclamationTriangleIcon`.
|
|
9782
|
+
- Swap it for your own icon with a `paths` entry for `shelving/icon/WarningIcon` in your `tsconfig.json`. See `README.md` in this folder.
|
|
9783
|
+
|
|
9784
|
+
|
|
9460
9785
|
---
|
|
9461
9786
|
|
|
9462
9787
|
# shelving/markup
|
|
@@ -23090,7 +23415,7 @@ Button that closes its wrapping `<dialog>`, showing an X icon by default.
|
|
|
23090
23415
|
|
|
23091
23416
|
```ts
|
|
23092
23417
|
DialogCloseButton({
|
|
23093
|
-
children = <
|
|
23418
|
+
children = <CloseIcon />,
|
|
23094
23419
|
plain = true,
|
|
23095
23420
|
className,
|
|
23096
23421
|
...variants
|
|
@@ -29905,9 +30230,9 @@ Props for `<Icon>` — the `status` to represent and optional icon `size`.
|
|
|
29905
30230
|
|
|
29906
30231
|
Render the icon for a given status, coloured to match.
|
|
29907
30232
|
|
|
29908
|
-
- Picks
|
|
30233
|
+
- Picks an icon per status from `shelving/icon` (`success`, `error`, `warning`, etc.), falling back to an info icon, and uses the animated `<Loading>` spinner for `"loading"`.
|
|
29909
30234
|
|
|
29910
|
-
Renders an icon for a given status, coloured to match. Picks
|
|
30235
|
+
Renders an icon for a given status, coloured to match. Picks an icon per status from `shelving/icon` (`success`, `error`, `warning`, etc.) and uses the animated `<Loading>` spinner for `"loading"`.
|
|
29911
30236
|
|
|
29912
30237
|
**Things to know:**
|
|
29913
30238
|
|
package/docs/llms.txt
CHANGED
|
@@ -25,6 +25,19 @@ Every page of the docs site is also Markdown: add `.md` to the page path (`https
|
|
|
25
25
|
- [shelving/error](error.md): Typed error classes for system and transport failures.
|
|
26
26
|
- [shelving/extract](extract.md): Turn a folder of source files into a navigable tree of documentation. extract is the engine behind the Shelving documentation site itself.
|
|
27
27
|
- [shelving/firebase](firebase.md): FirestoreProvider — a Cloud Firestore DBProvider that talks directly to the Firestore REST API using fetch.
|
|
28
|
+
- [shelving/icon/AddIcon](icon/AddIcon.md)
|
|
29
|
+
- [shelving/icon/CloseIcon](icon/CloseIcon.md)
|
|
30
|
+
- [shelving/icon/ErrorIcon](icon/ErrorIcon.md)
|
|
31
|
+
- [shelving/icon/ExitFullscreenIcon](icon/ExitFullscreenIcon.md)
|
|
32
|
+
- [shelving/icon/FullscreenIcon](icon/FullscreenIcon.md)
|
|
33
|
+
- [shelving/icon/InfoIcon](icon/InfoIcon.md)
|
|
34
|
+
- [shelving/icon/MenuIcon](icon/MenuIcon.md)
|
|
35
|
+
- [shelving/icon/RetryIcon](icon/RetryIcon.md)
|
|
36
|
+
- [shelving/icon/RightIcon](icon/RightIcon.md)
|
|
37
|
+
- [shelving/icon/SubmitIcon](icon/SubmitIcon.md)
|
|
38
|
+
- [shelving/icon/SuccessIcon](icon/SuccessIcon.md)
|
|
39
|
+
- [shelving/icon/UpIcon](icon/UpIcon.md)
|
|
40
|
+
- [shelving/icon/WarningIcon](icon/WarningIcon.md)
|
|
28
41
|
- [shelving/markup](markup.md): A rule-based Markdown renderer that turns user-facing text into React nodes.
|
|
29
42
|
- [shelving/react](react.md): React hooks and context helpers for integrating Shelving shelving/store, async sequences, and API/DB providers into React components. The module is built on useSyncExternalStore and standard React patterns — no magic, no global state.
|
|
30
43
|
- [shelving/schema](schema.md): Schema validation for TypeScript. A Schema<T> describes how to coerce and validate an unknown value into a typed T. Schemas are the foundation of shelving — database collections, API endpoints, and form handlers all build on them.
|