docs: initial overview docs for button - dialog #2290
Conversation
googlebot
added
the
cla: yes
src/lib/dialog/OVERVIEW.md
Outdated
| | `md-dialog-title` | \[Attr] Dialog title, applied to a heading element (e.g., `<h1>`, `<h2>`)| | ||
| | `<md-dialog-content>` | Primary scrollable content of the dialog | | ||
| | `<md-dialog-actions>` | Container for action buttons at the bottom of the dialog | | ||
| | `md-dialog-close` | \[Attr] Added to a `<button>` to make the button close the on click | |
There was a problem hiding this comment.
You missed "dialog" here - "...to make the button close the dialog on click".
|
@jelbourn Yeah I will do the docs for the slide-toggle and toolbar. |
src/lib/button-toggle/OVERVIEW.md
Outdated
| @@ -0,0 +1,21 @@ | |||
| Buttons toggles aregroups of buttons that can be toggled on and off. They can be configured to | |||
There was a problem hiding this comment.
Button toggles are groups...
There was a problem hiding this comment.
I still think "buttons toggles" is a weird way to pluralize it, it also says "button toggles" elsewhere in this same readme
src/lib/button-toggle/OVERVIEW.md
Outdated
| @@ -0,0 +1,21 @@ | |||
| Buttons toggles aregroups of buttons that can be toggled on and off. They can be configured to | |||
| behave as checkboxes or as radio buttons. Button toggles are always part of a | |||
| `md-button-toggle-group`. | |||
There was a problem hiding this comment.
I don't think this is true, you could have a single button that can toggle on or off. The code says the toggle group is optional: https://github.com/angular/material2/blob/master/src/lib/button-toggle/button-toggle.ts#L299
| <!-- example(button-toggle-overview) --> | ||
|
|
||
| ### Exclusive selection vs. multiple selection | ||
| By default, `md-button-toggle-group` acts like a radio-button group- only one item can be selected. |
There was a problem hiding this comment.
radio-button-group (also surround with backticks)
There was a problem hiding this comment.
I wanted to refer to the general idea of a radio-button group vs. md-radio-group specifically.
src/lib/button-toggle/OVERVIEW.md
Outdated
|
|
||
| ### Exclusive selection vs. multiple selection | ||
| By default, `md-button-toggle-group` acts like a radio-button group- only one item can be selected. | ||
| In this mode, the `value` of the `md-radio-group` will reflect the value of the selected button and |
src/lib/button-toggle/OVERVIEW.md
Outdated
| `ngModel` is supported. | ||
|
|
||
| Adding the `multiple` attribute allows multiple items to be selected (checkbox behavior). In this | ||
| mode the values of the the toggles are not used, the `md-radio-group` does not have a value, and |
|
Good catches- comments addressed. |
|
lgtm |
|
This had an funny commit in snackbar-ref that is breaking the tests. Check out #2298 for the removal of the line. |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
6 participants
Initial overview docs for button, button-toggle, card, checkbox, and dialog. Will need more examples added later.
cc @topherfangio @devversion if you want to do something similar for your components