@firecms/core 3.0.0-beta.1 → 3.0.0-beta.10

package/src/app/Scaffold.tsx

@@ -0,0 +1,243 @@
+import React, { PropsWithChildren, useCallback } from "react";
+import { ChevronLeftIcon, cls, defaultBorderMixin, IconButton, MenuIcon, Sheet, Tooltip } from "@firecms/ui";
+import equal from "react-fast-compare"
+import { useLargeLayout } from "../hooks";
+import { ErrorBoundary } from "../components";
+import { AppContext } from "./useApp";
+
+export const DRAWER_WIDTH = 280;
+
+/**
+ * @group Core
+ */
+export interface ScaffoldProps {
+
+    /**
+     * Open the drawer on hover
+     */
+    autoOpenDrawer?: boolean;
+
+    /**
+     * Logo to be displayed in the top bar and drawer.
+     * Note that this has no effect if you are using a custom AppBar or Drawer.
+     */
+    logo?: string;
+
+    className?: string;
+
+    style?: React.CSSProperties;
+}
+
+/**
+ * This view acts as a scaffold for FireCMS.
+ *
+ * It is in charge of displaying the navigation drawer, top bar and main
+ * collection views.
+ * This component needs a parent {@link FireCMS}
+ *
+ * @param props
+
+ * @group Core
+ */
+export const Scaffold = React.memo<PropsWithChildren<ScaffoldProps>>(
+    function Scaffold(props: PropsWithChildren<ScaffoldProps>) {
+
+        const {
+            children,
+            autoOpenDrawer,
+            logo,
+            className,
+            style
+        } = props;
+
+        const drawerChildren = React.Children.toArray(children).filter((child: any) => child.type.componentType === "Drawer");
+        if (drawerChildren.length > 1) {
+            throw Error("Only one Drawer component is allowed in Scaffold");
+        }
+        const appBarChildren = React.Children.toArray(children).filter((child: any) => child.type.componentType === "AppBar");
+        if (appBarChildren.length > 1) {
+            throw Error("Only one AppBar component is allowed in Scaffold");
+        }
+        const otherChildren = React.Children.toArray(children)
+            .filter((child: any) => child.type.componentType !== "Drawer" && child.type.componentType !== "AppBar");
+        const includeDrawer = drawerChildren.length > 0;
+        const largeLayout = useLargeLayout();
+
+        const [drawerOpen, setDrawerOpen] = React.useState(false);
+        const [onHover, setOnHover] = React.useState(false);
+
+        const setOnHoverTrue = useCallback(() => setOnHover(true), []);
+        const setOnHoverFalse = useCallback(() => setOnHover(false), []);
+
+        const handleDrawerOpen = useCallback(() => {
+            setDrawerOpen(true);
+        }, []);
+
+        const handleDrawerClose = useCallback(() => {
+            setDrawerOpen(false);
+        }, []);
+
+        const computedDrawerOpen: boolean = drawerOpen || Boolean(largeLayout && autoOpenDrawer && onHover);
+
+        const hasAppBar = Boolean(appBarChildren.length > 0);
+        return (
+            <AppContext.Provider value={{
+                logo,
+                hasDrawer: includeDrawer,
+                drawerHovered: onHover,
+                drawerOpen: computedDrawerOpen,
+                closeDrawer: handleDrawerClose,
+                openDrawer: handleDrawerOpen,
+                autoOpenDrawer
+            }}>
+                <div
+                    className={cls("flex h-screen w-screen bg-gray-50 dark:bg-gray-900 text-gray-900 dark:text-white overflow-hidden", className)}
+                    style={{
+                        paddingTop: "env(safe-area-inset-top)",
+                        paddingLeft: "env(safe-area-inset-left)",
+                        paddingRight: "env(safe-area-inset-right)",
+                        paddingBottom: "env(safe-area-inset-bottom)",
+                        height: "100dvh",
+                        ...style
+                    }}>
+
+                    {appBarChildren}
+
+                    <DrawerWrapper
+                        displayed={includeDrawer}
+                        onMouseEnter={setOnHoverTrue}
+                        onMouseMove={setOnHoverTrue}
+                        onMouseLeave={setOnHoverFalse}
+                        open={computedDrawerOpen}
+                        hovered={onHover}
+                        setDrawerOpen={setDrawerOpen}>
+                        {includeDrawer && drawerChildren}
+                    </DrawerWrapper>
+
+                    <main
+                        className="flex flex-col flex-grow overflow-auto">
+                        {hasAppBar && <DrawerHeader/>}
+                        <div
+                            className={cls(defaultBorderMixin, "flex-grow overflow-auto lg:m-0 lg:mx-4 lg:mb-4 lg:rounded-lg lg:border lg:border-solid m-0 mt-1", {
+                                "lg:mt-4": !hasAppBar
+                            })}>
+
+                            <ErrorBoundary>
+                                {otherChildren}
+                            </ErrorBoundary>
+
+                        </div>
+                    </main>
+                </div>
+            </AppContext.Provider>
+        );
+    },
+    equal
+)
+
+const DrawerHeader = () => {
+    return (
+        <div className="flex flex-col min-h-16"></div>
+    );
+};
+
+function DrawerWrapper(props: {
+    children: React.ReactNode,
+    displayed: boolean,
+    open: boolean,
+    logo?: string,
+    hovered: boolean,
+    setDrawerOpen: (open: boolean) => void,
+    onMouseEnter: () => void,
+    onMouseMove: () => void,
+    onMouseLeave: () => void
+}) {
+
+    const width = !props.displayed ? 0 : (props.open ? DRAWER_WIDTH : 72);
+    const innerDrawer = <div
+        className={"relative h-full no-scrollbar overflow-y-auto overflow-x-hidden"}
+        style={{
+            width,
+            transition: "left 100ms cubic-bezier(0.4, 0, 0.6, 1) 0ms, opacity 100ms cubic-bezier(0.4, 0, 0.6, 1) 0ms, width 100ms cubic-bezier(0.4, 0, 0.6, 1) 0ms"
+        }}
+    >
+
+        {!props.open && props.displayed && (
+            <Tooltip title="Open menu"
+                     side="right"
+                     sideOffset={12}
+                     asChild={true}>
+                <div
+                    className="ml-2 fixed top-1 left-2 sm:top-2 sm:left-3 !bg-gray-50 dark:!bg-gray-900 rounded-full w-fit z-20">
+                    <IconButton
+                        color="inherit"
+                        aria-label="Open menu"
+                        onClick={() => props.setDrawerOpen(true)}
+                        size="large"
+                    >
+                        <MenuIcon/>
+                    </IconButton>
+                </div>
+            </Tooltip>
+        )}
+
+        <div
+            className={`z-20 absolute right-0 top-4 ${
+                props.open ? "opacity-100" : "opacity-0 invisible"
+            } transition-opacity duration-200 ease-in-out`}>
+            <IconButton
+                aria-label="Close drawer"
+                onClick={() => props.setDrawerOpen(false)}
+            >
+                <ChevronLeftIcon/>
+            </IconButton>
+        </div>
+
+        <div className={"flex flex-col h-full"}>
+            {props.children}
+        </div>
+
+    </div>;
+
+    const largeLayout = useLargeLayout();
+    if (!largeLayout) {
+        if (!props.displayed)
+            return null;
+        return <>
+            <IconButton
+                color="inherit"
+                aria-label="Open drawer"
+                onClick={() => props.setDrawerOpen(true)}
+                size="large"
+                className="absolute sm:top-2 sm:left-5 top-1 left-2"
+            >
+                <MenuIcon/>
+            </IconButton>
+            <Sheet side={"left"}
+                   transparent={true}
+                   open={props.open}
+                   onOpenChange={props.setDrawerOpen}
+                   title={"Navigaion drawer"}
+                   overlayClassName={"bg-white bg-opacity-80"}
+            >
+                {innerDrawer}
+            </Sheet>
+        </>;
+    }
+
+    return (
+        <div
+            className="z-20 relative"
+            onMouseEnter={props.onMouseEnter}
+            onMouseMove={props.onMouseMove}
+            onMouseLeave={props.onMouseLeave}
+            style={{
+                width,
+                transition: "left 100ms cubic-bezier(0.4, 0, 0.6, 1) 0ms, opacity 100ms cubic-bezier(0.4, 0, 0.6, 1) 0ms, width 100ms cubic-bezier(0.4, 0, 0.6, 1) 0ms"
+            }}>
+
+            {innerDrawer}
+
+        </div>
+    );
+}

