UNPKG

@coveord/plasma-mantine

Version:

A Plasma flavoured Mantine theme

53 lines 2.13 kB
import { Factory, GroupProps, StylesApiProps } from '@mantine/core'; import { ReactNode } from 'react'; import { HeaderActions, HeaderActionsStyleNames } from './HeaderActions/HeaderActions'; import { HeaderBreadcrumbs, HeaderBreadcrumbsStyleNames } from './HeaderBreadcrumbs/HeaderBreadcrumbs'; import { HeaderDocAnchor, HeaderDocAnchorStyleNames } from './HeaderDocAnchor/HeaderDocAnchor'; export type { HeaderActionsProps } from './HeaderActions/HeaderActions'; export type { HeaderBreadcrumbsProps } from './HeaderBreadcrumbs/HeaderBreadcrumbs'; export type { HeaderDocAnchorProps } from './HeaderDocAnchor/HeaderDocAnchor'; export type HeaderVariant = 'primary' | 'secondary'; export type HeaderStyleNames = 'root' | 'title' | 'description' | 'divider' | HeaderDocAnchorStyleNames | HeaderBreadcrumbsStyleNames | HeaderActionsStyleNames; export interface HeaderProps extends StylesApiProps<HeaderFactory>, Omit<GroupProps, 'classNames' | 'styles' | 'vars'> { /** * The description text displayed inside the header underneath the title */ description?: ReactNode; /** * Whether the header should have a border on the bottom */ borderBottom?: boolean; /** * Use the primary variant for page header and secondary variant elsewhere * * @default 'primary' */ variant?: 'primary' | 'secondary'; /** * The title of the header. */ children: ReactNode; } export type HeaderFactory = Factory<{ props: HeaderProps; ref: HTMLDivElement; variant: HeaderVariant; stylesNames: HeaderStyleNames; staticComponents: { Breadcrumbs: typeof HeaderBreadcrumbs; Actions: typeof HeaderActions; DocAnchor: typeof HeaderDocAnchor; }; }>; export declare const Header: import("@mantine/core").MantineComponent<{ props: HeaderProps; ref: HTMLDivElement; variant: HeaderVariant; stylesNames: HeaderStyleNames; staticComponents: { Breadcrumbs: typeof HeaderBreadcrumbs; Actions: typeof HeaderActions; DocAnchor: typeof HeaderDocAnchor; }; }>; //# sourceMappingURL=Header.d.ts.map