React Native SDK
Find the right guide, integration path, or component reference for @ovok/native
- Stable unknown
- Release candidate not available
- Development not available
@ovok/native is the React Native UI and mobile integration package for OVOK apps. It works alongside @ovok/core, which owns the OVOK client, authentication state, and server-facing FHIR context.
The documentation has two layers:
- Guides are written by hand: an overview, getting started, how-to guides, one page per module and one page per component.
- The API reference 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
| If you want to… | Start here |
|---|---|
| Get a first screen running | Quick start |
| Install the SDK and configure native projects | Installation and native setup |
| Build a complete app flow | Build an app with the SDK |
| Set up the app root and provider order | App shell and providers |
| Understand package boundaries and lifecycle | Architecture and lifecycle |
| Find the right import path or exported symbol | Public API map |
Follow a feature guide
| Feature | Guide | Reference |
|---|---|---|
| Authentication | Authentication | Auth components |
| Bluetooth measurements | Bluetooth | Pairing flow · Supported devices |
| HealthKit and Health Connect | Health data | Data sync components |
| Background delivery | Background sync | Background sync components |
| CMS content and translations | CMS | CMS hooks |
| App UI | App UI guide | UI components · Reusable flows |
| Progress indicators | Progress bars · Progress ring | ProgressBar · ProgressRing |
| Logs and telemetry | Observability | Helpers |
For setup failures, platform permission issues, or integration questions, see Troubleshooting.
Browse component pages
App features
Authentication · Content · Questionnaire response forms · Patient · Measurement · Observation detail · Diary · Journal · CMS hooks
Native integrations
Bluetooth · Data sync · Background sync · PDF viewer · Socket
UI foundations and utilities
Theme · Tabs · Tiles · Settings · Picker sheet · Progress bar · Progress ring · Language switcher · Breathing exercise · Helpers · Optimized image · Polyfills · API reference
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 lists each supported path.
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 before building.
For contributors
Release and development 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.
Last updated on