package/src/app/index.ts

@@ -0,0 +1,4 @@
+export * from "./Drawer";
+export * from "./AppBar";
+export * from "./Scaffold";
+export * from "./useApp";

package/src/app/useApp.tsx

@@ -0,0 +1,32 @@
+import React from "react";
+
+/**
+ * This context represents the state of the app in terms of layout.
+ * @group Core
+ */
+export type AppState = {
+    hasDrawer: boolean,
+    drawerHovered: boolean,
+    drawerOpen: boolean,
+    openDrawer: () => void,
+    closeDrawer: () => void,
+    autoOpenDrawer?: boolean,
+    logo?: string
+}
+
+export const AppContext = React.createContext<AppState>({
+    hasDrawer: false,
+    drawerHovered: false,
+    drawerOpen: false,
+    openDrawer: () => {
+        throw new Error("openDrawer not implemented");
+    },
+    closeDrawer: () => {
+        throw new Error("closeDrawer not implemented");
+    },
+    autoOpenDrawer: false
+});
+
+export function useApp() {
+    return React.useContext(AppContext);
+}

package/src/components/ArrayContainer.tsx

@@ -3,18 +3,18 @@ import React, { useCallback, useEffect, useRef, useState } from "react";
 import { DragDropContext, Draggable, DraggableProvided, Droppable } from "@hello-pangea/dnd";
 
 import { getHashValue } from "../util";
