@patternfly/react-core/dist/esm/components/Page/PageSection.d.ts

This library provides a set of common React components for use with the PatternFly reference implementation.

/// <reference types="react" />
export declare enum PageSectionVariants {
    default = "default",
    secondary = "secondary"
}
export declare enum PageSectionTypes {
    default = "default",
    subNav = "subnav",
    breadcrumb = "breadcrumb",
    tabs = "tabs",
    wizard = "wizard"
}
export interface PageSectionProps extends React.HTMLProps<HTMLDivElement> {
    /** Content rendered inside the section */
    children?: React.ReactNode;
    /** Additional classes added to the section */
    className?: string;
    /** Section background color variant. This will only apply when the type prop has the "default" value. */
    variant?: 'default' | 'secondary';
    /** Section type variant */
    type?: 'default' | 'subnav' | 'breadcrumb' | 'tabs' | 'wizard';
    /** Enables the page section to fill the available vertical space if true, or disable filling if false. */
    isFilled?: boolean;
    /** Limits the width of the section */
    isWidthLimited?: boolean;
    /** Flag indicating if the section content is center aligned. isWidthLimited must be set for this to work  */
    isCenterAligned?: boolean;
    /** Padding at various breakpoints. */
    padding?: {
        default?: 'padding' | 'noPadding';
        sm?: 'padding' | 'noPadding';
        md?: 'padding' | 'noPadding';
        lg?: 'padding' | 'noPadding';
        xl?: 'padding' | 'noPadding';
        '2xl'?: 'padding' | 'noPadding';
    };
    /** Modifier indicating if the PageBreadcrumb is sticky to the top or bottom at various breakpoints */
    stickyOnBreakpoint?: {
        default?: 'top' | 'bottom';
        sm?: 'top' | 'bottom';
        md?: 'top' | 'bottom';
        lg?: 'top' | 'bottom';
        xl?: 'top' | 'bottom';
        '2xl'?: 'top' | 'bottom';
    };
    /** Modifier indicating if PageSection should have a shadow at the top */
    hasShadowTop?: boolean;
    /** Modifier indicating if PageSection should have a shadow at the bottom */
    hasShadowBottom?: boolean;
    /** Flag indicating if the PageSection has a scrolling overflow */
    hasOverflowScroll?: boolean;
    /** @beta Flag indicating whether children passed to the component should be wrapped by a PageBody.
     * Set this to false in order to pass multiple, custom PageBody's as children.
     */
    hasBodyWrapper?: boolean;
    /** Adds an accessible name to the page section. Required when the hasOverflowScroll prop is set to true.
     * This prop should also be passed in if a heading is not being used to describe the content of the page section.
     */
    'aria-label'?: string;
    /** Sets the base component to render. Defaults to section */
    component?: keyof React.JSX.IntrinsicElements;
}
export declare const PageSection: React.FunctionComponent<PageSectionProps>;
//# sourceMappingURL=PageSection.d.ts.map