Skip to content

Fix component property docs for callouts, cards, and steps#4493

Merged
ethanpalm merged 4 commits intomainfrom
mintlify/fix-component-props-1773627301
Mar 16, 2026
Merged

Fix component property docs for callouts, cards, and steps#4493
ethanpalm merged 4 commits intomainfrom
mintlify/fix-component-props-1773627301

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Mar 16, 2026

Summary

  • Callouts: Added a Properties section for the generic Callout component documenting icon, iconType, and color props. Clarified that typed callouts (Note, Warning, etc.) only accept children.
  • Cards: Fixed title prop from required to optional (matches code). Added undocumented disabled prop.
  • Steps: Fixed title prop to be marked as required and children to be optional (matches code). Reordered properties to list title first.

Note

Low Risk
Low risk: documentation-only changes that adjust prop requirements/ordering and add missing Callout customization details, with no runtime behavior changes.

Overview
Updates the component docs to better reflect supported props and requirements.

Callouts documentation now includes a custom Callout properties section, clarifying that typed callouts only accept children and documenting custom icon/color usage via IconsOptional plus a color field.

Cards docs adjust the title prop to be optional (removing the required marker) and Steps docs reorder/clarify individual Step props by marking title as required and children as optional.

Written by Cursor Bugbot for commit d3c56d1. This will update automatically on new commits. Configure here.

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix prepared a fix for the issue found in the latest run.

  • ✅ Fixed: Import placed mid-file unlike all other components
    • Moved the IconsOptional import to immediately after frontmatter in components/callouts.mdx to match the repository’s MDX import placement convention.

Create PR

Or push these changes by commenting:

@cursor push 2a29d079d1
Preview (2a29d079d1)
diff --git a/components/callouts.mdx b/components/callouts.mdx
--- a/components/callouts.mdx
+++ b/components/callouts.mdx
@@ -4,6 +4,8 @@
 keywords: ["callouts", "notes", "warnings", "info boxes", "tips", "emphasis", "highlight"]
 ---
 
+import IconsOptional from "/snippets/icons-optional.mdx";
+
 Style callouts as Note, Warning, Info, Tip, Check, Danger, or create your own callout:
 
 <Note>This adds a note in the content</Note>
@@ -52,8 +54,6 @@
 
 The generic `Callout` component supports custom icons and colors. The typed callouts (`Note`, `Warning`, `Info`, `Tip`, `Check`, `Danger`) use preset icons and colors and only accept `children`.
 
-import IconsOptional from "/snippets/icons-optional.mdx";
-
 <IconsOptional />
 
 <ResponseField name="color" type="string">

This Bugbot Autofix run was free. To enable autofix for future PRs, go to the Cursor dashboard.

@ethanpalm ethanpalm merged commit 84ed647 into main Mar 16, 2026
4 checks passed
@ethanpalm ethanpalm deleted the mintlify/fix-component-props-1773627301 branch March 16, 2026 16:51
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