Skip to content
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

Merged
merged 4 commits into from
Jun 6, 2017
Merged

Dialog readme and i18n update #216

merged 4 commits into from
Jun 6, 2017

Conversation

bitpshr
Copy link
Member

@bitpshr bitpshr commented Jun 1, 2017

Type: feature

The following has been addressed in the PR:

  • There is a related issue
  • All code matches the style guide
  • Unit or Functional tests are included 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

@codecov
Copy link

codecov bot commented Jun 1, 2017

Codecov Report

❗ No coverage uploaded for pull request base (master@739d258). Click here to learn what that means.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #216   +/-   ##
=========================================
  Coverage          ?   99.09%           
=========================================
  Files             ?       19           
  Lines             ?      999           
  Branches          ?      300           
=========================================
  Hits              ?      990           
  Misses            ?        1           
  Partials          ?        8
Impacted Files Coverage Δ
src/dialog/Dialog.ts 96.66% <100%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 739d258...d0a81ee. Read the comment docs.

@codecov
Copy link

codecov bot commented Jun 1, 2017

Codecov Report

Merging #216 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@          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
Impacted Files Coverage Δ
src/dialog/Dialog.ts 96.66% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cc01318...872e833. Read the comment docs.

@bitpshr bitpshr requested review from tomdye, smhigley and rishson June 1, 2017 20:53
@@ -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.
Copy link
Contributor

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

Copy link
Contributor

@rishson rishson left a 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.

@bitpshr
Copy link
Member Author

bitpshr commented Jun 6, 2017

@rishson: I added a section on themeing, but the Dialog currently has no keyboard navigation cases (and would only have one to begin with, ESC to close). We probably can't reliably attach that event handler until we have a focus manager.

@bitpshr bitpshr merged commit f41d6d1 into dojo:master Jun 6, 2017
@dylans dylans added this to the 2017.06 milestone Jun 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants