@brainfish-ai/components 0.20.3 → 0.20.5

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import * as AlertDialogPrimitive from '@radix-ui/react-alert-dialog';
 import { ClassProp } from 'class-variance-authority/types';
 import * as CollapsiblePrimitive from '@radix-ui/react-collapsible';
 import { ColumnDef } from '@tanstack/react-table';
+import { ComponentProps } from 'react';
 import { DayPicker } from 'react-day-picker';
 import { default as default_2 } from 'react';
 import * as DialogPrimitive from '@radix-ui/react-dialog';
@@ -35,18 +36,59 @@ export declare function AccordionItem({ className, ...props }: React_2.Component
 
 export declare function AccordionTrigger({ className, children, ...props }: React_2.ComponentProps<typeof AccordionPrimitive.Trigger>): React_2.JSX.Element;
 
-export declare type AccountDropdownItem = {
+export declare type AccountDropdownActionItem = {
+    type?: 'action';
     id: string;
     label: string;
+    icon?: React_2.ReactNode;
     onClick: () => void;
 };
 
+export declare type AccountDropdownItem = AccountDropdownActionItem | AccountDropdownSubmenuItem;
+
 declare interface AccountDropdownProps extends React_2.ComponentPropsWithoutRef<typeof DropdownMenu> {
     accountPhoto: string;
     accountName: string;
     accountDropdownItems: AccountDropdownItem[];
+    /** Side the dropdown opens on relative to the trigger. Defaults to 'bottom'. */
+    side?: React_2.ComponentPropsWithoutRef<typeof DropdownMenuContent>['side'];
+    /** Alignment of the dropdown relative to the trigger. Defaults to 'end'. */
+    align?: React_2.ComponentPropsWithoutRef<typeof DropdownMenuContent>['align'];
 }
 
+/** Sub-option with a required `value`, used in radio-mode submenus. */
+export declare type AccountDropdownRadioSubOption = Omit<AccountDropdownSubOption, 'value' | 'onClick'> & {
+    value: string;
+};
+
+declare type AccountDropdownSubmenuBase = {
+    type: 'submenu';
+    id: string;
+    label: string;
+    icon?: React_2.ReactNode;
+};
+
+export declare type AccountDropdownSubmenuItem = AccountDropdownSubmenuBase & ({
+    /** The currently selected value. When provided with onValueChange, renders items as a radio group with selection indicators. */
+    value: string;
+    onValueChange: (value: string) => void;
+    items: AccountDropdownRadioSubOption[];
+} | {
+    value?: never;
+    onValueChange?: never;
+    items: AccountDropdownSubOption[];
+});
+
+export declare type AccountDropdownSubOption = {
+    id: string;
+    label: string;
+    icon?: React_2.ReactNode;
+    /** Required for radio mode. */
+    value?: string;
+    /** Used in plain (non-radio) mode. */
+    onClick?: () => void;
+};
+
 declare type Action = {
     id: string;
     type: ActionType;
@@ -285,6 +327,14 @@ export declare const badgeVariants: (props?: ({
     variant?: "default" | "disabled" | "destructive" | "success" | "warning" | null | undefined;
 } & ClassProp) | undefined) => string;
 
+declare function Body_2({ children }: {
+    children?: default_2.ReactNode;
+}): default_2.JSX.Element;
+
+declare namespace Body_2 {
+    var displayName: string;
+}
+
 export declare const BrainfishColors: {
     primary: {
         100: string;
@@ -758,6 +808,17 @@ declare type CompleteAnswer = {
     };
 };
 
+declare namespace Compounds {
+    export {
+        MainArea,
+        Body_2 as Body,
+        Header,
+        LeftSidebar,
+        Main,
+        RightSidebar
+    }
+}
+
 export declare function DataTable<TData extends Record<string, any> & {
     id?: string | number;
 }, TValue>({ columns, data, getRowCanExpand, className, expandeRowClassName, isLoading, skeletonRowCount, ...props }: DataTableProps<TData, TValue>): default_2.JSX.Element;
@@ -1028,6 +1089,89 @@ export declare const formatFileSize: (bytes: number) => string;
 
 export declare const FormattedMessage: FC<Props>;
 
+export declare const FullLayout: default_2.NamedExoticComponent<FullLayoutRootProps> & {
+    readonly type: typeof FullLayoutRoot;
+} & {
+    MainArea: typeof Compounds.MainArea;
+    Body: typeof Compounds.Body;
+    Header: typeof Compounds.Header;
+    LeftSidebar: typeof Compounds.LeftSidebar;
+    Main: typeof Compounds.Main;
+    RightSidebar: typeof Compounds.RightSidebar;
+};
+
+export declare interface FullLayoutContextValue {
+    isSideNavOpen: boolean;
+    isRightSidebarOpen: boolean;
+    toggleSidebar: () => void;
+    openRightSidebar: () => void;
+    closeRightSidebar: () => void;
+    toggleRightSidebar: () => void;
+    showSidenav: () => void;
+    disableLeftSideNav: boolean;
+    leftNavWidth: number;
+    isMobile: boolean;
+    sideNavRef: default_2.RefObject<HTMLDivElement | null>;
+    rightSidebarRef: default_2.RefObject<HTMLElement | null>;
+    sidebarToggleRef: default_2.RefObject<HTMLButtonElement | null>;
+    handleResizeStart: (e: default_2.MouseEvent) => void;
+    handleResizeKeyDown: (e: default_2.KeyboardEvent) => void;
+    ariaValuenow: number;
+    ariaValuemin: number;
+    ariaValuemax: number;
+}
+
+export declare const FullLayoutHeader: default_2.ForwardRefExoticComponent<FullLayoutHeaderProps & default_2.RefAttributes<HTMLElement>>;
+
+export declare interface FullLayoutHeaderProps extends default_2.ComponentPropsWithoutRef<'header'> {
+    onOpenLeft?: () => void;
+    onOpenRight?: () => void;
+}
+
+export declare const FullLayoutLeftSidebar: default_2.ForwardRefExoticComponent<FullLayoutLeftSidebarProps & default_2.RefAttributes<HTMLDivElement>>;
+
+export declare interface FullLayoutLeftSidebarProps extends Omit<default_2.ComponentPropsWithoutRef<'div'>, 'children'> {
+    open: boolean;
+    widthPx: number;
+    onResizeStart: (e: default_2.MouseEvent) => void;
+    onResizeKeyDown: (e: default_2.KeyboardEvent) => void;
+    ariaValuenow: number;
+    ariaValuemin: number;
+    ariaValuemax: number;
+    sidebarProps: ComponentProps<typeof Sidebar>;
+}
+
+/** Nav state derived from route (e.g. active ids). Provided by Platform; when null, layout uses props only. */
+export declare interface FullLayoutNavState {
+    appNavActiveId?: string;
+    sectionNavActiveId?: string;
+    activeArticleId?: string;
+}
+
+export declare const FullLayoutNavStateContext: default_2.Context<FullLayoutNavState | null>;
+
+export declare function FullLayoutProvider({ value, children }: FullLayoutProviderProps): default_2.JSX.Element;
+
+declare interface FullLayoutProviderProps {
+    value: FullLayoutContextValue;
+    children: default_2.ReactNode;
+}
+
+export declare const FullLayoutRightSidebar: default_2.ForwardRefExoticComponent<FullLayoutRightSidebarProps & default_2.RefAttributes<HTMLElement>>;
+
+export declare interface FullLayoutRightSidebarProps extends Omit<default_2.ComponentPropsWithoutRef<'aside'>, 'children'> {
+    open: boolean;
+    children: default_2.ReactNode;
+}
+
+declare function FullLayoutRoot({ children, disableLeftSideNav, className }: FullLayoutRootProps): default_2.JSX.Element;
+
+export declare interface FullLayoutRootProps {
+    children?: default_2.ReactNode;
+    disableLeftSideNav?: boolean;
+    className?: string;
+}
+
 declare type GetActionInputs = {
     type: typeof AnswersActions.GET_ACTION_INPUTS;
     payload: {
@@ -1046,6 +1190,12 @@ declare type GetActionInputs = {
  */
 export declare const getCachedFonts: () => FontOption[] | null;
 
+declare function Header(props: ComponentProps<typeof HeaderNav>): default_2.JSX.Element | null;
+
+declare namespace Header {
+    var displayName: string;
+}
+
 export declare const HEADER_NAV_HEIGHT = 60;
 
 export declare const HeaderNav: React_2.ForwardRefExoticComponent<HeaderNavProps & React_2.RefAttributes<HTMLElement>>;
@@ -1155,6 +1305,12 @@ declare type JSONSchema<T> = JSONSchemaType<T>;
 
 export declare const Label: React_2.ForwardRefExoticComponent<Omit<LabelPrimitive.LabelProps & React_2.RefAttributes<HTMLLabelElement>, "ref"> & VariantProps<(props?: ClassProp | undefined) => string> & React_2.RefAttributes<HTMLLabelElement>>;
 
+declare function LeftSidebar(props: ComponentProps<typeof Sidebar>): default_2.JSX.Element | null;
+
+declare namespace LeftSidebar {
+    var displayName: string;
+}
+
 /**
  * Load a Google Font stylesheet dynamically
  */
@@ -1171,6 +1327,22 @@ export declare interface LogoProps extends React_2.SVGProps<SVGSVGElement> {
 
 export declare type LogoVariant = 'mark' | 'text' | 'full';
 
+declare function Main({ children }: {
+    children?: default_2.ReactNode;
+}): default_2.JSX.Element;
+
+declare namespace Main {
+    var displayName: string;
+}
+
+declare function MainArea({ children }: {
+    children?: default_2.ReactNode;
+}): default_2.JSX.Element;
+
+declare namespace MainArea {
+    var displayName: string;
+}
+
 declare type MarkAsUncertain = {
     type: typeof AnswersActions.MARK_AS_UNCERTAIN;
     payload: {
@@ -1282,6 +1454,14 @@ declare type RedirectRule = {
     destination: string;
 };
 
+declare function RightSidebar({ children }: {
+    children?: default_2.ReactNode;
+}): default_2.JSX.Element | null;
+
+declare namespace RightSidebar {
+    var displayName: string;
+}
+
 export declare const ScrollArea: React_2.ForwardRefExoticComponent<Omit<ScrollAreaPrimitive.ScrollAreaProps & React_2.RefAttributes<HTMLDivElement>, "ref"> & React_2.RefAttributes<HTMLDivElement>>;
 
 export declare const ScrollBar: React_2.ForwardRefExoticComponent<Omit<ScrollAreaPrimitive.ScrollAreaScrollbarProps & React_2.RefAttributes<HTMLDivElement>, "ref"> & React_2.RefAttributes<HTMLDivElement>>;
@@ -1580,8 +1760,36 @@ export declare interface UseFontOptionsReturn {
     loadFont: typeof loadFont;
 }
 
+export declare function useFullLayoutContext(): FullLayoutContextValue | null;
+
 export declare const useIsChatSearchDirty: () => boolean;
 
+/**
+ * Convenience hook for programmatically controlling the right sidebar.
+ *
+ * Must be used inside a `<FullLayout>` tree.
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const rightSidebar = useRightSidebar();
+ *   return <button onClick={rightSidebar.open}>Open sidebar</button>;
+ * }
+ * ```
+ */
+export declare function useRightSidebar(): UseRightSidebarReturn;
+
+export declare interface UseRightSidebarReturn {
+    /** Whether the right sidebar is currently open. */
+    isOpen: boolean;
+    /** Open the right sidebar (no-op if already open). */
+    open: () => void;
+    /** Close the right sidebar (no-op if already closed). */
+    close: () => void;
+    /** Toggle the right sidebar open/closed. */
+    toggle: () => void;
+}
+
 export declare function useSidebar(): SidebarContextValue;
 
 export declare const ZoomableImage: React_2.FC<ZoomableImageProps>;