HelixOverviewDocsComponentsSandboxTheme builderCortexDocsEngramBuildingTraceBuildingRecallDeclaredServicesInsightsGet in touchSource on GitHub
Loading the reference
AnnouncementView SourceEdit in SandboxView MarkdownCopy MarkdownOpen in ClaudeOpen in CursorA page-level message above the masthead, which can be dismissed.StableSince 0.1.0FeedbackUsageimport'@fusion.dev/helix/announcement'import'@fusion.dev/helix-headless/announcement'Preview
API ReferenceRoothelix-announcementA page-level message above the masthead, which can be dismissed.
PropTypeDefaultDescriptiondismissiblebooleanfalseWhether it offers a control to take it away.dismissLabelstring"Dismiss"Accessible name for that control.tone"danger"|"info"|"neutral"|"primary"|"success"|"surface"|"warning"Which color the band wears.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The message.actionsWhat to do about it, usually a link or a button.iconReplaces the glyph inside the dismiss control.
EventTypeDescriptionhelix-dismissHelixDismissEventFired when the reader asks to close it. Cancelable: refusing it takes the decision and nothing moves.
MethodTypeDescriptiondismiss() => booleanAnnounces that it should go, and reports whether the request stood.
PartDescriptionactionsThe trailing action region.contentThe message region.dismissThe control that asks to close.dismiss-markThe glyph on the dismiss control, where none is slotted.
CSS PropertyDescription--announcement-insetInline padding, matched to the page.
Roothelix-headless-announcementA page-level message above the masthead, which can be dismissed.
PropTypeDefaultDescriptiondismissiblebooleanfalseWhether it offers a control to take it away.dismissLabelstring"Dismiss"Accessible name for that control.tone"danger"|"info"|"neutral"|"primary"|"success"|"surface"|"warning"Which color the band wears.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The message.actionsWhat to do about it, usually a link or a button.iconReplaces the glyph inside the dismiss control.
EventTypeDescriptionhelix-dismissHelixDismissEventFired when the reader asks to close it. Cancelable: refusing it takes the decision and nothing moves.
MethodTypeDescriptiondismiss() => booleanAnnounces that it should go, and reports whether the request stood.
PartDescriptionactionsThe trailing action region.contentThe message region.dismissThe control that asks to close.dismiss-markThe glyph on the dismiss control, where none is slotted.
ExamplesNameDescriptionEventsThe bar says it was dismissed and leaves the going to whoever put it there.PreviewA dismissible bar across the top of a page, tone and all.PreviewA dismissible bar across the top of a page, tone and all.TonesThe four tones side by side, from neutral notice to danger.With ActionsA bar carrying its own buttons, for a notice a reader can act on.