Skip to content

fix(checkbox): remove unsupported is prop and clean up Storybook#1905

Open
ShubhamS2005 wants to merge 1 commit intoRocketChat:mainfrom
ShubhamS2005:fix/remove-unsupported-prop
Open

fix(checkbox): remove unsupported is prop and clean up Storybook#1905
ShubhamS2005 wants to merge 1 commit intoRocketChat:mainfrom
ShubhamS2005:fix/remove-unsupported-prop

Conversation

@ShubhamS2005
Copy link
Copy Markdown

Problem

The CheckBox component no longer supports the is prop (was previously inherited from Box).
Storybook still had a control for is, causing TypeScript errors and Storybook crashes.

Steps to Reproduce

  1. Open Storybook for Inputs/CheckBox
  2. Try to use the is control in Storybook
  3. Observe TypeScript error:
    type 'string' is not assignable to type 'ElementType | undefined'
  4. Component still works, but Storybook shows errors and crashes when is is selected.

Solution

  • Removed is control from Storybook for CheckBox
  • Kept CheckBoxProps clean: Omit<BoxProps, 'is'>
  • Checkbox functionality remains unchanged
  • Storybook runs without error

Expected Behavior

  • No TypeScript errors
  • Storybook loads cleanly
  • CheckBox works normally

Actual Behavior

  • TypeScript error when passing is
  • Storybook crash or object showing instead of proper element

Backward-compatible fix
Tested manually in Storybook:
Closes #1904
image

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 21, 2026

⚠️ No Changeset found

Latest commit: 731099d

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

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 21, 2026

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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.

fix(checkbox): remove unsupported is prop and clean up Storybook

2 participants