tinybase 5.0.0-beta.27 → 5.0.0-beta.28

package/@types/ui-react-dom/with-schemas/index.d.cts

@@ -46,11 +46,15 @@ export type CustomCell<
   /**
    * An optional string that will be used as the label at the top of the table
    * column for this Cell.
+   * @category Prop
+   * @since v4.1.0
    */
   label?: string;
   /**
    * An optional custom component for rendering each Cell in the Table (to
    * override the default CellView component).
+   * @category Prop
+   * @since v4.1.0
    */
   component?: ComponentType<
     CellPropsForTableIdAndCellId<Schemas, TableId, CellId>
@@ -58,6 +62,8 @@ export type CustomCell<
   /**
    * An optional function for generating extra props for each custom Cell
    * component based on Row and Cell Id.
+   * @category Prop
+   * @since v4.1.0
    */
   getComponentProps?: (rowId: Id, cellId: CellId) => ExtraProps;
 };
@@ -72,16 +78,22 @@ export type CustomResultCell<Schemas extends OptionalSchemas> = {
   /**
    * An optional string that will be used as the label at the top of the table
    * column for this Cell.
+   * @category Prop
+   * @since v4.1.0
    */
   label?: string;
   /**
    * An optional custom component for rendering each Cell in the ResultTable (to
    * override the default ResultCellView component).
+   * @category Prop
+   * @since v4.1.0
    */
   component?: ComponentType<ResultCellProps<Schemas>>;
   /**
    * An optional function for generating extra props for each custom Cell
    * component based on Row and Cell Id.
+   * @category Prop
+   * @since v4.1.0
    */
   getComponentProps?: (rowId: Id, cellId: Id) => ExtraProps;
 };
