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(dropdownmenu): add @deprecated tag to comment #708

Merged
merged 1 commit into from
Nov 22, 2023

Conversation

masoudmanson
Copy link
Contributor

Summary

DropdownMenu

prefix the deprecation comment with a @deprecated tag so we get the strikethrough text to encourage users to migrate to the new type.

/**
 * @deprecated
 * (masoudmanson): We've replaced DefaultDropdownMenuOption with DefaultAutocompleteOption
 * as the preferred choice. However, for backward compatibility, we've exported this line to
 * prevent potential TypeScript type issues for product teams using previous versions.
 */
export type DefaultDropdownMenuOption = DefaultAutocompleteOption;

Copy link
Contributor

@tihuan tihuan left a comment

Choose a reason for hiding this comment

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

Hurray thank you! I forgot about this too 😆 Thanks for the quick followup PR!

@masoudmanson masoudmanson merged commit df22aff into main Nov 22, 2023
10 checks passed
@masoudmanson masoudmanson deleted the add-deprecated-to-dropdown-menu-type branch November 22, 2023 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants