Skip to content

fix(toolbar): no longer auto-generate toolbar rows #6661

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 8 additions & 9 deletions src/demo-app/toolbar/toolbar-demo.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,27 +35,27 @@

<p>
<mat-toolbar color="accent">
<span>Custom Toolbar</span>
<mat-toolbar-row>
<span>Second Line</span>
</mat-toolbar-row>
<mat-toolbar-row>First Row</mat-toolbar-row>
<mat-toolbar-row>Second Row</mat-toolbar-row>
</mat-toolbar>
</p>

<p>
<mat-toolbar color="primary">
<span>Custom Toolbar</span>
<mat-toolbar-row>
<span>First Row</span>
</mat-toolbar-row>

<mat-toolbar-row>
<span>Second Line</span>
<span>Second Row</span>

<span class="demo-fill-remaining"></span>

<mat-icon class="demo-toolbar-icon">verified_user</mat-icon>
</mat-toolbar-row>

<mat-toolbar-row>
<span>Third Line</span>
<span>Third Row</span>

<span class="demo-fill-remaining"></span>

Expand All @@ -64,5 +64,4 @@
</mat-toolbar-row>
</mat-toolbar>
</p>

</div>
</div>
4 changes: 2 additions & 2 deletions src/lib/toolbar/toolbar-module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@

import {NgModule} from '@angular/core';
import {MatCommonModule} from '@angular/material/core';
import {PlatformModule} from '@angular/cdk/platform';
import {MatToolbar, MatToolbarRow} from './toolbar';


@NgModule({
imports: [MatCommonModule],
imports: [MatCommonModule, PlatformModule],
exports: [MatToolbar, MatToolbarRow, MatCommonModule],
declarations: [MatToolbar, MatToolbarRow],
})
Expand Down
8 changes: 2 additions & 6 deletions src/lib/toolbar/toolbar.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@
<div class="mat-toolbar-layout">
<mat-toolbar-row>
<ng-content></ng-content>
</mat-toolbar-row>
<ng-content select="mat-toolbar-row"></ng-content>
</div>
<ng-content></ng-content>
<ng-content select="mat-toolbar-row"></ng-content>
29 changes: 21 additions & 8 deletions src/lib/toolbar/toolbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,38 @@

<!-- example(toolbar-overview) -->

### Multiple rows
Toolbars can have multiple rows using `<mat-toolbar-row>` elements. Any content outside of an
`<mat-toolbar-row>` element are automatically placed inside of one at the beginning of the toolbar.
Each toolbar row is a `display: flex` container.
### Single row

In the most situations, a toolbar will be placed at the top of your application and will only
have a single row that includes the title of your application.

```html
<mat-toolbar>
<span>First Row</span>

<span>My Application</span>
</mat-toolbar>
```

### Multiple rows

The Material Design specifications describe that toolbars can also have multiple rows. Creating
toolbars with multiple rows in Angular Material can be done by placing `<mat-toolbar-row>` elements
inside of a `<mat-toolbar>`.

```html
<mat-toolbar>
<mat-toolbar-row>
<span>Second Row</span>
<span>First Row</span>
</mat-toolbar-row>

<mat-toolbar-row>
<span>Third Row</span>
<span>Second Row</span>
</mat-toolbar-row>
</mat-toolbar>
```

**Note**: Placing content outside of a `<mat-toolbar-row>` when multiple rows are specified is not
supported.

### Positioning toolbar content
The toolbar does not perform any positioning of its content. This gives the user full power to
position the content as it suits their application.
Expand Down
36 changes: 18 additions & 18 deletions src/lib/toolbar/toolbar.scss
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,39 @@ $mat-toolbar-height-desktop: 64px !default;
$mat-toolbar-height-mobile-portrait: 56px !default;
$mat-toolbar-height-mobile-landscape: 48px !default;

$mat-toolbar-padding: 16px !default;
$mat-toolbar-row-padding: 16px !default;


