Lynx/Modules/OTA Update UI/UpdateReadyBanner
@sigx/lynx-updates-ui · Beta · Component library

UpdateReadyBanner#

A bottom banner shown when a non-mandatory update is downloaded and staged, offering an immediate in-place restart — or "Later" to apply it on the next cold launch.

Import#

TSX
import { UpdateReadyBanner } from '@sigx/lynx-updates-ui';

Usage#

<UpdateReadyBanner> appears at the bottom of the screen when the headless state reaches status: 'ready' and the update is not mandatory. It reads "Update ready — v1.2.3" (the version is appended to label) and offers a Restart button.

TSX
import { UpdateReadyBanner } from '@sigx/lynx-updates-ui';

<UpdateReadyBanner />
  • RestartUpdates.apply() (in-place reload).
  • Later → hides the banner for this session and fires onDismiss; the staged update still applies on the next cold launch (the headless package's default — nothing to persist here).

This is the natural pairing for UpdatePrompt with applyOn="next-launch": the prompt downloads, the banner offers the restart. Mandatory updates never reach this banner — UpdateGate blocks and auto-applies those.

Props#

PropTypeDefaultDescription
labelstring'Update ready'Banner text (the version is appended).
restartLabelstring'Restart'Restart button text.
classstringExtra class for the banner container.

Events#

EventPayloadDescription
onDismiss() => voidFired when the user taps "Later".