@ai-matrx/records-ui 0.92.1 → 0.93.0

package/dist/index.d.cts

@@ -1821,6 +1821,13 @@ interface GridProps {
      * the store compiles both into the one WHERE clause.
      */
     filter?: StoreFilter$1 | undefined;
+    /**
+     * Clear the question `filter` carries (the view's own filter), for the "No rows match these
+     * filters" screen's Clear filters. Left out, that screen clears only the grid's own search and
+     * column filters, and when `filter` alone holds every row back it says so instead of offering a
+     * button that could not clear it.
+     */
+    onClearFilter?: (() => void) | undefined;
     /** Opened from a row's handle, Space or the row menu. A host that has a record page passes its own. */
     onOpenRecord?: ((recordId: Uuid) => void) | undefined;
     /**
@@ -1889,7 +1896,7 @@ interface GridProps {
     footer?: FooterPlacement | undefined;
     className?: string | undefined;
 }
-declare function Grid({ tableId, pageSize, filter, onOpenRecord, openRecordId, onAddField, onNewRecordForm, toolbarActions, editable, presentation, onPresentationChange, viewOrder, footer, className, onAskWhoChanged, }: GridProps): react.JSX.Element;
+declare function Grid({ tableId, pageSize, filter, onClearFilter, onOpenRecord, openRecordId, onAddField, onNewRecordForm, toolbarActions, editable, presentation, onPresentationChange, viewOrder, footer, className, onAskWhoChanged, }: GridProps): react.JSX.Element;
 
 /** Answers "what is the record with this id called", for one Field's values. */
 type LabelLookup = (field: Field$1, id: string) => string | null;
@@ -2771,6 +2778,11 @@ interface ViewSwitcherProps {
      * store's Rule shape). The grid, the board's headings and the numbers all ask it.
      */
     filter?: StoreFilter | undefined;
+    /**
+     * Clear the question `filter` carries, for the "No rows match these filters" screen of every
+     * layout. Left out, that screen says the view's filter holds every row back without a button.
+     */
+    onClearFilter?: (() => void) | undefined;
     /**
      * The HOST layout showing now (`RecordsUiHost.layouts`, by id), or null for the
      * package's own. Controlled by the page, because the address names it.
@@ -2826,7 +2838,7 @@ declare function useViewRecords(view: SavedViewSpec, pageSize?: number, filter?:
      */
     membership: string;
 };
-declare function ViewSwitcher({ view, onLayoutChange, onViewChange, onOpenRecord, openRecordId, onMoved, onNewRecordForm, onAskWhoChanged, pageSize, titleField, filter, hostLayout, onHostLayoutChange, chooser, openExport, viewId, onOrderPlaced, footer, className, }: ViewSwitcherProps): react.JSX.Element;
+declare function ViewSwitcher({ view, onLayoutChange, onViewChange, onOpenRecord, openRecordId, onMoved, onNewRecordForm, onAskWhoChanged, pageSize, titleField, filter, onClearFilter, hostLayout, onHostLayoutChange, chooser, openExport, viewId, onOrderPlaced, footer, className, }: ViewSwitcherProps): react.JSX.Element;
 
 /** What the screen says above the list, so nobody has to be told twice that nothing was destroyed. */
 declare const ARCHIVE_MEANS = "Archiving never destroys anything. A record you remove from the grid waits here until somebody brings it back.";

package/dist/index.d.ts

@@ -1821,6 +1821,13 @@ interface GridProps {
      * the store compiles both into the one WHERE clause.
      */
     filter?: StoreFilter$1 | undefined;
+    /**
+     * Clear the question `filter` carries (the view's own filter), for the "No rows match these
+     * filters" screen's Clear filters. Left out, that screen clears only the grid's own search and
+     * column filters, and when `filter` alone holds every row back it says so instead of offering a
+     * button that could not clear it.
+     */
+    onClearFilter?: (() => void) | undefined;
     /** Opened from a row's handle, Space or the row menu. A host that has a record page passes its own. */
     onOpenRecord?: ((recordId: Uuid) => void) | undefined;
     /**
@@ -1889,7 +1896,7 @@ interface GridProps {
     footer?: FooterPlacement | undefined;
     className?: string | undefined;
 }
-declare function Grid({ tableId, pageSize, filter, onOpenRecord, openRecordId, onAddField, onNewRecordForm, toolbarActions, editable, presentation, onPresentationChange, viewOrder, footer, className, onAskWhoChanged, }: GridProps): react.JSX.Element;
+declare function Grid({ tableId, pageSize, filter, onClearFilter, onOpenRecord, openRecordId, onAddField, onNewRecordForm, toolbarActions, editable, presentation, onPresentationChange, viewOrder, footer, className, onAskWhoChanged, }: GridProps): react.JSX.Element;
 
 /** Answers "what is the record with this id called", for one Field's values. */
 type LabelLookup = (field: Field$1, id: string) => string | null;
@@ -2771,6 +2778,11 @@ interface ViewSwitcherProps {
      * store's Rule shape). The grid, the board's headings and the numbers all ask it.
      */
     filter?: StoreFilter | undefined;
+    /**
+     * Clear the question `filter` carries, for the "No rows match these filters" screen of every
+     * layout. Left out, that screen says the view's filter holds every row back without a button.
+     */
+    onClearFilter?: (() => void) | undefined;
     /**
      * The HOST layout showing now (`RecordsUiHost.layouts`, by id), or null for the
      * package's own. Controlled by the page, because the address names it.
@@ -2826,7 +2838,7 @@ declare function useViewRecords(view: SavedViewSpec, pageSize?: number, filter?:
      */
     membership: string;
 };
-declare function ViewSwitcher({ view, onLayoutChange, onViewChange, onOpenRecord, openRecordId, onMoved, onNewRecordForm, onAskWhoChanged, pageSize, titleField, filter, hostLayout, onHostLayoutChange, chooser, openExport, viewId, onOrderPlaced, footer, className, }: ViewSwitcherProps): react.JSX.Element;
+declare function ViewSwitcher({ view, onLayoutChange, onViewChange, onOpenRecord, openRecordId, onMoved, onNewRecordForm, onAskWhoChanged, pageSize, titleField, filter, onClearFilter, hostLayout, onHostLayoutChange, chooser, openExport, viewId, onOrderPlaced, footer, className, }: ViewSwitcherProps): react.JSX.Element;
 
 /** What the screen says above the list, so nobody has to be told twice that nothing was destroyed. */
 declare const ARCHIVE_MEANS = "Archiving never destroys anything. A record you remove from the grid waits here until somebody brings it back.";