This repository has been archived by the owner on Jan 13, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
docs(select): Reorganize / clean up enhanced select docs #3988
Merged
williamernest
merged 3 commits into
feat/select/hidden-input
from
feat/select/readme-cleanup
Oct 26, 2018
Merged
docs(select): Reorganize / clean up enhanced select docs #3988
williamernest
merged 3 commits into
feat/select/hidden-input
from
feat/select/readme-cleanup
Oct 26, 2018
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
e3bd3d1
to
5d2c3f5
Compare
e28eb07
to
19b5593
Compare
williamernest
approved these changes
Oct 25, 2018
@@ -282,13 +333,13 @@ programmatically select a disabled list item in the enhanced select. | |||
<div class="mdc-select__menu mdc-menu mdc-menu-surface" role="listbox"> | |||
<ul class="mdc-list"> | |||
<li class="mdc-list-item" data-value=""></li> | |||
<li class="mdc-list" data-value="grains"> | |||
<li class="mdc-list-item" data-value="grains"> |
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.
Good catch
``` | ||
|
||
### JavaScript Instantiation | ||
#### Usability Notes |
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.
+1
packages/mdc-select/README.md
Outdated
--- | --- | --- | ||
`MDCSelect:change` | `{value: string, index: number}` | Used to indicate when an element has been selected. This event also includes the value of the item and the index. | ||
|
||
|
||
### Events |
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.
Events section looks duplicated.
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.
That's funny, I noticed it was duplicated originally, and I must've moved the table up here and forgotten to remove the other Events heading.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes #3728.
Rearranges README content regarding the enhanced select to its own variant section, adds some notes around usability trade-offs, and also moves the accessibility example into there as well.
Also fixes a few mistyped
mdc-list-item
classnames I noticed.While reviewing the README, I found an opportunity to simplify one of the new APIs (
notifyChange
) so I added that here as well, in a separate commit.This PR is currently based on the branch for #3986 since that also had readme changes, so we can hopefully merge these in order.