-
Notifications
You must be signed in to change notification settings - Fork 65
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
Dialog readme and i18n update #216
Conversation
Codecov Report
@@ Coverage Diff @@
## master #216 +/- ##
=========================================
Coverage ? 99.09%
=========================================
Files ? 19
Lines ? 999
Branches ? 300
=========================================
Hits ? 990
Misses ? 1
Partials ? 8
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #216 +/- ##
======================================
Coverage 99.1% 99.1%
======================================
Files 19 19
Lines 1000 1000
Branches 300 300
======================================
Hits 991 991
Misses 1 1
Partials 8 8
Continue to review full report at Codecov.
|
src/dialog/README.md
Outdated
@@ -1 +1,55 @@ | |||
# Dialog widget | |||
# @dojo/widgets/dialog/Dialog widget | |||
Dojo 2's `Dialog` component can be used to show content inside of a window over top of application content. It provides default styling for a titlebar, content area, underlay, and a close button, and will respond to different screen sizes responsively. |
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.
grammar nit: inside of a window over top of -> inside of a window, over the top of
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.
It would be good to also update this to include any information (if needed) on: keyboard events
and themeing
. TimePicker
has a good example of these.
@rishson: I added a section on themeing, but the Dialog currently has no keyboard navigation cases (and would only have one to begin with, |
Type: feature
The following has been addressed in the PR:
Description:
This PR adds an initial readme for the Dialog based on Andy's template. The aim was to include a general description, pertinent a11y and i18n information, and to show common example uses, while avoiding API documentation. This PR also adds one property to the Dialog for i18n, a shortcoming discovered during the readme authoring.
Resolves #183