# React Native SDK

Canonical page: https://docs.ovok.com/native-sdk

`@ovok/native` is the React Native UI and mobile integration package for OVOK apps. It works alongside [`@ovok/core`](./guide/overview.md), which owns the OVOK client, authentication state, and server-facing FHIR context.

The documentation has two layers:

- **Guides** are written by hand: an [overview](./guide/overview.md), [getting started](./guide/getting-started.md), [how-to guides](./guide/how-to/app-building.md), one page per [module](./guide/modules/auth.md) and one page per component.
- **The [API reference](./reference/index.mdx)** is generated from the SDK's doc comments, one page per module, and lists every export with its signature, props and types.

## Start with your goal [#start-with-your-goal]

| If you want to… | Start here |
| --- | --- |
| Get a first screen running | [Quick start](./guide/getting-started.md) |
| Install the SDK and configure native projects | [Installation and native setup](./guide/how-to/installation.md) |
| Build a complete app flow | [Build an app with the SDK](./guide/how-to/app-building.md) |
| Set up the app root and provider order | [App shell and providers](./guide/how-to/app-shell.md) |
| Understand package boundaries and lifecycle | [Architecture and lifecycle](./guide/architecture.md) |
| Find the right import path or exported symbol | [Public API map](./guide/public-api.md) |

## Follow a feature guide [#follow-a-feature-guide]

| Feature | Guide | Reference |
| --- | --- | --- |
| Authentication | [Authentication](./guide/modules/auth.md) | [Auth components](./guide/components/auth/index.md) |
| Bluetooth measurements | [Bluetooth](./guide/modules/bluetooth.md) | [Pairing flow](./guide/components/ui/pairing-flow.md) · [Supported devices](./guide/supported-devices.md) |
| HealthKit and Health Connect | [Health data](./guide/modules/data-sync.md) | [Data sync components](./guide/components/data-sync/index.md) |
| Background delivery | [Background sync](./guide/modules/background-sync.md) | [Background sync components](./guide/components/background-sync/index.md) |
| CMS content and translations | [CMS](./guide/modules/cms.md) | [CMS hooks](./guide/components/cms/index.md) |
| App UI | [App UI guide](./guide/modules/ui.md) | [UI components](./guide/components/ui/index.md) · [Reusable flows](./guide/how-to/reusable-flows.md) |
| Progress indicators | [Progress bars](./guide/modules/progress-bar.md) · [Progress ring](./guide/modules/progress-ring.md) | [ProgressBar](./guide/components/progress-bar/index.md) · [ProgressRing](./guide/components/progress-ring/index.md) |
| Logs and telemetry | [Observability](./guide/how-to/observability.md) | [Helpers](./guide/components/helpers/index.md) |

For setup failures, platform permission issues, or integration questions, see [Troubleshooting](./guide/how-to/troubleshooting.md).

## Browse component pages [#browse-component-pages]

### App features [#app-features]

[Authentication](./guide/components/auth/index.md) · [Content](./guide/components/content/index.md) · [Questionnaire response forms](./guide/components/questionnaire-response-form/index.md) · [Patient](./guide/components/patient/index.md) · [Measurement](./guide/components/measurement/index.md) · [Observation detail](./guide/components/observation-detail/index.md) · [Diary](./guide/components/diary/index.md) · [Journal](./guide/components/journal/index.md) · [CMS hooks](./guide/components/cms/index.md)

### Native integrations [#native-integrations]

[Bluetooth](./guide/modules/bluetooth.md) · [Data sync](./guide/components/data-sync/index.md) · [Background sync](./guide/components/background-sync/index.md) · [PDF viewer](./guide/components/pdf/index.md) · [Socket](./guide/components/socket/index.md)

### UI foundations and utilities [#ui-foundations-and-utilities]

[Theme](./guide/components/theme/index.md) · [Tabs](./guide/components/tab/index.md) · [Tiles](./guide/components/tile/index.md) · [Settings](./guide/components/setting/index.md) · [Picker sheet](./guide/components/picker-sheet/index.md) · [Progress bar](./guide/components/progress-bar/index.md) · [Progress ring](./guide/components/progress-ring/index.md) · [Language switcher](./guide/components/language-switcher/index.md) · [Breathing exercise](./guide/components/breathing-exercise/index.md) · [Helpers](./guide/components/helpers/index.md) · [Optimized image](./guide/components/optimized-image/index.md) · [Polyfills](./guide/components/polyfills/index.md) · [API reference](./reference/index.mdx)

## Choose an import path [#choose-an-import-path]

The package root exports the `Ovok` client. UI, Bluetooth and optional native integrations have subpath imports so an app can include only the features it uses. The [Public API map](./guide/public-api.md) lists each supported path.

```tsx
import { BluetoothProvider } from "@ovok/native/bluetooth";
import { ThemeProvider } from "@ovok/native/theme";
import { DataSync } from "@ovok/native/data-sync";
```

The full SDK uses native modules. Use an Expo development build or another native React Native build; Expo Go cannot load all of the SDK's native integrations. See [Installation and native setup](./guide/how-to/installation.md) before building.

## For contributors [#for-contributors]

[Release and development](./guide/release-and-development.md) explains the repository workflow. Every public symbol must have a doc comment; `yarn docs:api-reference` regenerates the reference and fails on a missing one.
