@firecms/core 3.0.0-canary.2 → 3.0.0-canary.200

package/src/components/EntityCollectionTable/EntityCollectionTableProps.tsx

@@ -12,12 +12,15 @@ import {
 } from "../../types";
 import { OnCellValueChange, OnColumnResizeParams, UniqueFieldValidator } from "../common/types";
 
-
 /**
  * @group Collection components
  */
 export type EntityCollectionTableProps<M extends Record<string, any>,
-    UserType extends User = User> = {
+    USER extends User = User> = {
+
+    className?: string;
+
+    style?: React.CSSProperties;
 
     /**
      * Display these entities as selected
@@ -69,6 +72,21 @@ export type EntityCollectionTableProps<M extends Record<string, any>,
      */
     onColumnResize?(params: OnColumnResizeParams): void;
 
+    /**
+     * Initial scroll position
+     */
+    initialScroll?: number;
+
+    /**
+     * Callback when the table is scrolled
+     * @param props
+     */
+    onScroll?: (props: {
+        scrollDirection: "forward" | "backward",
+        scrollOffset: number,
+        scrollUpdateWasRequested: boolean
+    }) => void;
+
     /**
      * Callback when the selected size of the table is changed
      */
@@ -87,12 +105,12 @@ export type EntityCollectionTableProps<M extends Record<string, any>,
 
     /**
      * Controller holding the logic for the table
-     * {@link useDataSourceEntityCollectionTableController}
+     * {@link useDataSourceTableController}
      * {@link EntityTableController}
      */
     tableController: EntityTableController<M>;
 
-    displayedColumnIds: PropertyColumnConfig[];
+    displayedColumnIds?: PropertyColumnConfig[];
 
     forceFilter?: FilterValues<Extract<keyof M, string>>;
 
@@ -100,7 +118,7 @@ export type EntityCollectionTableProps<M extends Record<string, any>,
 
     inlineEditing?: boolean;
 
-    additionalFields?: AdditionalFieldDelegate<M, UserType>[];
+    additionalFields?: AdditionalFieldDelegate<M, USER>[];
 
     defaultSize?: CollectionSize;
 
@@ -131,15 +149,18 @@ export type EntityCollectionTableProps<M extends Record<string, any>,
     onTextSearchClick?: () => void;
 
     textSearchLoading?: boolean;
-}
+
+    enablePopupIcon: boolean;
+
+    openEntityMode?: "side_panel" | "full_screen";
+};
 
 export type GetPropertyForProps<M extends Record<string, any>> = {
     propertyKey: string,
-    propertyValue: any,
     entity: Entity<M>
 };
 
 export type PropertyColumnConfig = {
     key: string,
-    disabled: boolean,
+    disabled?: boolean,
 };

package/src/components/EntityCollectionTable/PropertyTableCell.tsx

@@ -24,15 +24,15 @@ import { getPreviewSizeFrom } from "../../preview/util";
 import { isReadOnly } from "../../util";
 
 import { CustomFieldValidator, mapPropertyToYup } from "../../form/validation";
-import { useClearRestoreValue, useFireCMSContext } from "../../hooks";
 
 import { EntityTableCell } from "./internal/EntityTableCell";
 import { EntityTableCellActions } from "./internal/EntityTableCellActions";
 
-import { getRowHeight } from "../VirtualTable/common";
 import { useSelectableTableController } from "../SelectableTable/SelectableTableContext";
+import { useClearRestoreValue } from "../../form/useClearRestoreValue";
+import { getRowHeight } from "../common/table_height";
 
