-
Notifications
You must be signed in to change notification settings - Fork 76
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: deprecate textarea type for input component #11005
docs: deprecate textarea type for input component #11005
Conversation
…nto dit13711/9974-deprecate-text-area-type-for-input-component
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using the @deprecated
tag would deprecate the entire property. Maybe we should consider adding the language that its deprecated in the JSDoc without using the tag? Perhaps similar to shell-panel
's displayMode
prop for "float"
?
Also, for consistency we should use calcite-text-area
to specify the component, similar to how calcite-action-bar
is referenced in the displayMode
prop as well:
calcite-design-system/packages/calcite-components/src/components/shell-panel/shell-panel.tsx
Lines 166 to 179 in 4e5bf1d
/** | |
* Specifies the display mode of the component, where: | |
* | |
* `"dock"` displays at full height adjacent to center content, | |
* | |
* `"overlay"` displays at full height on top of center content, and | |
* | |
* `"float"` [Deprecated] does not display at full height with content separately detached from `calcite-action-bar` on top of center content. | |
* | |
* `"float-content"` does not display at full height with content separately detached from `calcite-action-bar` on top of center content. | |
* | |
* `"float-all"` detaches the `calcite-panel` and `calcite-action-bar` on top of center content. | |
*/ | |
@property({ reflect: true }) displayMode: DisplayMode = "dock"; |
…nto dit13711/9974-deprecate-text-area-type-for-input-component
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small consideration, otherwise LGTM! 🚀📝
Related Issue: #9974
Summary
Deprecate the
"textarea"
value for thetype
property on the input component.