layout.api.md

API Report File for "@rocket.chat/layout"

Do not edit this file. It is a report generated by API Extractor.

import type { AnchorHTMLAttributes } from 'react';
import { Box } from '@rocket.chat/fuselage';
import { ClassAttributes } from 'react';
import type { ComponentProps } from 'react';
import type { CSSProperties } from 'react';
import type { Dispatch } from 'react';
import type { FormHTMLAttributes } from 'react';
import { FunctionComponent } from 'react';
import { HTMLAttributes } from 'react';
import { Icon } from '@rocket.chat/fuselage';
import { JSX } from 'react';
import { Margins } from '@rocket.chat/fuselage';
import type { ReactElement } from 'react';
import type { ReactNode } from 'react';
import type { RefAttributes } from 'react';
import type { RefObject } from 'react';
import type { SetStateAction } from 'react';

// @public (undocumented)
export const ActionLink: (input: ActionLinkProps) => JSX.Element;

// @public (undocumented)
export type ActionLinkProps = {
    children: ReactNode;
    href?: string;
    fontScale?: ComponentProps<typeof Box>['fontScale'];
} & AnchorHTMLAttributes<HTMLAnchorElement>;

// @public (undocumented)
export type AnchorParams = {
    ref: RefObject<Element | null>;
    toggle: Dispatch<SetStateAction<boolean>>;
    id: string;
};

// @public (undocumented)
const Aside: FunctionComponent<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & {
justifyContent?: string;
}>;

// @public (undocumented)
export const BackgroundLayer: (input: BackgroundLayerProps) => JSX.Element;

// @public (undocumented)
export type BackgroundLayerProps = {
    children?: ReactNode;
};

// @public (undocumented)
const Content: FunctionComponent<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement>>;

declare namespace DarkModeProvider {
    export {
        DarkModeProviderProps,
        DarkModeProvider_2 as default,
        useDarkMode
    }
}
export { DarkModeProvider }

// @public (undocumented)
const DarkModeProvider_2: (input: DarkModeProviderProps) => JSX.Element;

// @public (undocumented)
type DarkModeProviderProps = {
    children?: ReactNode;
    forcedDarkMode?: boolean;
};

// @public (undocumented)
const Description: FunctionComponent<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement>>;

// Warning: (ae-forgotten-export) The symbol "FormProps" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function Form(props: FormProps): JSX.Element;

// @public (undocumented)
export const FormContainer: (props: ComponentProps<typeof Box>) => JSX.Element;

// Warning: (ae-forgotten-export) The symbol "FormFooterProps" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function FormFooter(props: FormFooterProps): JSX.Element;

// Warning: (ae-forgotten-export) The symbol "FormHeaderProps" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function FormHeader(props: FormHeaderProps): JSX.Element;

declare namespace FormPageLayout {
    export {
        Wrapper,
        Aside,
        Content,
        Logo,
        Title,
        TitleHighlight,
        Subtitle,
        Description
    }
}
export { FormPageLayout }

// @public (undocumented)
export const FormSteps: (input: FormStepsProps) => JSX.Element;

// @public (undocumented)
export type FormStepsProps = {
    currentStep: number;
    stepCount: number;
};

// Warning: (ae-forgotten-export) The symbol "FormSubtitleProps" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function FormSubtitle(props: FormSubtitleProps): JSX.Element;

// Warning: (ae-forgotten-export) The symbol "FormTitleProps" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function FormTitle(props: FormTitleProps): JSX.Element;

// @public (undocumented)
export const HeroLayout: (input: LayoutContextValue & {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
export const HeroLayoutSubtitle: (input: {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
export const HeroLayoutTitle: (input: {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
export const HorizontalWizardLayout: (input: LayoutContextValue & {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
export const HorizontalWizardLayoutAside: (input: {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
export const HorizontalWizardLayoutCaption: (input: {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
export const HorizontalWizardLayoutContent: (input: {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
export const HorizontalWizardLayoutDescription: (props: ComponentProps<typeof FormPageLayout.Description>) => JSX.Element;

// @public (undocumented)
export const HorizontalWizardLayoutFooter: (input: {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
export const HorizontalWizardLayoutSubtitle: (props: ComponentProps<typeof FormPageLayout.Subtitle>) => JSX.Element;

// @public (undocumented)
export const HorizontalWizardLayoutTitle: (props: ComponentProps<typeof FormPageLayout.Title>) => JSX.Element;

// @public (undocumented)
export const HorizontalWizardTextHighlight: (props: {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
export type LayoutContextValue = {
    logo?: ReactNode;
    logoDark?: ReactNode;
    background?: string;
    backgroundDark?: string;
    forceDarkMode?: boolean;
};

// @public (undocumented)
export const LayoutLogo: () => JSX.Element;

// @public (undocumented)
export const List: (input: {
    children: ReactNode;
    spacing?: ComponentProps<typeof Margins>["block"];
    listStyleType?: CSSProperties["listStyleType"];
    color?: CSSProperties["color"];
    icon?: string;
}) => JSX.Element;

// @public (undocumented)
export const ListItem: (input: {
    children: ReactNode;
    icon?: ComponentProps<typeof Icon>["name"];
    iconColor?: ComponentProps<typeof Icon>["color"];
    fontScale?: ComponentProps<typeof Box>["fontScale"];
}) => JSX.Element;

// @public (undocumented)
const Logo: FunctionComponent<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement>>;

// @public (undocumented)
const Subtitle: FunctionComponent<ClassAttributes<HTMLHeadingElement> & HTMLAttributes<HTMLHeadingElement> & {
fontColor?: string;
fontWeight?: string;
}>;

// @public (undocumented)
const Title: FunctionComponent<ClassAttributes<HTMLHeadingElement> & HTMLAttributes<HTMLHeadingElement>>;

// @public (undocumented)
const TitleHighlight: FunctionComponent<ClassAttributes<HTMLSpanElement> & HTMLAttributes<HTMLSpanElement> & {
fontColor?: string;
isDark?: boolean;
}>;

// @public (undocumented)
export const TooltipWrapper: (input: TooltipWrapperProps) => JSX.Element;

// @public (undocumented)
export type TooltipWrapperProps = {
    children: ReactElement<any> | ((props: AnchorParams) => ReactNode);
    text: string;
};

// @public (undocumented)
const useDarkMode: () => boolean;

// @public (undocumented)
export const VerticalWizardLayout: (input: LayoutContextValue & {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
export const VerticalWizardLayoutFooter: (input: {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
export const VerticalWizardLayoutForm: (input: {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
export const VerticalWizardLayoutTitle: (input: {
    children: ReactNode;
}) => JSX.Element;

// @public (undocumented)
const Wrapper: FunctionComponent<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement>>;

// (No @packageDocumentation comment for this package)