@mskcc/carbon-react/lib/components/MskLayout/pageLayout.d.ts

Carbon react components for the MSKCC DSM

import * as React from 'react';
export type LayoutTypes = 'bookworm' | 'potato' | 'sarge' | 'bullseye' | 'buster' | 'slink';
export type LayoutDefaults = {
    children?: React.ReactNode;
    as?: React.ElementType;
};
export type SideProps = {
    side?: React.ReactNode;
} & LayoutDefaults;
export type LayoutSwitchProps = {
    /**
     *
     * Bookworm layout
     * 2400px max • 12 columns • 1 slot
     * Bookworm is a wide central container for dense applications.
     *
     * Potato layout
     * 1440px max • 12 columns • 1 slot
     * The Potato layout is a single slot container that uses all
     * 12 columns.
     *
     * Sarge layout
     * 1440px max • 12 columns • 1 slot
     * The Sarge layout focuses the user by skipping 2 of the 12
     * columns when content does not flow very much horizontally.
     *
     * Bullesye layout
     * 1440px max • 12 columns • 2 slots
     * Bullseye has two slots, where the left could be use for a
     * table of contents or search filters.
     *
     * Buster layout
     * 1440px max • 12 columns • 2 slots
     * Buster is a great layout for an article where the right slot
     * is useful for reading tools (like printing and sharing) and
     * also to link out to related articles or authors.
     *
     * Slink layout
     * 1440px max • 12 columns • 2 slots
     * Slink has two slots, where the left could be used for a
     * table of contents or search filters. This one differs from
     * Bullseye in that there is no extra gutter between the left
     * and main slots. It's wider too.
     *
     */
    layout?: LayoutTypes;
};
export interface PageLayoutProps extends SideProps, LayoutSwitchProps, React.HTMLAttributes<HTMLDivElement> {
}
export declare const PageLayout: React.FC<PageLayoutProps>;
export default PageLayout;