Skip to main content

Build Bible experiences with React

A comprehensive React SDK for integrating YouVersion Platform Bible content into your web applications. Type-safe API clients, React hooks, and ready-to-use components.

Get StartedAPI Reference

Quick Start

Get up and running with the YouVersion Platform React SDK in three simple steps.

1

Install the SDK

Choose your preferred package based on your needs. Install the UI components package for the complete experience, or use the hooks or core package for more control.
npm install @youversion/platform-react-ui
2

Get your API credentials

Visit the YouVersion Platform to create an account and obtain your API key. You’ll need this key to authenticate your requests.
Your API key is required to access Bible content through the SDK. Keep it secure and never commit it to version control.
3

Display your first verse

Wrap your app with YouVersionProvider and start using components to display Bible content.
import { YouVersionProvider, BibleTextView } from '@youversion/platform-react-ui';

function App() {
  return (
    <YouVersionProvider appKey="YOUR_APP_KEY">
      <BibleTextView reference="JHN.3.16" versionId={3034} />
    </YouVersionProvider>
  );
}
The BibleTextView component will render the verse text with proper formatting, including verse numbers and styling that adapts to your application’s theme.

Explore by Package

The SDK is organized into three packages, each serving a different level of abstraction.

UI Components

Pre-built React components for Bible readers, verses, and navigation. The fastest way to add Bible content to your app.

React Hooks

Data fetching hooks and providers for Bible content. Build custom UI with state management included.

Core API

Type-safe API clients for direct access to YouVersion Platform. Framework-agnostic and fully typed.

Key Features

Everything you need to build world-class Bible experiences.

Type-Safe API

Full TypeScript support with Zod schema validation ensures type safety from API responses to your components.

OAuth Authentication

Built-in OAuth 2.0 PKCE flow for secure user authentication with YouVersion accounts.

Multi-Language Support

Access Bible versions in multiple languages with built-in language filtering and version management.

Customizable Theming

Tailwind-based styling with dark mode support. All components adapt to your design system.

Learn More

Dive deeper into the SDK with guides and examples.

Core Concepts

Understand the three-layer architecture and how the packages work together.

Authentication Guide

Learn how to implement user authentication with YouVersion accounts.

Component Examples

Explore real-world examples of building Bible reading experiences.

Custom Hooks

See how to use hooks to build custom data fetching patterns.

Ready to get started?

Follow our quickstart guide to build your first Bible experience in minutes.

View Quickstart

Build docs developers (and LLMs) love

Get started for freeTalk to us