Skip to content
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

Merged

Conversation

DitwanP
Copy link
Contributor

@DitwanP DitwanP commented Dec 6, 2024

Related Issue: #9974

Summary

Deprecate the "textarea" value for the type property on the input component.

@DitwanP DitwanP added the skip visual snapshots Pull requests that do not need visual regression testing. label Dec 6, 2024
@github-actions github-actions bot added the docs Issues relating to documentation updates only. label Dec 6, 2024
…nto dit13711/9974-deprecate-text-area-type-for-input-component
@DitwanP DitwanP requested a review from geospatialem December 6, 2024 23:29
Copy link
Member

@geospatialem geospatialem left a 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:

/**
* 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
@DitwanP DitwanP requested a review from geospatialem December 9, 2024 17:54
Copy link
Member

@geospatialem geospatialem left a 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! 🚀📝

packages/calcite-components/src/components/input/input.tsx Outdated Show resolved Hide resolved
@DitwanP DitwanP merged commit 58201b0 into dev Dec 9, 2024
10 checks passed
@DitwanP DitwanP deleted the dit13711/9974-deprecate-text-area-type-for-input-component branch December 9, 2024 20:47
@github-actions github-actions bot added this to the 2024-12-17 - Dec Milestone milestone Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues relating to documentation updates only. skip visual snapshots Pull requests that do not need visual regression testing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants