@firecms/core 3.0.0-beta.6 → 3.0.0-beta.8

package/src/components/common/useTableSearchHelper.ts

@@ -1,7 +1,7 @@
 import { useState } from "react";
 
 import { EntityCollection } from "../../types";
-import { useCustomizationController, useFireCMSContext } from "../../hooks";
+import { useCustomizationController, useDataSource, useFireCMSContext } from "../../hooks";
 
 export interface UseTableSearchHelperParams<M extends Record<string, any>> {
     collection: EntityCollection<M>;
@@ -9,27 +9,57 @@ export interface UseTableSearchHelperParams<M extends Record<string, any>> {
     parentCollectionIds?: string[];
 }
 
-export function useTableSearchHelper<M extends Record<string, any>>({ collection, fullPath, parentCollectionIds }: UseTableSearchHelperParams<M>) {
+export function useTableSearchHelper<M extends Record<string, any>>({
+                                                                        collection,
+                                                                        fullPath,
+                                                                        parentCollectionIds
+                                                                    }: UseTableSearchHelperParams<M>) {
 
     const context = useFireCMSContext();
     const customizationController = useCustomizationController();
+    const dataSource = useDataSource();
 
     const [textSearchLoading, setTextSearchLoading] = useState<boolean>(false);
     const [textSearchInitialised, setTextSearchInitialised] = useState<boolean>(false);
+
     let onTextSearchClick: (() => void) | undefined;
     let textSearchEnabled = Boolean(collection.textSearchEnabled);
-    if (customizationController?.plugins) {
-        const addTextSearchClickListener = customizationController.plugins?.find(p => Boolean(p.collectionView?.onTextSearchClick));
+
+    const props = {
+        context,
+        path: fullPath,
+        collection,
+        parentCollectionIds
+    };
+
+    const searchBlocked = customizationController.plugins?.find(p => {
+        return p.collectionView?.blockSearch?.(props);
+    });
+
+    const addTextSearchClickListener = Boolean(dataSource?.initTextSearch) || customizationController.plugins?.find(p => Boolean(p.collectionView?.onTextSearchClick));
+
+    if (addTextSearchClickListener) {
 
         onTextSearchClick = addTextSearchClickListener
             ? () => {
                 setTextSearchLoading(true);
-                Promise.all(customizationController.plugins?.map(p => {
-                    if (p.collectionView?.onTextSearchClick)
-                        return p.collectionView.onTextSearchClick({ context, path: fullPath, collection, parentCollectionIds });
-                    return Promise.resolve(true);
-                }) as Promise<boolean>[])
-                    .then((res) => {
+                const promises: Promise<boolean>[] = [];
+                if (dataSource?.initTextSearch && !searchBlocked) {
+                    promises.push(dataSource.initTextSearch(props));
+                }
+                if (searchBlocked) {
+                    customizationController.plugins?.forEach(p => {
+                        if (p.collectionView?.onTextSearchClick)
+                            promises.push(p.collectionView.onTextSearchClick({
+                                context,
+                                path: fullPath,
+                                collection,
+                                parentCollectionIds
+                            }));
+                    })
+                }
+                return Promise.all(promises)
+                    .then((res: boolean[]) => {
                         if (res.every(Boolean)) setTextSearchInitialised(true);
                     })
                     .finally(() => setTextSearchLoading(false));
@@ -39,9 +69,19 @@ export function useTableSearchHelper<M extends Record<string, any>>({ collection
         customizationController.plugins?.forEach(p => {
             if (!textSearchEnabled)
                 if (p.collectionView?.showTextSearchBar) {
-                    textSearchEnabled = p.collectionView.showTextSearchBar({ context, path: fullPath, collection, parentCollectionIds });
+                    textSearchEnabled = p.collectionView.showTextSearchBar({
+                        context,
+                        path: fullPath,
+                        collection,
+                        parentCollectionIds
+                    });
                 }
         })
     }
-    return { textSearchLoading, textSearchInitialised, onTextSearchClick, textSearchEnabled };
+    return {
+        textSearchLoading,
+        textSearchInitialised,
+        onTextSearchClick,
+        textSearchEnabled
+    };
 }

package/src/components/index.tsx

@@ -13,6 +13,7 @@ export * from "./common";
 
 export * from "./HomePage";
 export * from "./SelectableTable/SelectableTable";
+export * from "./SelectableTable/SelectableTableContext";
 export * from "./EntityCollectionView/EntityCollectionView";
 export * from "./EntityCollectionView/EntityCollectionViewActions";
 export * from "./EntityCollectionView/useSelectionController";
@@ -28,7 +29,7 @@ export * from "./DeleteConfirmationDialog";
 
 export * from "./FireCMSLogo";
 
-export * from "./FireCMSAppBar";
+export * from "../core/DefaultAppBar";
 
 export * from "./ArrayContainer";
 export * from "./ReferenceWidget";

package/src/contexts/DialogsProvider.tsx

@@ -18,14 +18,14 @@ export const DialogsProvider: React.FC<PropsWithChildren<{}>> = ({ children }) =
         if (dialogEntries.length === 0)
             return;
 
-        const updatedPanels = [...dialogEntries.slice(0, -1)];
+        const updatedPanels = [...dialogEntriesRef.current.slice(0, -1)];
         updateDialogEntries(updatedPanels);
 
     }, [dialogEntries]);
 
     const open = useCallback((dialogEntry: DialogControllerEntryProps) => {
 
-        const updatedPanels = [...dialogEntries, dialogEntry];
+        const updatedPanels = [...dialogEntriesRef.current, dialogEntry];
         updateDialogEntries(updatedPanels);
 
         return {

package/src/{components/FireCMSAppBar.tsx → core/DefaultAppBar.tsx}

@@ -1,10 +1,10 @@
 import React from "react";
 
-import { Link as ReactLink } from "react-router-dom";
-import { ErrorBoundary } from "../components";
+import { Link as ReactLink, useNavigate } from "react-router-dom";
+import { ErrorBoundary, FireCMSLogo } from "../components";
 import {
     Avatar,
-    cn,
+    cls,
     DarkModeIcon,
     IconButton,
     LightModeIcon,
@@ -16,9 +16,11 @@ import {
 } from "@firecms/ui";
 import { useAuthController, useLargeLayout, useModeController, useNavigationController } from "../hooks";
 import { User } from "../types";
+import { useApp } from "../app/useApp";
 
-export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
-    title: string;
+export type DefaultAppBarProps<ADDITIONAL_PROPS = object> = {
+
+    title?: React.ReactNode;
     /**
      * A component that gets rendered on the upper side of the main toolbar
      */
@@ -28,14 +30,14 @@ export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
 
     dropDownActions?: React.ReactNode;
 
-    includeDrawer?: boolean;
-
-    drawerOpen: boolean;
+    includeModeToggle?: boolean;
 
     className?: string;
 
     style?: React.CSSProperties;
 
+    logo?: string;
+
     user?: User;
 } & ADDITIONAL_PROPS;
 
@@ -43,22 +45,24 @@ export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
  * This component renders the main app bar of FireCMS.
  * You will likely not need to use this component directly.
  *
- * @param title
- * @param toolbarExtraWidget
- * @param drawerOpen
  * @constructor
  */
-export const FireCMSAppBar = function FireCMSAppBar({
+export const DefaultAppBar = function DefaultAppBar({
                                                         title,
                                                         endAdornment,
                                                         startAdornment,
-                                                        drawerOpen,
                                                         dropDownActions,
-                                                        includeDrawer,
+                                                        includeModeToggle = true,
                                                         className,
                                                         style,
                                                         user: userProp
-                                                    }: FireCMSAppBarProps) {
+                                                    }: DefaultAppBarProps) {
+
+    const {
+        hasDrawer,
+        drawerOpen,
+        logo
+    } = useApp();
     const navigation = useNavigationController();
 
     const authController = useAuthController();
@@ -67,6 +71,8 @@ export const FireCMSAppBar = function FireCMSAppBar({
         toggleMode
     } = useModeController();
 
+    const navigate = useNavigate();
+
     const largeLayout = useLargeLayout();
 
     const user = userProp ?? authController.user;
@@ -89,40 +95,45 @@ export const FireCMSAppBar = function FireCMSAppBar({
     return (
         <div
             style={style}
-            className={cn("pr-2",
+            className={cls("pr-2 w-full h-16 transition-all ease-in duration-75 fixed",
                 {
-                    "ml-[17rem]": drawerOpen && largeLayout,
-                    "ml-16": includeDrawer && !(drawerOpen && largeLayout) && !startAdornment,
-                    "h-16": true,
+                    "pl-[17rem]": drawerOpen && largeLayout,
+                    "pl-20": hasDrawer && !(drawerOpen && largeLayout),
                     "z-10": largeLayout,
-                    "transition-all": true,
-                    "ease-in": true,
-                    "duration-75": true,
-                    "w-full": !includeDrawer,
-                    "w-[calc(100%-64px)]": includeDrawer && !(drawerOpen && largeLayout),
-                    "w-[calc(100%-17rem)]": includeDrawer && (drawerOpen && largeLayout),
+                    // "w-full": !hasDrawer,
+                    // "w-[calc(100%-64px)]": hasDrawer && !(drawerOpen && largeLayout),
+                    // "w-[calc(100%-17rem)]": hasDrawer && (drawerOpen && largeLayout),
                     "duration-150": drawerOpen && largeLayout,
-                    fixed: true,
                 },
                 className)}>
 
             <div className="flex flex-row gap-2 px-4 h-full items-center">
 
-                {startAdornment}
-
                 {navigation && <div className="mr-8 hidden lg:block">
                     <ReactLink
                         className="visited:text-inherit visited:dark:text-inherit"
                         to={navigation?.basePath ?? "/"}
                     >
-                        <Typography variant="subtitle1"
-                                    noWrap
-                                    className={"ml-2 !font-medium"}>
-                            {title}
-                        </Typography>
+                        <div className={"flex flex-row gap-4"}>
+                            {!hasDrawer && (logo
+                                ? <img src={logo}
+                                       alt="Logo"
+                                       className={cls("w-[32px] h-[32px] object-contain")}/>
+                                : <FireCMSLogo width={"32px"} height={"32px"}/>)}
+
+                            {typeof title === "string"
+                                ? <Typography variant="subtitle1"
+                                              noWrap
+                                              className={"ml-2 !font-medium"}>
+                                    {title}
+                                </Typography>
+                                : title}
+                        </div>
                     </ReactLink>
                 </div>}
 
+                {startAdornment}
+
                 <div className={"flex-grow"}/>
 
                 {endAdornment &&
@@ -130,7 +141,7 @@ export const FireCMSAppBar = function FireCMSAppBar({
                         {endAdornment}
                     </ErrorBoundary>}
 
-                <IconButton
+                {includeModeToggle && <IconButton
                     color="inherit"
                     aria-label="Open drawer"
                     onClick={toggleMode}
@@ -138,7 +149,7 @@ export const FireCMSAppBar = function FireCMSAppBar({
                     {mode === "dark"
                         ? <DarkModeIcon/>
                         : <LightModeIcon/>}
-                </IconButton>
+                </IconButton>}
 
                 <Menu trigger={avatarComponent}>
                     {user && <div className={"px-4 py-2 mb-2"}>
@@ -152,7 +163,11 @@ export const FireCMSAppBar = function FireCMSAppBar({
 
                     {dropDownActions}
 
-                    {!dropDownActions && <MenuItem onClick={authController.signOut}>
+                    {!dropDownActions && <MenuItem onClick={async () => {
+                        await authController.signOut();
+                        // replace current route with home
+                        navigate("/");
+                    }}>
                         <LogoutIcon/>
                         Log Out
                     </MenuItem>}

package/src/core/DefaultDrawer.tsx

@@ -0,0 +1,177 @@
+import React, { useCallback } from "react";
+
+import { useLargeLayout, useNavigationController } from "../hooks";
+
+import { Link, useNavigate } from "react-router-dom";
+import { CMSAnalyticsEvent, TopNavigationEntry, TopNavigationResult } from "../types";
+import { IconForView } from "../util";
+import { cls, IconButton, Menu, MenuItem, MoreVertIcon, Tooltip, Typography } from "@firecms/ui";
+import { useAnalyticsController } from "../hooks/useAnalyticsController";
+import { DrawerNavigationItem } from "./DrawerNavigationItem";
+import { FireCMSLogo } from "../components";
+import { useApp } from "../app/useApp";
+
+/**
+ * Default drawer used in the CMS
+ * @group Core
+ */
+export function DefaultDrawer({
+                                  className,
+                                  style,
+                              }: {
+    className?: string
+    style?: React.CSSProperties,
+}) {
+
+    const {
+        drawerHovered,
+        drawerOpen,
+        closeDrawer,
+        logo
+    } = useApp();
+
+    const analyticsController = useAnalyticsController();
+    const navigation = useNavigationController();
+
+    const tooltipsOpen = drawerHovered && !drawerOpen;
+    const largeLayout = useLargeLayout();
+    const navigate = useNavigate();
+
+    const [adminMenuOpen, setAdminMenuOpen] = React.useState(false);
+
+    if (!navigation.topLevelNavigation)
+        throw Error("Navigation not ready in Drawer");
+
+    const {
+        navigationEntries,
+        groups
+    }: TopNavigationResult = navigation.topLevelNavigation;
+
+    const adminViews = navigationEntries.filter(e => e.type === "admin") ?? [];
+    const groupsWithoutAdmin = groups.filter(g => g !== "Admin");
+
+    const buildGroupHeader = useCallback((group?: string) => {
+        if (!drawerOpen) return <div className="h-12 w-full"/>;
+        return <div
+            className="pt-8 pl-6 pr-8 pb-2 flex flex-row items-center">
+            <Typography variant={"caption"}
+                        color={"secondary"}
+                        className="font-medium flex-grow line-clamp-1">
+                {group ? group.toUpperCase() : "Views".toUpperCase()}
+            </Typography>
+
+        </div>;
+    }, [drawerOpen]);
+
+    const onClick = (view: TopNavigationEntry) => {
+        const eventName: CMSAnalyticsEvent = view.type === "collection"
+            ? "drawer_navigate_to_collection"
+            : (view.type === "view" ? "drawer_navigate_to_view" : "unmapped_event");
+        analyticsController.onAnalyticsEvent?.(eventName, { url: view.url });
+        if (!largeLayout)
+            closeDrawer();
+    };
+
+    return (
+        <>
+            <div className={cls("flex flex-col h-full relative flex-grow w-full", className)} style={style}>
+
+                <DrawerLogo logo={logo}/>
+
+                <div className={"overflow-scroll no-scrollbar"}>
+
+                    {groupsWithoutAdmin.map((group) => (
+                        <React.Fragment
+                            key={`drawer_group_${group}`}>
+                            {buildGroupHeader(group)}
+                            {Object.values(navigationEntries)
+                                .filter(e => e.group === group)
+                                .map((view, index) =>
+                                    <DrawerNavigationItem
+                                        key={`navigation_${index}`}
+                                        icon={<IconForView collectionOrView={view.collection ?? view.view}/>}
+                                        tooltipsOpen={tooltipsOpen}
+                                        drawerOpen={drawerOpen}
+                                        onClick={() => onClick(view)}
+                                        url={view.url}
+                                        name={view.name}/>)}
+                        </React.Fragment>
+                    ))}
+
+                </div>
+
+                {adminViews.length > 0 && <Menu
+                    open={adminMenuOpen}
+                    onOpenChange={setAdminMenuOpen}
+                    trigger={
+                        <IconButton
+                            shape={"square"}
+                            className={"m-4 text-gray-900 dark:text-white w-fit"}>
+                            <Tooltip title={"Admin"}
+                                     open={tooltipsOpen}
+                                     side={"right"} sideOffset={28}>
+                                <MoreVertIcon/>
+                            </Tooltip>
+                            {drawerOpen && <div
+                                className={cls(
+                                    drawerOpen ? "opacity-100" : "opacity-0 hidden",
+                                    "mx-4 font-inherit text-inherit"
+                                )}>
+                                ADMIN
+                            </div>}
+                        </IconButton>}
+                >
+                    {adminViews.map((entry, index) =>
+                        <MenuItem
+                            onClick={(event) => {
+                                event.preventDefault();
+                                navigate(entry.path);
+                            }}
+                            key={`navigation_${index}`}>
+                            {<IconForView collectionOrView={entry.view}/>}
+                            {entry.name}
+                        </MenuItem>)}
+
+                </Menu>}
+            </div>
+
+        </>
+    );
+}
+
+/**
+ * This is the logo displayed in the drawer
+ * It expands when the drawer is open.
+ *
+ * @param logo
+ * @constructor
+ */
+export function DrawerLogo({ logo }: {
+    logo?: string;
+}) {
+
+    const navigation = useNavigationController();
+    const { drawerOpen } = useApp();
+    return <div
+        style={{
+            transition: "padding 100ms cubic-bezier(0.4, 0, 0.6, 1) 0ms",
+            padding: drawerOpen ? "32px 144px 0px 24px" : "72px 16px 0px"
+        }}
+        className={cls("cursor-pointer")}>
+
+        <Tooltip title={"Home"}
+                 sideOffset={20}
+                 side="right">
+            <Link
+                to={navigation.basePath}>
+                {logo
+                    ? <img src={logo}
+                           alt="Logo"
+                           className={cls("max-w-full max-h-full",
+                               drawerOpen ?? "w-[112px] h-[112px]")}/>
+                    : <FireCMSLogo/>}
+
+            </Link>
+        </Tooltip>
+    </div>;
+}

package/src/core/DrawerNavigationItem.tsx

@@ -0,0 +1,62 @@
+import React from "react";
+
+import { NavLink } from "react-router-dom";
+import { cls, Tooltip } from "@firecms/ui";
+
+export function DrawerNavigationItem({
+                                         name,
+                                         icon,
+                                         drawerOpen,
+                                         tooltipsOpen,
+                                         url,
+                                         onClick
+                                     }: {
+    icon: React.ReactElement,
+    name: string,
+    tooltipsOpen: boolean,
+    drawerOpen: boolean,
+    url: string,
+    onClick?: () => void,
+}) {
+
+    const iconWrap = <div
+        className={"text-gray-600 dark:text-gray-500"}>
+        {icon}
+    </div>;
+
+    const listItem = <NavLink
+        onClick={onClick}
+        style={{
+            width: !drawerOpen ? "72px" : "280px",
+            transition: drawerOpen ? "width 150ms ease-in" : undefined
+        }}
+        className={({ isActive }: any) => cls("rounded-r-lg truncate",
+            "hover:bg-slate-300 hover:bg-opacity-75 dark:hover:bg-gray-700 dark:hover:bg-opacity-75 text-gray-800 dark:text-gray-200 hover:text-gray-900 hover:dark:text-white",
+            "flex flex-row items-center mr-8",
+            // "transition-all ease-in-out delay-100 duration-300",
+            // drawerOpen ? "w-full" : "w-18",
+            drawerOpen ? "pl-8 h-12" : "pl-6 h-11",
+            "font-medium text-sm",
+            isActive ? "bg-slate-200 bg-opacity-60 dark:bg-gray-800 dark:bg-opacity-30" : ""
+        )}
+        to={url}
+    >
+
+        {iconWrap}
+
+        <div
+            className={cls(
+                drawerOpen ? "opacity-100" : "opacity-0 hidden",
+                "ml-4 font-inherit text-inherit"
+            )}>
+            {name.toUpperCase()}
+        </div>
+    </NavLink>;
+
+    return <Tooltip
+        open={drawerOpen ? false : tooltipsOpen}
+        side="right"
+        title={name}>
+        {listItem}
+    </Tooltip>;
+}