shelving 1.315.0 → 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 (75) hide show
  1. package/docs/icon/CloseIcon/CloseIcon.md +1 -1
  2. package/docs/icon/CloseIcon.md +1 -1
  3. package/docs/icon/DownIcon/DownIcon.md +8 -0
  4. package/docs/icon/DownIcon.md +8 -0
  5. package/docs/icon/ExpandIcon/ExpandIcon.md +8 -0
  6. package/docs/icon/ExpandIcon.md +8 -0
  7. package/docs/icon/LeftIcon/LeftIcon.md +8 -0
  8. package/docs/icon/LeftIcon.md +8 -0
  9. package/docs/icon/LoadingIcon/LoadingIcon.md +9 -0
  10. package/docs/icon/LoadingIcon.md +8 -0
  11. package/docs/icon/RemoveIcon/RemoveIcon.md +8 -0
  12. package/docs/icon/RemoveIcon.md +8 -0
  13. package/docs/icon/ShrinkIcon/ShrinkIcon.md +8 -0
  14. package/docs/icon/ShrinkIcon.md +8 -0
  15. package/docs/index.md +6 -3
  16. package/docs/llms-full.txt +129 -53
  17. package/docs/llms.txt +6 -3
  18. package/docs/ui/Icon.md +1 -1
  19. package/docs/ui/LOADING.md +1 -1
  20. package/docs/ui/Loading.md +2 -2
  21. package/docs/ui/SubmitButton.md +1 -1
  22. package/docs/ui/SubmitButtonProps.md +1 -1
  23. package/icon/CloseIcon.d.ts +1 -1
  24. package/icon/CloseIcon.js +1 -1
  25. package/icon/DownIcon.d.ts +9 -0
  26. package/icon/DownIcon.js +7 -0
  27. package/icon/ExpandIcon.d.ts +9 -0
  28. package/icon/ExpandIcon.js +7 -0
  29. package/icon/LeftIcon.d.ts +9 -0
  30. package/icon/LeftIcon.js +7 -0
  31. package/icon/LoadingIcon.d.ts +8 -0
  32. package/icon/LoadingIcon.js +8 -0
  33. package/icon/RemoveIcon.d.ts +9 -0
  34. package/icon/RemoveIcon.js +7 -0
  35. package/icon/ShrinkIcon.d.ts +9 -0
  36. package/icon/ShrinkIcon.js +7 -0
  37. package/package.json +1 -1
  38. package/ui/button/Clickable.js +1 -1
  39. package/ui/button/Clickable.tsx +1 -1
  40. package/ui/button/FullscreenButton.js +3 -3
  41. package/ui/button/FullscreenButton.tsx +3 -3
  42. package/ui/button/SubmitButton.d.ts +1 -1
  43. package/ui/button/SubmitButton.js +3 -5
  44. package/ui/button/SubmitButton.tsx +3 -11
  45. package/ui/input/ArrayInput.js +3 -3
  46. package/ui/input/ArrayInput.tsx +3 -3
  47. package/ui/input/DictionaryInput.js +3 -3
  48. package/ui/input/DictionaryInput.tsx +3 -3
  49. package/ui/input/ImageInput.js +2 -2
  50. package/ui/input/ImageInput.tsx +2 -2
  51. package/ui/input/Input.js +1 -1
  52. package/ui/input/Input.tsx +1 -1
  53. package/ui/misc/Icon.d.ts +9 -1
  54. package/ui/misc/Icon.js +11 -3
  55. package/ui/misc/Icon.tsx +12 -3
  56. package/ui/misc/Loader.js +1 -1
  57. package/ui/misc/Loader.tsx +1 -1
  58. package/ui/misc/Loading.d.ts +0 -8
  59. package/ui/misc/Loading.js +0 -9
  60. package/ui/misc/Loading.md +2 -2
  61. package/ui/misc/Loading.tsx +0 -10
  62. package/ui/notice/Empty.js +1 -1
  63. package/ui/notice/Empty.tsx +1 -1
  64. package/docs/icon/ExitFullscreenIcon/ExitFullscreenIcon.md +0 -8
  65. package/docs/icon/ExitFullscreenIcon.md +0 -8
  66. package/docs/icon/FullscreenIcon/FullscreenIcon.md +0 -8
  67. package/docs/icon/FullscreenIcon.md +0 -8
  68. package/docs/icon/SubmitIcon/SubmitIcon.md +0 -8
  69. package/docs/icon/SubmitIcon.md +0 -8
  70. package/icon/ExitFullscreenIcon.d.ts +0 -9
  71. package/icon/ExitFullscreenIcon.js +0 -7
  72. package/icon/FullscreenIcon.d.ts +0 -9
  73. package/icon/FullscreenIcon.js +0 -7
  74. package/icon/SubmitIcon.d.ts +0 -9
  75. package/icon/SubmitIcon.js +0 -7
