@blueprintjs/core
Version:
Core styles & components
49 lines (48 loc) • 1.83 kB
TypeScript
/// <reference types="react" />
import { AbstractPureComponent2 } from "../../common";
import { IProps } from "../../common/props";
import { IPanel } from "./panelProps";
export interface IPanelStackProps extends IProps {
/**
* The initial panel to show on mount. This panel cannot be removed from the
* stack and will appear when the stack is empty.
* This prop is only used in uncontrolled mode and is thus mutually
* exclusive with the `stack` prop.
*/
initialPanel?: IPanel<any>;
/**
* Callback invoked when the user presses the back button or a panel invokes
* the `closePanel()` injected prop method.
*/
onClose?: (removedPanel: IPanel) => void;
/**
* Callback invoked when a panel invokes the `openPanel(panel)` injected
* prop method.
*/
onOpen?: (addedPanel: IPanel) => void;
/**
* Whether to show the header with the "back" button in each panel.
* @default true
*/
showPanelHeader?: boolean;
/**
* The full stack of panels in controlled mode. The last panel in the stack
* will be displayed.
*/
stack?: Array<IPanel<any>>;
}
export interface IPanelStackState {
/** Whether the stack is currently animating the push or pop of a panel. */
direction: "push" | "pop";
/** The current stack of panels. The first panel in the stack will be displayed. */
stack: IPanel[];
}
export declare class PanelStack extends AbstractPureComponent2<IPanelStackProps, IPanelStackState> {
state: IPanelStackState;
componentDidUpdate(prevProps: IPanelStackProps, _prevState: IPanelStackState, _snapshot: {}): void;
render(): JSX.Element;
protected validateProps(props: IPanelStackProps): void;
private renderCurrentPanel;
private handlePanelClose;
private handlePanelOpen;
}