shelving 1.314.1 → 1.316.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.
Files changed (111) hide show
  1. package/docs/icon/AddIcon/AddIcon.md +8 -0
  2. package/docs/icon/AddIcon.md +8 -0
  3. package/docs/icon/CloseIcon/CloseIcon.md +8 -0
  4. package/docs/icon/CloseIcon.md +8 -0
  5. package/docs/icon/DownIcon/DownIcon.md +8 -0
  6. package/docs/icon/DownIcon.md +8 -0
  7. package/docs/icon/ErrorIcon/ErrorIcon.md +8 -0
  8. package/docs/icon/ErrorIcon.md +8 -0
  9. package/docs/icon/ExpandIcon/ExpandIcon.md +8 -0
  10. package/docs/icon/ExpandIcon.md +8 -0
  11. package/docs/icon/InfoIcon/InfoIcon.md +8 -0
  12. package/docs/icon/InfoIcon.md +8 -0
  13. package/docs/icon/LeftIcon/LeftIcon.md +8 -0
  14. package/docs/icon/LeftIcon.md +8 -0
  15. package/docs/icon/LoadingIcon/LoadingIcon.md +9 -0
  16. package/docs/icon/LoadingIcon.md +8 -0
  17. package/docs/icon/MenuIcon/MenuIcon.md +8 -0
  18. package/docs/icon/MenuIcon.md +8 -0
  19. package/docs/icon/RemoveIcon/RemoveIcon.md +8 -0
  20. package/docs/icon/RemoveIcon.md +8 -0
  21. package/docs/icon/RetryIcon/RetryIcon.md +8 -0
  22. package/docs/icon/RetryIcon.md +8 -0
  23. package/docs/icon/RightIcon/RightIcon.md +8 -0
  24. package/docs/icon/RightIcon.md +8 -0
  25. package/docs/icon/ShrinkIcon/ShrinkIcon.md +8 -0
  26. package/docs/icon/ShrinkIcon.md +8 -0
  27. package/docs/icon/SuccessIcon/SuccessIcon.md +8 -0
  28. package/docs/icon/SuccessIcon.md +8 -0
  29. package/docs/icon/UpIcon/UpIcon.md +8 -0
  30. package/docs/icon/UpIcon.md +8 -0
  31. package/docs/icon/WarningIcon/WarningIcon.md +8 -0
  32. package/docs/icon/WarningIcon.md +8 -0
  33. package/docs/index.md +16 -0
  34. package/docs/llms-full.txt +420 -19
  35. package/docs/llms.txt +16 -0
  36. package/docs/ui/DialogCloseButton.md +1 -1
  37. package/docs/ui/Icon.md +2 -2
  38. package/docs/ui/LOADING.md +1 -1
  39. package/docs/ui/Loading.md +2 -2
  40. package/docs/ui/SubmitButton.md +1 -1
  41. package/docs/ui/SubmitButtonProps.md +1 -1
  42. package/icon/AddIcon.d.ts +9 -0
  43. package/icon/AddIcon.js +7 -0
  44. package/icon/CloseIcon.d.ts +9 -0
  45. package/icon/CloseIcon.js +7 -0
  46. package/icon/DownIcon.d.ts +9 -0
  47. package/icon/DownIcon.js +7 -0
  48. package/icon/ErrorIcon.d.ts +9 -0
  49. package/icon/ErrorIcon.js +7 -0
  50. package/icon/ExpandIcon.d.ts +9 -0
  51. package/icon/ExpandIcon.js +7 -0
  52. package/icon/InfoIcon.d.ts +9 -0
  53. package/icon/InfoIcon.js +7 -0
  54. package/icon/LeftIcon.d.ts +9 -0
  55. package/icon/LeftIcon.js +7 -0
  56. package/icon/LoadingIcon.d.ts +8 -0
  57. package/icon/LoadingIcon.js +8 -0
  58. package/icon/MenuIcon.d.ts +9 -0
  59. package/icon/MenuIcon.js +7 -0
  60. package/icon/RemoveIcon.d.ts +9 -0
  61. package/icon/RemoveIcon.js +7 -0
  62. package/icon/RetryIcon.d.ts +9 -0
  63. package/icon/RetryIcon.js +7 -0
  64. package/icon/RightIcon.d.ts +9 -0
  65. package/icon/RightIcon.js +7 -0
  66. package/icon/ShrinkIcon.d.ts +9 -0
  67. package/icon/ShrinkIcon.js +7 -0
  68. package/icon/SuccessIcon.d.ts +9 -0
  69. package/icon/SuccessIcon.js +7 -0
  70. package/icon/UpIcon.d.ts +9 -0
  71. package/icon/UpIcon.js +7 -0
  72. package/icon/WarningIcon.d.ts +9 -0
  73. package/icon/WarningIcon.js +7 -0
  74. package/package.json +2 -1
  75. package/ui/block/Details.js +2 -2
  76. package/ui/block/Details.tsx +2 -2
  77. package/ui/button/Clickable.js +1 -1
  78. package/ui/button/Clickable.tsx +1 -1
  79. package/ui/button/FullscreenButton.js +3 -2
  80. package/ui/button/FullscreenButton.tsx +3 -2
  81. package/ui/button/RetryButton.js +2 -2
  82. package/ui/button/RetryButton.tsx +2 -2
  83. package/ui/button/SubmitButton.d.ts +1 -1
  84. package/ui/button/SubmitButton.js +3 -5
  85. package/ui/button/SubmitButton.tsx +3 -11
  86. package/ui/dialog/Dialog.js +2 -2
  87. package/ui/dialog/Dialog.tsx +2 -2
  88. package/ui/input/ArrayInput.js +5 -4
  89. package/ui/input/ArrayInput.tsx +5 -4
  90. package/ui/input/DictionaryInput.js +5 -4
  91. package/ui/input/DictionaryInput.tsx +5 -4
  92. package/ui/input/ImageInput.js +2 -2
  93. package/ui/input/ImageInput.tsx +2 -2
  94. package/ui/input/Input.js +1 -1
  95. package/ui/input/Input.tsx +1 -1
  96. package/ui/layout/SidebarLayout.js +3 -2
  97. package/ui/layout/SidebarLayout.tsx +3 -2
  98. package/ui/misc/Icon.d.ts +9 -1
  99. package/ui/misc/Icon.js +20 -9
  100. package/ui/misc/Icon.md +1 -1
  101. package/ui/misc/Icon.tsx +21 -9
  102. package/ui/misc/Loader.js +1 -1
  103. package/ui/misc/Loader.tsx +1 -1
  104. package/ui/misc/Loading.d.ts +0 -8
  105. package/ui/misc/Loading.js +0 -9
  106. package/ui/misc/Loading.md +2 -2
  107. package/ui/misc/Loading.tsx +0 -10
  108. package/ui/notice/Empty.js +1 -1
  109. package/ui/notice/Empty.tsx +1 -1
  110. package/ui/tree/TreeBreadcrumbs.js +2 -2
  111. 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
