@cerberus-design/react/dist/components/admonition/admonition.d.ts

The Cerberus Design React component library.

import { ReactNode } from 'react';
import { AdmonitionRootProps } from './primitives';
/**
 * This module provides an abstraction for the Admonition component.
 * @module 'admonition/admonition'
 */
export interface AdmonitionProps extends AdmonitionRootProps {
    /**
     * The heading title for the Admonition.
     */
    heading?: string;
    /**
     * One off replacement for the icon.
     */
    icon?: ReactNode;
}
/**
 * The Admonition component is an abstraction of the primitives which
 * displays a Admonition with a label.
 *
 * @description [Cerberus Docs](https://cerberus.digitalu.design/react/admonition)
 *
 * @remarks
 *
 * For a customizable Admonition, use the `AdmonitionParts` object to access the
 * individual primitives of the Admonition component.
 */
export declare function Admonition(props: AdmonitionProps): import("react/jsx-runtime").JSX.Element;