@firecms/core 3.0.0-alpha.71 → 3.0.0-alpha.72

package/dist/components/EntityCollectionTable/EntityCollectionTable.d.ts

@@ -5,8 +5,7 @@ export declare const EntityCollectionTableContext: React.Context<EntityCollectio
 export declare const useEntityCollectionTableController: () => EntityCollectionTableController<any>;
 /**
  * This component is in charge of rendering a collection table with a high
- * degree of customization. It is in charge of fetching data from
- * the {@link DataSource} and holding the state of filtering and sorting.
+ * degree of customization.
  *
  * This component is used internally by {@link EntityCollectionView} and
  * {@link useReferenceDialog}
@@ -17,10 +16,11 @@ export declare const useEntityCollectionTableController: () => EntityCollectionT
  *
  * If you want to bind a {@link EntityCollection} to a table with the default
  * options you see in collections in the top level navigation, you can
- * check {@link EntityCollectionView}
+ * check {@link EntityCollectionView}.
  *
- * If you need a table that is not bound to the datasource or entities and
- * properties at all, you can check {@link VirtualTable}
+ * The data displayed in the table is managed by a {@link TableController}.
+ * You can build the default, bound to a path in the datasource, by using the hook
+ * {@link useDataSourceEntityCollectionTableController}
  *
  * @see EntityCollectionTableProps
  * @see EntityCollectionView

package/dist/components/EntityCollectionTable/EntityCollectionTableProps.d.ts

@@ -68,7 +68,7 @@ export type EntityCollectionTableProps<M extends Record<string, any>, UserType e
     actions?: React.ReactNode;
     /**
      * Controller holding the logic for the table
-     * {@link useEntityCollectionTableController}
+     * {@link useDataSourceEntityCollectionTableController}
      * {@link TableController}
      */
     tableController: TableController<M>;

package/dist/components/EntityCollectionTable/index.d.ts

@@ -1,4 +1,4 @@
 export { EntityCollectionTable } from "./EntityCollectionTable";
 export type { EntityCollectionTableProps, OnColumnResizeParams } from "./EntityCollectionTableProps";
 export type { UniqueFieldValidator, OnCellValueChange, OnCellValueChangeParams } from "./types";
-export * from "./useEntityCollectionTableController";
+export * from "./useDataSourceEntityCollectionTableController";

package/dist/components/EntityCollectionTable/types.d.ts

@@ -1,10 +1,24 @@
 import { CollectionSize, Entity, FireCMSContext, ResolvedProperty, SelectedCellProps } from "../../types";
 export type EntityCollectionTableController<M extends Record<string, any>> = {
+    /**
+     * This cell is displayed as selected
+     */
     selectedCell?: SelectedCellProps<any>;
+    /**
+     * Select a table cell
+     * @param cell
+     */
     select: (cell?: SelectedCellProps<M>) => void;
+    /**
+     * The cell that is displayed as a popup view.
+     * @param cell
+     */
     setPopupCell?: (cell?: SelectedCellProps<M>) => void;
+    /**
+     * Callback used when the value of a cell has changed.
+     * @param params
+     */
     onValueChange?: (params: OnCellValueChangeParams<any, M>) => void;
-    selectedEntityIds?: string[];
     /**
      * Size of the elements in the collection
      */

package/dist/components/EntityCollectionTable/useDataSourceEntityCollectionTableController.d.ts

@@ -0,0 +1,32 @@
+import { Entity, EntityCollection, FilterValues, TableController, User } from "../../types";
+export type DataSourceEntityCollectionTableControllerProps<M extends Record<string, any> = any> = {
+    /**
+     * Full path where the data of this table is located
+     */
+    fullPath: string;
+    /**
+     * The collection that is represented by this config.
+     */
+    collection: EntityCollection<M>;
+    /**
+     * List of entities that will be displayed on top, no matter the ordering.
+     * This is used for reference fields selection
+     */
+    entitiesDisplayedFirst?: Entity<M>[];
+    lastDeleteTimestamp?: number;
+    forceFilter?: FilterValues<string>;
+};
+/**
+ * Use this hook to build a controller for the {@link EntityCollectionTable}.
+ * This controller is bound to data in a path in your specified datasource.
+ *
+ * Note that you can build your own hook returning a {@link TableController}
+ * if you would like to display different data.
+ *
+ * @param fullPath
+ * @param collection
+ * @param entitiesDisplayedFirst
+ * @param lastDeleteTimestamp
+ * @param forceFilterFromProps
+ */
+export declare function useDataSourceEntityCollectionTableController<M extends Record<string, any> = any, UserType extends User = User>({ fullPath, collection, entitiesDisplayedFirst, lastDeleteTimestamp, forceFilter: forceFilterFromProps, }: DataSourceEntityCollectionTableControllerProps<M>): TableController<M>;

package/dist/components/SearchIconsView.d.ts

@@ -0,0 +1,5 @@
+export interface SearchIconsProps {
+    selectedIcon?: string;
+    onIconSelected?: (icon: string) => void;
+}
+export declare function SearchIconsView({ selectedIcon, onIconSelected }: SearchIconsProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/index.d.ts

@@ -18,3 +18,4 @@ export * from "./FireCMSAppBar";
 export * from "./ArrayContainer";
 export * from "./ReferenceWidget";
 export * from "./LabelWithIcon";
+export * from "./SearchIconsView";