+ # shelving/icon/AddIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/AddIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [AddIcon](AddIcon/AddIcon.md): Icon to add an item, e.g. the add button on <ArrayInput> and <DictionaryInput>.
@@ -0,0 +1,8 @@
1
+ # CloseIcon
2
+
3
+ - Kind: constant
4
+ - Import: `import { CloseIcon } from "shelving/icon/CloseIcon";`
5
+
6
+ Icon to close something, e.g. the close button on `<Dialog>` and `<SidebarLayout>`.
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 something, e.g. the close button on <Dialog> and <SidebarLayout>.
@@ -0,0 +1,8 @@
1
+ # DownIcon
2
+
3
+ - Kind: constant
4
+ - Import: `import { DownIcon } from "shelving/icon/DownIcon";`
5
+
6
+ Chevron that points down.
7
+ - Default is the Heroicons `ChevronDownIcon`.
8
+ - Swap it for your own icon with a `paths` entry for `shelving/icon/DownIcon` in your `tsconfig.json`. See `README.md` in this folder.
@@ -0,0 +1,8 @@
1
+ # shelving/icon/DownIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/DownIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [DownIcon](DownIcon/DownIcon.md): Chevron that points down.
@@ -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
+ # shelving/icon/ErrorIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/ErrorIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [ErrorIcon](ErrorIcon/ErrorIcon.md): Icon for status="error" in <Icon>.
@@ -0,0 +1,8 @@
1
+ # ExpandIcon
2
+
3
+ - Kind: constant
4
+ - Import: `import { ExpandIcon } from "shelving/icon/ExpandIcon";`
5
+
6
+ Icon to expand, e.g. 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/ExpandIcon` in your `tsconfig.json`. See `README.md` in this folder.
@@ -0,0 +1,8 @@
1
+ # shelving/icon/ExpandIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/ExpandIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [ExpandIcon](ExpandIcon/ExpandIcon.md): Icon to expand, e.g. to enter fullscreen, used in <FullscreenButton>.
@@ -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
+ # shelving/icon/InfoIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/InfoIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [InfoIcon](InfoIcon/InfoIcon.md): Icon for status="info" (the default) in <Icon>.
@@ -0,0 +1,8 @@
1
+ # LeftIcon
2
+
3
+ - Kind: constant
4
+ - Import: `import { LeftIcon } from "shelving/icon/LeftIcon";`
5
+
6
+ Chevron that points left.
7
+ - Default is the Heroicons `ChevronLeftIcon`.
8
+ - Swap it for your own icon with a `paths` entry for `shelving/icon/LeftIcon` in your `tsconfig.json`. See `README.md` in this folder.
@@ -0,0 +1,8 @@
1
+ # shelving/icon/LeftIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/LeftIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [LeftIcon](LeftIcon/LeftIcon.md): Chevron that points left.
@@ -0,0 +1,9 @@
1
+ # LoadingIcon
2
+
3
+ - Kind: constant
4
+ - Import: `import { LoadingIcon } from "shelving/icon/LoadingIcon";`
5
+
6
+ Animated icon that shows something is loading, e.g. `<Icon status="loading">` and `LOADING`.
7
+ - Default is shelving's own `<Loading>` spinner.
8
+ - Swap it for your own icon with a `paths` entry for `shelving/icon/LoadingIcon` in your `tsconfig.json`. See `README.md` in this folder.
9
+ - An icon has no CSS of its own, so animate your icon inside the SVG, e.g. with SMIL `<animateTransform>`.
@@ -0,0 +1,8 @@
1
+ # shelving/icon/LoadingIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/LoadingIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [LoadingIcon](LoadingIcon/LoadingIcon.md): Animated icon that shows something is loading, e.g. <Icon status="loading"> and LOADING.
@@ -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
+ # shelving/icon/MenuIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/MenuIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [MenuIcon](MenuIcon/MenuIcon.md): Icon to open a menu, e.g. the menu button on <SidebarLayout>.
@@ -0,0 +1,8 @@
1
+ # RemoveIcon
2
+
3
+ - Kind: constant
4
+ - Import: `import { RemoveIcon } from "shelving/icon/RemoveIcon";`
5
+
6
+ Icon to remove an item, e.g. the remove buttons on `<ArrayInput>`, `<DictionaryInput>` and `<ImageInput>`. The pair of `AddIcon`.
7
+ - Default is the Heroicons `XMarkIcon`, the same as `CloseIcon`.
8
+ - Swap it for your own icon with a `paths` entry for `shelving/icon/RemoveIcon` in your `tsconfig.json`. See `README.md` in this folder.
@@ -0,0 +1,8 @@
1
+ # shelving/icon/RemoveIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/RemoveIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [RemoveIcon](RemoveIcon/RemoveIcon.md): Icon to remove an item, e.g. the remove buttons on <ArrayInput>, <DictionaryInput> and <ImageInput>. The pair of AddIcon.
@@ -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
+ # shelving/icon/RetryIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/RetryIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [RetryIcon](RetryIcon/RetryIcon.md): Icon for <RetryButton>.
@@ -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
+ # shelving/icon/RightIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/RightIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [RightIcon](RightIcon/RightIcon.md): Chevron that points right, e.g. the separator in <TreeBreadcrumbs>.
@@ -0,0 +1,8 @@
1
+ # ShrinkIcon
2
+
3
+ - Kind: constant
4
+ - Import: `import { ShrinkIcon } from "shelving/icon/ShrinkIcon";`
5
+
6
+ Icon to shrink, e.g. 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/ShrinkIcon` in your `tsconfig.json`. See `README.md` in this folder.
@@ -0,0 +1,8 @@
1
+ # shelving/icon/ShrinkIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/ShrinkIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [ShrinkIcon](ShrinkIcon/ShrinkIcon.md): Icon to shrink, e.g. to exit fullscreen, used in <FullscreenButton>.
@@ -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
+ # shelving/icon/SuccessIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/SuccessIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [SuccessIcon](SuccessIcon/SuccessIcon.md): Icon for status="success" in <Icon>.
@@ -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
+ # shelving/icon/UpIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/UpIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [UpIcon](UpIcon/UpIcon.md): Chevron that points up, e.g. the open and close arrow on <Details>.
@@ -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.
@@ -0,0 +1,8 @@
1
+ # shelving/icon/WarningIcon
2
+
3
+ - Kind: module
4
+ - Import: `import { … } from "shelving/icon/WarningIcon";`
5
+
6
+ ## Constants
7
+
8
+ - [WarningIcon](WarningIcon/WarningIcon.md): Icon for status="warning" and status="danger" in <Icon>.
package/docs/index.md CHANGED
@@ -49,6 +49,22 @@ 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/DownIcon](icon/DownIcon.md)
55
+ - [shelving/icon/ErrorIcon](icon/ErrorIcon.md)
56
+ - [shelving/icon/ExpandIcon](icon/ExpandIcon.md)
57
+ - [shelving/icon/InfoIcon](icon/InfoIcon.md)
58
+ - [shelving/icon/LeftIcon](icon/LeftIcon.md)
59
+ - [shelving/icon/LoadingIcon](icon/LoadingIcon.md)
60
+ - [shelving/icon/MenuIcon](icon/MenuIcon.md)
61
+ - [shelving/icon/RemoveIcon](icon/RemoveIcon.md)
62
+ - [shelving/icon/RetryIcon](icon/RetryIcon.md)
63
+ - [shelving/icon/RightIcon](icon/RightIcon.md)
64
+ - [shelving/icon/ShrinkIcon](icon/ShrinkIcon.md)
65
+ - [shelving/icon/SuccessIcon](icon/SuccessIcon.md)
66
+ - [shelving/icon/UpIcon](icon/UpIcon.md)
67
+ - [shelving/icon/WarningIcon](icon/WarningIcon.md)
52
68
  - [shelving/markup](markup.md): A rule-based Markdown renderer that turns user-facing text into React nodes.
53
69
  - [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
70
  - [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.