-export interface PropertyTableCellProps<T extends CMSType, M extends Record<string, any>> {
+export interface PropertyTableCellProps<T extends CMSType> {
     propertyKey: string;
     columnIndex: number;
     align: "right" | "left" | "center";
@@ -45,9 +45,12 @@ export interface PropertyTableCellProps<T extends CMSType, M extends Record<stri
     entity: Entity<any>;
     path: string;
     disabled: boolean;
+    enablePopupIcon?: boolean;
 }
 
 function isStorageProperty(property: ResolvedProperty) {
+    if (property.dataType === "string" && property.markdown)
+        return false;
     if (property.dataType === "string" && (property as ResolvedStringProperty).storage)
         return true;
     if (property.dataType === "array") {
@@ -61,7 +64,7 @@ function isStorageProperty(property: ResolvedProperty) {
     return false;
 }
 
-export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
+export const PropertyTableCell = React.memo<PropertyTableCellProps<any>>(
     function PropertyTableCell<T extends CMSType, M extends Record<string, any>>({
                                                                                      propertyKey,
                                                                                      customFieldValidator,
@@ -73,10 +76,9 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                                                                                      path,
                                                                                      entity,
                                                                                      readonly,
-                                                                                     disabled: disabledProp
-                                                                                 }: PropertyTableCellProps<T, M>) {
-
-        const context = useFireCMSContext();
+                                                                                     disabled: disabledProp,
+                                                                                     enablePopupIcon = true
+                                                                                 }: PropertyTableCellProps<T>) {
 
         const {
             onValueChange,
@@ -87,13 +89,14 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
         } = useSelectableTableController();
 
         const selected = selectedCell?.propertyKey === propertyKey &&
-            selectedCell?.entity.path === entity.path &&
-            selectedCell?.entity.id === entity.id;
+            selectedCell?.entityPath === entity.path &&
+            selectedCell?.entityId === entity.id;
 
         const [internalValue, setInternalValue] = useState<any | null>(value);
         const internalValueRef = useRef(value);
 
         const [error, setError] = useState<Error | undefined>();
+        const [validationError, setValidationError] = useState<Error | undefined>();
         const [saved, setSaved] = useState<boolean>(false);
 
         const onValueUpdated = useCallback(() => {
@@ -119,7 +122,7 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
         useEffect(
             () => {
                 if (!equal(value, internalValueRef.current)) {
-                    setError(undefined);
+                    setValidationError(undefined);
                     setInternalValue(value);
                     internalValueRef.current = value;
                     onValueUpdated();
@@ -135,32 +138,34 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
             validation
                 .validate(value)
                 .then(() => {
-                    setError(undefined);
+                    setValidationError(undefined);
                     internalValueRef.current = value;
                     if (onValueChange) {
-                        onValueChange({
-                            value,
-                            propertyKey,
-                            setError,
-                            onValueUpdated,
-                            entity,
-                            fullPath: path,
-                            context
-                        });
+                        try {
+                            onValueChange({
+                                value,
+                                propertyKey,
+                                setError,
+                                onValueUpdated,
+                                data: entity,
+                            });
+                        } catch (e: any) {
+                            console.error("onValueChange error", e);
+                            setError(e);
+                        }
+
                     }
                 })
                 .catch((e) => {
-                    setError(e);
+                    setValidationError(e);
                 });
         };
 
         useEffect(() => {
             validation
                 .validate(internalValue)
-                .then(() => setError(undefined))
-                .catch((e) => {
-                    setError(e);
-                });
+                .then(() => setValidationError(undefined))
+                .catch(setValidationError);
         }, [internalValue, validation, propertyKey, property, entity]);
 
         const updateValue = (newValue: any | null) => {
@@ -188,7 +193,8 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                 select({
                     width,
                     height,
-                    entity,
+                    entityPath: entity.path,
+                    entityId: entity.id,
                     cellRect,
                     propertyKey: propertyKey as Extract<keyof M, string>
                 });
@@ -204,7 +210,8 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                 setPopupCell({
                     width,
                     height,
-                    entity,
+                    entityPath: entity.path,
+                    entityId: entity.id,
                     cellRect,
                     propertyKey: propertyKey as Extract<keyof M, string>
                 });
@@ -236,7 +243,6 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                     height={getRowHeight(size)}
                     propertyKey={propertyKey}
                     property={property}
-                    // entity={entity}
                     value={internalValue}
                     size={getPreviewSizeFrom(size)}
                 />
@@ -246,7 +252,7 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
         if (!customField && (!customPreview || selected)) {
             const isAStorageProperty = isStorageProperty(property);
             if (isAStorageProperty) {
-                innerComponent = <TableStorageUpload error={error}
+                innerComponent = <TableStorageUpload error={validationError ?? error}
                                                      disabled={disabled}
                                                      focused={selected}
                                                      selected={selected}
@@ -273,7 +279,7 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                                                          valueType={"number"}
                                                          small={getPreviewSizeFrom(size) !== "medium"}
                                                          enumValues={numberProperty.enumValues}
-                                                         error={error}
+                                                         error={validationError ?? error}
                                                          internalValue={internalValue as string | number}
                                                          updateValue={updateValue}
                     />;
@@ -281,7 +287,7 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                 } else {
                     innerComponent = <VirtualTableNumberInput
                         align={align}
-                        error={error}
+                        error={validationError ?? error}
                         focused={selected}
                         disabled={disabled}
                         value={internalValue as number}
@@ -299,14 +305,14 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                                                          valueType={"string"}
                                                          small={getPreviewSizeFrom(size) !== "medium"}
                                                          enumValues={stringProperty.enumValues}
-                                                         error={error}
+                                                         error={validationError ?? error}
                                                          internalValue={internalValue as string | number}
                                                          updateValue={updateValue}
                     />;
                     fullHeight = true;
-                } else if (!stringProperty.storage) {
+                } else if (stringProperty.markdown || !stringProperty.storage) {
                     const multiline = Boolean(stringProperty.multiline) || Boolean(stringProperty.markdown);
-                    innerComponent = <VirtualTableInput error={error}
+                    innerComponent = <VirtualTableInput error={validationError ?? error}
                                                         disabled={disabled}
                                                         multiline={multiline}
                                                         focused={selected}
@@ -316,7 +322,7 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                     allowScroll = true;
                 }
             } else if (property.dataType === "boolean") {
-                innerComponent = <VirtualTableSwitch error={error}
+                innerComponent = <VirtualTableSwitch error={validationError ?? error}
                                                      disabled={disabled}
                                                      focused={selected}
                                                      internalValue={internalValue as boolean}
@@ -324,7 +330,7 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                 />;
             } else if (property.dataType === "date") {
                 innerComponent = <VirtualTableDateField name={propertyKey as string}
-                                                        error={error}
+                                                        error={validationError ?? error}
                                                         disabled={disabled}
                                                         mode={property.mode}
                                                         focused={selected}
@@ -345,6 +351,8 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                                              path={property.path}
                                              multiselect={false}
                                              previewProperties={property.previewProperties}
+                                             includeId={property.includeId}
+                                             includeEntityLink={property.includeEntityLink}
                                              title={property.name}
                                              forceFilter={property.forceFilter}
                         />;
@@ -367,7 +375,7 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                                                     small={getPreviewSizeFrom(size) !== "medium"}
                                                     valueType={arrayProperty.of.dataType}
                                                     enumValues={arrayProperty.of.enumValues}
-                                                    error={error}
+                                                    error={validationError ?? error}
                                                     internalValue={internalValue as string | number}
                                                     updateValue={updateValue}
                                 />;
@@ -389,6 +397,8 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                                     previewProperties={arrayProperty.of.previewProperties}
                                     title={arrayProperty.name}
                                     forceFilter={arrayProperty.of.forceFilter}
+                                    includeId={arrayProperty.of.includeId}
+                                    includeEntityLink={arrayProperty.of.includeEntityLink}
                                 />;
                         }
                         allowScroll = false;
@@ -400,16 +410,14 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
 
         if (!innerComponent) {
             allowScroll = false;
-            showExpandIcon = selected && !innerComponent && !disabled && !readOnlyProperty;
+            showExpandIcon = enablePopupIcon && selected && !innerComponent && !disabled && !readOnlyProperty;
             innerComponent = (
-                <PropertyPreview
-                    width={width}
-                    height={height}
-                    // entity={entity}
-                    propertyKey={propertyKey as string}
-                    value={internalValue}
-                    property={property}
-                    size={getPreviewSizeFrom(size)}
+                <PropertyPreview width={width}
+                                 height={height}
+                                 propertyKey={propertyKey as string}
+                                 value={internalValue}
+                                 property={property}
+                                 size={getPreviewSizeFrom(size)}
                 />
             );
         }
@@ -426,7 +434,7 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
                 removePadding={removePadding}
                 fullHeight={fullHeight}
                 saved={saved}
-                error={error}
+                error={validationError ?? error}
                 align={align}
                 allowScroll={allowScroll}
                 showExpandIcon={showExpandIcon}
@@ -446,9 +454,9 @@ export const PropertyTableCell = React.memo<PropertyTableCellProps<any, any>>(
         );
 
     },
-    areEqual) as React.FunctionComponent<PropertyTableCellProps<any, any>>;
+    areEqual) as React.FunctionComponent<PropertyTableCellProps<any>>;
 
-function areEqual(prevProps: PropertyTableCellProps<any, any>, nextProps: PropertyTableCellProps<any, any>) {
+function areEqual(prevProps: PropertyTableCellProps<any>, nextProps: PropertyTableCellProps<any>) {
     return prevProps.height === nextProps.height &&
         prevProps.propertyKey === nextProps.propertyKey &&
         prevProps.align === nextProps.align &&

package/src/components/EntityCollectionTable/column_utils.tsx

@@ -21,7 +21,6 @@ export interface PropertiesToColumnsParams<M extends Record<string, any>> {
     properties: ResolvedProperties<M>;
     sortable?: boolean;
     forceFilter?: FilterValues<keyof M extends string ? keyof M : never>;
-    disabledFilter?: boolean;
     AdditionalHeaderWidget?: React.ComponentType<{
         property: ResolvedProperty,
         propertyKey: string,
@@ -29,7 +28,8 @@ export interface PropertiesToColumnsParams<M extends Record<string, any>> {
     }>;
 }
 
-export function propertiesToColumns<M extends Record<string, any>>({ properties, sortable, forceFilter, disabledFilter, AdditionalHeaderWidget }: PropertiesToColumnsParams<M>): VirtualTableColumn[] {
+export function propertiesToColumns<M extends Record<string, any>>({ properties, sortable, forceFilter, AdditionalHeaderWidget }: PropertiesToColumnsParams<M>): VirtualTableColumn[] {
+    const disabledFilter = Boolean(forceFilter);
     return Object.entries<ResolvedProperty>(properties)
         .flatMap(([key, property]) => getColumnKeysForProperty(property, key))
         .map(({
@@ -45,7 +45,7 @@ export function propertiesToColumns<M extends Record<string, any>>({ properties,
                 align: getTableCellAlignment(property),
                 icon: getIconForProperty(property, "small"),
                 title: property.name ?? key as string,
-                sortable: sortable && (forceFilter ? Object.keys(forceFilter).includes(key) : true),
+                sortable: sortable,
                 filter: !disabledFilter && filterable,
                 width: getTablePropertyColumnWidth(property),
                 resizable: true,

package/src/components/EntityCollectionTable/fields/TableReferenceField.tsx

@@ -1,14 +1,15 @@
-import React, { useCallback, useState } from "react";
+import React, { useCallback } from "react";
 import equal from "react-fast-compare"
 
-import { ReferencePreview, ReferencePreviewContainer } from "../../../preview";
+import { ReferencePreview } from "../../../preview";
 import { CollectionSize, Entity, EntityCollection, EntityReference, FilterValues } from "../../../types";
 
 import { getPreviewSizeFrom } from "../../../preview/util";
-import { getReferenceFrom } from "../../../util";
+import { getReferenceFrom, IconForView } from "../../../util";
 import { useCustomizationController, useNavigationController, useReferenceDialog } from "../../../hooks";
 import { ErrorView } from "../../ErrorView";
-import { Button } from "@firecms/ui";
+import { cls, EditIcon } from "@firecms/ui";
+import { EntityPreviewContainer } from "../../EntityPreview";
 
 type TableReferenceFieldProps = {
     name: string;
@@ -21,6 +22,8 @@ type TableReferenceFieldProps = {
     title?: string;
     path: string;
     forceFilter?: FilterValues<string>;
+    includeId?: boolean;
+    includeEntityLink?: boolean;
 };
 
 export function TableReferenceField(props: TableReferenceFieldProps) {
@@ -28,7 +31,7 @@ export function TableReferenceField(props: TableReferenceFieldProps) {
 
     const navigationController = useNavigationController();
     const { path } = props;
-    const collection = navigationController.getCollection<EntityCollection>(path);
+    const collection = navigationController.getCollection(path);
     if (!collection) {
         if (customizationController.components?.missingReference) {
             return <customizationController.components.missingReference path={path}/>;
@@ -36,11 +39,11 @@ export function TableReferenceField(props: TableReferenceFieldProps) {
             throw Error(`Couldn't find the corresponding collection view for the path: ${path}`);
         }
     }
-    return <TableReferenceFieldSuccess {...props} collection={collection}/>;
+    return <TableReferenceFieldInternal {...props} collection={collection}/>;
 }
 
-export const TableReferenceFieldSuccess = React.memo(
-    function TableReferenceFieldSuccess(props: TableReferenceFieldProps & {
+export const TableReferenceFieldInternal = React.memo(
+    function TableReferenceFieldInternal(props: TableReferenceFieldProps & {
         collection: EntityCollection;
     }) {
         const {
@@ -54,14 +57,11 @@ export const TableReferenceFieldSuccess = React.memo(
             title,
             disabled,
             forceFilter,
-            collection
+            collection,
+            includeId,
+            includeEntityLink
         } = props;
 
-        const [onHover, setOnHover] = useState(false);
-
-        const hoverTrue = useCallback(() => setOnHover(true), []);
-        const hoverFalse = useCallback(() => setOnHover(false), []);
-
         const onSingleEntitySelected = useCallback((entity: Entity<any>) => {
             updateValue(entity ? getReferenceFrom(entity) : null);
         }, [updateValue]);
@@ -87,45 +87,49 @@ export const TableReferenceFieldSuccess = React.memo(
             }
         );
 
-        const handleOpen = useCallback(() => {
+        const handleOpen = () => {
             if (disabled)
                 return;
             referenceDialogController.open();
-        }, [disabled, referenceDialogController]);
+        };
 
         const valueNotSet = !internalValue || (Array.isArray(internalValue) && internalValue.length === 0);
 
         const buildSingleReferenceField = () => {
-            if (internalValue instanceof EntityReference)
+            if (internalValue && !Array.isArray(internalValue) && internalValue.isEntityReference && internalValue.isEntityReference())
                 return <ReferencePreview
                     onClick={disabled ? undefined : handleOpen}
                     size={getPreviewSizeFrom(size)}
                     reference={internalValue as EntityReference}
-                    onHover={onHover}
+                    hover={!disabled}
                     disabled={!path}
                     previewProperties={previewProperties}
+                    includeId={includeId}
+                    includeEntityLink={includeEntityLink}
                 />;
             else
-                return <ReferencePreviewContainer
+                return <EntityPreviewContainer
                     onClick={disabled ? undefined : handleOpen}
                     size={getPreviewSizeFrom(size)}>
                     <ErrorView title="Value is not a reference." error={"Click to edit"}/>
-                </ReferencePreviewContainer>;
+                </EntityPreviewContainer>;
         };
 
         const buildMultipleReferenceField = () => {
             if (Array.isArray(internalValue))
                 return <>
                     {internalValue.map((reference, index) =>
-                        <div className="m-1 w-full"
+                        <div className="w-full my-0.5"
                              key={`preview_array_ref_${name}_${index}`}>
                             <ReferencePreview
                                 onClick={disabled ? undefined : handleOpen}
-                                size={"tiny"}
+                                size={"small"}
                                 reference={reference}
-                                onHover={onHover}
+                                hover={!disabled}
                                 disabled={!path}
                                 previewProperties={previewProperties}
+                                includeId={includeId}
+                                includeEntityLink={includeEntityLink}
                             />
                         </div>
                     )
@@ -139,23 +143,26 @@ export const TableReferenceFieldSuccess = React.memo(
             return <ErrorView error={"The specified collection does not exist"}/>;
 
         return (
-            <div className="w-full"
-                 onMouseEnter={hoverTrue}
-                 onMouseMove={hoverTrue}
-                 onMouseLeave={hoverFalse}>
+            <div className="w-full group">
 
                 {internalValue && !multiselect && buildSingleReferenceField()}
 
                 {internalValue && multiselect && buildMultipleReferenceField()}
 
                 {valueNotSet &&
-                    <Button
+                    <EntityPreviewContainer
+                        className={cls("px-3 py-2 text-sm font-medium flex items-center",
+                            multiselect ? "gap-4" : "gap-6",
+                            disabled
+                                ? "text-surface-accent-500"
+                                : "cursor-pointer text-text-secondary dark:text-text-secondary-dark hover:bg-surface-accent-50 dark:hover:bg-surface-800 group-hover:bg-surface-accent-50 dark:group-hover:bg-surface-800")}
                         onClick={handleOpen}
-                        size={"small"}
-                        variant="outlined"
-                        color="primary">
-                        Edit {title}
-                    </Button>}
+                        size={"medium"}>
+                        <EditIcon
+                            size={"small"}
+                            className={"ml-2 mr-1 text-surface-300 dark:text-surface-600"}/>
+                        {title}
+                    </EntityPreviewContainer>}
 
             </div>
         );