@firecms/core 3.0.0-canary.61 → 3.0.0-canary.63

package/dist/app/AppBar.d.ts

@@ -0,0 +1,12 @@
+import { DefaultAppBarProps } from "../core/DefaultAppBar";
+/**
+ * This component renders the main app bar of FireCMS.
+ */
+export declare function AppBar({ children, ...props }: {
+    children?: React.ReactNode;
+    className?: string;
+    style?: React.CSSProperties;
+} & DefaultAppBarProps): import("react/jsx-runtime").JSX.Element;
+export declare namespace AppBar {
+    var componentType: string;
+}

package/dist/app/Drawer.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This component is in charge of rendering the drawer.
+ * If you add this component under your {@link Scaffold}, it will be rendered
+ * as a drawer, and the open and close functionality will be handled automatically.
+ * If you want to customise the drawer, you can create your own component and pass it as a child.
+ * For custom drawers, you can use the {@link useApp} to open and close the drawer.
+ *
+ * @constructor
+ */
+export declare function Drawer({ children, className, style }: {
+    children?: React.ReactNode;
+    className?: string;
+    style?: React.CSSProperties;
+}): import("react/jsx-runtime").JSX.Element;
+export declare namespace Drawer {
+    var componentType: string;
+}

package/dist/app/Scaffold.d.ts

@@ -0,0 +1,30 @@
+import React from "react";
+export declare 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
+ * @constructor
+ * @group Core
+ */
+export declare const Scaffold: React.NamedExoticComponent<React.PropsWithChildren<ScaffoldProps>>;

package/dist/app/index.d.ts

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

package/dist/app/useApp.d.ts

@@ -0,0 +1,16 @@
+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 declare const AppContext: React.Context<AppState>;
+export declare function useApp(): AppState;

package/dist/components/index.d.ts

@@ -19,7 +19,7 @@ export * from "./VirtualTable";
 export * from "./ErrorBoundary";
 export * from "./DeleteConfirmationDialog";
 export * from "./FireCMSLogo";
-export * from "./FireCMSAppBar";
+export * from "../core/DefaultAppBar";
 export * from "./ArrayContainer";
 export * from "./ReferenceWidget";
 export * from "./SearchIconsView";

package/dist/{components/FireCMSAppBar.d.ts → core/DefaultAppBar.d.ts}

@@ -1,6 +1,6 @@
 import React from "react";
 import { User } from "../types";
-export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
+export type DefaultAppBarProps<ADDITIONAL_PROPS = object> = {
     title?: React.ReactNode;
     /**
      * A component that gets rendered on the upper side of the main toolbar
@@ -8,9 +8,7 @@ export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
     endAdornment?: React.ReactNode;
     startAdornment?: React.ReactNode;
     dropDownActions?: React.ReactNode;
-    includeDrawer?: boolean;
     includeModeToggle?: boolean;
-    drawerOpen: boolean;
     className?: string;
     style?: React.CSSProperties;
     logo?: string;
@@ -20,9 +18,6 @@ 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 declare const FireCMSAppBar: ({ title, endAdornment, startAdornment, drawerOpen, dropDownActions, includeDrawer, includeModeToggle, className, style, logo, user: userProp }: FireCMSAppBarProps) => import("react/jsx-runtime").JSX.Element;
+export declare const DefaultAppBar: ({ title, endAdornment, startAdornment, dropDownActions, includeModeToggle, className, style, user: userProp }: DefaultAppBarProps) => import("react/jsx-runtime").JSX.Element;

package/dist/core/DefaultDrawer.d.ts

@@ -0,0 +1,19 @@
+import React from "react";
+/**
+ * Default drawer used in the CMS
+ * @group Core
+ */
+export declare function DefaultDrawer({ className, style, }: {
+    className?: string;
+    style?: React.CSSProperties;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * This is the logo displayed in the drawer
+ * It expands when the drawer is open.
+ *
+ * @param logo
+ * @constructor
+ */
+export declare function DrawerLogo({ logo }: {
+    logo?: string;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/core/NavigationRoutes.d.ts

@@ -7,7 +7,7 @@ export type NavigationRoutesProps = {
      * In case you need to override the home page
      */
     homePage?: React.ReactNode;
-    customRoutes?: React.ReactNode[];
+    children?: React.ReactNode | React.ReactNode[];
 };
 /**
  * This component is in charge of rendering

package/dist/core/index.d.ts

@@ -1,6 +1,6 @@
 export * from "./FireCMS";
-export * from "./Scaffold";
-export * from "./Drawer";
+export * from "../app/Scaffold";
+export * from "./DefaultDrawer";
 export * from "./DrawerNavigationItem";
 export * from "./field_configs";
 export * from "./SideDialogs";

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./core";
+export * from "./app";
 export * from "./types";
 export * from "./form";
 export * from "./preview";