chore: add deprecation notice to userprofileimage #6223
There are no files selected for viewing
This file contains 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
This file contains 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
|
There was a problem hiding this comment. @anamikaanu96 thoughts on adding some docs on the codemod here? :) There was a problem hiding this comment. yea we already have an issue for that, we can do codemod doc along this with PR, |
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -9,6 +9,7 @@ import React from 'react'; | |||||
| import { UserProfileImage } from '.'; | ||||||
| import image from './headshot.jpg'; // cspell:disable-line | ||||||
| import DocsPage from './UserProfileImage.docs-page'; | ||||||
| import { Annotation } from '../../../../core/.storybook/Annotation'; | ||||||
|
|
||||||
| // import styles from './_storybook.scss'; // import storybook which includes component and additional storybook styles | ||||||
|
|
||||||
|
|
@@ -19,7 +20,7 @@ const defaultArgs = { | |||||
| }; | ||||||
|
|
||||||
| export default { | ||||||
| title: 'Deprecated/User profile images/UserProfileImage', | ||||||
| component: UserProfileImage, | ||||||
| tags: ['autodocs'], | ||||||
| argTypes: { | ||||||
|
|
@@ -69,6 +70,27 @@ export default { | |||||
| page: DocsPage, | ||||||
| }, | ||||||
| }, | ||||||
| decorators: [ | ||||||
| (story) => ( | ||||||
| <div> | ||||||
| <Annotation | ||||||
| type="deprecation-notice" | ||||||
| text={ | ||||||
| <div> | ||||||
| This component is deprecated and will be removed in the next major | ||||||
| version. Please migrate to{' '} | ||||||
| <a href="/?path=/docs/experimental-components-user-avatar-useravatar--docs"> | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. thanks for catching. fixt |
||||||
| UserAvatar | ||||||
| </a> | ||||||
| . | ||||||
| </div> | ||||||
| } | ||||||
| > | ||||||
| {story()} | ||||||
| </Annotation> | ||||||
| </div> | ||||||
| ), | ||||||
| ], | ||||||
| }; | ||||||
|
|
||||||
| const Template = (args) => { | ||||||
|
|
||||||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,6 +27,10 @@ const renderComponent = ({ ...rest } = {}) => | |
| render(<UserProfileImage {...{ kind, size, theme, ...rest }} />); | ||
|
|
||
| describe(componentName, () => { | ||
| beforeEach(() => { | ||
| jest.spyOn(console, 'warn').mockImplementation(() => {}); | ||
| }); | ||
|
|
||
| it('should return a circle with background color', async () => { | ||
| const { container } = renderComponent({ | ||
| backgroundColor: 'light-cyan', | ||
|
|
||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -98,6 +98,7 @@ export type UserProfileImageProps = UserProfileImageBaseProps & imageProps; | |
|
|
||
| /** | ||
| * The user profile avatar allows for an image of the user to be displayed by passing in the image prop. By default the component will display a user icon on a blue background. | ||
| * @deprecated | ||
| */ | ||
| export let UserProfileImage = React.forwardRef< | ||
| HTMLDivElement, | ||
|
|
@@ -227,6 +228,12 @@ export let UserProfileImage = React.forwardRef< | |
| } | ||
| ); | ||
|
|
||
| /**@ts-ignore*/ | ||
| UserProfileImage.deprecated = { | ||
| level: 'warn', | ||
| details: `Please replace ${componentName} with UserAvatar`, | ||
| }; | ||
|
|
||
| // Return a placeholder if not released and not enabled by feature flag | ||
| UserProfileImage = pkg.checkComponentEnabled(UserProfileImage, componentName); | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
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.
Let’s keep the cspell disables for
useravatarinline since I think it only applies when we’re putting it in the URL. (I do realize a lot of our other components probably made it into cspell for the same reason, but it does make us a bit more prone to spelling/stylistic errors.)