tinybase 8.2.0-beta.1 → 8.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.
Files changed (32) hide show
  1. package/@types/ui-react-dom/index.d.ts +40 -10
  2. package/@types/ui-react-dom/with-schemas/index.d.ts +40 -10
  3. package/@types/ui-react-inspector/index.d.ts +4 -1
  4. package/@types/ui-react-inspector/with-schemas/index.d.ts +4 -1
  5. package/@types/ui-svelte-dom/index.d.ts +40 -10
  6. package/@types/ui-svelte-dom/with-schemas/index.d.ts +40 -10
  7. package/@types/ui-svelte-inspector/index.d.ts +4 -1
  8. package/@types/ui-svelte-inspector/with-schemas/index.d.ts +4 -1
  9. package/agents.md +7 -3
  10. package/min/ui-svelte-dom/index.js +1 -1
  11. package/min/ui-svelte-dom/index.js.gz +0 -0
  12. package/min/ui-svelte-dom/with-schemas/index.js +1 -1
  13. package/min/ui-svelte-dom/with-schemas/index.js.gz +0 -0
  14. package/min/ui-svelte-inspector/index.js +1 -1
  15. package/min/ui-svelte-inspector/index.js.gz +0 -0
  16. package/min/ui-svelte-inspector/with-schemas/index.js +1 -1
  17. package/min/ui-svelte-inspector/with-schemas/index.js.gz +0 -0
  18. package/package.json +12 -12
  19. package/readme.md +14 -14
  20. package/releases.md +102 -67
  21. package/ui-react/index.js +7 -4
  22. package/ui-react/with-schemas/index.js +7 -4
  23. package/ui-react-dom/index.js +7 -4
  24. package/ui-react-dom/with-schemas/index.js +7 -4
  25. package/ui-react-inspector/index.js +7 -4
  26. package/ui-react-inspector/with-schemas/index.js +7 -4
  27. package/ui-svelte/index.js +1 -1
  28. package/ui-svelte/with-schemas/index.js +1 -1
  29. package/ui-svelte-dom/index.js +22 -24
  30. package/ui-svelte-dom/with-schemas/index.js +22 -24
  31. package/ui-svelte-inspector/index.js +22 -24
  32. package/ui-svelte-inspector/with-schemas/index.js +22 -24
