Skip to content

docs(button): remove reference to non-existent iconOnly prop#1680

Open
farhan523 wants to merge 1 commit into
themesberg:mainfrom
farhan523:docs/remove-nonexistent-icononly-prop
Open

docs(button): remove reference to non-existent iconOnly prop#1680
farhan523 wants to merge 1 commit into
themesberg:mainfrom
farhan523:docs/remove-nonexistent-icononly-prop

Conversation

@farhan523

@farhan523 farhan523 commented Jul 6, 2026

Copy link
Copy Markdown

Summary

The "Button with only icons" section of the Button docs tells users to add an iconOnly prop to <Button>, but that prop no longer exists — it was removed in flowbite-react@0.11.0. The code example in that section already shows the correct usage (passing the icon as the button's only child), so only the descriptive text was wrong.

This PR rewords the sentence to describe the actual usage, keeping the section and example intact as suggested by the maintainers in the issue discussion.

Related issues

Fixes #1589

No API or theme changes — documentation only.

Summary by CodeRabbit

  • Documentation
    • Updated the “Button with only icons” example to reflect the current recommended usage.
    • Clarified how to create an icon-only button by using the icon as the sole child and adjusting sizing through the icon’s styling.
    • Removed the older guidance that referenced the button-level icon-only setting.

The Button docs referenced an iconOnly prop that was removed in
flowbite-react@0.11.0 and no longer exists on the component. Reword
the section to describe the actual usage shown in the example
(icon passed as the button's only child).

Fixes themesberg#1589
@vercel

vercel Bot commented Jul 6, 2026

Copy link
Copy Markdown

@farhan523 is attempting to deploy a commit to the Bergside Team on Vercel.

A member of the Team first needs to authorize it.

@changeset-bot

changeset-bot Bot commented Jul 6, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: ec6efe8

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

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bbb0d0a1-b4de-4b05-905a-a51d38a41a18

📥 Commits

Reviewing files that changed from the base of the PR and between 85319bd and ec6efe8.

📒 Files selected for processing (1)
  • apps/web/content/docs/components/button.mdx

📝 Walkthrough

Walkthrough

Updated documentation for the Button component's "icon-only" example, replacing the reference to a nonexistent iconOnly prop with guidance to pass an icon as the button's sole child and control its size via the icon's className.

Changes

Button documentation update

Layer / File(s) Summary
Icon-only example guidance update
apps/web/content/docs/components/button.mdx
Replaced the instruction to use a nonexistent iconOnly prop with guidance to pass an icon as the button's only child and size it via the icon's className.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Related issues: Fixes reference to a nonexistent iconOnly prop documented for the <Button> component.

Suggested labels: documentation

Suggested reviewers: None

Poem

A rabbit hopped through docs so neat,
Found a prop that made deceit,
No iconOnly here to see,
Just an icon child, sized and free,
Hop, hop, hooray — the fix is complete! 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly states the docs change and the removed iconOnly reference.
Linked Issues check ✅ Passed The doc update addresses issue #1589 by removing the nonexistent iconOnly prop reference.
Out of Scope Changes check ✅ Passed The only change is a documentation wording update in the targeted Button section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

ESLint install failed. For unrecoverable errors, disable the tool in CodeRabbit configuration.


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

Comment @coderabbitai help to get the list of available commands.

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.

<Button> iconOnly prop referenced in documentation does not exist in the component

1 participant