@mixin mat-toolbar-height($height) {
.mat-toolbar {
.mat-toolbar-multiple-rows {
min-height: $height;
}
.mat-toolbar-row {
.mat-toolbar-row, .mat-toolbar-single-row {
height: $height;
}
}

.mat-toolbar {
.mat-toolbar-row, .mat-toolbar-single-row {
display: flex;
box-sizing: border-box;
width: 100%;
padding: 0 $mat-toolbar-padding;
flex-direction: column;

.mat-toolbar-row {
display: flex;
box-sizing: border-box;
padding: 0 $mat-toolbar-row-padding;
width: 100%;

width: 100%;
// Flexbox Vertical Alignment
flex-direction: row;
align-items: center;

// Flexbox Vertical Alignment
flex-direction: row;
align-items: center;
// Per Material specs a toolbar cannot have multiple lines inside of a single row.
// Disable text wrapping inside of the toolbar. Developers are still able to overwrite it.
white-space: nowrap;
}

// Per Material specs a toolbar cannot have multiple lines inside of a single row.
// Disable text wrapping inside of the toolbar. Developers are still able to overwrite it.
white-space: nowrap;
}
.mat-toolbar-multiple-rows {
display: flex;
box-sizing: border-box;
flex-direction: column;
width: 100%;
}

// Set the default height for the toolbar.
Expand Down
114 changes: 87 additions & 27 deletions src/lib/toolbar/toolbar.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,55 +3,115 @@ import {TestBed, async, ComponentFixture} from '@angular/core/testing';
import {By} from '@angular/platform-browser';
import {MatToolbarModule} from './index';


describe('MatToolbar', () => {

let fixture: ComponentFixture<TestApp>;
let testComponent: TestApp;
let toolbarElement: HTMLElement;

beforeEach(async(() => {
TestBed.configureTestingModule({
imports: [MatToolbarModule],
declarations: [TestApp],
declarations: [ToolbarSingleRow, ToolbarMultipleRows, ToolbarMixedRowModes],
});

TestBed.compileComponents();
}));

beforeEach(() => {
fixture = TestBed.createComponent(TestApp);
testComponent = fixture.debugElement.componentInstance;
toolbarElement = fixture.debugElement.query(By.css('mat-toolbar')).nativeElement;
});
describe('with single row', () => {
let fixture: ComponentFixture<ToolbarSingleRow>;
let testComponent: ToolbarSingleRow;
let toolbarElement: HTMLElement;

beforeEach(() => {
fixture = TestBed.createComponent(ToolbarSingleRow);
testComponent = fixture.debugElement.componentInstance;
toolbarElement = fixture.debugElement.query(By.css('.mat-toolbar')).nativeElement;
});

it('should apply class based on color attribute', () => {
testComponent.toolbarColor = 'primary';
fixture.detectChanges();
it('should apply class based on color attribute', () => {
testComponent.toolbarColor = 'primary';
fixture.detectChanges();

expect(toolbarElement.classList.contains('mat-primary')).toBe(true);
expect(toolbarElement.classList.contains('mat-primary')).toBe(true);

testComponent.toolbarColor = 'accent';
fixture.detectChanges();
testComponent.toolbarColor = 'accent';
fixture.detectChanges();

expect(toolbarElement.classList.contains('mat-primary')).toBe(false);
expect(toolbarElement.classList.contains('mat-accent')).toBe(true);
expect(toolbarElement.classList.contains('mat-primary')).toBe(false);
expect(toolbarElement.classList.contains('mat-accent')).toBe(true);

testComponent.toolbarColor = 'warn';
fixture.detectChanges();
testComponent.toolbarColor = 'warn';
fixture.detectChanges();

expect(toolbarElement.classList.contains('mat-accent')).toBe(false);
expect(toolbarElement.classList.contains('mat-warn')).toBe(true);
expect(toolbarElement.classList.contains('mat-accent')).toBe(false);
expect(toolbarElement.classList.contains('mat-warn')).toBe(true);
});

it('should not wrap the first row contents inside of a generated element', () => {
expect(toolbarElement.firstElementChild!.tagName).toBe('SPAN',
'Expected the <span> element of the first row to be a direct child of the toolbar');
});
});

it('should set the toolbar role on the host', () => {
expect(toolbarElement.getAttribute('role')).toBe('toolbar');
describe('with multiple rows', () => {

it('should project each toolbar-row element inside of the toolbar', () => {
const fixture = TestBed.createComponent(ToolbarMultipleRows);
fixture.detectChanges();

expect(fixture.debugElement.queryAll(By.css('.mat-toolbar > .mat-toolbar-row')).length)
.toBe(2, 'Expected one toolbar row to be present while no content is projected.');
});

it('should throw an error if different toolbar modes are mixed', () => {
expect(() => {
const fixture = TestBed.createComponent(ToolbarMixedRowModes);
fixture.detectChanges();
}).toThrowError(/attempting to combine different/i);
});

it('should throw an error if a toolbar-row is added later', () => {
const fixture = TestBed.createComponent(ToolbarMixedRowModes);

fixture.componentInstance.showToolbarRow = false;
fixture.detectChanges();

expect(() => {
fixture.componentInstance.showToolbarRow = true;
fixture.detectChanges();
}).toThrowError(/attempting to combine different/i);
});
});

});


@Component({template: `<mat-toolbar [color]="toolbarColor">Test Toolbar</mat-toolbar>`})
class TestApp {
@Component({
template: `
<mat-toolbar [color]="toolbarColor">
<span>First Row</span>
</mat-toolbar>
`
})
class ToolbarSingleRow {
toolbarColor: string;
}

@Component({
template: `
<mat-toolbar>
<mat-toolbar-row>First Row</mat-toolbar-row>
<mat-toolbar-row>Second Row</mat-toolbar-row>
</mat-toolbar>
`
})
class ToolbarMultipleRows {}

@Component({
template: `
<mat-toolbar>
First Row
<mat-toolbar-row *ngIf="showToolbarRow">Second Row</mat-toolbar-row>
</mat-toolbar>
`
})
class ToolbarMixedRowModes {
showToolbarRow: boolean = true;
}
Loading