docs(select): Update README to new format #2589
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2589 +/- ##
=======================================
Coverage 98.48% 98.48%
=======================================
Files 98 98
Lines 4230 4230
Branches 537 537
=======================================
Hits 4166 4166
Misses 64 64Continue to review full report at Codecov.
|
kfranqueiro
force-pushed
the
feat/select/no-import-common
branch
from
6cdb18e
to
932f8cf
Compare
kfranqueiro
changed the title
|
Disregard the branch name; since we decided to move forward with #2578 instead, I've repurposed this PR to simply update the Select README to the new format, since I had done it in this PR anyway. |
kfranqueiro
force-pushed
the
feat/select/no-import-common
branch
from
932f8cf
to
c79523a
Compare
packages/mdc-select/README.md
Outdated
| ```scss | ||
| @import "@material/select/mdc-select"; | ||
|
|
||
| // Invoke mixins in the context of a custom class applied to the component's root element: |
There was a problem hiding this comment.
Is this necessary to get the default select? If not, it doesn't need to go under Basic Usage.
There was a problem hiding this comment.
I had done this as a replacement for the remark about including the mixins within a .foo-select custom class selector in the Sass mixins section, but I can put that back.
packages/mdc-select/README.md
Outdated
| @@ -148,6 +171,8 @@ Since MDC Select uses native `<select>` and `<option>` elements, simply add the | |||
| </div> | |||
| ``` | |||
|
|
|||
| ## Style Customization | |||
|
|
|||
| #### CSS Classes | |||
|
|
|||
| | Class | Description | | |||
There was a problem hiding this comment.
I think these were missing from before: mdc-select--disabled, mdc-select__native-control
This also updates the README to follow our new structure, since I needed to document the necessary imports now anyway.
BREAKING CHANGE: mdc-floating-label and mdc-line-ripple styles must now be explicitly imported