<Aside>
component.
Include nonessential, supplementary information in a regular
<Aside>
. If some information is important or might lead to bad cases when not taken into consideration, specify a different type
, such as "caution"
or "danger"
.Import
Usage
Display an aside (also known as “admonitions” or “callouts”) using the<Aside>
component.
An <Aside>
can have an optional type
attribute, which controls the aside’s color, icon, and default title.
Use custom titles
Override the default aside titles by using thetitle
attribute.
Watch out!
<Aside>
props
Implementation: aside.jsx
The <Aside>
component accepts the following props:
type
type: "note" | "tip" | "caution" | "danger"
default:
"note"
The type of aside to display:
note
asides (the default) are blue and display an information icon.tip
asides are purple and display a rocket icon.caution
asides are yellow and display a triangular warning icon.danger
asides are red and display an octagonal warning icon.
danger
and replaces text content with the corresponding error message.
title
type: string
default:
""
(no title)
The title of the aside to display. If title
is not set, no title is displayed.
icon
type: string
default:
""
(corresponds to the type
)
The custom icon to display instead of the default one set by the type
. Can be one of the following:
- Font Awesome icon name
- Lucide icon name
iconType
type: "regular" | "solid" | "light" | "thin" | "sharp-solid" | "duotone" | "brands"
default:
"regular"
The Font Awesome icon style — only used with Font Awesome icons.