From 817fa925380ec6d1ab5efa790a4e2b20c59fab68 Mon Sep 17 00:00:00 2001 From: Jeremy Elbourn Date: Mon, 19 Dec 2016 22:30:31 -0800 Subject: [PATCH 1/3] docs: initial overview docs for button - dialog --- src/lib/button-toggle/OVERVIEW.md | 21 +++++++++++++++ src/lib/button/OVERVIEW.md | 25 +++++++++++++++++ src/lib/card/OVERVIEW.md | 45 +++++++++++++++++++++++++++++++ src/lib/checkbox/OVERVIEW.md | 28 +++++++++++++++++++ src/lib/dialog/OVERVIEW.md | 39 +++++++++++++++++++++++++++ src/lib/dialog/README.md | 1 - 6 files changed, 158 insertions(+), 1 deletion(-) create mode 100644 src/lib/button-toggle/OVERVIEW.md create mode 100644 src/lib/button/OVERVIEW.md create mode 100644 src/lib/card/OVERVIEW.md create mode 100644 src/lib/checkbox/OVERVIEW.md create mode 100644 src/lib/dialog/OVERVIEW.md diff --git a/src/lib/button-toggle/OVERVIEW.md b/src/lib/button-toggle/OVERVIEW.md new file mode 100644 index 000000000000..bbe86a5d4acb --- /dev/null +++ b/src/lib/button-toggle/OVERVIEW.md @@ -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`. + + + +### 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 +`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 +`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 000000000000..8cd5feb07879 --- /dev/null +++ b/src/lib/button/OVERVIEW.md @@ -0,0 +1,25 @@ +Angular Material buttons are native `