@@ -96,16 +108,22 @@ export type CustomResultCell<Schemas extends OptionalSchemas> = {
 export type HtmlTableProps = {
   /**
    * A string className to use on the root of the resulting element.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly className?: string;
   /**
    * Whether a header row should be rendered at the top of the table, defaulting
    * to `true`.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly headerRow?: boolean;
   /**
    * Whether an Id column should be rendered on the left of the table,
    * defaulting to `true`.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly idColumn?: boolean;
 };
@@ -126,17 +144,23 @@ export type TableInHtmlTableProps<
     ? {
         /**
    * The Id of the Table in the Store to be rendered.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly tableId: TableId;
         /**
    * The Store to be accessed: omit for the default context Store, provide an Id
    * for a named context Store, or provide an explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly store?: StoreOrStoreId<Schemas>;
         /**
    * Whether the Cells should be editable. This affects the default CellView
    * component (to use the EditableCellView component instead) but of course
    * will not affect custom Cell components if you have set them.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly editable?: boolean;
         /**
@@ -145,6 +169,8 @@ export type TableInHtmlTableProps<
    * Cell Ids as keys, and with a value that can either be a string label to
    * show in the column header, or a CustomCell object to further configure the
    * column.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly customCells?:
           | CellIdFromSchema<Schemas[0], TableId>[]
@@ -173,34 +199,48 @@ export type SortedTableInHtmlTableProps<
     ? {
         /**
    * The Id of the Table in the Store to be rendered.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly tableId: TableId;
         /**
    * The Id of the Cell whose values are used for the sorting. If omitted, the
    * view will sort the Row Id itself.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly cellId?: CellIdFromSchema<Schemas[0], TableId>;
         /**
    * Whether the sorting should be in descending order.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly descending?: boolean;
         /**
    * The number of Row Ids to skip for pagination purposes.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly offset?: number;
         /**
    * The maximum number of Row Ids to return.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly limit?: number;
         /**
    * The Store to be accessed: omit for the default context Store, provide an Id
    * for a named context Store, or provide an explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly store?: StoreOrStoreId<Schemas>;
         /**
    * Whether the Cells should be editable. This affects the default CellView
    * component (to use the EditableCellView component instead) but of course
    * will not affect custom Cell components if you have set them.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly editable?: boolean;
         /**
@@ -209,6 +249,8 @@ export type SortedTableInHtmlTableProps<
    * Cell Ids as keys, and with a value that can either be a string label to
    * show in the column header, or a CustomCell object to further configure the
    * column.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly customCells?:
           | CellIdFromSchema<Schemas[0], TableId>[]
@@ -220,17 +262,23 @@ export type SortedTableInHtmlTableProps<
         /**
    * Whether the table should be interactive such that clicking a header changes
    * the sorting and/or direction.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly sortOnClick?: boolean;
         /**
    * Either `true` to show the default SortedTablePaginator for the Table, or
    * provide your own paginator component that takes SortedTablePaginatorProps.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly paginator?: boolean | ComponentType<SortedTablePaginatorProps>;
         /**
    * A function that is called whenever the sorting or pagination of the Table
    * is changed by the user, invoked with the sorted Cell Id, whether descending
    * or not, and the offset of the pagination.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly onChange?: (
           sortAndOffset: [
@@ -253,22 +301,30 @@ export type ValuesInHtmlTableProps<Schemas extends OptionalSchemas> = {
   /**
    * The Store to be accessed: omit for the default context Store, provide an Id
    * for a named context Store, or provide an explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly store?: StoreOrStoreId<Schemas>;
   /**
    * Whether the Values should be editable. This affects the default ValueView
    * component (to use the EditableValueView component instead) but of course
    * will not affect a custom valueComponent if you have set one.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly editable?: boolean;
   /**
    * A custom component for rendering each Value in the Store (to override the
    * default ValueView component).
+   * @category Prop
+   * @since v4.1.0
    */
   readonly valueComponent?: ComponentType<ValueProps<Schemas>>;
   /**
    * A function for generating extra props for each custom Value component based
    * on its Id.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly getValueComponentProps?: (valueId: Id) => ExtraProps;
 };
@@ -282,22 +338,30 @@ export type ValuesInHtmlTableProps<Schemas extends OptionalSchemas> = {
 export type SliceInHtmlTableProps<Schemas extends OptionalSchemas> = {
   /**
    * The Id of the Index in the Indexes object.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly indexId: Id;
   /**
    * The Id of the Slice in the Index to be rendered.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly sliceId: Id;
   /**
    * The Indexes object to be accessed: omit for the default context Indexes
    * object, provide an Id for a named context Indexes object, or provide an
    * explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly indexes?: IndexesOrIndexesId<Schemas>;
   /**
    * Whether the Cells should be editable. This affects the default CellView
    * component (to use the EditableCellView component instead) but of course
    * will not affect custom Cell components if you have set them.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly editable?: boolean;
   /**
@@ -306,6 +370,8 @@ export type SliceInHtmlTableProps<Schemas extends OptionalSchemas> = {
    * Cell Ids as keys, and with a value that can either be a string label to
    * show in the column header, or a CustomCell object to further configure the
    * column.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly customCells?:
     | Ids
@@ -328,18 +394,24 @@ export type RelationshipInHtmlTableProps<Schemas extends OptionalSchemas> = {
   /**
    * The Id of the relationship in the Relationships object for which the
    * relationship Table Rows will be rendered.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly relationshipId: Id;
   /**
    * The Relationships object to be accessed: omit for the default context
    * Relationships object, provide an Id for a named context Relationships
    * object, or provide an explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly relationships?: RelationshipsOrRelationshipsId<Schemas>;
   /**
    * Whether the Cells should be editable. This affects the default CellView
    * component (to use the EditableCellView component instead) but of course
    * will not affect custom Cell components if you have set them.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly editable?: boolean;
   /**
@@ -349,6 +421,8 @@ export type RelationshipInHtmlTableProps<Schemas extends OptionalSchemas> = {
    * pairs as keys, and with a value that can either be a string label to show
    * in the column header, or a CustomCell object to further configure the
    * column.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly customCells?:
     | Ids
@@ -365,12 +439,16 @@ export type ResultTableInHtmlTableProps<Schemas extends OptionalSchemas> = {
   /**
    * The Id of the query in the Queries object for which the ResultTable will be
    * rendered.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly queryId: Id;
   /**
    * The Queries object to be accessed: omit for the default context Queries
    * object, provide an Id for a named context Queries object, or provide an
    * explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly queries?: QueriesOrQueriesId<Schemas>;
   /**
@@ -379,6 +457,8 @@ export type ResultTableInHtmlTableProps<Schemas extends OptionalSchemas> = {
    * desired Cell Ids as keys, and with a value that can either be a string
    * label to show in the column header, or a ResultCustomCell object to further
    * configure the column.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly customCells?:
     | Ids
@@ -397,29 +477,41 @@ export type ResultSortedTableInHtmlTableProps<Schemas extends OptionalSchemas> =
     /**
    * The Id of the query in the Queries object for which the ResultTable will be
    * rendered.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly queryId: Id;
     /**
    * The Id of the Cell whose values are used for the sorting. If omitted, the
    * view will sort the Row Id itself.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly cellId?: Id;
     /**
    * Whether the sorting should be in descending order.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly descending?: boolean;
     /**
    * The number of Row Ids to skip for pagination purposes.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly offset?: number;
     /**
    * The maximum number of Row Ids to return.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly limit?: number;
     /**
    * The Queries object to be accessed: omit for the default context Queries
    * object, provide an Id for a named context Queries object, or provide an
    * explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly queries?: QueriesOrQueriesId<Schemas>;
     /**
@@ -428,6 +520,8 @@ export type ResultSortedTableInHtmlTableProps<Schemas extends OptionalSchemas> =
    * desired Cell Ids as keys, and with a value that can either be a string
    * label to show in the column header, or a ResultCustomCell object to further
    * configure the column.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly customCells?:
       | Ids
@@ -435,18 +529,24 @@ export type ResultSortedTableInHtmlTableProps<Schemas extends OptionalSchemas> =
     /**
    * Whether the table should be interactive such that clicking a header changes
    * the sorting and/or direction.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly sortOnClick?: boolean;
     /**
    * Either `true` to show the default SortedTablePaginator for the ResultTable,
    * or provide your own paginator component that takes
    * SortedTablePaginatorProps.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly paginator?: boolean | ComponentType<SortedTablePaginatorProps>;
     /**
    * A function that is called whenever the sorting or pagination of the
    * ResultTable is changed by the user, invoked with the sorted Cell Id,
    * whether descending or not, and the offset of the pagination.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly onChange?: (
       sortAndOffset: [
@@ -467,28 +567,40 @@ export type SortedTablePaginatorProps = {
   /**
    * An event that will fire when the offset is updated, called with the new
    * offset.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly onChange: (offset: number) => void;
   /**
    * The number of Row Ids to skip for pagination.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly offset?: number;
   /**
    * The maximum number of Row Ids being returned.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly limit?: number;
   /**
    * The total number of Row Ids in the paginated table.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly total: number;
   /**
    * A noun to use in the pagination label for a single row, defaulting to
    * 'row'.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly singular?: string;
   /**
    * A noun to use in the pagination label for multiple rows, defaulting to the
    * value of the singular noun suffixed with the letter 's'.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly plural?: string;
 };