-import useMeasure from "react-use-measure";
 import {
     AddIcon,
     Button,
     ContentCopyIcon,
     fieldBackgroundHoverMixin,
+    HandleIcon,
     IconButton,
     Menu,
     MenuItem,
-    MoreVertIcon,
     RemoveIcon,
-    Tooltip
+    Tooltip,
+    useOutsideAlerter
 } from "@firecms/ui";
 
 interface ArrayContainerProps<T> {
@@ -27,7 +27,8 @@ interface ArrayContainerProps<T> {
     onInternalIdAdded?: (id: number) => void;
     includeAddButton?: boolean;
     newDefaultEntry: T;
-    onValueChange: (value: T[]) => void
+    onValueChange: (value: T[]) => void,
+    className?: string;
 }
 
 const buildIdsMap = (value: any[]) =>
@@ -49,11 +50,12 @@ export function ArrayContainer<T>({
                                       value,
                                       disabled = false,
                                       buildEntry,
-                                      size,
+                                      size = "medium",
                                       onInternalIdAdded,
                                       includeAddButton,
                                       newDefaultEntry,
-                                      onValueChange
+                                      onValueChange,
+                                      className
                                   }: ArrayContainerProps<T>) {
 
     const hasValue = value && Array.isArray(value) && value.length > 0;
@@ -154,6 +156,7 @@ export function ArrayContainer<T>({
             >
                 {(droppableProvided, droppableSnapshot) => (
                     <div
+                        className={className}
                         {...droppableProvided.droppableProps}
                         ref={droppableProvided.innerRef}>
                         {hasValue && internalIds.map((internalId: number, index: number) => {
@@ -224,11 +227,6 @@ export function ArrayContainerItem({
                                        isDragging
                                    }: ArrayContainerItemProps) {
 
-    const [measureRef, bounds] = useMeasure();
-
-    const measuring = size !== "small" && bounds.height === 0;
-    const menuOverflow = size !== "small" && bounds.height < 100;
-
     const [onHover, setOnHover] = React.useState(false);
     const setOnHoverTrue = useCallback(() => setOnHover(true), []);
     const setOnHoverFalse = useCallback(() => setOnHover(false), []);
@@ -241,14 +239,13 @@ export function ArrayContainerItem({
         {...provided.draggableProps}
         style={provided.draggableProps.style}
         className={`${
-            (isDragging || onHover) ? fieldBackgroundHoverMixin : ""
+            (isDragging || onHover) ? "hover:bg-slate-50 dark:hover:bg-gray-800 dark:hover:bg-opacity-20" : ""
         } mb-1 rounded-md opacity-100`}
     >
         <div
             className="flex items-start">
-            <div ref={measureRef}
-                 className="flex-grow w-[calc(100%-48px)] text-text-primary dark:text-text-primary-dark"
-            >
+            <div
+                className="flex-grow w-[calc(100%-48px)] text-text-primary dark:text-text-primary-dark">
                 {buildEntry(index, internalId)}
             </div>
             <ArrayItemOptions direction={size === "small" ? "row" : "column"}
@@ -256,8 +253,6 @@ export function ArrayContainerItem({
                               remove={remove}
                               index={index}
                               provided={provided}
-                              measuring={measuring}
-                              contentOverflow={menuOverflow}
                               copy={copy}/>
         </div>
     </div>;
@@ -270,12 +265,8 @@ export function ArrayItemOptions({
                                      index,
                                      provided,
                                      copy,
-                                     contentOverflow,
-                                     measuring
                                  }: {
     direction?: "row" | "column",
-    contentOverflow: boolean,
-    measuring: boolean,
     disabled: boolean,
     remove: (index: number) => void,
     index: number,
@@ -283,77 +274,56 @@ export function ArrayItemOptions({
     copy: (index: number) => void
 }) {
 
-    return <div className={`p-1 flex ${direction === "row" ? "flex-row-reverse" : "flex-col"} items-center`}
-                {...provided.dragHandleProps}
-    >
+    const [menuOpen, setMenuOpen] = useState(false);
+
+    const iconRef = React.useRef<HTMLDivElement>(null);
+    useOutsideAlerter(iconRef, () => setMenuOpen(false));
+
+    return <div className={`pl-2 pt-1 pb-1 flex ${direction === "row" ? "flex-row-reverse" : "flex-col"} items-center`}
+                ref={iconRef}
+                {...provided.dragHandleProps}>
         <Tooltip
+            delayDuration={400}
+            open={menuOpen ? false : undefined}
             side={direction === "column" ? "left" : undefined}
-            title="Move">
+            title="Drag to move. Click for more options">
             <IconButton
                 size="small"
                 disabled={disabled}
+                onClick={(e) => {
+                    e.preventDefault();
+                    setMenuOpen(true);
+                }}
+                onDragStart={(e: any) => {
+                    setMenuOpen(false);
+                }}
                 className={`cursor-${disabled ? "inherit" : "grab"}`}>
-                {/* TODO: for some reason, the icon as a span does not work with Drag and Drop
-                */}
-                <svg focusable="false"
-                     fill={"currentColor"}
-                     aria-hidden="true" viewBox="0 0 24 24">
-                    <path d="M20 9H4v2h16V9zM4 15h16v-2H4v2z"></path>
-                </svg>
-                {/*<DragHandleIcon*/}
-                {/*    size={"small"}*/}
-                {/*    color={disabled ? "disabled" : "inherit"}/>*/}
+                <HandleIcon/>
             </IconButton>
-        </Tooltip>
-
-        {!measuring && !contentOverflow && <>
-            <Tooltip
-                title="Remove"
-                side={direction === "column" ? "left" : undefined}>
-                <IconButton
-                    size="small"
-                    aria-label="remove"
-                    disabled={disabled}
-                    onClick={() => remove(index)}>
-                    <RemoveIcon
-                        size={"small"}/>
-                </IconButton>
-            </Tooltip>
-
-            <Tooltip
-                side={direction === "column" ? "left" : undefined}
-                title="Copy in this position">
-                <IconButton
-                    size="small"
-                    aria-label="copy"
-                    disabled={disabled}
-                    onClick={() => copy(index)}>
-                    <ContentCopyIcon
-                        size={"small"}/>
-                </IconButton>
-            </Tooltip>
-        </>}
-
-        {!measuring && contentOverflow && <>
 
             <Menu
-                trigger={<IconButton size={"small"}>
-                    <MoreVertIcon
-                        size={"small"}/>
-                </IconButton>}
-            >
-
-                <MenuItem dense onClick={() => remove(index)}>
+                portalContainer={iconRef.current}
+                open={menuOpen}
+                trigger={<div tabIndex={-1}/>}>
+
+                <MenuItem dense onClick={(e) => {
+                    setMenuOpen(false);
+                    remove(index);
+                }}>
                     <RemoveIcon size={"small"}/>
                     Remove
                 </MenuItem>
-                <MenuItem dense onClick={() => copy(index)}>
+                <MenuItem dense onClick={() => {
+                    setMenuOpen(false);
+                    copy(index);
+                }}>
                     <ContentCopyIcon size={"small"}/>
                     Copy
                 </MenuItem>
 
             </Menu>
-        </>}
+        </Tooltip>
+
     </div>;
 }
 

package/src/components/CircularProgressCenter.tsx

@@ -5,7 +5,7 @@ import { CircularProgress, CircularProgressProps, Typography } from "@firecms/ui
  *
  * @param text
  * @param props
- * @constructor
+
  * @ignore
  */
 export function CircularProgressCenter({ text, ...props }: CircularProgressProps & {

package/src/components/ClearFilterSortButton.tsx

@@ -0,0 +1,41 @@
+import { Button, FilterListOffIcon } from "@firecms/ui";
+import { EntityTableController } from "../types";
+
+export function ClearFilterSortButton({
+                                          tableController,
+                                          enabled
+                                      }: {
+    enabled: boolean;
+    tableController: EntityTableController
+}) {
+    if (!enabled) {
+        return null;
+    }
+
+    const filterIsSet = !!tableController.filterValues && Object.keys(tableController.filterValues).length > 0;
+    const sortIsSet = !!tableController.sortBy && tableController.sortBy.length > 0;
+
+    if ((filterIsSet || sortIsSet) && (tableController.clearFilter || tableController.setSortBy)) {
+        let label;
+        if (filterIsSet && sortIsSet) {
+            label = "Clear filter and sort";
+        } else if (filterIsSet) {
+            label = "Clear filter";
+        } else {
+            label = "Clear sort";
+        }
+        return <Button
+            variant={"outlined"}
+            className="h-fit-content"
+            aria-label="filter clear"
+            onClick={() => {
+                tableController.clearFilter?.();
+                tableController.setSortBy?.(undefined);
+            }}
+            size={"small"}>
+            <FilterListOffIcon/>
+            {label}
+        </Button>
+    }
+    return null;
+}

package/src/components/{DeleteConfirmationDialog.tsx → ConfirmationDialog.tsx}

@@ -2,7 +2,7 @@ import React from "react";
 
 import { Button, Dialog, DialogActions, DialogContent, LoadingButton, Typography } from "@firecms/ui";
 
-export function DeleteConfirmationDialog({
+export function ConfirmationDialog({
                                              open,
                                              onAccept,
                                              onCancel,

package/src/components/DeleteEntityDialog.tsx

@@ -9,7 +9,7 @@ import {
     useSnackbarController
 } from "../hooks";
 import { resolveCollection } from "../util";
-import { EntityPreview } from "./EntityPreview";
+import { EntityView } from "./EntityView";
 
 export interface DeleteEntityDialogProps<M extends Record<string, any>> {
     entityOrEntitiesToDelete?: Entity<M> | Entity<M>[],
@@ -35,7 +35,7 @@ export function DeleteEntityDialog<M extends Record<string, any>>({
                                                                       path
                                                                   }: DeleteEntityDialogProps<M>) {
 
-    const dataSource = useDataSource();
+    const dataSource = useDataSource(collection);
     const customizationController = useCustomizationController();
     const snackbarController = useSnackbarController();
     const [loading, setLoading] = useState(false);
@@ -163,7 +163,7 @@ export function DeleteEntityDialog<M extends Record<string, any>>({
     } else {
         const entity = entityOrEntities as Entity<M> | undefined;
         content = entity
-            ? <EntityPreview
+            ? <EntityView
                 entity={entity}
                 collection={collection}
                 path={path}/>
@@ -176,7 +176,7 @@ export function DeleteEntityDialog<M extends Record<string, any>>({
 
     return (
         <Dialog
-            maxWidth={"2xl"}
+            maxWidth={multipleEntities ? "lg" : "2xl"}
             aria-labelledby="delete-dialog"
             open={open}
             onOpenChange={(open) => !open ? onClose() : undefined}