feat: pinInput supports disabled props

[anncwb]

Description

fixed #4850

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• New Features

  • Introduced a new disabled property for the Pin Input component, allowing users to disable the input when needed.
  • Replaced the btnLoading property with loading for improved clarity.
  • Updated the handleSendCode property to createText, enhancing the functionality of the input.

• Improvements

  • Streamlined property handling for better clarity and usability of the Pin Input component.
  • Enhanced error handling during the send process for a more robust user experience.

[changeset-bot]

⚠️ No Changeset found

Latest commit: a2ba03e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Warning

Rate limit exceeded

@anncwb has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 7 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 8048045 and a2ba03e.

Walkthrough

The changes in this pull request focus on the PinInputProps interface and the input.vue component within the UI kit. Key modifications include the introduction of a new disabled property, the renaming of btnLoading to loading, and the introduction of createText. The handling of these properties has been streamlined by removing the withDefaults function and directly destructuring properties from defineProps<PinInputProps>(). These updates enhance the clarity and functionality of the component.

Changes

File	Change Summary
packages/@core/ui-kit/shadcn-ui/src/components/pin-input/input.vue	Modified property handling in the component, added disabled, renamed btnLoading to loading, and updated computed properties.
packages/@core/ui-kit/shadcn-ui/src/components/pin-input/types.ts	Added new optional property disabled to PinInputProps, renamed btnLoading to loading, and updated handleSendCode to createText.

Assessment against linked issues

Objective	Addressed	Explanation
Implement disabled property for VbenPinInput to control button state (4850)	✅
Improve validation handling for VbenPinInput (4850)	❌	No changes made to validation logic.

Possibly related PRs

• feat: pinInput supports disabled props #4851: This PR directly relates to the main PR as it introduces support for the disabled property in the PinInputProps, which is a key change in the main PR. Both PRs modify the same properties in the PinInputProps interface and the input.vue component.

Suggested labels

feature

Suggested reviewers

• vince292007

🐰 In the meadow where bunnies play,
A new disabled prop has come to stay.
With createText now in sight,
Our inputs shine, oh what a delight!
No more fuss with buttons that glow,
Just hop along, let the codeflow! 🌼

---

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

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (3)

packages/@core/ui-kit/shadcn-ui/src/components/pin-input/input.vue (3)

13-20: LGTM! Consider adding type annotations for default values.

The props destructuring is clean and follows Vue 3 best practices. The new disabled and loading props align well with the component's requirements.

Consider adding type annotations to the default values for better type safety:

-  codeLength = 6,
+  codeLength = 6 as const,
-  maxTime = 60,
+  maxTime = 60 as const,

---

34-35: Add null check for createText callback.

The optional chaining on createText is good, but the function might still return undefined. Consider providing a default text.

const btnText = computed(() => {
  const countdownValue = countdown.value;
-  return createText?.(countdownValue);
+  return createText?.(countdownValue) ?? countdownValue > 0 ? `${countdownValue}s` : 'Send Code';
});

Also applies to: 38-39

---

81-82: Consider making button props configurable.

The button's variant and size are hardcoded. Consider making these configurable through props for better component flexibility.

// In types.ts
interface PinInputProps {
  // ... existing props
+  buttonVariant?: 'outline' | 'default' | 'destructive' | 'secondary' | 'ghost' | 'link';
+  buttonSize?: 'default' | 'sm' | 'lg' | 'icon';
}

// In template
<VbenButton
  :disabled="disabled"
  :loading="btnLoading"
  class="flex-grow"
-  size="lg"
-  variant="outline"
+  :size="buttonSize ?? 'lg'"
+  :variant="buttonVariant ?? 'outline'"
  @click="handleSend"
>

Also applies to: 97-101

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 57d5a91 and 8048045.

📒 Files selected for processing (2)

• packages/@core/ui-kit/shadcn-ui/src/components/pin-input/input.vue (5 hunks)
• packages/@core/ui-kit/shadcn-ui/src/components/pin-input/types.ts (1 hunks)

🔇 Additional comments (1)

packages/@core/ui-kit/shadcn-ui/src/components/pin-input/types.ts (1)

11-14: LGTM: Well-documented disabled property addition.

The new disabled property is properly typed and documented, aligning well with the PR objectives for supporting disabled state in the PinInput component.