Skip to content

Commit 654f401

Browse files
msluszniakmsluszniak
authored
docs: Create compatibility table (#976)
## Description <!-- Provide a concise and descriptive summary of the changes implemented in this PR. --> ### Introduces a breaking change? - [ ] Yes - [x] No ### Type of change - [ ] Bug fix (change which fixes an issue) - [ ] New feature (change which adds functionality) - [x] Documentation update (improves or adds clarity to existing documentation) - [ ] Other (chores, tests, code style improvements etc.) ### Tested on - [x] iOS - [x] Android ### Testing instructions - [ ] Build documentation locally, check if the section is on the sidebar. - [ ] **Optionally**, repeat testing with versions and check that tables are correct. ### Screenshots <img width="1004" height="768" alt="image" src="https://github.com/user-attachments/assets/cef498a9-23a0-491f-8139-cf15c0999a9d" /> ### Related issues Closes #533 ### Checklist - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have updated the documentation accordingly - [x] My changes generate no new warnings ### Additional notes Links in `README.md` will be correct after deploying documentation.
1 parent 9406dd0 commit 654f401

File tree

11 files changed

+181
-6
lines changed

11 files changed

+181
-6
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ React Native ExecuTorch bridges the gap between React Native and native platform
6464
The minimal supported version are:
6565
* iOS 17.0
6666
* Android 13
67-
* React Native 0.81
67+
* React Native - see [compatibility table](https://docs.swmansion.com/react-native-executorch/docs/next/other/compatibility)
6868

6969
> [!IMPORTANT]
7070
> React Native ExecuTorch supports only the [New React Native architecture](https://reactnative.dev/architecture/landing-page).

‎docs/docs/01-fundamentals/01-getting-started.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ React Native Executorch supports only the [New React Native architecture](https:
3434

3535
If your app still runs on the old architecture, please consider upgrading to the New Architecture.
3636

37+
For supported React Native and Expo versions, see the [Compatibility table](../07-other/01-compatibility.mdx).
38+
3739
## Installation
3840

3941
Installation is pretty straightforward, just use your favorite package manager.

‎docs/docs/07-other/01-compatibility.mdx‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: Compatibility
3+
slug: /other/compatibility
4+
description: 'React Native ExecuTorch compatibility table showing which versions of React Native are supported.'
5+
---
6+
7+
import styles from '@site/src/components/CompatibilityTable/styles.module.css';
8+
9+
## New Architecture (Fabric)
10+
11+
React Native ExecuTorch supports only the [New Architecture](https://reactnative.dev/architecture/landing-page) of React Native.
12+
13+
## react-native-executorch
14+
15+
<div className={styles.compatibility}>
16+
<table>
17+
<thead>
18+
<tr>
19+
<th rowSpan={2}>React Native ExecuTorch</th>
20+
<th colSpan={6}>React Native version</th>
21+
</tr>
22+
<tr>
23+
<th>0.78</th>
24+
<th>0.79</th>
25+
<th>0.80</th>
26+
<th>0.81</th>
27+
<th>0.82</th>
28+
<th>0.83</th>
29+
</tr>
30+
</thead>
31+
<tbody>
32+
<tr>
33+
<td><div className={styles.version}>0.8.x</div></td>
34+
<td><div className={styles.notSupported}>no</div></td>
35+
<td><div className={styles.notSupported}>no</div></td>
36+
<td><div className={styles.notSupported}>no</div></td>
37+
<td><div className={styles.supported}>yes</div></td>
38+
<td><div className={styles.supported}>yes</div></td>
39+
<td><div className={styles.supported}>yes</div></td>
40+
</tr>
41+
</tbody>
42+
</table>
43+
</div>
44+
45+
## react-native-executorch-bare-resource-fetcher
46+
47+
<div className={styles.compatibility}>
48+
<table>
49+
<thead>
50+
<tr>
51+
<th rowSpan={2}>Bare Resource Fetcher</th>
52+
<th colSpan={6}>React Native version</th>
53+
</tr>
54+
<tr>
55+
<th>0.78</th>
56+
<th>0.79</th>
57+
<th>0.80</th>
58+
<th>0.81</th>
59+
<th>0.82</th>
60+
<th>0.83</th>
61+
</tr>
62+
</thead>
63+
<tbody>
64+
<tr>
65+
<td><div className={styles.version}>0.8.x</div></td>
66+
<td><div className={styles.notSupported}>no</div></td>
67+
<td><div className={styles.notSupported}>no</div></td>
68+
<td><div className={styles.notSupported}>no</div></td>
69+
<td><div className={styles.supported}>yes</div></td>
70+
<td><div className={styles.supported}>yes</div></td>
71+
<td><div className={styles.supported}>yes</div></td>
72+
</tr>
73+
</tbody>
74+
</table>
75+
</div>
76+
77+
## react-native-executorch-expo-resource-fetcher
78+
79+
<div className={styles.compatibility}>
80+
<table>
81+
<thead>
82+
<tr>
83+
<th rowSpan={2}>Expo Resource Fetcher</th>
84+
<th colSpan={4}>Expo SDK version</th>
85+
</tr>
86+
<tr>
87+
<th>52</th>
88+
<th>53</th>
89+
<th>54</th>
90+
<th>55</th>
91+
</tr>
92+
</thead>
93+
<tbody>
94+
<tr>
95+
<td><div className={styles.version}>0.8.x</div></td>
96+
<td><div className={styles.notSupported}>no</div></td>
97+
<td><div className={styles.notSupported}>no</div></td>
98+
<td><div className={styles.supported}>yes</div></td>
99+
<td><div className={styles.supported}>yes</div></td>
100+
</tr>
101+
</tbody>
102+
</table>
103+
</div>

‎docs/docs/07-other/_category_.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"label": "Other",
3+
"link": {
4+
"type": "generated-index"
5+
}
6+
}

‎docs/sidebars.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ const sidebars = {
4040
label: 'Utilities',
4141
items: [{ type: 'autogenerated', dirName: '05-utilities' }],
4242
},
43+
{
44+
type: 'category',
45+
label: 'Other',
46+
// 07 to avoid conflict with 06-api-reference which is auto-generated and not tracked by git
47+
items: [{ type: 'autogenerated', dirName: '07-other' }],
48+
},
4349
{
4450
type: 'category',
4551
label: 'API Reference',

‎docs/src/components/CompatibilityTable/styles.module.css‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
.compatibility {
2+
overflow-x: auto;
3+
}
4+
5+
.compatibility table {
6+
display: table;
7+
width: 100%;
8+
border-collapse: collapse;
9+
}
10+
11+
.compatibility th {
12+
text-align: center;
13+
padding: 8px 12px;
14+
white-space: nowrap;
15+
}
16+
17+
.compatibility td {
18+
text-align: center;
19+
padding: 6px 8px;
20+
}
21+
22+
.version {
23+
font-weight: 600;
24+
color: var(--swm-navy-light-100);
25+
white-space: nowrap;
26+
}
27+
28+
[data-theme='dark'] .version {
29+
color: var(--swm-navy-dark-40);
30+
}
31+
32+
.supported {
33+
background-color: var(--swm-green-light-40);
34+
color: var(--swm-green-dark-120);
35+
border-radius: 4px;
36+
padding: 4px 8px;
37+
font-weight: 600;
38+
font-size: 0.85rem;
39+
}
40+
41+
[data-theme='dark'] .supported {
42+
background-color: var(--swm-green-dark-140);
43+
color: var(--swm-green-dark-40);
44+
}
45+
46+
.notSupported {
47+
background-color: var(--swm-red-light-40);
48+
color: var(--swm-red-light-100);
49+
border-radius: 4px;
50+
padding: 4px 8px;
51+
font-weight: 600;
52+
font-size: 0.85rem;
53+
}
54+
55+
[data-theme='dark'] .notSupported {
56+
background-color: var(--swm-red-dark-140);
57+
color: var(--swm-red-dark-80);
58+
}

‎readmes/README_cn.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ React Native ExecuTorch 架起了 React Native 和原生平台功能之间的桥
6060

6161
- iOS 17.0
6262
- Android 13
63-
- React Native 0.81
63+
- React Native - 请参阅[兼容性表格](https://docs.swmansion.com/react-native-executorch/docs/next/other/compatibility)
6464

6565
> [!IMPORTANT]
6666
> React Native ExecuTorch 仅支持 [New React Native architecture](https://reactnative.dev/architecture/landing-page)。

‎readmes/README_es.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Las versiones mínimas compatibles son:
6060

6161
- iOS 17.0
6262
- Android 13
63-
- React Native 0.81
63+
- React Native - ver [tabla de compatibilidad](https://docs.swmansion.com/react-native-executorch/docs/next/other/compatibility)
6464

6565
> [!IMPORTANT]
6666
> React Native ExecuTorch solo admite la [nueva arquitectura de React Native](https://reactnative.dev/architecture/landing-page).

‎readmes/README_fr.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Les versions minimales supportées sont :
6060

6161
- iOS 17.0
6262
- Android 13
63-
- React Native 0.81
63+
- React Native - voir le [tableau de compatibilité](https://docs.swmansion.com/react-native-executorch/docs/next/other/compatibility)
6464

6565
> [!IMPORTANT]
6666
> React Native ExecuTorch ne supporte que la [nouvelle architecture React Native](https://reactnative.dev/architecture/landing-page).

‎readmes/README_in.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ React Native ExecuTorch, React Native और नेटिव प्लेटफ
6060

6161
- iOS 17.0
6262
- Android 13
63-
- React Native 0.81
63+
- React Native - [संगतता तालिका](https://docs.swmansion.com/react-native-executorch/docs/next/other/compatibility) देखें
6464

6565
> [!IMPORTANT]
6666
> React Native ExecuTorch केवल [नई React Native आर्किटेक्चर](https://reactnative.dev/architecture/landing-page) का समर्थन करता है।

0 commit comments

Comments
 (0)