@massds/mayflower-react/dist/IllustratedHeader/index.d.ts

React versions of Mayflower design system UI components

/**
 * IllustratedHeader module.
 * @module @massds/mayflower-react/IllustratedHeader
 * @requires module:@massds/mayflower-assets/scss/03-organisms/illustrated-header
 * @requires module:@massds/mayflower-assets/scss/03-organisms/page-header
 * * @requires module:@massds/mayflower-assets/scss/03-organisms/page-header-addons
 * @requires module:@massds/mayflower-assets/scss/01-atoms/publish-state
 */
import React from 'react';
import { PageHeaderProps } from '../PageHeader';
export interface IllustratedHeaderProps {
    /** background image aria label */
    bgInfo?: string;
    /** background image url */
    bgImage?: string;
    /** invert to change style */
    inverted?: boolean;
    /** category prefix text rendered in all caps above the page header title */
    category?: string;
    /** render PageHeader component `@organisms/PageHeader` */
    pageHeader?: PageHeaderProps;
    children?: React.ReactNode;
}
declare const IllustratedHeader: (illustratedHeader: IllustratedHeaderProps) => any;
export default IllustratedHeader;