Skip to content

Commit 0f769e3

Browse files
authored
docs: update readme (#148)
* docs: update readme * docs: update readme
1 parent 8363e65 commit 0f769e3

2 files changed

Lines changed: 11 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This library serves as a wrapper for the three Ticketmaster Ignite SDK's: [Accou
77

88
In order to use the library, setup a developer account with Ticketmaster by contacting nexus_sdk@ticketmaster.com. When your account is activated you will receive an **API key** and **scheme** that you'll need to use to finish the setup.
99

10-
<details>
10+
<details open>
1111
<summary><h2 style="display:inline-block">Installation</h2></summary>
1212

1313
Depending on your package manager you can install this library with one of the below commands:
@@ -33,7 +33,7 @@ If your project is an **Expo Managed Workflow** project then skip the "Setting u
3333

3434
</details>
3535

36-
<details>
36+
<details open>
3737
<summary><h2 style="display:inline-block">Setting up iOS</h2></summary>
3838

3939
Edit the `Podfile` and set the platform to `17.0`
@@ -46,7 +46,7 @@ platform :ios, '17.0'
4646

4747
</details>
4848

49-
<details>
49+
<details open>
5050
<summary><h2 style="display:inline-block">Setting up Android</h2></summary>
5151

5252
#### Set the minSdkVersion and compileSdkVersion
@@ -178,14 +178,14 @@ The SDK's internal theme defaults the Tickets SDK status bar colour to Ticketmas
178178

179179
</details>
180180

181-
<details>
181+
<details open>
182182
<summary><h2 style="display:inline-block">Setting up Expo</h2></summary>
183183

184184
If you are using an Expo (Continuous Native Generation) workflow, ignore the "Setting up iOS" and "Setting up Android" sections above — the native `ios/` and `android/` directories are regenerated by `expo prebuild`, so everything must be configured through a config plugin instead. See [`docs/expo.md`](./docs/expo.md) for a complete example plugin covering the **Kotlin version pin** (required for Ticketmaster SDK `3.18.0`+), `dataBinding`/desugaring, `compileSdk`/`minSdk`, the **login redirect scheme**, and the iOS deployment target.
185185

186186
</details>
187187

188-
<details>
188+
<details open>
189189
<summary><h2 style="display:inline-block">Usage</h2></summary>
190190

191191
The full User Guide with all methods can be found [here](./docs/user-guide.md)
@@ -231,7 +231,7 @@ See the full User Guide [here](./docs/user-guide.md)
231231

232232
</details>
233233

234-
<details>
234+
<details open>
235235
<summary><h2 style="display:inline-block">Running the demo apps</h2></summary>
236236

237237
To run the React Native example app:
@@ -260,7 +260,7 @@ Then run the project with either `yarn expo:android`/`yarn expo:ios`
260260

261261
</details>
262262

263-
<details>
263+
<details open>
264264
<summary><h2 style="display:inline-block">Environment variables</h2></summary>
265265

266266
In order to use the library, setup a developer account with Ticketmaster by contacting nexus_sdk@ticketmaster.com.

docs/user-guide.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -406,6 +406,8 @@ If you do not send a style prop, `{width: '100%', height: '100%'}` is used by de
406406
If you want to force the `<TicketsSdkEmbedded />` component to carry out a fresh call on focus or after navigation to that tab/screen, you can add the below to any screen that renders the `<TicketsSdkEmbedded />` component to perform an unmount on blur behaviour:
407407

408408
```typescript
409+
import { useIsFocused } from '@react-navigation/native';
410+
409411
const isFocused = useIsFocused();
410412

411413
return (
@@ -495,6 +497,8 @@ The `<TicketsSdkEmbedded />` component has a deep link prop which takes an order
495497
Example:
496498
497499
```typescript
500+
import { useIsFocused } from '@react-navigation/native';
501+
498502
const isFocused = useIsFocused();
499503
// Set the deeplink value in an earlier screen or with redux/context before navigating to the screen rendering the Tickets SDK.
500504
const [ticketDeepLinkId, setTicketDeepLinkId] = useState('');

0 commit comments

Comments
 (0)