Skip to content

[MOB-11189] add-disclaimer-about-not-supporting-new-architectu #630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 10, 2025
Merged

[MOB-11189] add-disclaimer-about-not-supporting-new-architectu #630

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6119f4
docs: add note on architecture support for React Native SDK compatibi…
lposen Apr 10, 2025
5d7f988
docs: add table of contents to README for improved navigation
lposen Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,25 @@ message and web push notification campaigns to your customers.
This SDK helps you integrate your React Native-based iOS and Android apps with
Iterable. It supports JavaScript and TypeScript.


<!-- @import "[TOC]" {cmd="toc" depthFrom=2 depthTo=6 orderedList=false} -->

<!-- code_chunk_output -->

- [Requirements](#requirements)
- [Architecture Support](#architecture-support)
- [Installation](#installation)
- [Features](#features)
- [Sample projects](#sample-projects)
- [Version mapping](#version-mapping)
- [Release notes, support and troubleshooting](#release-notes-support-and-troubleshooting)
- [License](#license)
- [Want to contribute?](#want-to-contribute)

<!-- /code_chunk_output -->



## Requirements

Iterable's React Native SDK relies on:
Expand All @@ -33,6 +52,10 @@ Iterable's React Native SDK relies on:
- [`minSdkVersion` 21+, `compileSdkVersion` 31+](https://medium.com/androiddevelopers/picking-your-compilesdkversion-minsdkversion-targetsdkversion-a098a0341ebd)
- [Iterable's Android SDK](https://github.com/Iterable/iterable-android-sdk)

## Architecture Support

**Important**: Iterable's React Native SDK currently does not support [React Native's New Architecture](https://reactnative.dev/architecture/landing-page) (Fabric, TurboModules, and Codegen). The SDK is designed to work with the **legacy architecture only**. If you're using the New Architecture in your React Native application, you may encounter compatibility issues.

## Installation

For installation instructions, read [Installing Iterable's React Native SDK](https://support.iterable.com/hc/articles/360045714132).
Expand Down