@mskcc/carbon-react/es/components/MskHeader/next/Header.d.ts

Carbon react components for the MSKCC DSM

/**
 * MSKCC 2021, 2023
 */
import PropTypes from 'prop-types';
import React from 'react';
import { type ElementType } from 'react';
export declare const HeaderWidths: readonly ["default", "fluid", "max"];
export type HeaderWidth = (typeof HeaderWidths)[number];
export type HeaderProps<E extends ElementType> = {
    /**
     * Provide a custom element or component to render the top-level node for the
     * component.
     */
    as?: E | undefined;
    /**
     * Optionally provide a custom class name that is applied to the underlying <header>
     */
    className?: string;
    children?: React.ReactNode;
    /**
     * Provide a width to the header container
     */
    width?: HeaderWidth;
};
export declare function Header<E extends ElementType = 'header'>({ className: customClassName, children, width, ...rest }: HeaderProps<E>): JSX.Element;
export declare namespace Header {
    var displayName: string;
    var propTypes: {
        as: PropTypes.Requireable<PropTypes.ReactComponentLike>;
        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
        className: PropTypes.Requireable<string>;
        width: PropTypes.Requireable<"default" | "max" | "fluid">;
    };
}
export default Header;