# React Native onboarding screen (Pro)

> A React Native onboarding screen for iOS, Android and the web: first-run pages you swipe or tap through, page dots, Skip, and Get started on the last page. Built from free patine-ui components, no native code.

# Onboarding Pro

The first-run pages before an app: swipe or tap through them, watch the dots follow, skip at any point, and finish with **Get started** on the last page. Pages are data (`art`, `title`, `body`), so you change the words without touching the layout. It follows the reduce-motion setting.

```tsx
import { OnboardingScreen } from '@patine-ui/pro';
```

```tsx live device
import { useState } from 'react';
import { OnboardingScreen } from '@patine-ui/pro';

export default function Example() {
  // Finishing starts it over, so you can go through it again.
  const [run, setRun] = useState(0);
  const restart = () => setRun((n) => n + 1);
  return <OnboardingScreen key={run} onDone={restart} onSkip={restart} />;
}
```

## Make it yours

| Prop | Type | Default |
| --- | --- | --- |
| `pages` | `{ art, title, body }[]` | Three sample pages (`ONBOARDING_PAGES`) |
| `onDone` | `() => void` | **Required** |
| `onSkip` | `() => void` | Hides Skip when left out |
| `labels` | `Partial<OnboardingLabels>`: `next`, `skip`, `done`, `page` | English |

Built from the free [Button](/docs/components/button), [Heading and Text](/docs/components/text).

## In real apps

Every complete app has its own version of this screen, wired to its auth, data and settings: see the [templates](/templates).

## Related

- [Sign in](./sign-in) PRO
- [Paywall](./paywall) PRO
- [All blocks](./overview)
