(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)

Inline Notification

Overview

Example Inline Notification

Specs

Tokens

Token Short description
displayName Display name shown in the structure panel.
displayConditions Rules for when the component is shown.
type Notification style: Warning, Success, System, or Error.
text Message text displayed in the notification.
hideCloseButton Shows or hides the close (✕) button.
paddingClass Internal spacing via CSS utility class (e.g., p-4).
events Events the component can fire or handle.
ON_INIT (Events) Fires when the component initializes.
ON_INLINE_NOTIFICATION_CLOSE_CLICK (Events) Fires when the close button is clicked.
visibilityPolicySetId Controls visibility via a policy set (e.g., admin-only).
id Unique identifier for testing or code access.
dataTestId Stable test hook for automated tests.
enableAsHotspot Enables use as a guided tour hotspot.

Structure

(Configured in General Properties)

(Configured in Visibility)

Styling

(Configured in Visual Properties)

Different types of inline notifications

Inline Notification with and without close button

(Configured in Layout)

Actions & Variants

(Configured in Events)

Authorization

(Configured in Visual Properties)

Tests

(Configured in Testing Hooks)

Links

Guidelines

Usage

Sizing & Layout

States & Feedback

Visibility & Authorization

Content & Localization

Dos & Don’ts

Do Don’t Article setting(s)
Choose the semantic type that matches the message (e.g., Error for failures). Use Success styling for problems or Error for neutral info. type, text
Keep the message short and actionable. Write multi-paragraph blocks in the notification. text
Make blocking errors persistent by hiding the close button. Let users dismiss critical errors. hideCloseButton, type
Allow dismissal for non-critical notices and handle the event. Force users to live with low-value notices or ignore the click event. hideCloseButton, events.ON_INLINE_NOTIFICATION_CLOSE_CLICK
Show only when conditions are met. Display the notification at all times. displayConditions
Restrict sensitive notices to allowed roles. Expose internal/system notices to all users. visibilityPolicySetId
Provide comfortable spacing for readability. Let text touch edges or feel cramped. paddingClass
Name the instance clearly for authors. Leave a generic default name. displayName
Use hotspot sparingly to teach context during tours. Depend on the hotspot to convey critical instructions. enableAsHotspot, text

Accessibility