Skip to content

docs(apple): document global view models and binding migration - #976

Open
dskuza wants to merge 2 commits into
mainfrom
apple/global-view-models
Open

dskuza wants to merge 2 commits into
mainfrom
apple/global-view-models

Conversation

@dskuza

@dskuza dskuza commented Sep 17, 2026

Copy link
Copy Markdown
Collaborator

Updates the Apple runtime docs for global view model support in https://github.com/rive-app/rive/pull/13377. Examples now create and retain instances explicitly, bind them during state machine creation or with the async binding API, and pass the configured components to Rive.

  • Document global discovery, conditional light/dark bindings, and setter semantics: omitted globals remain bound.
  • Explain the deprecated APIs and the initializer behavior change that leaves Rive.viewModelInstance nil.
  • Include an explicit setup recipe and an optional app-owned Rive.autoBound(...) extension returning the main and global instances.
  • Update the Apple overview and state-machine error guidance, and fix related data-binding example typos.

Publication should align with the runtime change's release.

Validation: mint broken-links and git diff --check pass. The helper passes Swift syntax parsing; it has not been compiled against the runtime.

@dskuza
dskuza requested a review from a team as a code owner September 17, 2026 20:28
@mintlify

mintlify Bot commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
rive 🟢 Ready View Preview Sep 17, 2026, 8:38 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The new helper passes optional artboard and state-machine names directly to APIs that require resolved names, so the sample does not compile as written.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Updates Apple runtime documentation for global view model binding and migration from deprecated auto-binding APIs.

Changes:

  • Documents global discovery, rebinding, defaults, and error semantics.
  • Adds explicit instance-retention setup and an optional helper.
  • Refreshes overview/state-machine guidance and fixes binding examples.
File summaries
File Description
runtimes/apple/data-binding.mdx Adds global binding and rebinding documentation.
runtimes/apple/migrating-from-legacy.mdx Documents migration and explicit setup patterns.
runtimes/apple/apple.mdx Updates Apple quick-start guidance.
runtimes/apple/state-machines.mdx Updates binding and error guidance.
Review details
  • Files reviewed: 4/4 changed files
  • Comments generated: 3
  • Review effort level: Lite (auto)

Note

Copilot is running an experiment and ran this review at Lite.


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread runtimes/apple/migrating-from-legacy.mdx
Comment thread runtimes/apple/migrating-from-legacy.mdx
Comment thread runtimes/apple/data-binding.mdx Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation changes are consistent and no unresolved issues were found.

Review details
  • Files reviewed: 4/4 changed files
  • Comments generated: 0 new
  • Review effort level: Lite (auto)

Note

Copilot is running an experiment and ran this review at Lite.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants