Skip to content

Commit 3de5ca8

Browse files
committed
iOS AR docs
1 parent f695071 commit 3de5ca8

1 file changed

Lines changed: 21 additions & 6 deletions

File tree

documentation/how-to-guides/xr/ios-webxr-app-clip.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,21 @@ Needle Engine's iOS WebXR support includes comprehensive functionality:
138138

139139
## Custom Branding for iOS AR
140140

141-
On iOS, the Needle Go App Clip experience includes a splash screen and wording. This branding can be customized for your project with a PRO subscription. Custom branding is only supported when using **QR codes** to launch the AR experience.
141+
On iOS, the Needle Go App Clip experience includes a splash screen and wording. This branding can be customized for your project with a PRO subscription — your own header image, title, subtitle, and call-to-action button.
142+
143+
Custom branding is delivered through a **dedicated branded link** we set up for your experience, of the form:
144+
145+
```
146+
https://appclip.needle.tools/x/<your-experience>
147+
```
148+
149+
Opening this link on an iPhone or iPad shows **your** App Clip card (your image, title, and subtitle) before launching into AR.
150+
151+
::: tip Now works from a link click — not only QR codes
152+
Previously, custom branding only appeared when launching via a **QR code**. Your branded `/x/…` link now also shows your custom card when **tapped directly** in Safari — so you can put it behind an *Enter AR* button on your website, send it in a message, or link to it from any app. Opening it in Safari presents your branded App Clip card automatically.
153+
154+
Note: only your branded `/x/…` link carries your branding. The generic `…/ar?url=…` link always shows the default Needle card, because Apple selects the card by URL **path** (and your branded experience is registered on its own path).
155+
:::
142156

143157
Scan the QR code below with your iOS device to see how the App Clip card looks with the [image tracking sample](/docs/how-to-guides/xr/image-tracking):
144158

@@ -174,13 +188,14 @@ Ensure that camera permissions are granted. Check in your device settings if the
174188

175189
### I don't see my custom branding
176190

177-
Custom branding is only shown when the App Clip is launched via a **QR code** that encodes the App Clip URL directly. Make sure your QR code uses the following format:
191+
Custom branding is shown on your dedicated **branded link** (`https://appclip.needle.tools/x/<your-experience>`), opened in **Safari** on iOS — via either a direct tap or a QR code. If it doesn't appear, check:
178192

179-
```
180-
https://appclip.needle.tools/ar?url=<your-webxr-url>
181-
```
193+
- You're using your branded `/x/<your-experience>` link, **not** the generic `https://appclip.needle.tools/ar?url=…` link (the generic one always shows the default Needle card).
194+
- You opened it in **Safari**. App Clip cards don't appear in Chrome or Firefox on iOS — those browsers prompt you to open the page in Safari first.
195+
- Your custom branding is active (PRO) and the experience has been approved on Apple's side (a newly set-up experience can take a little while to go live).
196+
- The full Needle Go app isn't already installed on the device — if it is, iOS shows an "Open" banner instead of the App Clip card.
182197

183-
If you link to your website first and let users navigate to the AR experience from there, the App Clip card won't show your custom branding. See [Custom Branding for iOS AR](#custom-branding-for-ios-ar) for details.
198+
See [Custom Branding for iOS AR](#custom-branding-for-ios-ar) for details.
184199

185200
## Contact Us
186201

0 commit comments

Comments
 (0)