Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add support for live content API #1152

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Conversation

rdunk
Copy link
Collaborator

@rdunk rdunk commented Feb 3, 2025

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This PR adds support for the new Live Content API.

If I've got this one right, I think Nuxt will be a strong contender for the best Sanity Visual Editing experience (when optimistic state lands in another PR). We can maintain the "fastest" path for live updates when in Presentation tool, in addition to having live content in production or when viewing the app in preview mode outside of Presentation. And because Nuxt lets us take care of all the implementation details under the hood, the path for adding this feature for users is still by far the simplest of any framework. In fact adding live content to an existing app should be possible with only a few more lines of configuration.

There is quite a bit of refactoring in this PR as I've tried to move the module away from loading configuration dependent implementations of the same composables. I've tried to avoid breaking changes, assuming we can keep this is a minor release. Input appreciated!

Copy link

netlify bot commented Feb 3, 2025

βœ… Deploy Preview for nuxt-sanity-module canceled.

Name Link
πŸ”¨ Latest commit ce4bf36
πŸ” Latest deploy log https://app.netlify.com/sites/nuxt-sanity-module/deploys/67a922154dc76e0008040811

@rdunk rdunk force-pushed the feat/live-content-api branch from a174c39 to 0dff794 Compare February 4, 2025 14:40
@rdunk
Copy link
Collaborator Author

rdunk commented Feb 4, 2025

The conditional addImports calls seem to be a bit of a headache with type checking. Would it make more sense to just make composables available regardless, and warn/error if they're used with incorrect configuration?

@rdunk rdunk marked this pull request as ready for review February 6, 2025 11:43
@rdunk
Copy link
Collaborator Author

rdunk commented Feb 6, 2025

Moved to Ready to Review as I think this is ready for input, but will need to investigate why the CI type checks are still failing.

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.

2 participants