@@ -3,6 +3,6 @@
3
3
  - Kind: constant
4
4
  - Import: `import { CloseIcon } from "shelving/icon/CloseIcon";`
5
5
 
6
- Icon to close or remove something, e.g. the close button on `<Dialog>` and the remove buttons on inputs.
6
+ Icon to close something, e.g. the close button on `<Dialog>` and `<SidebarLayout>`.
7
7
  - Default is the Heroicons `XMarkIcon`.
8
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.
@@ -5,4 +5,4 @@
5
5
 
6
6
  ## Constants
7
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.
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
+ # 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
+ # 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
+ # 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
+ # 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>.
package/docs/index.md CHANGED
@@ -51,14 +51,17 @@ See [Releases](https://github.com/dhoulb/shelving/releases) on GitHub.
51
51
  - [shelving/firebase](firebase.md): FirestoreProvider — a Cloud Firestore DBProvider that talks directly to the Firestore REST API using fetch.
52
52
  - [shelving/icon/AddIcon](icon/AddIcon.md)
53
53
  - [shelving/icon/CloseIcon](icon/CloseIcon.md)
54
+ - [shelving/icon/DownIcon](icon/DownIcon.md)
54
55
  - [shelving/icon/ErrorIcon](icon/ErrorIcon.md)
55
- - [shelving/icon/ExitFullscreenIcon](icon/ExitFullscreenIcon.md)
56
- - [shelving/icon/FullscreenIcon](icon/FullscreenIcon.md)
56
+ - [shelving/icon/ExpandIcon](icon/ExpandIcon.md)
57
57
  - [shelving/icon/InfoIcon](icon/InfoIcon.md)
58
+ - [shelving/icon/LeftIcon](icon/LeftIcon.md)
59
+ - [shelving/icon/LoadingIcon](icon/LoadingIcon.md)
58
60
  - [shelving/icon/MenuIcon](icon/MenuIcon.md)
61
+ - [shelving/icon/RemoveIcon](icon/RemoveIcon.md)
59
62
  - [shelving/icon/RetryIcon](icon/RetryIcon.md)
60
63
  - [shelving/icon/RightIcon](icon/RightIcon.md)
61
- - [shelving/icon/SubmitIcon](icon/SubmitIcon.md)
64
+ - [shelving/icon/ShrinkIcon](icon/ShrinkIcon.md)
62
65
  - [shelving/icon/SuccessIcon](icon/SuccessIcon.md)
63
66
  - [shelving/icon/UpIcon](icon/UpIcon.md)
64
67
  - [shelving/icon/WarningIcon](icon/WarningIcon.md)
@@ -51,14 +51,17 @@ See [Releases](https://github.com/dhoulb/shelving/releases) on GitHub.
51
51
  - [shelving/firebase](firebase.md): FirestoreProvider — a Cloud Firestore DBProvider that talks directly to the Firestore REST API using fetch.
52
52
  - [shelving/icon/AddIcon](icon/AddIcon.md)
53
53
  - [shelving/icon/CloseIcon](icon/CloseIcon.md)
54
+ - [shelving/icon/DownIcon](icon/DownIcon.md)
54
55
  - [shelving/icon/ErrorIcon](icon/ErrorIcon.md)
55
- - [shelving/icon/ExitFullscreenIcon](icon/ExitFullscreenIcon.md)
56
- - [shelving/icon/FullscreenIcon](icon/FullscreenIcon.md)
56
+ - [shelving/icon/ExpandIcon](icon/ExpandIcon.md)
57
57
  - [shelving/icon/InfoIcon](icon/InfoIcon.md)
58
+ - [shelving/icon/LeftIcon](icon/LeftIcon.md)
59
+ - [shelving/icon/LoadingIcon](icon/LoadingIcon.md)
58
60
  - [shelving/icon/MenuIcon](icon/MenuIcon.md)
61
+ - [shelving/icon/RemoveIcon](icon/RemoveIcon.md)
59
62
  - [shelving/icon/RetryIcon](icon/RetryIcon.md)
60
63
  - [shelving/icon/RightIcon](icon/RightIcon.md)
61
- - [shelving/icon/SubmitIcon](icon/SubmitIcon.md)
64
+ - [shelving/icon/ShrinkIcon](icon/ShrinkIcon.md)
62
65
  - [shelving/icon/SuccessIcon](icon/SuccessIcon.md)
63
66
  - [shelving/icon/UpIcon](icon/UpIcon.md)
64
67
  - [shelving/icon/WarningIcon](icon/WarningIcon.md)
@@ -9503,7 +9506,7 @@ Icon to add an item, e.g. the add button on `<ArrayInput>` and `<DictionaryInput
9503
9506
 
9504
9507
  ## Constants
9505
9508
 
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.
9509
+ - [CloseIcon](icon/CloseIcon/CloseIcon.md): Icon to close something, e.g. the close button on <Dialog> and <SidebarLayout>.
9507
9510
 
9508
9511
 
9509
9512
  ---
@@ -9513,81 +9516,81 @@ Icon to add an item, e.g. the add button on `<ArrayInput>` and `<DictionaryInput
9513
9516
  - Kind: constant
9514
9517
  - Import: `import { CloseIcon } from "shelving/icon/CloseIcon";`
9515
9518
 
9516
- Icon to close or remove something, e.g. the close button on `<Dialog>` and the remove buttons on inputs.
9519
+ Icon to close something, e.g. the close button on `<Dialog>` and `<SidebarLayout>`.
9517
9520
  - Default is the Heroicons `XMarkIcon`.
9518
9521
  - 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
9522
 
9520
9523
 
9521
9524
  ---
9522
9525
 
9523
- # shelving/icon/ErrorIcon
9526
+ # shelving/icon/DownIcon
9524
9527
 
9525
9528
  - Kind: module
9526
- - Import: `import { … } from "shelving/icon/ErrorIcon";`
9529
+ - Import: `import { … } from "shelving/icon/DownIcon";`
9527
9530
 
9528
9531
  ## Constants
9529
9532
 
9530
- - [ErrorIcon](icon/ErrorIcon/ErrorIcon.md): Icon for status="error" in <Icon>.
9533
+ - [DownIcon](icon/DownIcon/DownIcon.md): Chevron that points down.
9531
9534
 
9532
9535
 
9533
9536
  ---
9534
9537
 
9535
- # ErrorIcon
9538
+ # DownIcon
9536
9539
 
9537
9540
  - Kind: constant
9538
- - Import: `import { ErrorIcon } from "shelving/icon/ErrorIcon";`
9541
+ - Import: `import { DownIcon } from "shelving/icon/DownIcon";`
9539
9542
 
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
+ Chevron that points down.
9544
+ - Default is the Heroicons `ChevronDownIcon`.
9545
+ - Swap it for your own icon with a `paths` entry for `shelving/icon/DownIcon` in your `tsconfig.json`. See `README.md` in this folder.
9543
9546
 
9544
9547
 
9545
9548
  ---
9546
9549
 
9547
- # shelving/icon/ExitFullscreenIcon
9550
+ # shelving/icon/ErrorIcon
9548
9551
 
9549
9552
  - Kind: module
9550
- - Import: `import { … } from "shelving/icon/ExitFullscreenIcon";`
9553
+ - Import: `import { … } from "shelving/icon/ErrorIcon";`
9551
9554
 
9552
9555
  ## Constants
9553
9556
 
9554
- - [ExitFullscreenIcon](icon/ExitFullscreenIcon/ExitFullscreenIcon.md): Icon to exit fullscreen, used in <FullscreenButton>.
9557
+ - [ErrorIcon](icon/ErrorIcon/ErrorIcon.md): Icon for status="error" in <Icon>.
9555
9558
 
9556
9559
 
9557
9560
  ---
9558
9561
 
9559
- # ExitFullscreenIcon
9562
+ # ErrorIcon
9560
9563
 
9561
9564
  - Kind: constant
9562
- - Import: `import { ExitFullscreenIcon } from "shelving/icon/ExitFullscreenIcon";`
9565
+ - Import: `import { ErrorIcon } from "shelving/icon/ErrorIcon";`
9563
9566
 
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
+ Icon for `status="error"` in `<Icon>`.
9568
+ - Default is the Heroicons `XCircleIcon`.
9569
+ - Swap it for your own icon with a `paths` entry for `shelving/icon/ErrorIcon` in your `tsconfig.json`. See `README.md` in this folder.
9567
9570
 
9568
9571
 
9569
9572
  ---
9570
9573
 
9571
- # shelving/icon/FullscreenIcon
9574
+ # shelving/icon/ExpandIcon
9572
9575
 
9573
9576
  - Kind: module
9574
- - Import: `import { … } from "shelving/icon/FullscreenIcon";`
9577
+ - Import: `import { … } from "shelving/icon/ExpandIcon";`
9575
9578
 
9576
9579
  ## Constants
9577
9580
 
9578
- - [FullscreenIcon](icon/FullscreenIcon/FullscreenIcon.md): Icon to enter fullscreen, used in <FullscreenButton>.
9581
+ - [ExpandIcon](icon/ExpandIcon/ExpandIcon.md): Icon to expand, e.g. to enter fullscreen, used in <FullscreenButton>.
9579
9582
 
9580
9583
 
9581
9584
  ---
9582
9585
 
9583
- # FullscreenIcon
9586
+ # ExpandIcon
9584
9587
 
9585
9588
  - Kind: constant
9586
- - Import: `import { FullscreenIcon } from "shelving/icon/FullscreenIcon";`
9589
+ - Import: `import { ExpandIcon } from "shelving/icon/ExpandIcon";`
9587
9590
 
9588
- Icon to enter fullscreen, used in `<FullscreenButton>`.
9591
+ Icon to expand, e.g. to enter fullscreen, used in `<FullscreenButton>`.
9589
9592
  - 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.
9593
+ - Swap it for your own icon with a `paths` entry for `shelving/icon/ExpandIcon` in your `tsconfig.json`. See `README.md` in this folder.
9591
9594
 
9592
9595
 
9593
9596
  ---
@@ -9614,6 +9617,55 @@ Icon for `status="info"` (the default) in `<Icon>`.
9614
9617
  - 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
9618
 
9616
9619
 
9620
+ ---
9621
+
9622
+ # shelving/icon/LeftIcon
9623
+
9624
+ - Kind: module
9625
+ - Import: `import { … } from "shelving/icon/LeftIcon";`
9626
+
9627
+ ## Constants
9628
+
9629
+ - [LeftIcon](icon/LeftIcon/LeftIcon.md): Chevron that points left.
9630
+
9631
+
9632
+ ---
9633
+
9634
+ # LeftIcon
9635
+
9636
+ - Kind: constant
9637
+ - Import: `import { LeftIcon } from "shelving/icon/LeftIcon";`
9638
+
9639
+ Chevron that points left.
9640
+ - Default is the Heroicons `ChevronLeftIcon`.
9641
+ - Swap it for your own icon with a `paths` entry for `shelving/icon/LeftIcon` in your `tsconfig.json`. See `README.md` in this folder.
9642
+
9643
+
9644
+ ---
9645
+
9646
+ # shelving/icon/LoadingIcon
9647
+
9648
+ - Kind: module
9649
+ - Import: `import { … } from "shelving/icon/LoadingIcon";`
9650
+
9651
+ ## Constants
9652
+
9653
+ - [LoadingIcon](icon/LoadingIcon/LoadingIcon.md): Animated icon that shows something is loading, e.g. <Icon status="loading"> and LOADING.
9654
+
9655
+
9656
+ ---
9657
+
9658
+ # LoadingIcon
9659
+
9660
+ - Kind: constant
9661
+ - Import: `import { LoadingIcon } from "shelving/icon/LoadingIcon";`
9662
+
9663
+ Animated icon that shows something is loading, e.g. `<Icon status="loading">` and `LOADING`.
9664
+ - Default is shelving's own `<Loading>` spinner.
9665
+ - Swap it for your own icon with a `paths` entry for `shelving/icon/LoadingIcon` in your `tsconfig.json`. See `README.md` in this folder.
9666
+ - An icon has no CSS of its own, so animate your icon inside the SVG, e.g. with SMIL `<animateTransform>`.
9667
+
9668
+
9617
9669
  ---
9618
9670
 
9619
9671
  # shelving/icon/MenuIcon
@@ -9638,6 +9690,30 @@ Icon to open a menu, e.g. the menu button on `<SidebarLayout>`.
9638
9690
  - 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
9691
 
9640
9692
 
9693
+ ---
9694
+
9695
+ # shelving/icon/RemoveIcon
9696
+
9697
+ - Kind: module
9698
+ - Import: `import { … } from "shelving/icon/RemoveIcon";`
9699
+
9700
+ ## Constants
9701
+
9702
+ - [RemoveIcon](icon/RemoveIcon/RemoveIcon.md): Icon to remove an item, e.g. the remove buttons on <ArrayInput>, <DictionaryInput> and <ImageInput>. The pair of AddIcon.
9703
+
9704
+
9705
+ ---
9706
+
9707
+ # RemoveIcon
9708
+
9709
+ - Kind: constant
9710
+ - Import: `import { RemoveIcon } from "shelving/icon/RemoveIcon";`
9711
+
9712
+ Icon to remove an item, e.g. the remove buttons on `<ArrayInput>`, `<DictionaryInput>` and `<ImageInput>`. The pair of `AddIcon`.
9713
+ - Default is the Heroicons `XMarkIcon`, the same as `CloseIcon`.
9714
+ - Swap it for your own icon with a `paths` entry for `shelving/icon/RemoveIcon` in your `tsconfig.json`. See `README.md` in this folder.
9715
+
9716
+
9641
9717
  ---
9642
9718
 
9643
9719
  # shelving/icon/RetryIcon
@@ -9688,26 +9764,26 @@ Chevron that points right, e.g. the separator in `<TreeBreadcrumbs>`.
9688
9764
 
9689
9765
  ---
9690
9766
 
9691
- # shelving/icon/SubmitIcon
9767
+ # shelving/icon/ShrinkIcon
9692
9768
 
9693
9769
  - Kind: module
9694
- - Import: `import { … } from "shelving/icon/SubmitIcon";`
9770
+ - Import: `import { … } from "shelving/icon/ShrinkIcon";`
9695
9771
 
9696
9772
  ## Constants
9697
9773
 
9698
- - [SubmitIcon](icon/SubmitIcon/SubmitIcon.md): Icon for the default <SubmitButton>.
9774
+ - [ShrinkIcon](icon/ShrinkIcon/ShrinkIcon.md): Icon to shrink, e.g. to exit fullscreen, used in <FullscreenButton>.
9699
9775
 
9700
9776
 
9701
9777
  ---
9702
9778
 
9703
- # SubmitIcon
9779
+ # ShrinkIcon
9704
9780
 
9705
9781
  - Kind: constant
9706
- - Import: `import { SubmitIcon } from "shelving/icon/SubmitIcon";`
9782
+ - Import: `import { ShrinkIcon } from "shelving/icon/ShrinkIcon";`
9707
9783
 
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.
9784
+ Icon to shrink, e.g. to exit fullscreen, used in `<FullscreenButton>`.
9785
+ - Default is the Heroicons `ArrowsPointingInIcon`.
9786
+ - Swap it for your own icon with a `paths` entry for `shelving/icon/ShrinkIcon` in your `tsconfig.json`. See `README.md` in this folder.
9711
9787
 
9712
9788
 
9713
9789
  ---
@@ -23203,7 +23279,7 @@ RetryButton({ children = _RETRY_CHILDREN, ...props }: RetryButtonProps): ReactEl
23203
23279
 
23204
23280
  Component props for `<SubmitButton>`, a form submit button.
23205
23281
 
23206
- @property children - The content of the button. Defaults to `"Save"` with a right-pointing arrow icon.
23282
+ @property children - The content of the button. Defaults to `"Save"`.
23207
23283
 
23208
23284
  @property color - The color variant of the button. Defaults to `"primary"`
23209
23285
 
@@ -23230,7 +23306,7 @@ Submit button for a form that disables itself and shows a spinner while the form
23230
23306
 
23231
23307
  ```ts
23232
23308
  SubmitButton({
23233
- children = _SUBMIT_CHILDREN,
23309
+ children = "Save",
23234
23310
  color = "primary",
23235
23311
  solid = true,
23236
23312
  full = true,
@@ -30230,7 +30306,7 @@ Props for `<Icon>` — the `status` to represent and optional icon `size`.
30230
30306
 
30231
30307
  Render the icon for a given status, coloured to match.
30232
30308
 
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"`.
30309
+ - Picks an icon per status from `shelving/icon` (`success`, `error`, `warning`, etc.), falling back to an info icon, and uses the animated `LoadingIcon` for `"loading"`.
30234
30310
 
30235
30311
  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"`.
30236
30312
 
@@ -30282,6 +30358,18 @@ Icon(props: IconProps): ReactElement
30282
30358
  | `ReactElement` | |
30283
30359
 
30284
30360
 
30361
+ ---
30362
+
30363
+ # LOADING
30364
+
30365
+ - Kind: constant
30366
+ - Import: `import { LOADING } from "shelving/ui";`
30367
+
30368
+ Shared loading spinner element with a stable `key`, ready to drop into `Suspense` fallbacks and lists.
30369
+
30370
+ - A `LoadingIcon` rendered through `<Icon>`, so it picks up icon sizing, colour, and centring.
30371
+
30372
+
30285
30373
  ---
30286
30374
 
30287
30375
  # LoaderProps
@@ -30390,8 +30478,8 @@ An animated SVG spinner shaped like a Heroicon — a faint full track plus a rot
30390
30478
 
30391
30479
  - The track and indicator paint from scaled steps of the current tint ladder (`--tint-70` / `--tint-80`), so the faint track and brighter indicator both follow whatever tint `<Icon>` (or an ancestor) sets, correctly shaded.
30392
30480
  - The spin is driven by an inline SMIL `<animateTransform>`, so it needs no CSS to animate.
30393
- - Feed it to `<Icon>` to size, colour, and centre it: `<Icon icon={Loading} size="large" status="loading" />`. `<Icon status="loading">` already uses it automatically.
30394
- - `LOADING` is a pre-keyed `<Icon icon={Loading} />` element with a stable `key` — drop it straight into `Suspense` fallbacks and lists to avoid unnecessary reconciliation overhead.
30481
+ - Feed it to `<Icon>` to size, colour, and centre it: `<Icon icon={Loading} size="large" status="loading" />`. `<Icon status="loading">` and `LOADING` use `LoadingIcon`, which is this spinner by default. An app can swap it (see `shelving/icon`).
30482
+ - `LOADING` is a pre-keyed `<Icon icon={LoadingIcon} />` element with a stable `key` — drop it straight into `Suspense` fallbacks and lists to avoid unnecessary reconciliation overhead.
30395
30483
 
30396
30484
  ## Usage
30397
30485
 
@@ -30446,18 +30534,6 @@ Loading({ className }: ClassProps): ReactElement
30446
30534
  | `ReactElement` | |
30447
30535
 
30448
30536
 
30449
- ---
30450
-
30451
- # LOADING
30452
-
30453
- - Kind: constant
30454
- - Import: `import { LOADING } from "shelving/ui";`
30455
-
30456
- Shared loading spinner element with a stable `key`, ready to drop into `Suspense` fallbacks and lists.
30457
-
30458
- - A `<Loading>` rendered through `<Icon>`, so it picks up icon sizing, colour, and centring.
30459
-
30460
-
30461
30537
  ---
30462
30538
 
30463
30539
  # Mapping
package/docs/llms.txt CHANGED
@@ -27,14 +27,17 @@ Every page of the docs site is also Markdown: add `.md` to the page path (`https
27
27
  - [shelving/firebase](firebase.md): FirestoreProvider — a Cloud Firestore DBProvider that talks directly to the Firestore REST API using fetch.
28
28
  - [shelving/icon/AddIcon](icon/AddIcon.md)
29
29
  - [shelving/icon/CloseIcon](icon/CloseIcon.md)
30
+ - [shelving/icon/DownIcon](icon/DownIcon.md)
30
31
  - [shelving/icon/ErrorIcon](icon/ErrorIcon.md)
31
- - [shelving/icon/ExitFullscreenIcon](icon/ExitFullscreenIcon.md)
32
- - [shelving/icon/FullscreenIcon](icon/FullscreenIcon.md)
32
+ - [shelving/icon/ExpandIcon](icon/ExpandIcon.md)
33
33
  - [shelving/icon/InfoIcon](icon/InfoIcon.md)
34
+ - [shelving/icon/LeftIcon](icon/LeftIcon.md)
35
+ - [shelving/icon/LoadingIcon](icon/LoadingIcon.md)
34
36
  - [shelving/icon/MenuIcon](icon/MenuIcon.md)
37
+ - [shelving/icon/RemoveIcon](icon/RemoveIcon.md)
35
38
  - [shelving/icon/RetryIcon](icon/RetryIcon.md)
36
39
  - [shelving/icon/RightIcon](icon/RightIcon.md)
37
- - [shelving/icon/SubmitIcon](icon/SubmitIcon.md)
40
+ - [shelving/icon/ShrinkIcon](icon/ShrinkIcon.md)
38
41
  - [shelving/icon/SuccessIcon](icon/SuccessIcon.md)
39
42
  - [shelving/icon/UpIcon](icon/UpIcon.md)
40
43
  - [shelving/icon/WarningIcon](icon/WarningIcon.md)
package/docs/ui/Icon.md CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  Render the icon for a given status, coloured to match.
7
7
 
8
- - 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"`.
8
+ - Picks an icon per status from `shelving/icon` (`success`, `error`, `warning`, etc.), falling back to an info icon, and uses the animated `LoadingIcon` for `"loading"`.
9
9
 
10
10
  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"`.
11
11
 
@@ -5,4 +5,4 @@
5
5
 
6
6
  Shared loading spinner element with a stable `key`, ready to drop into `Suspense` fallbacks and lists.
7
7
 
8
- - A `<Loading>` rendered through `<Icon>`, so it picks up icon sizing, colour, and centring.
8
+ - A `LoadingIcon` rendered through `<Icon>`, so it picks up icon sizing, colour, and centring.
@@ -15,8 +15,8 @@ An animated SVG spinner shaped like a Heroicon — a faint full track plus a rot
15
15
 
16
16
  - The track and indicator paint from scaled steps of the current tint ladder (`--tint-70` / `--tint-80`), so the faint track and brighter indicator both follow whatever tint `<Icon>` (or an ancestor) sets, correctly shaded.
17
17
  - The spin is driven by an inline SMIL `<animateTransform>`, so it needs no CSS to animate.
18
- - Feed it to `<Icon>` to size, colour, and centre it: `<Icon icon={Loading} size="large" status="loading" />`. `<Icon status="loading">` already uses it automatically.
19
- - `LOADING` is a pre-keyed `<Icon icon={Loading} />` element with a stable `key` — drop it straight into `Suspense` fallbacks and lists to avoid unnecessary reconciliation overhead.
18
+ - Feed it to `<Icon>` to size, colour, and centre it: `<Icon icon={Loading} size="large" status="loading" />`. `<Icon status="loading">` and `LOADING` use `LoadingIcon`, which is this spinner by default. An app can swap it (see `shelving/icon`).
19
+ - `LOADING` is a pre-keyed `<Icon icon={LoadingIcon} />` element with a stable `key` — drop it straight into `Suspense` fallbacks and lists to avoid unnecessary reconciliation overhead.
20
20
 
21
21
  ## Usage
22
22
 
@@ -10,7 +10,7 @@ Submit button for a form that disables itself and shows a spinner while the form
10
10
 
11
11
  ```ts
12
12
  SubmitButton({
13
- children = _SUBMIT_CHILDREN,
13
+ children = "Save",
14
14
  color = "primary",
15
15
  solid = true,
16
16
  full = true,
@@ -6,7 +6,7 @@
6
6
 
7
7
  Component props for `<SubmitButton>`, a form submit button.
8
8
 
9
- @property children - The content of the button. Defaults to `"Save"` with a right-pointing arrow icon.
9
+ @property children - The content of the button. Defaults to `"Save"`.
10
10
 
11
11
  @property color - The color variant of the button. Defaults to `"primary"`
12
12
 
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Icon to close or remove something, e.g. the close button on `<Dialog>` and the remove buttons on inputs.
2
+ * Icon to close something, e.g. the close button on `<Dialog>` and `<SidebarLayout>`.
3
3
  * - Default is the Heroicons `XMarkIcon`.
4
4
  * - Swap it for your own icon with a `paths` entry for `shelving/icon/CloseIcon` in your `tsconfig.json`. See `README.md` in this folder.
5
5
  */
package/icon/CloseIcon.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import { XMarkIcon } from "@heroicons/react/24/solid";
2
2
  /**
3
- * Icon to close or remove something, e.g. the close button on `<Dialog>` and the remove buttons on inputs.
3
+ * Icon to close something, e.g. the close button on `<Dialog>` and `<SidebarLayout>`.
4
4
  * - Default is the Heroicons `XMarkIcon`.
5
5
  * - Swap it for your own icon with a `paths` entry for `shelving/icon/CloseIcon` in your `tsconfig.json`. See `README.md` in this folder.
6
6
  */
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Chevron that points down.
3
+ * - Default is the Heroicons `ChevronDownIcon`.
4
+ * - Swap it for your own icon with a `paths` entry for `shelving/icon/DownIcon` in your `tsconfig.json`. See `README.md` in this folder.
5
+ */
6
+ export declare const DownIcon: import("react").ForwardRefExoticComponent<Omit<import("react").SVGProps<SVGSVGElement>, "ref"> & {
7
+ title?: string;
8
+ titleId?: string;
9
+ } & import("react").RefAttributes<SVGSVGElement>>;
@@ -0,0 +1,7 @@
1
+ import { ChevronDownIcon } from "@heroicons/react/24/solid";
2
+ /**
3
+ * Chevron that points down.
4
+ * - Default is the Heroicons `ChevronDownIcon`.
5
+ * - Swap it for your own icon with a `paths` entry for `shelving/icon/DownIcon` in your `tsconfig.json`. See `README.md` in this folder.
6
+ */
7
+ export const DownIcon = ChevronDownIcon;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Icon to expand, e.g. to enter fullscreen, used in `<FullscreenButton>`.
3
+ * - Default is the Heroicons `ArrowsPointingOutIcon`.
4
+ * - Swap it for your own icon with a `paths` entry for `shelving/icon/ExpandIcon` in your `tsconfig.json`. See `README.md` in this folder.
5
+ */
6
+ export declare const ExpandIcon: import("react").ForwardRefExoticComponent<Omit<import("react").SVGProps<SVGSVGElement>, "ref"> & {
7
+ title?: string;
8
+ titleId?: string;
9
+ } & import("react").RefAttributes<SVGSVGElement>>;
@@ -0,0 +1,7 @@
1
+ import { ArrowsPointingOutIcon } from "@heroicons/react/24/solid";
2
+ /**
3
+ * Icon to expand, e.g. to enter fullscreen, used in `<FullscreenButton>`.
4
+ * - Default is the Heroicons `ArrowsPointingOutIcon`.
5
+ * - Swap it for your own icon with a `paths` entry for `shelving/icon/ExpandIcon` in your `tsconfig.json`. See `README.md` in this folder.
6
+ */
7
+ export const ExpandIcon = ArrowsPointingOutIcon;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Chevron that points left.
3
+ * - Default is the Heroicons `ChevronLeftIcon`.
4
+ * - Swap it for your own icon with a `paths` entry for `shelving/icon/LeftIcon` in your `tsconfig.json`. See `README.md` in this folder.
5
+ */
6
+ export declare const LeftIcon: import("react").ForwardRefExoticComponent<Omit<import("react").SVGProps<SVGSVGElement>, "ref"> & {
7
+ title?: string;
8
+ titleId?: string;
9
+ } & import("react").RefAttributes<SVGSVGElement>>;
@@ -0,0 +1,7 @@
1
+ import { ChevronLeftIcon } from "@heroicons/react/24/solid";
2
+ /**
3
+ * Chevron that points left.
4
+ * - Default is the Heroicons `ChevronLeftIcon`.
5
+ * - Swap it for your own icon with a `paths` entry for `shelving/icon/LeftIcon` in your `tsconfig.json`. See `README.md` in this folder.
6
+ */
7
+ export const LeftIcon = ChevronLeftIcon;