Skip to content
This repository has been archived by the owner on Jan 13, 2025. It is now read-only.

docs(select): Reorganize / clean up enhanced select docs #3988

Merged
merged 3 commits into from
Oct 26, 2018

Conversation

kfranqueiro
Copy link
Contributor

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.

@kfranqueiro kfranqueiro changed the title Feat/select/readme cleanup docs(select): Reorganize / clean up enhanced select docs Oct 24, 2018
@kfranqueiro kfranqueiro force-pushed the feat/select/hidden-input branch from e3bd3d1 to 5d2c3f5 Compare October 25, 2018 12:52
@kfranqueiro kfranqueiro force-pushed the feat/select/readme-cleanup branch from e28eb07 to 19b5593 Compare October 25, 2018 12:52
@@ -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">
Copy link
Contributor

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

--- | --- | ---
`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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Events section looks duplicated.

Copy link
Contributor Author

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.

@williamernest williamernest merged commit fe18582 into feat/select/hidden-input Oct 26, 2018
@williamernest williamernest deleted the feat/select/readme-cleanup branch October 26, 2018 14:31
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants