https://github.com/youversion/platform-sdk-react
React SDK for the YouVersion Platform
https://github.com/youversion/platform-sdk-react
Last synced: 8 days ago
JSON representation
React SDK for the YouVersion Platform
- Host: GitHub
- URL: https://github.com/youversion/platform-sdk-react
- Owner: youversion
- License: apache-2.0
- Created: 2025-11-11T21:22:22.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-03-27T19:42:33.000Z (4 months ago)
- Last Synced: 2026-03-28T01:16:56.812Z (4 months ago)
- Language: TypeScript
- Size: 1.83 MB
- Stars: 16
- Watchers: 0
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# YouVersion Platform React SDK
A comprehensive React SDK for integrating [YouVersion Platform](https://platform.youversion.com/) features into your web applications. This monorepo provides a type-safe API client, React hooks, and ready-to-use components for Bible content.
## Quick Start
### NPM packages
This repo contains the source code for three NPM packages which we advise that you install directly:
- UI components: [@youversion/platform-react-ui](https://www.npmjs.com/package/@youversion/platform-react-ui)
- React hooks: [@youversion/platform-react-hooks](https://www.npmjs.com/package/@youversion/platform-react-hooks)
- Direct API access: [@youversion/platform-core](https://www.npmjs.com/package/@youversion/platform-core)
### Installation
```bash
# For UI components
pnpm add @youversion/platform-react-ui
# For React hooks only
pnpm add @youversion/platform-react-hooks
# For direct API access
pnpm add @youversion/platform-core
```
## Quick Start Examples
### UI Components
To display a verse, or a range of verses:
```tsx
import { YouVersionProvider, BibleTextView } from '@youversion/platform-react-ui';
function App() {
return (
);
}
```
To display the YouVersion Verse of the Day:
```tsx
import { YouVersionProvider, VerseOfTheDay } from '@youversion/platform-react-ui';
function App() {
return (
);
}
```
### Custom Hooks
```tsx
import { YouVersionProvider, usePassage } from '@youversion/platform-react-hooks';
function BibleVerse() {
const { passage, loading } = usePassage({ versionId: 3034, usfm: 'JHN.3.16' });
if (loading) return
Loading...;
return ;
}
function App() {
return (
);
}
```
### Core API
```ts
import { ApiClient, BibleClient } from '@youversion/platform-core';
const apiClient = new ApiClient({ appKey: 'YOUR_APP_KEY' });
const bibleClient = new BibleClient(apiClient);
// Find available Bible versions in English
const versions = await bibleClient.getVersions('en*');
console.log(versions.data[0].title);
// Fetch the html text of John 3:16 in that first Bible version
const passage = await bibleClient.getPassage(versions.data[0].id, 'JHN.3.16');
console.log(passage.content);
```
## Contributing
> [!NOTE]
> We are not yet accepting pull requests from external contributors, though we intend to do so in the future. In the meantime, we welcome you to use the SDK, report bugs via [GitHub Issues](https://github.com/youversion/platform-sdk-react/issues), and share feedback. See [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
## License
This SDK is licensed under [Apache 2.0](./LICENSE).
Licensing information for the Bible versions is available
at the [YouVersion Platform](https://platform.youversion.com/) site.