# API map of the "Notices" family: old path to new path and setter renames. # Filled in by the family track; the codemods and the app scan read it. family = "Notices" new_module = "craft_ui::notices" # One entry per public type: `old` is the path an app calls today, `new` the path after migration. # `status` is "pending", "same" (path unchanged), "moved", "replaced" (use `note`) or "removed". [[type]] name = "Notice" old = "craft_ui::composites::notice::Notice" new = "craft_ui::notices::Notice" status = "moved" note = "A `Component` shown with `Show::show`; `Notice::new(Tone::Warn, message).show(ui)` replaces `Notice::new(message).tone(Tone::Warn).show(ui)`. The output is `NoticeOutput { response, action, dismissed }`. `Notice::style(tokens, tone)` is gone; the look is `NoticeStyle`. A notice announces nothing by default; callers add `.announce(Politeness::..)` to keep the legacy behaviour (Bad `Politeness::Assertive` as an ALERT, every other tone `Politeness::Polite` as a STATUS)." [[type]] name = "SettingsNotices" old = "craft_ui::composites::settings_notice::SettingsNotices" new = "craft_ui::notices::SettingsNotices" status = "moved" note = "A pattern built from the app's `SettingsNoticeState` (the failure count and messages, owned by the app instead of kept in the pattern): `SettingsNotices::new(&state).app(name).show(ui)`, which returns `SettingsNoticesOutput`. Every caller passes `.app(..)`: the name is no longer read from `Host`, and the notices say \"The app\" without it. `loaded` and `ticked` are methods of `SettingsNoticeState`; they take the egui context (they request a repaint through it, as the legacy methods did) and plain values (`SettingsLoad`, `SaveResult`) instead of craft-settings reports." [[type]] name = "NoticeCenter" old = "craft_ui::composites::notice_center::NoticeCenter" new = "craft_ui::notices::NoticeCenter" status = "moved" note = "A pattern over `runtime::toast`: `NoticeCenter::new().post(ctx, &PostedNotice, &silenced)` returns the toast id, `keep(ctx, id)` makes a posted notice sticky, and `NoticeCenter::new().show(ui)` returns `NoticeCenterOutput { response, ends }` with the `NoticeEnd` list (`Closed`, `Expired`, `Silenced { id, key }`). The queue, the cap of three cards, the timers and the cards are the toast service's and the shell's `ToastHost`; a notice with a dismiss key carries the `common.dontShowAgain` action. The default timeout is `toast::TIMEOUT`, six seconds." [[type]] name = "PostedNotice" old = "craft_ui::composites::notice_center::PostedNotice" new = "craft_ui::notices::PostedNotice" status = "moved" note = "Built with `PostedNotice::new(title)` and setters (`lines`, `tone`, `dismiss_key`, `sticky`); the fields are private." [[type]] name = "NoticeEnd" old = "craft_ui::composites::notice_center::NoticeEnd" new = "craft_ui::notices::NoticeEnd" status = "replaced" note = "`Closed(ToastId)`, `Expired(ToastId)` and `Silenced { id, key }`, read from `NoticeCenter::show(ui).ends`; `Dropped` is not reported (the cap drops the oldest card without an action)." [[type]] name = "NoticePost" old = "craft_ui::composites::notice_center::NoticePost" new = "" status = "removed" note = "`NoticeCenter::post` returns `Option`; the cap of three cards lives in the toast service (`toast::MAX_CARDS`)." [[type]] name = "ToastStack" old = "craft_ui::composites::toast::ToastStack" new = "" status = "replaced" note = "Post with `craft_ui::runtime::toast::post(ctx, Toast::new(message))`; the shell shows `ToastHost`. `ToastEnd`, `ToastStyle` and the stack's id salt are gone." [[type]] name = "Toast" old = "craft_ui::composites::toast::Toast" new = "craft_ui::runtime::toast::Toast" status = "replaced" note = "`Toast::new(message)` with `timeout(Option)`, `politeness(Politeness)`, `tone(Tone)`, `title(Label)` and `action(ToastAction)`; `toast::end(ctx, id)` reads how the toast ended (`ToastEnd::Action(index)`, `Dismissed`, `Expired`). The message is the lines joined by newlines; `persistent` is `timeout(None)`." [[type]] name = "ToastStyle" old = "craft_ui::composites::toast::ToastStyle" new = "" status = "removed" note = "The card is a `Notice` in `NoticeLayout::Card`; its look is `NoticeStyle`." [[type]] name = "EmptyState" old = "craft_ui::composites::empty_state::EmptyState" new = "" status = "replaced" note = "`craft_ui::notices::Notice`: `Notice::new(Tone::Neutral, message).layout(NoticeLayout::Centred).title(heading).action(NoticeAction::new(label))`; the title takes the heading role and the height comes from layout. `EmptyState::new(message)` (an inline message) becomes `Notice::new(Tone::Neutral, message)` in the default `Inline` layout." [[type]] name = "EmptyStateStyle" old = "craft_ui::composites::empty_state::EmptyStateStyle" new = "" status = "removed" note = "Use `NoticeStyle`." [[type]] name = "EmptyStateResponse" old = "craft_ui::composites::empty_state::EmptyStateResponse" new = "" status = "replaced" note = "`craft_ui::notices::NoticeOutput`: `NoticeOutput.action` is the index of the action taken." [[type]] name = "NoticeStyle" old = "craft_ui::composites::notice::NoticeStyle" new = "craft_ui::notices::NoticeStyle" status = "moved" note = "A `ComponentStyle` keyed by tone and layout; the public sizes, type roles and colours are looks." [[type]] name = "region" old = "craft_ui::composites::live::region" new = "" status = "replaced" note = "A container's live region is `ContainerProps::live(Politeness)`; a notice announces its first show with `Notice::announce(Politeness)`; transient text goes through `announce`. `live::Labels` and `live::for_tone` are gone." [[type]] name = "StatusLine" old = "craft_ui::composites::status::StatusLine" new = "" status = "replaced" note = "`craft_ui::notices::SettingsStatus`: `SettingsNoticeState::take_status()` returns a `SettingsStatus`; `.tone()` and `.text(&words)` give what `StatusLine { text, tone }` held." # One entry per renamed, removed or reshaped setter or constructor. [[setter]] type = "Notice" old = "new(message)" new = "new(Tone, message)" [[setter]] type = "Notice" old = "tone(Tone)" new = "new(Tone, message)" [[setter]] type = "Notice" old = "title(impl Into)" new = "title(impl Into