Repository navigation
Tip: Migrate inserter usages to Notice and deprecate the component #84197
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
11083c7
Inserter: Use info notices for block editor tips
ciampo 79aa41a
Inserter: Document the info notice migration
ciampo fe4a574
Tip: Deprecate in favor of UI Notice
ciampo ddce5bf
Inserter: Style tip keyboard hints as keys
ciampo 70fa7b1
Tip: Align deprecation and migration guidance
ciampo 106bee1
Inserter: Hide separators beside empty block sections
ciampo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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
|
ciampo marked this conversation as resolved.
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| import { Meta } from '@storybook/addon-docs/blocks'; | ||
| import * as TipStories from './index.story'; | ||
|
|
||
| <Meta of={ TipStories } name="Migration Guide" /> | ||
|
|
||
| # Tip migration guide | ||
|
|
||
| `Tip` is deprecated since WordPress 7.2 and scheduled for removal in WordPress 7.4. Use [`Notice`](?path=/docs/design-system-components-notice--docs) from `@wordpress/ui` instead. | ||
|
|
||
| ## Basic migration | ||
|
|
||
| Use `Notice.Root` with `intent="info"` and `Notice.Description` for the content. Pass the `tip` icon from `@wordpress/icons` to retain the light-bulb icon. The notice uses the design system's info colors, border, and padding. | ||
|
|
||
| ```jsx | ||
| import { tip } from '@wordpress/icons'; | ||
| import { Notice } from '@wordpress/ui'; | ||
|
|
||
| const MyTip = ( { children } ) => ( | ||
| <Notice.Root intent="info" icon={ tip }> | ||
| <Notice.Description>{ children }</Notice.Description> | ||
| </Notice.Root> | ||
| ); | ||
| ``` | ||
|
|
||
| For a call to action, use `Notice.Actions` and `Notice.ActionLink`. Pass `openInNewTab` to retain an external link's new-tab indicator and accessible notice. Add `Notice.CloseIconButton` only if the consuming interface supports dismissal. | ||
|
|
||
| Like Tip, Notice does not announce its content automatically. Consumers must announce dynamic updates when needed. See the [Notice announcement guidance](?path=/docs/design-system-components-notice-announcements--docs). | ||
|
|
||
| The `.components-tip` selector belongs to the legacy component. Update custom consumer styles when migrating to Notice rather than carrying this class name into the new composition. |
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
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
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.