@youversion/platform-react-ui 0.5.5 → 0.5.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -10
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -9,11 +9,11 @@ Pre-built React components for Bible applications with styling included.
|
|
|
9
9
|
Use `@youversion/platform-react-ui` when you need:
|
|
10
10
|
- ✅ Production-ready Bible components for your React app
|
|
11
11
|
- ✅ Pre-styled components with light/dark mode
|
|
12
|
-
- ✅ Minimal setup
|
|
12
|
+
- ✅ Minimal setup: wrap your app with providers and use the components
|
|
13
13
|
- ✅ Consistent, accessible UI out of the box
|
|
14
14
|
Get your App Key at [platform.youversion.com](https://platform.youversion.com/)
|
|
15
15
|
|
|
16
|
-
**Use other packages instead if:**
|
|
16
|
+
**Use other packages instead if you:**
|
|
17
17
|
- ❌ Need low-level API access → Use [@youversion/platform-core](../core/README.md)
|
|
18
18
|
- ❌ Want custom UI → Use [@youversion/platform-react-hooks](../hooks/README.md)
|
|
19
19
|
|
|
@@ -30,15 +30,13 @@ Get your App Key at [platform.youversion.com](https://platform.youversion.com/)
|
|
|
30
30
|
Import styles and wrap your app:
|
|
31
31
|
|
|
32
32
|
```tsx
|
|
33
|
-
import { BibleSDKProvider,
|
|
33
|
+
import { BibleSDKProvider, BibleTextView } from '@youversion/platform-react-ui';
|
|
34
34
|
import '@youversion/platform-react-ui/styles.css';
|
|
35
35
|
|
|
36
36
|
function App() {
|
|
37
37
|
return (
|
|
38
|
-
<BibleSDKProvider appKey="YOUR_APP_KEY">
|
|
39
|
-
<
|
|
40
|
-
<VerseOfTheDay versionId={111} />
|
|
41
|
-
</YVPProvider>
|
|
38
|
+
<BibleSDKProvider appKey={"YOUR_APP_KEY"}>
|
|
39
|
+
<BibleTextView reference="JHN.1.1-4" versionId={111} />
|
|
42
40
|
</BibleSDKProvider>
|
|
43
41
|
);
|
|
44
42
|
}
|
|
@@ -50,7 +48,7 @@ Toggle theme via the `YVPProvider`:
|
|
|
50
48
|
|
|
51
49
|
```tsx
|
|
52
50
|
import { useState } from 'react';
|
|
53
|
-
import { BibleSDKProvider, YVPProvider } from '@youversion/platform-react-ui';
|
|
51
|
+
import { BibleSDKProvider, YVPProvider, BibleTextView } from '@youversion/platform-react-ui';
|
|
54
52
|
|
|
55
53
|
export default function App() {
|
|
56
54
|
const [theme, setTheme] = useState<'light' | 'dark'>('light');
|
|
@@ -61,6 +59,7 @@ export default function App() {
|
|
|
61
59
|
<button onClick={() => setTheme(theme === 'light' ? 'dark' : 'light')}>
|
|
62
60
|
Toggle theme
|
|
63
61
|
</button>
|
|
62
|
+
<BibleTextView reference="JHN.1.1-4" versionId={111} />
|
|
64
63
|
</YVPProvider>
|
|
65
64
|
</BibleSDKProvider>
|
|
66
65
|
);
|
|
@@ -77,6 +76,12 @@ Customize via CSS variables:
|
|
|
77
76
|
}
|
|
78
77
|
```
|
|
79
78
|
|
|
80
|
-
|
|
79
|
+
## Documentation and API Reference
|
|
80
|
+
* [developers.youversion.com/sdks/react](https://developers.youversion.com/sdks/react)
|
|
81
|
+
|
|
82
|
+
## License
|
|
83
|
+
|
|
84
|
+
This SDK is licensed under [Apache 2.0](./LICENSE).
|
|
81
85
|
|
|
82
|
-
|
|
86
|
+
Licensing information for the Bible versions is available
|
|
87
|
+
at the [YouVersion Platform](https://platform.youversion.com/) site.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@youversion/platform-react-ui",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.7",
|
|
4
4
|
"description": "React SDK for YouVersion Platform",
|
|
5
5
|
"license": "TBD",
|
|
6
6
|
"type": "module",
|
|
@@ -40,8 +40,8 @@
|
|
|
40
40
|
"lucide-react": "0.546.0",
|
|
41
41
|
"tailwind-merge": "3.3.1",
|
|
42
42
|
"tw-animate-css": "1.4.0",
|
|
43
|
-
"@youversion/platform-core": "0.5.
|
|
44
|
-
"@youversion/platform-react-hooks": "0.5.
|
|
43
|
+
"@youversion/platform-core": "0.5.7",
|
|
44
|
+
"@youversion/platform-react-hooks": "0.5.7"
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {
|
|
47
47
|
"react": ">=19.1.0 <20.0.0",
|
|
@@ -92,9 +92,9 @@
|
|
|
92
92
|
"sdk",
|
|
93
93
|
"youversion"
|
|
94
94
|
],
|
|
95
|
-
"homepage": "https://github.com/youversion/sdk-
|
|
95
|
+
"homepage": "https://github.com/youversion/platform-sdk-react#readme",
|
|
96
96
|
"bugs": {
|
|
97
|
-
"url": "https://github.com/youversion/sdk-
|
|
97
|
+
"url": "https://github.com/youversion/platform-sdk-react/issues"
|
|
98
98
|
},
|
|
99
99
|
"msw": {
|
|
100
100
|
"workerDirectory": [
|