Skip to content

doc(material/button): improve button docs & examples #26170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 4, 2022
Merged

doc(material/button): improve button docs & examples #26170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37d4ebd
docs(material/button): improve button docs & examples
mmalerba Dec 2, 2022
5ee49fc
fixup! docs(material/button): improve button docs & examples
mmalerba Dec 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/components-examples/material/button/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ ng_module(
"//src/material/button/testing",
"//src/material/divider",
"//src/material/icon",
"//src/material/tooltip",
"@npm//@angular/platform-browser",
"@npm//@angular/platform-browser-dynamic",
"@npm//@types/jasmine",
Expand Down
4 changes: 4 additions & 0 deletions src/components-examples/material/button/button-types/button-types-example.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
.example-button-row a {
margin-right: 8px;
}

.example-disabled {
display: inline-block;
}
85 changes: 65 additions & 20 deletions src/components-examples/material/button/button-types/button-types-example.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,45 +40,90 @@ <h3>Flat Buttons</h3>

<h3>Icon Buttons</h3>
<div class="example-button-row">
<button mat-icon-button aria-label="Example icon-button with a heart icon">
<button mat-icon-button matTooltip="Basic" aria-label="Example icon-button with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
<button mat-icon-button color="primary" aria-label="Example icon-button with a heart icon">
<button mat-icon-button matTooltip="Primary" color="primary" aria-label="Example icon-button with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
<button mat-icon-button color="accent" aria-label="Example icon-button with a heart icon">
<button mat-icon-button matTooltip="Accent" color="accent" aria-label="Example icon-button with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
<button mat-icon-button color="warn" aria-label="Example icon-button with a heart icon">
<button mat-icon-button matTooltip="Warn" color="warn" aria-label="Example icon-button with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
<button mat-icon-button disabled aria-label="Example icon-button with a heart icon">
<div matTooltip="Disabled" class="example-disabled">
<button mat-icon-button disabled aria-label="Example icon-button with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
</div>
<a mat-icon-button matTooltip="Lik" routerLink="." aria-label="Example icon-button with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
</a>
</div>

<h3>Fab Buttons</h3>
<div class="example-button-row">
<button mat-fab>Basic</button>
<button mat-fab color="primary">Primary</button>
<button mat-fab color="accent">Accent</button>
<button mat-fab color="warn">Warn</button>
<button mat-fab disabled>Disabled</button>
<button mat-fab aria-label="Example icon-button with a heart icon">
<button mat-fab matTooltip="Primary" color="primary" aria-label="Example fab with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
<button mat-fab matTooltip="Accent" color="accent" aria-label="Example fab with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
<a mat-fab routerLink=".">Link</a>
<button mat-fab matTooltip="Warn" color="warn" aria-label="Example fab with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
<div matTooltip="Disabled" class="example-disabled">
<button mat-fab disabled aria-label="Example fab with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
</div>
<a mat-fab matTooltip="Link" routerLink="." aria-label="Example fab with a heart icon">
<mat-icon>favorite</mat-icon>
</a>
</div>

<h3>Mini Fab Buttons</h3>
<div class="example-button-row">
<button mat-mini-fab>Basic</button>
<button mat-mini-fab color="primary">Primary</button>
<button mat-mini-fab color="accent">Accent</button>
<button mat-mini-fab color="warn">Warn</button>
<button mat-mini-fab disabled>Disabled</button>
<button mat-mini-fab aria-label="Example icon-button with a heart icon">
<button mat-mini-fab matTooltip="Primary" color="primary" aria-label="Example mini fab with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
<a mat-mini-fab routerLink=".">Link</a>
<button mat-mini-fab matTooltip="Accent" color="accent" aria-label="Example mini fab with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
<button mat-mini-fab matTooltip="Warn" color="warn" aria-label="Example mini fab with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
<div matTooltip="Disabled" class="example-disabled">
<button mat-mini-fab disabled aria-label="Example mini fab with a heart icon">
<mat-icon>favorite</mat-icon>
</button>
</div>
<a mat-mini-fab matTooltip="Link" routerLink="." aria-label="Example mini fab with a heart icon">
<mat-icon>favorite</mat-icon>
</a>
</div>

<h3>Extended Fab</h3>
<div class="example-button-row">
<button mat-fab extended color="primary">
<mat-icon>favorite</mat-icon>
Primary
</button>
<button mat-fab extended color="accent">
<mat-icon>favorite</mat-icon>
Accent
</button>
<button mat-fab extended color="warn">
<mat-icon>favorite</mat-icon>
Warn
</button>
<button mat-fab extended disabled>
<mat-icon>favorite</mat-icon>
Disabled
</button>
<a mat-fab extended routerLink=".">
<mat-icon>favorite</mat-icon>
Link
</a>
</div>
3 changes: 2 additions & 1 deletion src/components-examples/material/button/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import {NgModule} from '@angular/core';
import {MatButtonModule} from '@angular/material/button';
import {MatDividerModule} from '@angular/material/divider';
import {MatIconModule} from '@angular/material/icon';
import {MatTooltipModule} from '@angular/material/tooltip';
import {ButtonOverviewExample} from './button-overview/button-overview-example';
import {ButtonTypesExample} from './button-types/button-types-example';
import {ButtonHarnessExample} from './button-harness/button-harness-example';
Expand All @@ -11,7 +12,7 @@ export {ButtonOverviewExample, ButtonTypesExample, ButtonHarnessExample};
const EXAMPLES = [ButtonOverviewExample, ButtonTypesExample, ButtonHarnessExample];

@NgModule({
imports: [MatButtonModule, MatDividerModule, MatIconModule],
imports: [MatButtonModule, MatDividerModule, MatIconModule, MatTooltipModule],
declarations: EXAMPLES,
exports: EXAMPLES,
})
Expand Down
80 changes: 0 additions & 80 deletions src/material/button/README.md
View file
Open in desktop

This file was deleted.

13 changes: 13 additions & 0 deletions src/material/button/button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,19 @@ certain locales. It is also worth noting that using ALL CAPS in the text itself
screen-readers, which will read the text character-by-character. We leave the decision of how to
approach this to the consuming app.

### Extended fab buttons
Traditional fab buttons are circular and only have space for a single icon. However, you can add the
`extended` attribute to allow the fab to expand into a rounded rectangle shape with space for a text
label in addition to the icon. Only full sized fabs support the `extended` attribute, mini fabs do
not.

```html
<button mat-fab extended>
<mat-icon>home</mat-icon>
Home
</button>
```

### Accessibility
Angular Material uses native `<button>` and `<a>` elements to ensure an accessible experience by
default. A `<button>` element should be used for any interaction that _performs an action on the
Expand Down