UNPKG

1.54 kBTypeScriptView Raw
1import * as React from "react";
2import { IconName } from "@blueprintjs/icons";
3import { AbstractPureComponent, HTMLDivProps, Intent, IntentProps, MaybeElement, Props } from "../../common";
4/** This component also supports the full range of HTML `<div>` attributes. */
5export interface CalloutProps extends IntentProps, Props, HTMLDivProps {
6 /** Callout contents. */
7 children?: React.ReactNode;
8 /**
9 * Name of a Blueprint UI icon (or an icon element) to render on the left side.
10 *
11 * If this prop is omitted or `undefined`, the `intent` prop will determine a default icon.
12 * If this prop is explicitly `null`, no icon will be displayed (regardless of `intent`).
13 */
14 icon?: IconName | MaybeElement;
15 /**
16 * Visual intent color to apply to background, title, and icon.
17 *
18 * Defining this prop also applies a default icon, if the `icon` prop is omitted.
19 */
20 intent?: Intent;
21 /**
22 * String content of optional title element.
23 *
24 * Due to a conflict with the HTML prop types, to provide JSX content simply
25 * pass `<H4>JSX title content</H4>` as first `children` element instead of
26 * using this prop (note uppercase tag name to use the Blueprint Heading
27 * component).
28 */
29 title?: string;
30}
31/**
32 * Callout component.
33 *
34 * @see https://blueprintjs.com/docs/#core/components/callout
35 */
36export declare class Callout extends AbstractPureComponent<CalloutProps> {
37 static displayName: string;
38 render(): JSX.Element;
39 private renderIcon;
40}