#298 Adjust type of prop 'link' of FwbSidebarItem.vue

[zoltanka]

#298

In order to make the <FwbSidebarItem> work with named router links, I propose the following.

Now of course, the type { name: string } could be extracted into an interface if you wish.

Edit:

This could be adjusted to take route parameters in the FwbSidebarItem, so the input would not be just { name: string } instead { name: string, params ?: {[key: string]: string|number} }

Of course the type for the params is more complex than this: {[key: string]: string|number}.

// Assuming that I have the path `/tool/foo/{baz}`
<FwbSidebarItem :to="{ name: 'tool-foo-name', params: {baz: 23}}">

Summary by CodeRabbit

• New Features
  • Updated sidebar item links to support both string URLs and named route objects for improved navigation flexibility.

[coderabbitai]

Walkthrough

The FwbSidebarItem.vue component's link prop type has been updated to accept either a string or an object with a name property. This change enhances the flexibility of defining the link values, allowing both simple and more dynamic route specifications.

Changes

File	Change Summary
src/components/FwbSidebar/...	Updated the link prop to accept a string or an object with a name property.

Poem

In the sidebar's glow, a path we bestow,
Links now abound, in string or name's flow.
With object aplenty, navigation grows,
Seamlessly guiding wherever we go. 🚀

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify]

✅ Deploy Preview for sensational-seahorse-8635f8 ready!

Name	Link
🔨 Latest commit	ef43286
🔍 Latest deploy log	https://app.netlify.com/sites/sensational-seahorse-8635f8/deploys/6685638f7e231700089abdb8
😎 Deploy Preview	https://deploy-preview-299--sensational-seahorse-8635f8.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

src/components/FwbSidebar/FwbSidebarItem.vue (1)

22-22: Ensure type safety for the link prop.

The type { name: string } for the link prop is flexible and beneficial. However, consider extracting this into an interface for better readability and maintainability.

interface LinkObject {
  name: string
}

const props = withDefaults(
  defineProps<{
    link?: string | LinkObject
    tag?: string
  }>(),
  {
    link: '/',
    tag: 'router-link',
  },
)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a0f04ed and ef43286.

Files selected for processing (1)

• src/components/FwbSidebar/FwbSidebarItem.vue (1 hunks)

[zoltanka]

Now, what I made here is a very rudimentary solution. First I'd like some feedback if you would be open for such an enhancement. Then I make a more cleaner solution.