search

enzonotario / vitepress-openapi

Generate VitePress API Docs from OpenAPI specifications
https://vitepress-openapi.vercel.app
MIT License
36 stars 8 forks source link

change(Try section): avoid SSR #67

Closed enzonotario closed 2 days ago

enzonotario commented 2 days ago

Description

Wraps Try section in ClientOnly to avoid SSR, since it includes client-only code.

Related issues/external references

Fixes #65

Types of changes

vercel[bot] commented 2 days ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
vitepress-theme-openapi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 5, 2024 11:09pm
coderabbitai[bot] commented 2 days ago

Walkthrough

The changes involve wrapping the OATryWithVariables component in a ClientOnly component within the try-it slot template of src/components/Common/OAOperation.vue. This adjustment ensures that the OATryWithVariables component is rendered exclusively on the client side, accommodating components that rely on browser-specific features. No other modifications were made to the component's structure, logic, or control flow.

Changes

File Path Change Summary
src/components/Common/OAOperation.vue Added a ClientOnly wrapper around the OATryWithVariables component in the try-it slot template.
📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: ASSERTIVE**
📥 Commits Files that changed from the base of the PR and between 957918ef510ed4e80f8997e21c6a58ee40ac6518 and 8dd4bc66aff97a6d6602d9c4facfc64df9056469.
📒 Files selected for processing (1) * src/components/Common/OAOperation.vue (1 hunks)
🔇 Additional comments (1)
src/components/Common/OAOperation.vue (1)
`269-280`: **LGTM! Wrapping OATryWithVariables with ClientOnly prevents SSR issues.** The addition of the `ClientOnly` wrapper around the `OATryWithVariables` component is a good solution to prevent server-side rendering (SSR) of client-only code. This change aligns perfectly with the PR objective and should resolve the SSR-related issues mentioned in the related issue #65. Some benefits of this change: 1. It ensures that the "Try" section is only rendered on the client-side, avoiding potential SSR compatibility problems. 2. It doesn't affect the functionality or props of the `OATryWithVariables` component. 3. The implementation is clean and follows Vue best practices for handling client-only components.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
pkg-pr-new[bot] commented 2 days ago

Open in Stackblitz

pnpm add https://pkg.pr.new/vitepress-theme-openapi@67
pnpm add https://pkg.pr.new/vitepress-theme-openapi@67

commit: 8dd4bc6