fix(dialog-wrapper): add dismiss-label attribute for the close button's label #4154
Conversation
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
Lighthouse scores
What is this?Lighthouse scores comparing the documentation site built from the PR ("Branch") to that of the production documentation site ("Latest") and the build currently on Transfer Size
Request Count
|
Tachometer resultsChromedialog permalinkbasic-test
Firefoxdialog permalinkbasic-test
|
Westbrook
reviewed
Mar 14, 2024
packages/dialog/src/Dialog.ts
Outdated
| @@ -61,6 +61,9 @@ export class Dialog extends ObserveSlotPresence(AlertDialog, [ | |||
| @property({ type: Boolean, reflect: true }) | |||
| public dismissable = false; | |||
|
|
|||
| @property({ type: String, reflect: true, attribute: 'dismiss-label' }) | |||
| public dismissLabel = ''; | |||
There was a problem hiding this comment.
Please default this to Close to reduce default effort required to consume this pattern.
This should also prevent the need to alter the story files, unless you'd like to add one that leverages this for an internationalized delivery.
Westbrook
force-pushed
the
yenugula/issue-3375
branch
from
4782663 to
ce577c4
Compare
Westbrook
changed the title
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
dialog-wrapper has several labels for customization. This PR introduces a new attribute
dismiss-labelfordialog-wrapperanddialog. It allows the string passed in to be used as thelabelfordialog-wrapperanddialog.Description
dismissLabeland attributedismiss-labeltodialog-wrapperanddialog. Default is ``.dismiss-labelwill be used as thesp-close-button'slabelprop.dialog-wrapperanddialogstories to pass indismiss-label = 'Close'.dismiss-labelset in the stories trickles down to thearia-labelof the components.dialog-wrapperreadme with newdismiss-label.Related issue(s)
fixes #3375
Motivation and context
#1975
How has this been tested?
DialogWrapper
Dialog Wrapper.Wrapper Dismissable.sp-close-buttonhaslabel = 'Close'sp-dialogandsp-dialog-wrapperhasdismiss-label = 'Close'Dialog
Dialog.Dismissable.sp-close-buttonhaslabel = 'Close'sp-dialoghasdismiss-label = 'Close'Screenshots (if appropriate)
Dialog Wrapper
Dialog
Types of changes
Checklist
Best practices
This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against
main.