[UI library] Add toast element #21407

pls78 · 2024-05-24T10:36:21Z

Context

We want to add a generic Toast element to the UI Library in order to render customizable notifications.

Summary

This PR can be summarized in the following changelog entry:

[@yoast/ui-library 0.0.1] Adds a Toast element.

Relevant technical choices:

The Notification component has been refactored to use the new Toast element.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Test the Settings notification

Go to Yoast SEO -> Settings
- change any setting and hit Save changes
- verify the following notification appears
- wait until it closes automatically
- change another setting, and when the notification appears click on the close button
  - verify the notification closes immediately
Go to Yoast SEO -> Settings -> Site connections
- in the Google input field type &&&& and click on Save changes
- verify:
  - the following notification appears
  - the notification stays open until you close it

Test the AI Generator notification

With a MySQL client open the wp_usermeta table and search for the tuple where user_id = your user id and meta_key = _yoast_alerts_dismissed
if the following string is present in the meta_value field:s:26:"wpseo_premium_ai_generator";b:1;, remove it and update the array length accordingly (or remove the whole meta_value content if you don't care about the notifications you previously dismissed)
Activate Yoast SEO Premium
Edit a post in the block editor
- make sure
  - it has little to no content
  - it has a keyphrase
- Click on Use AI and verify the following notification appears
- verify that either clicking on the close or Dismiss button closes the notification
- click on Use AI again
  - verify the notification is shown again

Test the UI-Library storybook

In the terminal got to the wordpress-seo/packages/ui-library directory
- type yarn storybook: after some time the StoryBook page should appear in your browser
- go to the Toaster sub-section in the Elements section and verify
  - all the stories ( the Toaster factory, with title, with description and with close button ) render properly
  - you can correctly interact with the toaster

Relevant test scenarios

Changes should be tested with the browser console open
Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
Changes should be tested on different browsers
Changes should be tested on multisite

Test instructions for QA when the code is in the RC

QA should use the same steps as above.

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

The above testing instructions cover the possible regressions.

UI changes

This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

I have tested this code to the best of my abilities.
During testing, I had activated all plugins that Yoast SEO provides integrations for.
I have added unit tests to verify the code works as intended.
If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
I have written this PR in accordance with my team's definition of done.
I have checked that the base branch is correctly set.

Innovation

No innovation project is applicable for this PR.
This PR falls under an innovation project. I have attached the innovation label.
I have added my hours to the WBSO document.

Fixes #21396

coveralls · 2024-05-24T10:44:53Z

Pull Request Test Coverage Report for Build fbadf8a8c26ec0a7ccf4470c8e292df90e9afc0a

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
3706 unchanged lines in 106 files lost coverage.
Overall coverage decreased (-4.3%) to 48.3%

Files with Coverage Reduction	New Missed Lines	%
admin/class-option-tabs-formatter.php	1	0.0%
src/actions/configuration/first-time-configuration-action.php	1	91.84%
src/builders/indexable-home-page-builder.php	1	98.0%
src/builders/indexable-term-builder.php	1	99.15%
src/context/meta-tags-context.php	1	28.29%
src/generators/breadcrumbs-generator.php	1	64.23%
src/generators/schema/webpage.php	1	90.32%
src/integrations/blocks/structured-data-blocks.php	1	16.0%
src/integrations/settings-integration.php	1	28.49%
src/integrations/watchers/indexable-ancestor-watcher.php	1	98.41%

Totals
Change from base Build 9092209d55aa5a8e5ebf33e771925ce9dfb32d9e:	-4.3%
Covered Lines:	24971
Relevant Lines:	53563

💛 - Coveralls

mhkuu

CR: Approved, just one quirk I don't fully understand 😅 See my comment above.

In my commit above I fixed one issue where the 'Close' story did not have right docs. I also updated some strings and fixed some JSDoc 🙌

packages/ui-library/src/elements/toaster/index.js

Jordi-PV · 2024-05-28T11:20:45Z

packages/ui-library/src/elements/toast/style.css

+@layer components {
+    .yst-root {
+
+        .yst-toast {


Not a big deal, but I would consider placing every CSS rule in a different line for readability. E.g.

.yst-toast { @apply yst-w-80 yst-max-w-full yst-overflow-y-auto yst-p-4 yst-bg-white yst-shadow-lg y st-rounded-lg yst-ring-1 yst-ring-black yst-ring-opacity-5 yst-z-20 yst-pointer-events-auto; } `.yst-toast--large { @apply yst-w-96; }`

I am also looking at the stylesheets of other elements/components in the UI library, where we also do it this way.

I think that the general approach is to keep the @apply on the same line as the Tailwind classes when they are a few (like 2 or 3), so I'm updating just the .yst-toast one 🙂

Jordi-PV · 2024-05-28T12:05:26Z

packages/ui-library/src/elements/toast/docs/close.md

@@ -0,0 +1 @@
+The `Toast.Close` subcomponent allows to render a button that closes the toast. It is useful when you want to give the user the ability to close the toast manually.


Maybe I would refactor this doc as follow:

The Toast.Close subcomponent renders a Toast with a button to close the toast. This feature is useful when you want to provide the user with the option to manually close the toast notification.

Technically the Toast.Close it is a subcomponent of the Toast element, so it renders just the close button. I'd rephrase it as:
The Toast.Close subcomponent renders a button to close the toast. This feature is useful when you want to provide the user with the option to manually close the toast notification.

Jordi-PV · 2024-05-28T12:08:10Z

packages/ui-library/src/elements/toast/docs/component.md

@@ -0,0 +1 @@
+The Toast component is a general-purpose toast element which can be used to implement custom notifications.


Here I would describe it as:

The Toast component is a versatile toast element that can be used to implement custom notifications.

Counter-proposal 😁 What about:
The Toast element is a versatile toast component that can be used to implement custom notifications.
In the original description I forgot to change component to element, as the Toast is now an element

Jordi-PV · 2024-05-28T12:14:14Z

packages/ui-library/src/elements/toast/docs/description.md

@@ -0,0 +1 @@
+`Toast.Description` can be used to add a description to the toast's content. It can be a list of strings.


And in this doc maybe also mention the paragraph option;

The Toast.Description subcomponent allows you to add detailed content to the toast, either as a paragraph or a list of strings.

Jordi-PV · 2024-05-28T13:13:38Z

Screen.Recording.2024-05-28.at.14.59.16.mov

Nothing relevant for the AI assessment fixes project, but I was testing the Toast subcomponents Toast.Title and Toast.Description in the Storybook, and I noticed that in the Toast.Title when adding the 'children' it changes the content paragraph instead of title, and in the Toast.Description the

pls78 · 2024-05-29T09:34:49Z

Screen.Recording.2024-05-28.at.14.59.16.mov

Nothing relevant for the AI assessment fixes project, but I was testing the Toast subcomponents Toast.Title and Toast.Description in the Storybook, and I noticed that in the Toast.Title when adding the 'children' it changes the content paragraph instead of title, and in the Toast.Description the
list also changes to a paragraph instead of the array list of elements. 🤔

Yeah, I should have disabled the children control for both Title and Description as they don't make any sense: the user controls what's in there through the title and description props respectively. I have now disabled all the controls for the subcomponents as I didn't find a way to hide just the children one.

packages/ui-library/src/elements/toast/docs/component.md

pls78 and others added 15 commits May 24, 2024 12:08

Introduce CustomNotification component

a1f51d1

Introduce new Toaster component

d05de93

Use new Toaster component to refactor the Notification component

e750251

Moved the Toaster component to elements directory

a3c29f9

Cleaned up the Notification component from unneeded stuff

78ed7de

Add the Close subcomponent and re-instate the position prop

d970277

Use the new Close subcomponent and re-instate the position prop

7d6ef38

Move enclosing div from Toaster to Notification

2977e81

Add className prop to subelements (where relevant)

eae1af7

Removed Content subcomponent

92eef45

Add Storybook docs

a901bd2

Add stories

c3c1422

add on dismiss prop

e3beb49

Use the same string everywhere

5be6e84

Revert changes done for testing purposes

7b117e7

pls78 added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label May 24, 2024

pls78 added this to the 22.9 milestone May 24, 2024

Fix cs

3f8f13c

pls78 marked this pull request as ready for review May 24, 2024 11:37

pls78 requested a review from a team as a code owner May 24, 2024 11:37

mhkuu added 2 commits May 27, 2024 14:22

Fixes the 'Close' story and streamlines some other strings

0e4b8cf

Fixes the JSDoc

019e4fa

mhkuu approved these changes May 27, 2024

View reviewed changes

packages/ui-library/src/elements/toaster/index.js Outdated Show resolved Hide resolved

Rename Toaster to Toast

6f91c85

enricobattocchi removed this from the 22.9 milestone May 28, 2024

Jordi-PV self-requested a review May 28, 2024 11:13

mhkuu changed the base branch from trunk to release/22.9 May 28, 2024 11:18

Jordi-PV reviewed May 28, 2024

View reviewed changes

pls78 changed the title ~~[UI library] Add toaster element~~ [UI library] Add toast element May 28, 2024

Hide controls for subcomponents

7341358

pls78 added 2 commits May 29, 2024 11:44

Update stories descriptions

df7b47a

Better linting

859a850

pls78 commented May 29, 2024

View reviewed changes

packages/ui-library/src/elements/toast/docs/component.md Outdated Show resolved Hide resolved

pls78 and others added 2 commits May 29, 2024 11:47

Update packages/ui-library/src/elements/toast/docs/component.md

a792ab6

Capitalize sentence

c8e2a7d

pls78 merged commit e9c5c12 into release/22.9 May 30, 2024
15 of 16 checks passed

pls78 deleted the ui-library-add-toaster-element branch May 30, 2024 09:33

pls78 added this to the 22.9 milestone May 30, 2024

mhkuu added changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog and removed changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog labels Jun 18, 2024

mhkuu mentioned this pull request Jul 16, 2024

Merges the feature branch feature/fix-assessments into trunk #21480

Merged

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[UI library] Add toast element #21407

[UI library] Add toast element #21407

pls78 commented May 24, 2024 •

edited

Loading

coveralls commented May 24, 2024 •

edited

Loading

mhkuu left a comment

Jordi-PV May 28, 2024

pls78 May 29, 2024

Jordi-PV May 28, 2024

pls78 May 29, 2024

Jordi-PV May 28, 2024

pls78 May 29, 2024

Jordi-PV May 28, 2024

Jordi-PV commented May 28, 2024

pls78 commented May 29, 2024

		@@ -0,0 +1 @@
		The `Toast.Close` subcomponent allows to render a button that closes the toast. It is useful when you want to give the user the ability to close the toast manually.

		@@ -0,0 +1 @@
		The Toast component is a general-purpose toast element which can be used to implement custom notifications.

		@@ -0,0 +1 @@
		`Toast.Description` can be used to add a description to the toast's content. It can be a list of strings.

[UI library] Add toast element #21407

[UI library] Add toast element #21407

Conversation

pls78 commented May 24, 2024 • edited Loading

Context

Summary

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

Relevant test scenarios

Test instructions for QA when the code is in the RC

Impact check

UI changes

Other environments

Documentation

Quality assurance

Innovation

coveralls commented May 24, 2024 • edited Loading

Pull Request Test Coverage Report for Build fbadf8a8c26ec0a7ccf4470c8e292df90e9afc0a

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

mhkuu left a comment

Choose a reason for hiding this comment

Jordi-PV May 28, 2024

Choose a reason for hiding this comment

pls78 May 29, 2024

Choose a reason for hiding this comment

Jordi-PV May 28, 2024

Choose a reason for hiding this comment

pls78 May 29, 2024

Choose a reason for hiding this comment

Jordi-PV May 28, 2024

Choose a reason for hiding this comment

pls78 May 29, 2024

Choose a reason for hiding this comment

Jordi-PV May 28, 2024

Choose a reason for hiding this comment

Jordi-PV commented May 28, 2024

pls78 commented May 29, 2024

pls78 commented May 24, 2024 •

edited

Loading

coveralls commented May 24, 2024 •

edited

Loading