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

Fix FWBInput does not support v-model.number (#273) #327

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

alfatta
Copy link

@alfatta alfatta commented Oct 2, 2024

This pull request enhances the modelValue prop to accept not only string types but also number types. This improvement provides more flexibility in handling diverse data inputs for the component especially when using v-model.number modifier.

Summary by CodeRabbit

  • New Features
    • Enhanced FwbInput component to accept both string and numeric inputs for improved flexibility.

Copy link

coderabbitai bot commented Oct 2, 2024

Walkthrough

The changes involve an update to the InputProps interface in the FwbInput.vue component. The modelValue property type has been modified from string to string | number, allowing for both string and numeric inputs. This adjustment enhances the component's flexibility in handling various input types while leaving the overall structure of the component unchanged.

Changes

File Path Change Summary
src/components/FwbInput/FwbInput.vue Updated modelValue type in InputProps from string to `string

Poem

In the meadow where inputs play,
A change has come to brighten the day.
Numbers and strings can now unite,
In FwbInput, they dance in delight!
Hopping along, with joy we sing,
Flexibility's here, let the data spring! 🐇✨


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
🪧 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>, 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 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.

Copy link

netlify bot commented Oct 2, 2024

Deploy Preview for sensational-seahorse-8635f8 ready!

Name Link
🔨 Latest commit d86c01f
🔍 Latest deploy log https://app.netlify.com/sites/sensational-seahorse-8635f8/deploys/66fd06cc8e073d00085a36ee
😎 Deploy Preview https://deploy-preview-327--sensational-seahorse-8635f8.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
src/components/FwbInput/FwbInput.vue (2)

61-61: LGTM! The change supports v-model.number as intended.

The modification to allow modelValue to be of type string | number successfully addresses the PR objective of supporting v-model.number. This change enhances the component's flexibility in handling both string and numeric inputs.

Consider the following improvements:

  1. Update the default value in withDefaults to account for the new type:
const props = withDefaults(defineProps<InputProps>(), {
  // ...
-  modelValue: '',
+  modelValue: '' as string | number,
  // ...
})
  1. Add type checking or conversion when setting the value to ensure type safety:
const model = computed({
  get: () => props.modelValue,
  set: (value: string | number) => {
    if (props.type === 'number') {
      emit('update:modelValue', typeof value === 'string' ? parseFloat(value) : value)
    } else {
      emit('update:modelValue', String(value))
    }
  }
})

These changes will further improve the component's robustness and type safety.


Line range hint 1-94: Consider enhancing type handling and updating documentation

While the change successfully allows for both string and number types, there are a few additional enhancements that could improve the component's behavior and usability:

  1. Add a computed property to handle type conversion based on the type prop:
const typedModel = computed({
  get: () => props.modelValue,
  set: (value: string | number) => {
    if (props.type === 'number') {
      model.value = typeof value === 'string' ? parseFloat(value) : value
    } else {
      model.value = String(value)
    }
  }
})

Then, use v-model="typedModel" in the template instead of v-model="model".

  1. Update the component's documentation to reflect the new support for numeric values. This should include:
    • Mentioning that v-model.number is now supported.
    • Explaining how the component handles type conversion between string and number based on the type prop.

Would you like me to draft the documentation updates for you?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c679aa9 and d86c01f.

📒 Files selected for processing (1)
  • src/components/FwbInput/FwbInput.vue (1 hunks)

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.

1 participant