diff --git a/src/lib/button-toggle/OVERVIEW.md b/src/lib/button-toggle/OVERVIEW.md new file mode 100644 index 00000000000..5bd6507c7ac --- /dev/null +++ b/src/lib/button-toggle/OVERVIEW.md @@ -0,0 +1,22 @@ +Button-toggles are on/off toggles with the appearance of a button. These toggles can be configured +to behave as either radio-buttons or checkboxes. While they can be standalone, they are typically +part of a `md-button-toggle-group`. + + + + +### 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-button-toggle-group` will reflect the value of the selected +button and `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-button-toggle-group` does not have a value, +and `ngModel` is not supported. + +### Accessibility +The button-toggles will present themselves as either checkboxes or radio-buttons based on the +presence of the `multiple` attribute. + +### Orientation +The button-toggles can be rendered in a vertical orientation by adding the `vertical` attribute. diff --git a/src/lib/button/OVERVIEW.md b/src/lib/button/OVERVIEW.md new file mode 100644 index 00000000000..8cd5feb0787 --- /dev/null +++ b/src/lib/button/OVERVIEW.md @@ -0,0 +1,25 @@ +Angular Material buttons are native `