Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 4693057

Browse files
committed
Doc updates
1 parent 99da36f commit 4693057

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This plugin provides client-side integration for the [CodePush service](http://c
44

55
* [How does it work?](#how-does-it-work)
66
* [Supported React Native Platforms](#supported-react-native-platforms)
7+
* [Supported Components](#supported-components)
78
* [Getting Started](#getting-started)
89
* [iOS Setup](#ios-setup)
910
* [Plugin Installation](#plugin-installation-ios)
@@ -46,6 +47,24 @@ We try our best to maintain backwards compatability of our plugin with previous
4647
| v0.19.0-v0.21.0 | v1.7.0+ *(introduced Android asset support)* |
4748
| v0.22.0+ | TBD :) We work hard to respond to new RN releases, but they do occasionally break us. We will update this chart with each RN release, so that users can check to see what our "official" support is.
4849

50+
## Supported Components
51+
52+
The following list represents the set of components (and props) that currently support their assets being updated via CodePush:
53+
54+
| Component | Prop(s) |
55+
|-------------------------------------------------|------------------------------------------|
56+
| `Image` | `src` |
57+
| `ProgressViewIOS` | `progressImage`, `trackImage` |
58+
| `TabBarIOS.Item` | `icon`, `selectedIcon` |
59+
| `ToolbarAndroid` <br />*(React Native 0.21.0+)* | `actions[].icon`, `logo`, `overflowIcon` |
60+
61+
The following list represents the set of components (and props) that don't currently support their assets being updated via CodePush:
62+
63+
| Component | Prop(s) |
64+
|-------------|----------------------------------------------------------------------|
65+
| `SliderIOS` | `maximumTrackImage`, `minimumTrackImage`, `thumbImage`, `trackImage` |
66+
67+
As new core compoents are released, which suport referencing assets, we'll update this list to ensure users know what exactly they can update using CodePush.
4968
## Getting Started
5069

5170
Once you've followed the general-purpose ["getting started"](http://codepush.tools/docs/getting-started.html) instructions for setting up your CodePush account, you can start CodePush-ifying your React Native app by running the following command from within your app's root directory:

0 commit comments

Comments
 (0)