4 | 
18 | 
`
33 | name: 'mySharedAssets',
34 | // The virtual path is how hrefs from the root of the shared
35 | // directory are determined. For example, to use a shared image
36 | // the portal code may look something like this:
37 | // 
38 | virtualPath: '/virtual',
39 | // The root directory of the assets relative to Bundle.main on
40 | // iOS and src/main/assets on Android. If omitted, the root
41 | // of Bundle.main and src/main/assets will be used.
42 | startDir: 'shared'
43 | }
44 | ]
45 | }
46 | ```
47 |
48 | When this Portal loads, the shared asset information will be passed to the web content as part of the Portal's [InitialContext](../../for-web/portals-plugin.md#initialcontext) object.
49 |
50 | ## Using Registered Assets
51 |
52 | Refer to the page in the [Web docs](../../for-web/sharing-assets.md) to learn how to use your registered shared assets in your web content.
53 |
--------------------------------------------------------------------------------
/website/docs/for-react-native/how-to/statically-define-portals.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Static Portals Configuration File
3 | sidebar_label: Statically Register Portals
4 | ---
5 |
6 | An additional configuration method is now included to support a JSON configuration file to configure Portals on application start. The JSON file must be named `portals.config.json` and be placed in the application root on iOS and `assets` root on Android.
7 |
8 | ## JSON Schema
9 |
10 | This Typescript schema is for illustration purposes only.
11 |
12 | ```typescript
13 | type PortalConfig = {
14 | // The name of the public key file for secure live updates. If secure
15 | // live updates are not being used, this field is not needed.
16 | // Must be located in the Bundle.main root on iOS and assets root on Android.
17 | liveUpdatesKey?: string;
18 | // The portals registration key normally passed to `register`.
19 | // This can be omitted if the `register` function is called before
20 | // attempting to render any portals in code.
21 | registrationKey?: string;
22 | }
23 | ```
24 |
25 | ### Example Configuration
26 |
27 | ```json title=portals.config.json
28 | {
29 | "registrationKey": "YOUR_PORTALS_KEY",
30 | }
31 | ```
32 |
33 |
--------------------------------------------------------------------------------
/website/docs/for-react-native/how-to/sync-with-live-updates.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Syncing a Portal with Live Updates
3 | sidebar_label: Syncing with Live Updates
4 | ---
5 |
6 | The sync operation checks AppFlow for a new version of a web app used in a Portal. If an update is available, the files are downloaded and the Portal is updated to use those new files the next time it loads. The Live Updates SDK will perform a sync with the Live Update Config is added to the portal if it has been configured with `syncOnAdd: true`. This is typically done when an app is initially launched and requires a restart of an app to trigger subsequent syncs. We recommend performing a sync in other situations to provide more chances for Portals to update.
7 |
8 | ## Triggering a Sync
9 |
10 | A sync can be triggered by calling the `syncOne`, `syncSome`, or `syncAll` functions exposed in `@ionic/portals-react-native`:
11 |
12 | ```typescript
13 | import { syncOne, syncSome, syncAll } from `ionic/portals-react-native`;
14 |
15 | // Sync a single live update
16 | const singleResult = await syncOne('appId1');
17 |
18 | // Sync many live updates
19 | const manyResult = await syncSome(['appId1', 'appId2']);
20 |
21 | // Sync all live updates
22 | const allResult = await syncAll();
23 | ```
24 |
25 | The appId provided to `syncOne` and `syncSome` should correspond to the live update configuration associated with the Portal desired to be updated.
26 |
27 | See the Portals for React Native [reference documentation](https://react-native-ionic-portals.vercel.app) for the data that is returned from the sync calls.
28 |
29 |
--------------------------------------------------------------------------------
/website/docs/for-react-native/known-issues.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Known Issues
3 | sidebar_label: Known Issues
4 | ---
5 |
6 | ## iOS Notifications
7 |
8 | All versions of IonicPortals on iOS prior to 0.6.5 contain a bug where Capacitor takes control as the `UNNotificationCenterDelegate`. Upgrading to 0.6.5 will resolve the issue.
9 |
10 | ## iOS Swift Package Manager Integration
11 |
12 | There are currently two separate, but similar issues when integrating IonicPortals as an SPM dependency. Both manifest themselves as Invalid Bundle errors from App Store Connect
13 |
14 | ### IonicPortals as a single target dependency
15 |
16 | Capacitor v3.5.1 has an issue where it has an embedded `Cordova.framework`. This causes uploading to App Store Connect to fail with error codes `ITMS-90205` and `ITMS-90206`. The workaround is to delete the embedded framework as part of your build process:
17 |
18 | First, select the affected scheme in Xcode and click "Edit Scheme...":
19 |
20 | 
21 |
22 | Next, expand the "Build" drop down and select "Post-actions" to run the script after your build has completed:
23 |
24 | 
25 |
26 | Then, click the "+" button and select "New Run Script Action":
27 |
28 | 
29 |
30 | In the Run Script Action editor, select the target whose build settings you need to inherit:
31 |
32 | 
33 |
34 | Finally, add the following script in the script editor:
35 |
36 | ```bash
37 | rm -rf "${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.app/Frameworks/Capacitor.framework/Frameworks"
38 | ```
39 |
40 | 
41 |
42 | ### IonicPortals as a multi-target dependency
43 |
44 | When using IonicPortals as a multi-target dependency across Application and Framework targets, Xcode embeds `Capacitor.framework`, `Cordova.framework`, `IonicLiveUpdates.framework`, and `IonicPortals.framework` into your Framework targets as well.
45 |
46 | To avoid this altogether, you can migrate your Frameworks to be Swift Packages. However, if migrating framework targets to be Swift Packages isn't an option, then in addition to the steps outlined in [IonicPortals as a single target dependency](#ionicportals-as-a-single-target-dependency) add the following to the "Run Script Action" configured in that section:
47 |
48 | ```bash
49 | rm -rf "${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.app/Frameworks/YourFrameworkUsingPortals.framework/Frameworks"
50 | ```
51 |
52 | 
53 |
--------------------------------------------------------------------------------
/website/docs/for-react-native/live-updates.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Getting Started with Live Updates
3 | sidebar_label: Live Updates
4 | ---
5 |
6 | import Tabs from '@theme/Tabs';
7 | import TabItem from '@theme/TabItem';
8 | import CodeBlock from '@theme/CodeBlock';
9 | import { getCapacitorVersion, getPortalsVersion, getPortalsVersionIos, getPortalsVersionAndroid, getPortalsVersionRN } from '@site/src/util';
10 |
11 | Getting started with Live Updates in your Portals app.
12 |
13 | :::info
14 | To use the Live Updates SDK with Ionic Portals, check out the [Getting Started Guide](./guide.md) for Ionic Portals first.
15 | :::
16 |
17 | ## Appflow
18 |
19 | Create an app for your Portal in the [Ionic Dashboard](https://dashboard.ionicframework.com). For more information, see our documentation on [using Appflow](https://ionic.io/docs/appflow/quickstart/connect).
20 |
21 | :::info
22 | Take note of the **appId** of your app in Appflow, this will be used by the Live Updates sdk.
23 | :::
24 |
25 | To test Live Updates, create a new build of your app in Appflow and create a deployment to Live Updates from that build. Take note of the **channel** name as this is also used in the Live Updates sdk.
26 |
27 | 
28 |
29 | Deployments in Appflow will be downloaded as new Live Updates.
30 |
31 | ## Install
32 |
33 | The Live Updates SDK is publicly available via Maven Central, Cocoapods, and SPM.
34 |
35 | Live Updates is already added to your React Native project if you have the dependency for Portals in your `package.json`:
36 |
37 | ![]({useBaseUrl("/img/portals-key-screenshot-thumbnail.webp")})
22 |
23 | :::tip
24 | Later in these docs this key will be referred to as `YOUR_PORTALS_KEY`.
25 | :::
26 |
27 | From here, continue on to configuring the key in your Portals application.
28 |
29 | - [Getting Started Guide iOS](./for-ios/quick-start.md)
30 | - [Getting Started Guide Android](./for-android/guide.md)
31 | - [Getting Started Guide React Native](./for-react-native/guide.md)
32 | - [Federated Capacitor](./for-capacitor/overview.md)
33 |
34 | :::note
35 | You only need to register for a product key once for each organization you belong to. You can return to the Portals Key section of the Ionic Dashboard to retrieve your key at any time.
36 | :::
37 |
38 | ## Supported Platform Versions
39 |
40 | 43 | A complete release history for {props.name} is available{" "} 44 | 45 | on GitHub 46 | 47 | . Documentation for recent releases can also be found below. 48 |
49 | 50 |
51 | {props.releases.map((release: Release, index) => (
52 |
58 |
92 | ))}
93 |
94 |
59 |
91 |
60 |
64 |
82 | 65 | 66 | {release.version} 67 | 68 |
69 | 70 | {release.type} 71 | {index === 0 ? ( 72 | 78 | Latest Production Version 79 | 80 | ) : null} 81 |
83 |
85 |
90 | {release.published_at}
84 |95 | To see more releases, visit{" "} 96 | 97 | GitHub 98 | 99 | . 100 |101 |