@carbon/react/es/components/UIShell/HeaderContainer.d.ts

React components for the Carbon Design System

/**
 * Copyright IBM Corp. 2016, 2023
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */
import PropTypes from 'prop-types';
import React from 'react';
export interface HeaderContainerRenderProps {
    isSideNavExpanded: boolean;
    onClickSideNavExpand: () => void;
}
export type HeaderContainerProps<P extends HeaderContainerRenderProps> = {
    isSideNavExpanded?: boolean;
    render: React.ComponentType<P>;
} & {
    [K in keyof Omit<P, keyof HeaderContainerRenderProps>]: P[K];
};
declare function HeaderContainer<P extends HeaderContainerRenderProps>({ render: Children, isSideNavExpanded, ...rest }: HeaderContainerProps<P>): import("react/jsx-runtime").JSX.Element;
declare namespace HeaderContainer {
    var propTypes: {
        /**
         * Optionally provide a custom class name that is applied to the underlying <header>
         */
        isSideNavExpanded: PropTypes.Requireable<boolean>;
        /**
         * A function or a component that is invoked with `isSideNavExpanded` and `onClickSideNavExpand`.
         * The function or component can then use those properties to within the components it
         * returns, such as with the HeaderMenuButton and SideNav components. Additional props will also be passed
         * into this component for convenience.
         */
        render: PropTypes.Validator<NonNullable<PropTypes.ReactComponentLike>>;
    };
}
export default HeaderContainer;