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

package/src/preview/PropertyPreviewProps.tsx

@@ -3,12 +3,12 @@ import { CMSType, Property, ResolvedProperty } from "../types";
 /**
  * @group Preview components
  */
-export type PreviewSize = "medium" | "small" | "tiny";
+export type PreviewSize = "small" | "medium" | "large";
 
 /**
  * @group Preview components
  */
-export interface PropertyPreviewProps<T extends CMSType = any, CustomProps = any, M extends Record<string, any> = Record<string, any>> {
+export interface PropertyPreviewProps<T extends CMSType = any, CustomProps = any> {
     /**
      * Name of the property
      */
@@ -24,11 +24,6 @@ export interface PropertyPreviewProps<T extends CMSType = any, CustomProps = any
      */
     property: Property<T> | ResolvedProperty<T>;
 
-    /**
-     * Click handler
-     */
-    // onClick?: () => void;
-
     /**
      * Desired size of the preview, depending on the context.
      */
@@ -52,8 +47,9 @@ export interface PropertyPreviewProps<T extends CMSType = any, CustomProps = any
     customProps?: CustomProps;
 
     /**
-     * Entity this property refers to
+     * If the preview should be interactive or not.
+     * This applies only to videos.
      */
-    // entity?: Entity<M>;
+    interactive?: boolean;
 
 }

package/src/preview/components/BooleanPreview.tsx

@@ -1,11 +1,26 @@
 import React from "react";
-import { Checkbox } from "@firecms/ui";
+import { Checkbox, cls } from "@firecms/ui";
+import { PreviewSize } from "../PropertyPreviewProps";
+import { Property } from "../../types";
 
 /**
  * @group Preview components
  */
-export function BooleanPreview({ value }: {
-    value: boolean
+export function BooleanPreview({
+                                   value,
+                                   size,
+                                   property
+                               }: {
+    value: boolean,
+    size: PreviewSize,
+    property: Property,
 }): React.ReactElement {
-    return <Checkbox checked={value} color={"secondary"}/>;
+    return <div className={"flex flex-row gap-2 items-center"}>
+        <Checkbox checked={value}
+                  padding={false}
+                  size={size}
+                  color={"secondary"}/>
+        {property.name && <span
+            className={cls("text-text-secondary dark:text-text-secondary-dark", size === "small" ? "text-sm" : "")}>{property.name}</span>}
+    </div>;
 }

package/src/preview/components/EmptyValue.tsx

@@ -6,5 +6,5 @@ import React from "react";
 export function EmptyValue() {
 
     return <div
-        className="rounded-full bg-gray-200 bg-opacity-30 dark:bg-opacity-20 w-5 h-2 inline-block"/>;
+        className="rounded-full bg-surface-200 bg-opacity-30 dark:bg-opacity-20 w-5 h-2 inline-block"/>;
 }

package/src/preview/components/EnumValuesChip.tsx

@@ -1,12 +1,12 @@
 import React from "react";
+import { Chip } from "@firecms/ui";
 import { EnumValues } from "../../types";
 import { buildEnumLabel, enumToObjectEntries, getColorScheme, getLabelOrConfigFrom } from "../../util/enums";
-import { Chip } from "@firecms/ui";
 
 export interface EnumValuesChipProps {
     enumValues?: EnumValues;
     enumKey: string | number;
-    size: "small" | "medium";
+    size: "small" | "medium" | "large";
     className?: string;
     children?: React.ReactNode;
 }

package/src/preview/components/ImagePreview.tsx

@@ -1,4 +1,4 @@
-import React, { CSSProperties, useMemo, useState } from "react";
+import React, { CSSProperties, useMemo } from "react";
 
 import { getThumbnailMeasure } from "../util";
 import { PreviewSize } from "../PropertyPreviewProps";
@@ -20,11 +20,9 @@ export function ImagePreview({
                                  url
                              }: ImagePreviewProps) {
 
-    const [onHover, setOnHover] = useState(false);
-
     const imageSize = useMemo(() => getThumbnailMeasure(size), [size]);
 
-    if (size === "tiny") {
+    if (size === "small") {
         return (
             <img src={url}
                  className={"rounded-md"}
@@ -47,60 +45,51 @@ export function ImagePreview({
 
     return (
         <div
-            className="relative flex items-center justify-center max-w-full max-h-full"
+            className="relative flex items-center justify-center max-w-full max-h-full group"
             style={{
                 width: imageSize,
                 height: imageSize
             }}
-            key={"image_preview_" + url}
-            onMouseEnter={() => setOnHover(true)}
-            onMouseMove={() => setOnHover(true)}
-            onMouseLeave={() => setOnHover(false)}>
+            key={"image_preview_" + url}>
 
             <img src={url}
                  className={"rounded-md"}
                  style={imageStyle}/>
 
-            {onHover && <>
-
-                {navigator && <Tooltip title="Copy url to clipboard">
-                    <div
-                        className="rounded-full absolute bottom-[-4px] right-8">
-                        <IconButton
-                            variant={"filled"}
-                            size={"small"}
-                            onClick={(e) => {
-                                e.stopPropagation();
-                                e.preventDefault();
-                                return navigator.clipboard.writeText(url);
-                            }}>
-                            <ContentCopyIcon className={"text-gray-500"}
-                                             size={"small"}/>
-                        </IconButton>
-                    </div>
+            <div className={"flex flex-row gap-2 absolute bottom-[-4px] right-[-4px] invisible group-hover:visible"}>
+                {navigator && <Tooltip
+                    asChild={true}
+                    title="Copy url to clipboard" side={"bottom"}>
+                    <IconButton
+                        variant={"filled"}
+                        size={"small"}
+                        onClick={(e) => {
+                            e.stopPropagation();
+                            e.preventDefault();
+                            return navigator.clipboard.writeText(url);
+                        }}>
+                        <ContentCopyIcon className={"text-surface-700 dark:text-surface-300"}
+                                         size={"smallest"}/>
+                    </IconButton>
                 </Tooltip>}
 
-                <Tooltip title="Open image in new tab">
+                <Tooltip title="Open image in new tab" side={"bottom"}>
                     <IconButton
+                        className="invisible group-hover:visible"
                         variant={"filled"}
                         component={"a" as React.ElementType}
-                        style={{
-                            position: "absolute",
-                            bottom: -4,
-                            right: -4
-                        }}
                         href={url}
                         rel="noopener noreferrer"
                         target="_blank"
                         size={"small"}
                         onClick={(e: any) => e.stopPropagation()}
                     >
-                        <OpenInNewIcon className={"text-gray-500"}
-                                       size={"small"}/>
+                        <OpenInNewIcon className={"text-surface-700 dark:text-surface-300"}
+                                       size={"smallest"}/>
                     </IconButton>
                 </Tooltip>
-            </>
-            }
+            </div>
+
         </div>
     );
 }

package/src/preview/components/ReferencePreview.tsx

@@ -1,21 +1,11 @@
 import * as React from "react";
-import { useMemo } from "react";
 
-import { Entity, EntityCollection, EntityReference, ResolvedProperty } from "../../types";
-
-import { getReferencePreviewKeys, getValueInPath, resolveCollection } from "../../util";
-import {
-    useCustomizationController,
-    useEntityFetch,
-    useNavigationController,
-    useSideEntityController
-} from "../../hooks";
-import { PropertyPreview } from "../PropertyPreview";
+import { Entity, EntityCollection, EntityReference } from "../../types";
+import { useCustomizationController, useEntityFetch, useNavigationController } from "../../hooks";
 import { PreviewSize } from "../PropertyPreviewProps";
-import { SkeletonPropertyComponent } from "../property_previews/SkeletonPropertyComponent";
-import { cn, IconButton, KeyboardTabIcon, Skeleton, Tooltip, Typography } from "@firecms/ui";
+import { Skeleton } from "@firecms/ui";
 import { ErrorView } from "../../components";
-import { useAnalyticsController } from "../../hooks/useAnalyticsController";
+import { EntityPreview, EntityPreviewContainer } from "../../components/EntityPreview";
 
 export type ReferencePreviewProps = {
     disabled?: boolean;
@@ -23,52 +13,44 @@ export type ReferencePreviewProps = {
     size: PreviewSize;
     previewProperties?: string[];
     onClick?: (e: React.SyntheticEvent) => void;
-    onHover?: boolean;
-    allowEntityNavigation?: boolean;
+    hover?: boolean;
+    includeEntityLink?: boolean;
+    includeId?: boolean;
 };
 
 /**
  * @group Preview components
  */
-export const ReferencePreview = React.memo<ReferencePreviewProps>(function ReferencePreview(props: ReferencePreviewProps) {
+export const ReferencePreview = function ReferencePreview(props: ReferencePreviewProps) {
     const reference = props.reference;
-    if (!((reference as unknown) instanceof EntityReference)) {
+    if (!(typeof reference === "object" && "isEntityReference" in reference && reference.isEntityReference())) {
         console.warn("Reference preview received value of type", typeof reference);
-        return <ReferencePreviewContainer
+        return <EntityPreviewContainer
             onClick={props.onClick}
             size={props.size}>
             <ErrorView error={"Unexpected value. Click to edit"}
                        tooltip={JSON.stringify(reference)}/>
-        </ReferencePreviewContainer>;
+        </EntityPreviewContainer>;
     }
     return <ReferencePreviewInternal {...props} />;
-}, areEqual) as React.FunctionComponent<ReferencePreviewProps>;
-
-function areEqual(prevProps: ReferencePreviewProps, nextProps: ReferencePreviewProps) {
-    return prevProps.disabled === nextProps.disabled &&
-        prevProps.size === nextProps.size &&
-        prevProps.onHover === nextProps.onHover &&
-        prevProps.reference?.id === nextProps.reference?.id &&
-        prevProps.reference?.path === nextProps.reference?.path &&
-        prevProps.allowEntityNavigation === nextProps.allowEntityNavigation
-        ;
-}
+};
 
-function ReferencePreviewInternal<M extends Record<string, any>>({
-                                                                     disabled,
-                                                                     reference,
-                                                                     previewProperties,
-                                                                     size,
-                                                                     onHover,
-                                                                     onClick,
-                                                                     allowEntityNavigation = true
-                                                                 }: ReferencePreviewProps) {
+function ReferencePreviewInternal({
+                                      disabled,
+                                      reference,
+                                      previewProperties,
+                                      size,
+                                      hover,
+                                      onClick,
+                                      includeEntityLink = true,
+                                      includeId = true
+                                  }: ReferencePreviewProps) {
 
     const customizationController = useCustomizationController();
 
     const navigationController = useNavigationController();
 
-    const collection = navigationController.getCollection<EntityCollection<M>>(reference.path);
+    const collection = navigationController.getCollection(reference.path);
     if (!collection) {
         if (customizationController.components?.missingReference) {
             return <customizationController.components.missingReference path={reference.path}/>;
@@ -83,20 +65,26 @@ function ReferencePreviewInternal<M extends Record<string, any>>({
         previewProperties={previewProperties}
         size={size}
         disabled={disabled}
-        allowEntityNavigation={allowEntityNavigation}
+        includeEntityLink={includeEntityLink}
+        includeId={includeId}
         onClick={onClick}
-        onHover={onHover}/>
+        hover={hover}/>
 }
 
-function ReferencePreviewExisting<M extends Record<string, any> = any>({ reference, collection, previewProperties, size, disabled, allowEntityNavigation, onClick, onHover }: ReferencePreviewProps & {
+function ReferencePreviewExisting<M extends Record<string, any> = any>({
+                                                                           reference,
+                                                                           collection,
+                                                                           previewProperties,
+                                                                           size,
+                                                                           disabled,
+                                                                           includeEntityLink,
+                                                                           includeId,
+                                                                           onClick,
+                                                                           hover
+                                                                       }: ReferencePreviewProps & {
     collection: EntityCollection<M>
 }) {
 
-    const customizationController = useCustomizationController();
-
-    const analyticsController = useAnalyticsController();
-    const sideEntityController = useSideEntityController();
-
     const {
         entity,
         dataLoading,
@@ -114,145 +102,54 @@ function ReferencePreviewExisting<M extends Record<string, any> = any>({ referen
 
     const usedEntity = entity ?? referencesCache.get(reference.pathWithId);
 
-    const resolvedCollection = useMemo(() => resolveCollection({
-        collection,
-        path: reference.path,
-        values: usedEntity?.values,
-        fields: customizationController.propertyConfigs
-    }), [collection]);
-
-    const listProperties = useMemo(() => getReferencePreviewKeys(resolvedCollection, customizationController.propertyConfigs, previewProperties, size === "small" || size === "medium" ? 3 : 1),
-        [previewProperties, resolvedCollection, size]);
-
     let body: React.ReactNode;
 
-    if (!resolvedCollection) {
-        return <ErrorView
-            error={"Could not find collection with id " + resolvedCollection}/>
-    }
-
     if (!reference) {
         body = <ErrorView error={"Reference not set"}/>;
     } else if (usedEntity && !usedEntity.values) {
         body = <ErrorView error={"Reference does not exist"}
                           tooltip={reference.path}/>;
-    } else {
-        body = (
-            <>
-                <div
-                    className="flex flex-col flex-grow w-full max-w-[calc(100%-52px)] m-1">
-
-                    {size !== "tiny" && (
-                        reference
-                            ? <div className={`${
-                                size !== "medium"
-                                    ? "block whitespace-nowrap overflow-hidden truncate"
-                                    : ""
-                            }`}>
-                                <Typography variant={"caption"}
-                                            className={"font-mono"}>
-                                    {reference.id}
-                                </Typography>
-                            </div>
-                            : <Skeleton/>)}
-
-                    {listProperties && listProperties.map((key) => {
-                        const childProperty = resolvedCollection.properties[key as string];
-                        if (!childProperty) return null;
-
-                        return (
-                            <div key={"ref_prev_" + (key as string)}
-                                 className={listProperties.length > 1 ? "my-0.5" : "my-0"}>
-                                {
-                                    usedEntity
-                                        ? <PropertyPreview
-                                            propertyKey={key as string}
-                                            value={getValueInPath(usedEntity.values, key)}
-                                            property={childProperty as ResolvedProperty}
-                                            // entity={usedEntity}
-                                            size={"tiny"}/>
-                                        : <SkeletonPropertyComponent
-                                            property={childProperty as ResolvedProperty}
-                                            size={"tiny"}/>
-                                }
-                            </div>
-                        );
-                    })}
-
-                </div>
-                <div className={`my-${size === "tiny" ? 2 : 4}`}>
-                    {!disabled && usedEntity && allowEntityNavigation &&
-                        <Tooltip title={`See details for ${usedEntity.id}`}>
-                            <IconButton
-                                color={"inherit"}
-                                size={"small"}
-                                onClick={(e) => {
-                                    e.stopPropagation();
-                                    analyticsController.onAnalyticsEvent?.("entity_click_from_reference", {
-                                        path: usedEntity.path,
-                                        entityId: usedEntity.id
-                                    });
-                                    sideEntityController.open({
-                                        entityId: usedEntity.id,
-                                        path: usedEntity.path,
-                                        collection: resolvedCollection,
-                                        updateUrl: true
-                                    });
-                                }}>
-                                <KeyboardTabIcon size={"small"}/>
-                            </IconButton>
-                        </Tooltip>}
-                </div>
-            </>
+    }
+    if (body) {
+
+        return (
+            <EntityPreviewContainer onClick={disabled ? undefined : onClick}
+                                    hover={disabled ? undefined : hover}
+                                    size={size}>
+                {body}
+            </EntityPreviewContainer>
         );
     }
 
-    return (
-        <ReferencePreviewContainer onClick={disabled ? undefined : onClick}
-                                   onHover={disabled ? undefined : onHover}
-                                   size={size}>
-            {body}
-        </ReferencePreviewContainer>
-    );
-}
-
-export function ReferencePreviewContainer({
-                                              children,
-                                              onHover,
-                                              size,
-                                              onClick
-                                          }: {
-    children: React.ReactNode;
-    onHover?: boolean;
-    size: PreviewSize;
-    onClick?: (e: React.SyntheticEvent) => void;
-}) {
-    return <Typography variant={"label"}
-                       className={cn("bg-opacity-70 bg-gray-100 dark:bg-gray-800 dark:bg-opacity-60",
-                           "w-full",
-                           "flex",
-                           "rounded-md",
-                           "overflow-hidden",
-                           onHover ? "hover:bg-opacity-90 dark:hover:bg-opacity-90" : "",
-                           size === "medium" ? "p-2" : "p-1",
-                           size === "tiny" ? "items-center" : "",
-                           "transition-colors duration-300 ease-in-out ",
-                           // onHover ? "shadow-outline" : "",
-                           onClick ? "cursor-pointer" : "")}
-                       style={{
-                           // @ts-ignore
-                           tabindex: 0
-                       }}
-                       onClick={(event) => {
-                           if (onClick) {
-                               event.preventDefault();
-                               onClick(event);
-                           }
-                       }}>
+    if (dataLoading && !usedEntity) {
+        return (
+            <EntityPreviewContainer onClick={disabled ? undefined : onClick}
+                                    hover={disabled ? undefined : hover}
+                                    size={size}>
+                <Skeleton/>
+            </EntityPreviewContainer>
+        );
+    }
 
-        {children}
+    if (!usedEntity) {
+        return (
+            <EntityPreviewContainer onClick={disabled ? undefined : onClick}
+                                    hover={disabled ? undefined : hover}
+                                    size={size}>
+                <ErrorView error={"Entity not found"}/>
+            </EntityPreviewContainer>
+        );
+    }
+    return <EntityPreview size={size}
+                          previewProperties={previewProperties}
+                          disabled={disabled}
+                          entity={usedEntity}
+                          collection={collection}
+                          onClick={onClick}
+                          includeEntityLink={includeEntityLink}
+                          includeId={includeId}
+                          hover={hover}/>;
 
-    </Typography>
 }
 
 const referencesCache = new Map<string, Entity<any>>();

package/src/preview/components/StorageThumbnail.tsx

@@ -11,6 +11,7 @@ type StorageThumbnailProps = {
     storagePathOrDownloadUrl: string;
     storeUrl: boolean;
     size: PreviewSize;
+    interactive?: boolean;
 };
 
 /**
@@ -21,13 +22,15 @@ export const StorageThumbnail = React.memo<StorageThumbnailProps>(StorageThumbna
 function areEqual(prevProps: StorageThumbnailProps, nextProps: StorageThumbnailProps) {
     return prevProps.size === nextProps.size &&
         prevProps.storagePathOrDownloadUrl === nextProps.storagePathOrDownloadUrl &&
-        prevProps.storeUrl === nextProps.storeUrl;
+        prevProps.storeUrl === nextProps.storeUrl&&
+        prevProps.interactive === nextProps.interactive;
 }
 
 const URL_CACHE: Record<string, DownloadConfig> = {};
 
 export function StorageThumbnailInternal({
                                              storeUrl,
+                                             interactive,
                                              storagePathOrDownloadUrl,
                                              size
                                          }: StorageThumbnailProps) {
@@ -68,6 +71,7 @@ export function StorageThumbnailInternal({
     return downloadConfig?.url
         ? <UrlComponentPreview previewType={previewType}
                                url={downloadConfig.url}
+                               interactive={interactive}
                                size={size}
                                hint={storagePathOrDownloadUrl}/>
         : renderSkeletonImageThumbnail(size);

package/src/preview/components/UrlComponentPreview.tsx

@@ -1,10 +1,10 @@
-import React from "react";
+import React, { useMemo } from "react";
 
 import { ImagePreview } from "./ImagePreview";
 import { getThumbnailMeasure } from "../util";
 import { PreviewType } from "../../types";
 import { PreviewSize } from "../PropertyPreviewProps";
-import { DescriptionIcon, OpenInNewIcon, Tooltip, Typography } from "@firecms/ui";
+import { cls, DescriptionIcon, OpenInNewIcon, Tooltip, Typography } from "@firecms/ui";
 import { EmptyValue } from "./EmptyValue";
 
 /**
@@ -14,12 +14,15 @@ export function UrlComponentPreview({
                                         url,
                                         previewType,
                                         size,
-                                        hint
+                                        hint,
+                                        interactive = true
                                     }: {
     url: string,
     previewType?: PreviewType,
     size: PreviewSize,
-    hint?: string
+    hint?: string,
+    // for video controls
+    interactive?: boolean
 }): React.ReactElement {
 
     if (!previewType) {
@@ -43,37 +46,66 @@ export function UrlComponentPreview({
                              size={size}/>;
     } else if (previewType === "audio") {
         return <audio controls
+                      className={"max-w-100%"}
                       src={url}>
             Your browser does not support the
             <code>audio</code> element.
         </audio>;
     } else if (previewType === "video") {
-        return <video
-            className={`max-w-${size === "small" ? "sm" : "md"}`}
-            controls
-        >
-            <source src={url}/>
-        </video>;
+        return <VideoPreview size={size} src={url} interactive={interactive}/>;
     } else {
         return (
-            <a
-                href={url}
-                rel="noopener noreferrer"
-                target="_blank"
-                onClick={(e) => e.stopPropagation()}
-                className="flex flex-col items-center justify-center"
-                style={{
-                    width: getThumbnailMeasure(size),
-                    height: getThumbnailMeasure(size)
-                }}>
-                <DescriptionIcon className="flex-grow"/>
-                {hint &&
-                    <Tooltip title={hint}>
-                        <Typography
-                            className="max-w-full truncate rtl text-left"
-                            variant={"caption"}>{hint}</Typography>
-                    </Tooltip>}
-            </a>
+            <Tooltip title={hint}>
+                <a
+                    href={url}
+                    rel="noopener noreferrer"
+                    target="_blank"
+                    onClick={(e) => e.stopPropagation()}
+                    className="flex flex-col items-center justify-center"
+                    style={{
+                        width: getThumbnailMeasure(size),
+                        height: getThumbnailMeasure(size)
+                    }}>
+                    <DescriptionIcon className="text-surface-700 dark:text-surface-300"/>
+                    {hint && <Typography
+                        className="max-w-full truncate rtl text-left"
+                        variant={"caption"}>{hint}</Typography>}
+                </a>
+            </Tooltip>
         );
     }
 }
+
+function VideoPreview({
+                          size,
+                          src,
+                          interactive
+                      }: { size: PreviewSize, src: string, interactive: boolean }) {
+
+    const imageSize = useMemo(() => {
+        if (size === "small")
+            return "140px";
+        else if (size === "medium")
+            return "240px";
+        else if (size === "large")
+            return "100%";
+        else throw new Error("Invalid size");
+    }, [size]);
+
+    const videoProps = {
+        controls: interactive
+    };
+    return <video
+        style={{
+            position: "relative",
+            objectFit: "cover",
+            width: imageSize,
+            minWidth: "140px",
+            // height: imageSize,
+            maxHeight: "100%"
+        }}
+        {...videoProps}
+        className={cls("max-w-100% rounded", { "pointer-events-none": !interactive })}>
+        <source src={src}/>
+    </video>;
+}