@@ -690,7 +690,10 @@ export type SortedTablePaginatorProps = {
690
690
  * Store as an HTML <table> element, and registers a listener so that any
691
691
  * changes to that result will cause a re-render.
692
692
  *
693
- * See the <TableInHtmlTable /> (React) demo for this component in action.
693
+ * See the <TableInHtmlTable /> (React) demo for this component in action:
694
+ *
695
+ * ![TableInHtmlTable example](https://tinybase.org/shots/tableinhtmltable-react-demo.png
696
+ * "TableInHtmlTable example")
694
697
  *
695
698
  * The component's props identify which Table to render based on Table Id, and
696
699
  * Store (which is either the default context Store, a named context Store, or
@@ -833,7 +836,10 @@ export function TableInHtmlTable(
833
836
  * that any changes to that result will cause a re-render.
834
837
  *
835
838
  * See the <SortedTableInHtmlTable /> (React) demo for this component in
836
- * action.
839
+ * action:
840
+ *
841
+ * ![SortedTableInHtmlTable example](https://tinybase.org/shots/sortedtableinhtmltable-react-demo.png
842
+ * "SortedTableInHtmlTable example")
837
843
  *
838
844
  * The component's props identify which Table to render based on Table Id, and
839
845
  * Store (which is either the default context Store, a named context Store, or
@@ -1003,7 +1009,10 @@ export function SortedTableInHtmlTable(
1003
1009
  * as an HTML <table> element, and registers a listener so that any changes to
1004
1010
  * that result will cause a re-render.
1005
1011
  *
1006
- * See the <ValuesInHtmlTable /> (React) demo for this component in action.
1012
+ * See the <ValuesInHtmlTable /> (React) demo for this component in action:
1013
+ *
1014
+ * ![ValuesInHtmlTable example](https://tinybase.org/shots/valuesinhtmltable-react-demo.png
1015
+ * "ValuesInHtmlTable example")
1007
1016
  *
1008
1017
  * The component's props identify which Row to render based on Table Id, Row Id,
1009
1018
  * and Store (which is either the default context Store, a named context Store,
@@ -1131,7 +1140,10 @@ export function ValuesInHtmlTable(
1131
1140
  * <table> element, and registers a listener so that any changes to that result
1132
1141
  * will cause a re-render.
1133
1142
  *
1134
- * See the <SliceInHtmlTable /> (React) demo for this component in action.
1143
+ * See the <SliceInHtmlTable /> (React) demo for this component in action:
1144
+ *
1145
+ * ![SliceInHtmlTable example](https://tinybase.org/shots/sliceinhtmltable-react-demo.png
1146
+ * "SliceInHtmlTable example")
1135
1147
  *
1136
1148
  * The component's props identify which Slice to render based on Index Id, Slice
1137
1149
  * Id, and Indexes object (which is either the default context Indexes object, a
@@ -1286,7 +1298,10 @@ export function SliceInHtmlTable(
1286
1298
  * so that any changes to that result will cause a re-render.
1287
1299
  *
1288
1300
  * See the <RelationshipInHtmlTable /> (React) demo for this component in
1289
- * action.
1301
+ * action:
1302
+ *
1303
+ * ![RelationshipInHtmlTable example](https://tinybase.org/shots/relationshipinhtmltable-react-demo.png
1304
+ * "RelationshipInHtmlTable example")
1290
1305
  *
1291
1306
  * The component's props identify which Relationship to render based on
1292
1307
  * Relationship Id and Relationships object (which is either the default context
@@ -1461,7 +1476,10 @@ export function RelationshipInHtmlTable(
1461
1476
  * listener so that any changes to that result will cause a re-render.
1462
1477
  *
1463
1478
  * See the <ResultTableInHtmlTable /> (React) demo for this component in
1464
- * action.
1479
+ * action:
1480
+ *
1481
+ * ![ResultTableInHtmlTable example](https://tinybase.org/shots/resulttableinhtmltable-react-demo.png
1482
+ * "ResultTableInHtmlTable example")
1465
1483
  *
1466
1484
  * The component's props identify which ResultTable to render based on query Id,
1467
1485
  * and Queries object (which is either the default context Queries object, a
@@ -1611,7 +1629,10 @@ export function ResultTableInHtmlTable(
1611
1629
  * re-render.
1612
1630
  *
1613
1631
  * See the <ResultSortedTableInHtmlTable /> (React) demo for this component in
1614
- * action.
1632
+ * action:
1633
+ *
1634
+ * ![ResultSortedTableInHtmlTable example](https://tinybase.org/shots/resultsortedtableinhtmltable-react-demo.png
1635
+ * "ResultSortedTableInHtmlTable example")
1615
1636
  *
1616
1637
  * The component's props identify which ResultTable to render based on query Id,
1617
1638
  * and Queries object (which is either the default context Queries object, a
@@ -1782,7 +1803,10 @@ export function ResultSortedTableInHtmlTable(
1782
1803
  * that can be edited in a web browser, and registers a listener so that any
1783
1804
  * changes to that result will cause a re-render.
1784
1805
  *
1785
- * See the <EditableCellView /> (React) demo for this component in action.
1806
+ * See the <EditableCellView /> (React) demo for this component in action:
1807
+ *
1808
+ * ![EditableCellView example](https://tinybase.org/shots/editablecellview-react-demo.png
1809
+ * "EditableCellView example")
1786
1810
  *
1787
1811
  * The component's props identify which Cell to render based on Table Id, Row
1788
1812
  * Id, Cell Id, and Store (which is either the default context Store, a named
@@ -1850,7 +1874,10 @@ export function EditableCellView(
1850
1874
  * that can be edited in a web browser, and registers a listener so that any
1851
1875
  * changes to that result will cause a re-render.
1852
1876
  *
1853
- * See the <EditableValueView /> (React) demo for this component in action.
1877
+ * See the <EditableValueView /> (React) demo for this component in action:
1878
+ *
1879
+ * ![EditableValueView example](https://tinybase.org/shots/editablevalueview-react-demo.png
1880
+ * "EditableValueView example")
1854
1881
  *
1855
1882
  * The component's props identify which Value to render based on Table Id, Row
1856
1883
  * Id, Value Id, and Store (which is either the default context Store, a named
@@ -1918,7 +1945,10 @@ export function EditableValueView(
1918
1945
  * The SortedTablePaginator component renders a paginator for a sorted table.
1919
1946
  *
1920
1947
  * See the <SortedTableInHtmlTable /> (React) demo for this component in
1921
- * action.
1948
+ * action:
1949
+ *
1950
+ * ![SortedTablePaginator example](https://tinybase.org/shots/sortedtablepaginator-react-demo.png
1951
+ * "SortedTablePaginator example")
1922
1952
  *
1923
1953
  * The component displays 'previous' and 'next' buttons for paging through the
1924
1954
  * Table if there are more Row Ids than fit in each page. The component will
@@ -672,7 +672,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
672
672
  * ): ComponentReturnType;
673
673
  * ```
674
674
  *
675
- * See the <TableInHtmlTable /> (React) demo for this component in action.
675
+ * See the <TableInHtmlTable /> (React) demo for this component in action:
676
+ *
677
+ * ![TableInHtmlTable example](https://tinybase.org/shots/tableinhtmltable-react-demo.png
678
+ * "TableInHtmlTable example")
676
679
  *
677
680
  * The component's props identify which Table to render based on Table Id, and
678
681
  * Store (which is either the default context Store, a named context Store, or
@@ -823,7 +826,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
823
826
  * ```
824
827
  *
825
828
  * See the <SortedTableInHtmlTable /> (React) demo for this component in
826
- * action.
829
+ * action:
830
+ *
831
+ * ![SortedTableInHtmlTable example](https://tinybase.org/shots/sortedtableinhtmltable-react-demo.png
832
+ * "SortedTableInHtmlTable example")
827
833
  *
828
834
  * The component's props identify which Table to render based on Table Id, and
829
835
  * Store (which is either the default context Store, a named context Store, or
@@ -1001,7 +1007,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1001
1007
  * ): ComponentReturnType;
1002
1008
  * ```
1003
1009
  *
1004
- * See the <ValuesInHtmlTable /> (React) demo for this component in action.
1010
+ * See the <ValuesInHtmlTable /> (React) demo for this component in action:
1011
+ *
1012
+ * ![ValuesInHtmlTable example](https://tinybase.org/shots/valuesinhtmltable-react-demo.png
1013
+ * "ValuesInHtmlTable example")
1005
1014
  *
1006
1015
  * The component's props identify which Row to render based on Table Id, Row Id,
1007
1016
  * and Store (which is either the default context Store, a named context Store,
@@ -1137,7 +1146,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1137
1146
  * ): ComponentReturnType;
1138
1147
  * ```
1139
1148
  *
1140
- * See the <SliceInHtmlTable /> (React) demo for this component in action.
1149
+ * See the <SliceInHtmlTable /> (React) demo for this component in action:
1150
+ *
1151
+ * ![SliceInHtmlTable example](https://tinybase.org/shots/sliceinhtmltable-react-demo.png
1152
+ * "SliceInHtmlTable example")
1141
1153
  *
1142
1154
  * The component's props identify which Slice to render based on Index Id, Slice
1143
1155
  * Id, and Indexes object (which is either the default context Indexes object, a
@@ -1300,7 +1312,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1300
1312
  * ```
1301
1313
  *
1302
1314
  * See the <RelationshipInHtmlTable /> (React) demo for this component in
1303
- * action.
1315
+ * action:
1316
+ *
1317
+ * ![RelationshipInHtmlTable example](https://tinybase.org/shots/relationshipinhtmltable-react-demo.png
1318
+ * "RelationshipInHtmlTable example")
1304
1319
  *
1305
1320
  * The component's props identify which Relationship to render based on
1306
1321
  * Relationship Id and Relationships object (which is either the default context
@@ -1483,7 +1498,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1483
1498
  * ```
1484
1499
  *
1485
1500
  * See the <ResultTableInHtmlTable /> (React) demo for this component in
1486
- * action.
1501
+ * action:
1502
+ *
1503
+ * ![ResultTableInHtmlTable example](https://tinybase.org/shots/resulttableinhtmltable-react-demo.png
1504
+ * "ResultTableInHtmlTable example")
1487
1505
  *
1488
1506
  * The component's props identify which ResultTable to render based on query Id,
1489
1507
  * and Queries object (which is either the default context Queries object, a
@@ -1641,7 +1659,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1641
1659
  * ```
1642
1660
  *
1643
1661
  * See the <ResultSortedTableInHtmlTable /> (React) demo for this component in
1644
- * action.
1662
+ * action:
1663
+ *
1664
+ * ![ResultSortedTableInHtmlTable example](https://tinybase.org/shots/resultsortedtableinhtmltable-react-demo.png
1665
+ * "ResultSortedTableInHtmlTable example")
1645
1666
  *
1646
1667
  * The component's props identify which ResultTable to render based on query Id,
1647
1668
  * and Queries object (which is either the default context Queries object, a
@@ -1820,7 +1841,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1820
1841
  * ): ComponentReturnType;
1821
1842
  * ```
1822
1843
  *
1823
- * See the <EditableCellView /> (React) demo for this component in action.
1844
+ * See the <EditableCellView /> (React) demo for this component in action:
1845
+ *
1846
+ * ![EditableCellView example](https://tinybase.org/shots/editablecellview-react-demo.png
1847
+ * "EditableCellView example")
1824
1848
  *
1825
1849
  * The component's props identify which Cell to render based on Table Id, Row
1826
1850
  * Id, Cell Id, and Store (which is either the default context Store, a named
@@ -1902,7 +1926,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1902
1926
  * ): ComponentReturnType;
1903
1927
  * ```
1904
1928
  *
1905
- * See the <EditableValueView /> (React) demo for this component in action.
1929
+ * See the <EditableValueView /> (React) demo for this component in action:
1930
+ *
1931
+ * ![EditableValueView example](https://tinybase.org/shots/editablevalueview-react-demo.png
1932
+ * "EditableValueView example")
1906
1933
  *
1907
1934
  * The component's props identify which Value to render based on Table Id, Row
1908
1935
  * Id, Value Id, and Store (which is either the default context Store, a named
@@ -1970,7 +1997,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1970
1997
  * The SortedTablePaginator component renders a paginator for a sorted table.
1971
1998
  *
1972
1999
  * See the <SortedTableInHtmlTable /> (React) demo for this component in
1973
- * action.
2000
+ * action:
2001
+ *
2002
+ * ![SortedTablePaginator example](https://tinybase.org/shots/sortedtablepaginator-react-demo.png
2003
+ * "SortedTablePaginator example")
1974
2004
  *
1975
2005
  * The component displays 'previous' and 'next' buttons for paging through the
1976
2006
  * Table if there are more Row Ids than fit in each page. The component will
@@ -44,7 +44,10 @@ export type InspectorProps = {
44
44
  * The Inspector component renders a tool which allows you to view and edit the
45
45
  * content of a Store in a debug web environment.
46
46
  *
47
- * See the <Inspector /> (React) demo for this component in action.
47
+ * See the <Inspector /> (React) demo for this component in action:
48
+ *
49
+ * ![Inspector example](https://tinybase.org/shots/inspector-react-demo.png
50
+ * "Inspector example")
48
51
  *
49
52
  * The component displays a nub in the corner of the screen which you may then
50
53
  * click to interact with all the Store objects in the Provider component
@@ -44,7 +44,10 @@ export type InspectorProps = {
44
44
  * The Inspector component renders a tool which allows you to view and edit the
45
45
  * content of a Store in a debug web environment.
46
46
  *
47
- * See the <Inspector /> (React) demo for this component in action.
47
+ * See the <Inspector /> (React) demo for this component in action:
48
+ *
49
+ * ![Inspector example](https://tinybase.org/shots/inspector-react-demo.png
50
+ * "Inspector example")
48
51
  *
49
52
  * The component displays a nub in the corner of the screen which you may then
50
53
  * click to interact with all the Store objects in the Provider component
@@ -688,7 +688,10 @@ export type SortedTablePaginatorProps = {
688
688
  * Store as an HTML <table> element, and registers a listener so that any
689
689
  * changes to that result will cause a re-render.
690
690
  *
691
- * See the <TableInHtmlTable /> (Svelte) demo for this component in action.
691
+ * See the <TableInHtmlTable /> (Svelte) demo for this component in action:
692
+ *
693
+ * ![TableInHtmlTable example](https://tinybase.org/shots/tableinhtmltable-svelte-demo.png
694
+ * "TableInHtmlTable example")
692
695
  *
693
696
  * The component's props identify which Table to render based on Table Id, and
694
697
  * Store (which is either the default context Store, a named context Store, or
@@ -849,7 +852,10 @@ export const TableInHtmlTable: Component<
849
852
  * that any changes to that result will cause a re-render.
850
853
  *
851
854
  * See the <SortedTableInHtmlTable /> (Svelte) demo for this component in
852
- * action.
855
+ * action:
856
+ *
857
+ * ![SortedTableInHtmlTable example](https://tinybase.org/shots/sortedtableinhtmltable-svelte-demo.png
858
+ * "SortedTableInHtmlTable example")
853
859
  *
854
860
  * The component's props identify which Table to render based on Table Id, and
855
861
  * Store (which is either the default context Store, a named context Store, or
@@ -1034,7 +1040,10 @@ export const SortedTableInHtmlTable: Component<
1034
1040
  * as an HTML <table> element, and registers a listener so that any changes to
1035
1041
  * that result will cause a re-render.
1036
1042
  *
1037
- * See the <ValuesInHtmlTable /> (Svelte) demo for this component in action.
1043
+ * See the <ValuesInHtmlTable /> (Svelte) demo for this component in action:
1044
+ *
1045
+ * ![ValuesInHtmlTable example](https://tinybase.org/shots/valuesinhtmltable-svelte-demo.png
1046
+ * "ValuesInHtmlTable example")
1038
1047
  *
1039
1048
  * The component's props identify which Row to render based on Table Id, Row Id,
1040
1049
  * and Store (which is either the default context Store, a named context Store,
@@ -1174,7 +1183,10 @@ export const ValuesInHtmlTable: Component<
1174
1183
  * <table> element, and registers a listener so that any changes to that result
1175
1184
  * will cause a re-render.
1176
1185
  *
1177
- * See the <SliceInHtmlTable /> (Svelte) demo for this component in action.
1186
+ * See the <SliceInHtmlTable /> (Svelte) demo for this component in action:
1187
+ *
1188
+ * ![SliceInHtmlTable example](https://tinybase.org/shots/sliceinhtmltable-svelte-demo.png
1189
+ * "SliceInHtmlTable example")
1178
1190
  *
1179
1191
  * The component's props identify which Slice to render based on Index Id, Slice
1180
1192
  * Id, and Indexes object (which is either the default context Indexes object, a
@@ -1343,7 +1355,10 @@ export const SliceInHtmlTable: Component<
1343
1355
  * so that any changes to that result will cause a re-render.
1344
1356
  *
1345
1357
  * See the <RelationshipInHtmlTable /> (Svelte) demo for this component in
1346
- * action.
1358
+ * action:
1359
+ *
1360
+ * ![RelationshipInHtmlTable example](https://tinybase.org/shots/relationshipinhtmltable-svelte-demo.png
1361
+ * "RelationshipInHtmlTable example")
1347
1362
  *
1348
1363
  * The component's props identify which Relationship to render based on
1349
1364
  * Relationship Id and Relationships object (which is either the default context
@@ -1527,7 +1542,10 @@ export const RelationshipInHtmlTable: Component<
1527
1542
  * listener so that any changes to that result will cause a re-render.
1528
1543
  *
1529
1544
  * See the <ResultTableInHtmlTable /> (Svelte) demo for this component in
1530
- * action.
1545
+ * action:
1546
+ *
1547
+ * ![ResultTableInHtmlTable example](https://tinybase.org/shots/resulttableinhtmltable-svelte-demo.png
1548
+ * "ResultTableInHtmlTable example")
1531
1549
  *
1532
1550
  * The component's props identify which ResultTable to render based on query Id,
1533
1551
  * and Queries object (which is either the default context Queries object, a
@@ -1693,7 +1711,10 @@ export const ResultTableInHtmlTable: Component<
1693
1711
  * re-render.
1694
1712
  *
1695
1713
  * See the <ResultSortedTableInHtmlTable /> (Svelte) demo for this component in
1696
- * action.
1714
+ * action:
1715
+ *
1716
+ * ![ResultSortedTableInHtmlTable example](https://tinybase.org/shots/resultsortedtableinhtmltable-svelte-demo.png
1717
+ * "ResultSortedTableInHtmlTable example")
1697
1718
  *
1698
1719
  * The component's props identify which ResultTable to render based on query Id,
1699
1720
  * and Queries object (which is either the default context Queries object, a
@@ -1879,7 +1900,10 @@ export const ResultSortedTableInHtmlTable: Component<
1879
1900
  * that can be edited in a web browser, and registers a listener so that any
1880
1901
  * changes to that result will cause a re-render.
1881
1902
  *
1882
- * See the <EditableCellView /> (Svelte) demo for this component in action.
1903
+ * See the <EditableCellView /> (Svelte) demo for this component in action:
1904
+ *
1905
+ * ![EditableCellView example](https://tinybase.org/shots/editablecellview-svelte-demo.png
1906
+ * "EditableCellView example")
1883
1907
  *
1884
1908
  * The component's props identify which Cell to render based on Table Id, Row
1885
1909
  * Id, Cell Id, and Store (which is either the default context Store, a named
@@ -1949,7 +1973,10 @@ export const EditableCellView: Component<
1949
1973
  * that can be edited in a web browser, and registers a listener so that any
1950
1974
  * changes to that result will cause a re-render.
1951
1975
  *
1952
- * See the <EditableValueView /> (Svelte) demo for this component in action.
1976
+ * See the <EditableValueView /> (Svelte) demo for this component in action:
1977
+ *
1978
+ * ![EditableValueView example](https://tinybase.org/shots/editablevalueview-svelte-demo.png
1979
+ * "EditableValueView example")
1953
1980
  *
1954
1981
  * The component's props identify which Value to render based on Table Id, Row
1955
1982
  * Id, Value Id, and Store (which is either the default context Store, a named
@@ -2021,7 +2048,10 @@ export const EditableValueView: Component<
2021
2048
  * The SortedTablePaginator component renders a paginator for a sorted table.
2022
2049
  *
2023
2050
  * See the <SortedTableInHtmlTable /> (Svelte) demo for this component in
2024
- * action.
2051
+ * action:
2052
+ *
2053
+ * ![SortedTablePaginator example](https://tinybase.org/shots/sortedtablepaginator-svelte-demo.png
2054
+ * "SortedTablePaginator example")
2025
2055
  *
2026
2056
  * The component displays 'previous' and 'next' buttons for paging through the
2027
2057
  * Table if there are more Row Ids than fit in each page. The component will
@@ -668,7 +668,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
668
668
  * >;
669
669
  * ```
670
670
  *
671
- * See the <TableInHtmlTable /> (Svelte) demo for this component in action.
671
+ * See the <TableInHtmlTable /> (Svelte) demo for this component in action:
672
+ *
673
+ * ![TableInHtmlTable example](https://tinybase.org/shots/tableinhtmltable-svelte-demo.png
674
+ * "TableInHtmlTable example")
672
675
  *
673
676
  * The component's props identify which Table to render based on Table Id, and
674
677
  * Store (which is either the default context Store, a named context Store, or
@@ -835,7 +838,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
835
838
  * ```
836
839
  *
837
840
  * See the <SortedTableInHtmlTable /> (Svelte) demo for this component in
838
- * action.
841
+ * action:
842
+ *
843
+ * ![SortedTableInHtmlTable example](https://tinybase.org/shots/sortedtableinhtmltable-svelte-demo.png
844
+ * "SortedTableInHtmlTable example")
839
845
  *
840
846
  * The component's props identify which Table to render based on Table Id, and
841
847
  * Store (which is either the default context Store, a named context Store, or
@@ -1028,7 +1034,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1028
1034
  * >;
1029
1035
  * ```
1030
1036
  *
1031
- * See the <ValuesInHtmlTable /> (Svelte) demo for this component in action.
1037
+ * See the <ValuesInHtmlTable /> (Svelte) demo for this component in action:
1038
+ *
1039
+ * ![ValuesInHtmlTable example](https://tinybase.org/shots/valuesinhtmltable-svelte-demo.png
1040
+ * "ValuesInHtmlTable example")
1032
1041
  *
1033
1042
  * The component's props identify which Row to render based on Table Id, Row Id,
1034
1043
  * and Store (which is either the default context Store, a named context Store,
@@ -1176,7 +1185,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1176
1185
  * >;
1177
1186
  * ```
1178
1187
  *
1179
- * See the <SliceInHtmlTable /> (Svelte) demo for this component in action.
1188
+ * See the <SliceInHtmlTable /> (Svelte) demo for this component in action:
1189
+ *
1190
+ * ![SliceInHtmlTable example](https://tinybase.org/shots/sliceinhtmltable-svelte-demo.png
1191
+ * "SliceInHtmlTable example")
1180
1192
  *
1181
1193
  * The component's props identify which Slice to render based on Index Id, Slice
1182
1194
  * Id, and Indexes object (which is either the default context Indexes object, a
@@ -1351,7 +1363,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1351
1363
  * ```
1352
1364
  *
1353
1365
  * See the <RelationshipInHtmlTable /> (Svelte) demo for this component in
1354
- * action.
1366
+ * action:
1367
+ *
1368
+ * ![RelationshipInHtmlTable example](https://tinybase.org/shots/relationshipinhtmltable-svelte-demo.png
1369
+ * "RelationshipInHtmlTable example")
1355
1370
  *
1356
1371
  * The component's props identify which Relationship to render based on
1357
1372
  * Relationship Id and Relationships object (which is either the default context
@@ -1543,7 +1558,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1543
1558
  * ```
1544
1559
  *
1545
1560
  * See the <ResultTableInHtmlTable /> (Svelte) demo for this component in
1546
- * action.
1561
+ * action:
1562
+ *
1563
+ * ![ResultTableInHtmlTable example](https://tinybase.org/shots/resulttableinhtmltable-svelte-demo.png
1564
+ * "ResultTableInHtmlTable example")
1547
1565
  *
1548
1566
  * The component's props identify which ResultTable to render based on query Id,
1549
1567
  * and Queries object (which is either the default context Queries object, a
@@ -1717,7 +1735,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1717
1735
  * ```
1718
1736
  *
1719
1737
  * See the <ResultSortedTableInHtmlTable /> (Svelte) demo for this component in
1720
- * action.
1738
+ * action:
1739
+ *
1740
+ * ![ResultSortedTableInHtmlTable example](https://tinybase.org/shots/resultsortedtableinhtmltable-svelte-demo.png
1741
+ * "ResultSortedTableInHtmlTable example")
1721
1742
  *
1722
1743
  * The component's props identify which ResultTable to render based on query Id,
1723
1744
  * and Queries object (which is either the default context Queries object, a
@@ -1911,7 +1932,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1911
1932
  * >;
1912
1933
  * ```
1913
1934
  *
1914
- * See the <EditableCellView /> (Svelte) demo for this component in action.
1935
+ * See the <EditableCellView /> (Svelte) demo for this component in action:
1936
+ *
1937
+ * ![EditableCellView example](https://tinybase.org/shots/editablecellview-svelte-demo.png
1938
+ * "EditableCellView example")
1915
1939
  *
1916
1940
  * The component's props identify which Cell to render based on Table Id, Row
1917
1941
  * Id, Cell Id, and Store (which is either the default context Store, a named
@@ -1995,7 +2019,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
1995
2019
  * >;
1996
2020
  * ```
1997
2021
  *
1998
- * See the <EditableValueView /> (Svelte) demo for this component in action.
2022
+ * See the <EditableValueView /> (Svelte) demo for this component in action:
2023
+ *
2024
+ * ![EditableValueView example](https://tinybase.org/shots/editablevalueview-svelte-demo.png
2025
+ * "EditableValueView example")
1999
2026
  *
2000
2027
  * The component's props identify which Value to render based on Table Id, Row
2001
2028
  * Id, Value Id, and Store (which is either the default context Store, a named
@@ -2067,7 +2094,10 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
2067
2094
  * The SortedTablePaginator component renders a paginator for a sorted table.
2068
2095
  *
2069
2096
  * See the <SortedTableInHtmlTable /> (Svelte) demo for this component in
2070
- * action.
2097
+ * action:
2098
+ *
2099
+ * ![SortedTablePaginator example](https://tinybase.org/shots/sortedtablepaginator-svelte-demo.png
2100
+ * "SortedTablePaginator example")
2071
2101
  *
2072
2102
  * The component displays 'previous' and 'next' buttons for paging through the
2073
2103
  * Table if there are more Row Ids than fit in each page. The component will
@@ -44,7 +44,10 @@ export type InspectorProps = {
44
44
  * The Inspector component renders a tool which allows you to view and edit the
45
45
  * content of a Store in a debug web environment.
46
46
  *
47
- * See the <Inspector /> (Svelte) demo for this component in action.
47
+ * See the <Inspector /> (Svelte) demo for this component in action:
48
+ *
49
+ * ![Inspector example](https://tinybase.org/shots/inspector-svelte-demo.png
50
+ * "Inspector example")
48
51
  *
49
52
  * The component displays a nub in the corner of the screen which you may then
50
53
  * click to interact with all the Store objects in the Provider component
@@ -44,7 +44,10 @@ export type InspectorProps = {
44
44
  * The Inspector component renders a tool which allows you to view and edit the
45
45
  * content of a Store in a debug web environment.
46
46
  *
47
- * See the <Inspector /> (Svelte) demo for this component in action.
47
+ * See the <Inspector /> (Svelte) demo for this component in action:
48
+ *
49
+ * ![Inspector example](https://tinybase.org/shots/inspector-svelte-demo.png
50
+ * "Inspector example")
48
51
  *
49
52
  * The component displays a nub in the corner of the screen which you may then
50
53
  * click to interact with all the Store objects in the Provider component
package/agents.md CHANGED
@@ -309,9 +309,13 @@ from source code and markdown files.
309
309
  source files for guides on the website.
310
310
 
311
311
  4. **Generated Files**: `/releases.md` and `/readme.md` in the root are
312
- **GENERATED** from `/site/guides/17_releases.md` and `/site/home/index.md`.
312
+ **GENERATED** from `/site/guides/18_releases.md` and `/site/home/index.md`.
313
313
  **Never edit the generated files directly**.
314
314
 
315
+ 5. **Guide Redirects**: To preserve old guide URLs, leave a markdown stub at the
316
+ old path whose summary is just `-> /new-url`. The site generator hides these
317
+ from navigation and renders them as meta-refresh redirect pages.
318
+
315
319
  ### Documentation Testing
316
320
 
317
321
  TinyBase has automated tests that validate all inline code examples in
@@ -361,7 +365,7 @@ npx vitest run ./test/unit/documentation.test.ts --retry=0
361
365
 
362
366
  1. **API Documentation**: Edit `docs.js` file next to the type definition
363
367
  2. **Guide Content**: Edit markdown files in `/site/guides/`
364
- 3. **Release Notes**: Edit `/site/guides/17_releases.md` (not `/releases.md`)
368
+ 3. **Release Notes**: Edit `/site/guides/18_releases.md` (not `/releases.md`)
365
369
  4. **Always run documentation tests** after changes to verify examples work
366
370
 
367
371
  ## Creating New Schematizers
@@ -494,7 +498,7 @@ All code examples in a guide file are concatenated and executed as a test:
494
498
 
495
499
  When adding a new feature:
496
500
 
497
- 1. **Update `/site/guides/17_releases.md`** (NOT `/releases.md`):
501
+ 1. **Update `/site/guides/18_releases.md`** (NOT `/releases.md`):
498
502
  - Add new version section at the top
499
503
  - Include working code example that will be tested
500
504
  - Link to relevant guide if applicable