Documentation

Everything to ship over-the-air updates with Pulsar — from install to multi-deployment testing.

Ready-made update sheet

Render the built-in sheet as the last child of your root component. It checks on launch and when the app returns to the foreground, shows download progress, skips updates the device already rolled back, and never fails a download on a timer.

Update available

Downloading

Ready to restart

The sheet above uses Pulsar’s own colours. Pass your brand’s colours through theme (primary, background, text, mutedText, danger) and change any wording with labels.

jsx

import {PulsarUpdateSheet} from '@novacraft-engineering/pulsar-code-push/update';

<PulsarUpdateSheet
  deploymentKey={DEPLOYMENT_KEY}
  serverUrl="https://api.usepulsar.dev"
  theme={{
    primary: '#5aa9f0',
    background: '#11151d',
    text: '#eef2f7',
    mutedText: '#8f98a6',
    danger: '#ff7a9c',
  }}
/>

For a fully custom prompt, use the hook the sheet is built on. status is one of idle, checking, available, downloading, installing, installed, failed or upToDate.

jsx

import {usePulsarUpdate} from '@novacraft-engineering/pulsar-code-push/update';

const {status, update, progress, install, dismiss, retry, restart} = usePulsarUpdate({deploymentKey});

Needs SDK 1.7.0 or later.