search

enzonotario / vitepress-openapi

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

feat(useTheme): allows to configure operation's slots and cols #101

Closed enzonotario closed 3 weeks ago

enzonotario commented 4 weeks ago

Description

Allows to configure OAOperation slots and cols via useTheme for better customization.

Related issues/external references

Closes #91

Types of changes

vercel[bot] commented 4 weeks ago

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

Name Status Preview Comments Updated (UTC)
vitepress-openapi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 27, 2024 2:22pm
coderabbitai[bot] commented 4 weeks ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request enhance the theme configuration functionality by introducing new reactive properties and modifying the template structure in ThemeConfiguration.vue. The layout of components in one-page.md and example/one-page.md is adjusted with a new wrapping <div>. The useTheme composable documentation is updated with new properties, and the OAOperation component simplifies its structure by removing mobile path handling. Additionally, the OAPath component introduces computed properties for dynamic slot rendering, while the useTheme.ts file enhances the OperationConfig interface with optional properties.

Changes

File Change Summary
dev/.vitepress/theme/components/ThemeConfiguration.vue Added reactive references sticky, params, and initialized availableSlots. Modified template to include sticky behavior and reorganized configuration options. Introduced a watcher for dynamic updates to hidden slots. Scoped styles adjusted for <h3> elements.
dev/one-page.md, docs/example/one-page.md Introduced a new <div> wrapping <ThemeConfiguration /> and <OASpec :isDark="isDark" /> components, altering layout with classes relative, flex, flex-col, and gap-4.
docs/composables/useTheme.md Updated documentation to include new configuration options for the operation property, detailing new slots and properties like hiddenSlots and cols.
src/components/Operation/OAOperation.vue Removed mobile path handling from the OAOperation component, simplifying its structure while retaining other slot functionalities.
src/components/Path/OAPath.vue Added computed properties operationSlots and operationCols for dynamic slot rendering based on theme configuration. Adjusted template for conditional rendering of slots.
src/composables/useTheme.ts Enhanced OperationConfig interface by making badges optional and adding new properties: slots, hiddenSlots, and cols. Introduced DEFAULT_OPERATION_SLOTS and new getter/setter functions for managing slots and columns.
src/types.ts Modified OperationSlot type by removing 'path-mobile' and commenting out future slot implementations: 'summary', 'tags', 'servers', and 'parameters'.
src/components/Path/OAPaths.vue Integrated useTheme to manage lazy rendering based on theme configuration, modifying the :is-lazy prop in the OALazy component.
src/components/Path/OAPathsByTags.vue Updated the :is-lazy prop binding to include a check for lazyRendering, enhancing the conditional rendering logic.
dev/criptoya-argentina/index.md Modified the behavior of the useTheme function to adjust the request property during the component lifecycle.
package.json Added new dependency "@amoutonbrady/lz-string": "^0.1.0" to devDependencies.
test/composables/useTheme.test.ts Updated test cases to reflect changes in the useTheme configuration structure, including new properties and their expected behaviors.

Assessment against linked issues

Objective Addressed Explanation
Enable single column layout for OASpec (91) ✅
Make child components configurable (91) ✅

Possibly related PRs

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 4 weeks ago

Open in Stackblitz

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

commit: 76c0f67