Note

Display text that requires attention or provides additional information.

Default

A default note.

Sizes

• A small note.
• A medium note.

Action

This note details some information. This note details a large amount information that could potentially wrap into two or more lines, forcing the height of the Note to be larger.

Success

This note details some success information. This note details some success information. Check the documentation to learn more. This filled note details some success information. Check the documentation to learn more.

Error

This note details some error information. This note details some error information. This filled note details some error information. Check the documentation to learn more.

Warning

This note details some warning information. This note details some warning information. This filled note details some warning information. Check the documentation to learn more.

Secondary

This note details some secondary information. This note details some secondary information. Check the documentation to learn more.

Violet

This note details some violet information. This note details some violet information. Check the documentation to learn more.

Cyan

This note details some cyan information. This note details some cyan information. Check the documentation to learn more.

Disabled

This note details a warning.

Label

Region Change: Changing this region restarts all functions.

Custom icon

A custom icon replaces the variant’s default. Pass a null icon to render no icon at all.

Best Practices

When to use

• Use a Note for inline contextual feedback next to the field, card, or section it describes: a region change warning above a region picker, a rate-limit notice next to a usage gauge.
• Pick Banner when the message is page-level or system-wide and needs a CTA, Toast for transient acknowledgments, Modal for destructive confirmations.
• Choose variant by meaning: error for a problem the user must fix, warning for a consequence to acknowledge, success for a passed check, secondary for neutral information.

Behavior

• A Note is persistent until the underlying state changes; don’t add an ad hoc dismiss control because it competes with the message.
• One Note per concept. Stacking three Notes on a card means the page architecture, not the Note copy, is wrong.
• The optional NoteAction holds a single inline CTA. Don’t pair it with a second button.

Content

• NoteLabel is a 1–2 word Title Case prefix that names the topic: Region Change, Rate Limit, Plan Limit. Cut hedges like Heads Up, FYI, and Note.
• NoteContent is one sentence in active voice that names the impact: Changing this region restarts all functions.
• No variant="info" exists; omit variant for the default info icon or use variant="secondary" for neutral copy.
• Single-fragment labels take no period; full descriptive sentences in the body do.