Skip to content

Commit 6fb5f31

Browse files
authored
docs(material/button-toggle): add selection mode example (#23415)
Adds a new example showing a button toggle in multiple selection mode. Fixes #23344.
1 parent 172a6a1 commit 6fb5f31

File tree

4 files changed

+29
-1
lines changed

4 files changed

+29
-1
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<h3>Single selection</h3>
2+
<mat-button-toggle-group name="favoriteColor" aria-label="Favorite Color">
3+
<mat-button-toggle value="red">Red</mat-button-toggle>
4+
<mat-button-toggle value="green">Green</mat-button-toggle>
5+
<mat-button-toggle value="blue">Blue</mat-button-toggle>
6+
</mat-button-toggle-group>
7+
8+
<h3>Multiple selection</h3>
9+
<mat-button-toggle-group name="ingredients" aria-label="Ingredients" multiple>
10+
<mat-button-toggle value="flour">Flour</mat-button-toggle>
11+
<mat-button-toggle value="eggs">Eggs</mat-button-toggle>
12+
<mat-button-toggle value="sugar">Sugar</mat-button-toggle>
13+
</mat-button-toggle-group>
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import {Component} from '@angular/core';
2+
3+
/**
4+
* @title Button toggle selection mode
5+
*/
6+
@Component({
7+
selector: 'button-toggle-mode-example',
8+
templateUrl: 'button-toggle-mode-example.html',
9+
})
10+
export class ButtonToggleModeExample {}

src/components-examples/material/button-toggle/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ import {
1111
import {ButtonToggleOverviewExample} from './button-toggle-overview/button-toggle-overview-example';
1212
import {ButtonToggleHarnessExample} from './button-toggle-harness/button-toggle-harness-example';
1313
import {ButtonToggleFormsExample} from './button-toggle-forms/button-toggle-forms-example';
14+
import {ButtonToggleModeExample} from './button-toggle-mode/button-toggle-mode-example';
1415

1516
export {
1617
ButtonToggleAppearanceExample,
1718
ButtonToggleExclusiveExample,
1819
ButtonToggleOverviewExample,
1920
ButtonToggleHarnessExample,
2021
ButtonToggleFormsExample,
22+
ButtonToggleModeExample,
2123
};
2224

2325
const EXAMPLES = [
@@ -26,6 +28,7 @@ const EXAMPLES = [
2628
ButtonToggleOverviewExample,
2729
ButtonToggleHarnessExample,
2830
ButtonToggleFormsExample,
31+
ButtonToggleModeExample,
2932
];
3033

3134
@NgModule({

src/material/button-toggle/button-toggle.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ In this mode, the `value` of the `mat-button-toggle-group` will reflect the valu
1111
button and `ngModel` is supported.
1212

1313
Adding the `multiple` attribute allows multiple items to be selected (checkbox behavior). In this
14-
mode the values of the toggles are not used, the `mat-button-toggle-group` does not have a value,
14+
mode the values of the toggles are not used, the `mat-button-toggle-group` does not have a value,
1515
and `ngModel` is not supported.
1616

17+
<!-- example(button-toggle-mode) -->
18+
1719
### Appearance
1820
By default, the appearance of `mat-button-toggle-group` and `mat-button-toggle` will follow the
1921
latest Material Design guidelines. If you want to, you can switch back to the appearance that was

0 commit comments

Comments
 (0)