Skip to content
Last updated

Admonition React component

Products:RevelRevelRealmRealm
Plans:ProEnterpriseEnterprise+

Customize the admonition component to influence the types, styling and content of admonitions in your project.

Import

import { Admonition } from '@redocly/theme/components/Admonition/Admonition';

Properties

PropType Description
typeenum (warning | success | danger | info | idea)Sets the type of admonition. Default: info.
namestringHeading for admonition.
childrenReact.ReactNodePasses content between the opening and closing tags of a component.
classNamestringAdds custom CSS classes to the component for styling purposes.

Resources

  • Built-in React components - Browse all available built-in React components that you can customize and extend in your projects