fix(numeric): [numeric] update controls-position prop type and add validator

[gweesin]

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

What is the current behavior?

Issue Number: #3053

What is the new behavior?

type define correctly

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• Bug Fixes
  • Refined numeric component validations to ensure only the intended values are accepted.
  • Improved control button placement so that they consistently appear on the right.
  • Adjusted empty input handling for a cleaner, more intuitive numeric entry experience.

[coderabbitai]

Walkthrough

This pull request updates the property types for the numeric API and refines associated tests. In the demo API file, the blank property type is changed from a string to a boolean, and the controls-position property is restricted to the literal "right". Test cases for the Numeric component have been updated to correct typos, adjust assertions, and change the method of setting input values. Additionally, a validator function is added in the Numeric component's props to enforce that the controlsPosition value is either an empty string or "right".

Changes

File(s)	Change Summary
examples/sites/demos/apis/numeric.js	Changed property blank type from string to boolean; updated controls-position from string to literal type "right".
packages/vue/.../numeric.test.tsx	Updated tests: corrected typo for controls-position (expecting "right" and .is-controls-right), adjusted allow-empty expectation to empty string, and switched to setValue for updating input values.
packages/vue/.../index.ts	Added a validator for the controlsPosition property in numericProps to accept only '' or "right".

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NumericComponent
    participant Validator
    User->>NumericComponent: Provide controlsPosition prop value
    NumericComponent->>Validator: Validate value (must be '' or "right")
    Validator-->>NumericComponent: Return validation result
    NumericComponent->>UI: Render component based on validated value

Loading

Possibly related PRs

• fix(button-group): [button-group] update size prop type and add validator #3038: Addressed type restrictions and validation improvements for a similar component (button-group).
• feat(numeric): [numeric] add step strategy of props #2584: Modified property types in numeric.js, aligning with updates to the numeric component's API.

Suggested labels

bug

Suggested reviewers

• zzcr

Poem

I’m a bunny in the code field, hopping through the night,
Making changes neat and true with every byte.
Types now dance from string to boolean right,
Tests align, and validators check with might.
With carrot dreams, I celebrate this flight! 🐰

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

examples/sites/demos/apis/numeric.js

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

packages/vue/src/numeric/__tests__/numeric.test.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

packages/vue/src/numeric/src/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cd468ac and b840ce7.

📒 Files selected for processing (3)

• examples/sites/demos/apis/numeric.js (2 hunks)
• packages/vue/src/numeric/__tests__/numeric.test.tsx (3 hunks)
• packages/vue/src/numeric/src/index.ts (1 hunks)

🔇 Additional comments (6)

packages/vue/src/numeric/src/index.ts (1)

58-60: Good addition of a validator for controlsPosition values.

The validator ensures that controlsPosition only accepts valid values: either an empty string or "right". This prevents invalid values from being used and makes the component more robust.

examples/sites/demos/apis/numeric.js (2)

33-35: Type correction for 'blank' property.

The type has been correctly changed from 'string' to 'boolean', which matches the actual implementation in the component. This will provide more accurate type information for consumers of the API.

---

69-71: Type refinement for 'controls-position' property.

The type has been correctly changed from 'string' to a specific string literal '"right"', which aligns with the validator added to the component. This provides more precise type information and prevents invalid values from being used.

packages/vue/src/numeric/__tests__/numeric.test.tsx (3)

168-172: Fixed test for controls-position prop.

The test has been updated to correctly test the "right" position value and now checks for the .is-controls-right class, which is a more appropriate assertion for this functionality.

---

261-261: Improved test method for setting input value.

Using setValue() method instead of directly modifying the value is a better approach as it simulates user interaction more accurately and triggers the appropriate events.

---

225-228:

❓ Verification inconclusive

Updated test for allow-empty behavior.

The test has been simplified and corrected to properly test the behavior when allow-empty is not set. The assertion is now checking for an empty string, which matches the component's expected behavior.

---

🏁 Script executed:

#!/bin/bash
# Check the component's behavior when allow-empty is not set
rg -A 3 -B 3 "allow-empty.*empty" packages/vue/src/numeric/src

Length of output: 64

---

Action: Verify Numeric Component's Allow-Empty Behavior

The updated test correctly sets an empty value on the input (without explicitly setting an allow-empty prop) and asserts that the input’s value is an empty string. However, the source search for strings related to "allow-empty" in the Numeric component did not yield any output, so it remains unclear whether the component’s internal logic is aligned with this behavior.
• Next Step: Please manually verify that the Numeric component indeed handles empty strings correctly when the allow-empty prop is not provided.
• Confirmation Needed: Double-check the implementation in the component (found under packages/vue/src/numeric/src) to ensure that the expected behavior is enforced.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, 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 generate docstrings to generate docstrings for this 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.

[petercat-assistant]

Walkthrough

This pull request addresses a bug fix by updating the controls-position prop type in the numeric component and adding a validator to ensure valid values. The changes include modifying the prop type to a specific string value and adding validation logic. Additionally, test cases have been updated to reflect these changes.

Changes

File	Summary
examples/sites/demos/apis/numeric.js	Updated controls-position prop type to a specific string value.
packages/vue/src/numeric/tests/numeric.test.tsx	Updated test cases to align with the new controls-position prop type and validation logic.
packages/vue/src/numeric/src/index.ts	Added a validator for the controls-position prop to ensure valid values.