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

docs: add import instructions when auto-imports are disabled #840

Merged

Conversation

deleteme
Copy link
Contributor

πŸ”— 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 like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This modifies the example Bridge config in the readme to include a line of usage instructions for the imports option.

This imports option might be used by people who want to preserve explicit import statements when upgrading to Nuxt Bridge.

Providing a convenient example of where the Nuxt composables would be imported from (#app), this might help avoid incorrectly assuming that they're available from the @nuxt/bridge package or the #imports alias.

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

README.md Outdated Show resolved Hide resolved
@danielroe danielroe changed the title docs: Add usage instructions to imports option in readme docs: add import instructions when auto-imports are disabled (#840) Jul 17, 2023
@danielroe danielroe changed the title docs: add import instructions when auto-imports are disabled (#840) docs: add import instructions when auto-imports are disabled Jul 17, 2023
@danielroe danielroe merged commit c06688b into nuxt:main Jul 17, 2023
7 checks passed
@danielroe danielroe mentioned this pull request Sep 14, 2023
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