docs(storybook): create deprecated props section in arg tables - #8088
Open
nineteen88 wants to merge 1 commit into
Open
docs(storybook): create deprecated props section in arg tables#8088nineteen88 wants to merge 1 commit into
nineteen88 wants to merge 1 commit into
Conversation
this will seperate out the main props from the deprecated props
There was a problem hiding this comment.
Pull request overview
Updates the Storybook preview configuration to improve docs usability by separating deprecated component props into a dedicated “Deprecated Props” section within ArgTables, while still preserving deprecation text via the existing JSDoc workaround.
Changes:
- Adds lightweight local typings for argType/table shapes to avoid repeated inline casts.
- When a prop is marked
@deprecated, forces its argTablecategoryto “Deprecated Props” and attempts to retain prior grouping viasubcategory.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+64
to
+76
| const typedArgType = argType as EnhancedArgType; | ||
| const existingCategory = typedArgType.table?.category; | ||
| const shouldMoveExistingCategoryToSubcategory = | ||
| existingCategory && existingCategory !== DEPRECATED_PROPS_CATEGORY; | ||
|
|
||
| (acc as Record<string, unknown>)[argName] = { | ||
| ...typedArgType, | ||
| table: { | ||
| ...typedArgType.table, | ||
| category: DEPRECATED_PROPS_CATEGORY, | ||
| subcategory: shouldMoveExistingCategoryToSubcategory | ||
| ? existingCategory | ||
| : typedArgType.table?.subcategory, |
nineteen88
force-pushed
the
create-deprecated-prop-section
branch
from
August 11, 2026 22:48
8d129bf to
69de7a9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed behaviour
Seperate out the main props from the deprecated props
Current behaviour
Deprecated props are jumbled in with the main props which can be quite overwhelming to consumers
Checklist
QA
Additional context
Testing instructions