CalloutProps API Reference
Prop reference
| Title | Type | Default | Description |
|---|---|---|---|
| title | string | – | Title of the callout, displayed in bold |
| variant | 'note' | 'tip' | 'warning' | 'note' | Variant of the callout, affects default colour and icon. |
| icon | ReactElement | – | BYO icon. Will be cloned with size prop. |
| disableIcon | boolean | false | Hides the default (or provided) icon. |
| children | ReactNode | – | Content of the callout, can be any valid React node, usually just text. |
* Props marked with an asterisk are required.
CSS target reference
| Export | CSS Class Target | Description |
|---|---|---|
| CalloutTargetClassRoot | .NPUI-Callout-root | Root of the callout |
| CalloutTargetClassIcon | .NPUI-Callout-icon | Icon of the callout |
| CalloutTargetClassContent | .NPUI-Callout-content | Content of the callout, wraps the title and text. |
| CalloutTargetClassTitle | .NPUI-Callout-title | Title of the callout |
| CalloutTargetClassText | .NPUI-Callout-text | Text of the callout |
Exports are available from /src/components/callout/callout.tsx or from
Related APIs