UNPKG

1.72 kBTypeScriptView Raw
1import * as React from "react";
2import { IconName } from "@blueprintjs/icons";
3import { AbstractPureComponent, MaybeElement, Props } from "../../common";
4export declare enum NonIdealStateIconSize {
5 STANDARD = 48,
6 SMALL = 32,
7 EXTRA_SMALL = 20
8}
9export interface NonIdealStateProps extends Props {
10 /** An action to resolve the non-ideal state which appears after `description`. */
11 action?: JSX.Element;
12 /**
13 * Advanced usage: React `children` will appear last (after `action`).
14 * Avoid passing raw strings as they will not receive margins and disrupt the layout flow.
15 */
16 children?: React.ReactNode;
17 /**
18 * A longer description of the non-ideal state.
19 * A string or number value will be wrapped in a `<div>` to preserve margins.
20 */
21 description?: React.ReactChild;
22 /** The name of a Blueprint icon or a JSX Element (such as `<Spinner/>`) to render above the title. */
23 icon?: IconName | MaybeElement;
24 /**
25 * How large the icon visual should be.
26 *
27 * @default NonIdealStateIconSize.STANDARD
28 */
29 iconSize?: NonIdealStateIconSize;
30 /**
31 * Component layout, either vertical or horizontal.
32 *
33 * @default "vertical"
34 */
35 layout?: "vertical" | "horizontal";
36 /** The title of the non-ideal state. */
37 title?: React.ReactNode;
38}
39/**
40 * Non-ideal state component.
41 *
42 * @see https://blueprintjs.com/docs/#core/components/non-ideal-state
43 */
44export declare class NonIdealState extends AbstractPureComponent<NonIdealStateProps> {
45 static displayName: string;
46 static defaultProps: Partial<NonIdealStateProps>;
47 render(): JSX.Element;
48 private maybeRenderVisual;
49 private maybeRenderText;
50}