Skip to content

fix(material-experimental/mdc-snack-bar): avoid hard reference to base components and align API #21425

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 1 commit into from
Jan 13, 2022
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
4 changes: 2 additions & 2 deletions src/dev-app/mdc-snack-bar/mdc-snack-bar-demo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@

import {Directionality} from '@angular/cdk/bidi';
import {Component, TemplateRef, ViewChild, ViewEncapsulation} from '@angular/core';
import {MatSnackBar} from '@angular/material-experimental/mdc-snack-bar';
import {
MatSnackBar,
MatSnackBarConfig,
MatSnackBarHorizontalPosition,
MatSnackBarVerticalPosition,
} from '@angular/material/snack-bar';
} from '@angular/material-experimental/mdc-snack-bar';

@Component({
selector: 'mdc-snack-bar-demo',
Expand Down
4 changes: 2 additions & 2 deletions src/material-experimental/mdc-snack-bar/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {NgModule} from '@angular/core';
import {MatButtonModule} from '@angular/material-experimental/mdc-button';
import {MatCommonModule} from '@angular/material-experimental/mdc-core';

import {MatSimpleSnackBar} from './simple-snack-bar';
import {SimpleSnackBar} from './simple-snack-bar';
import {MatSnackBarContainer} from './snack-bar-container';
import {MatSnackBarAction, MatSnackBarActions, MatSnackBarLabel} from './snack-bar-content';

Expand All @@ -27,7 +27,7 @@ import {MatSnackBarAction, MatSnackBarActions, MatSnackBarLabel} from './snack-b
MatSnackBarAction,
],
declarations: [
MatSimpleSnackBar,
SimpleSnackBar,
MatSnackBarContainer,
MatSnackBarLabel,
MatSnackBarActions,
Expand Down
1 change: 0 additions & 1 deletion src/material-experimental/mdc-snack-bar/public-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ export {
MatSnackBarConfig,
MatSnackBarDismiss,
MatSnackBarRef,
SimpleSnackBar,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this needs to be added back, still getting build failures about not finding SimpleSnackBar

MAT_SNACK_BAR_DATA,
MAT_SNACK_BAR_DEFAULT_OPTIONS,
MAT_SNACK_BAR_DEFAULT_OPTIONS_FACTORY,
Expand Down
11 changes: 3 additions & 8 deletions src/material-experimental/mdc-snack-bar/simple-snack-bar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,10 @@
*/

import {ChangeDetectionStrategy, Component, Inject, ViewEncapsulation} from '@angular/core';
import {
MAT_SNACK_BAR_DATA,
TextOnlySnackBar,
MatSnackBarRef,
SimpleSnackBar,
} from '@angular/material/snack-bar';
import {MAT_SNACK_BAR_DATA, TextOnlySnackBar, MatSnackBarRef} from '@angular/material/snack-bar';

@Component({
selector: 'mat-simple-snack-bar',
selector: 'simple-snack-bar',
templateUrl: 'simple-snack-bar.html',
styleUrls: ['simple-snack-bar.css'],
exportAs: 'matSnackBar',
Expand All @@ -25,7 +20,7 @@ import {
'class': 'mat-mdc-simple-snack-bar',
},
})
export class MatSimpleSnackBar implements TextOnlySnackBar {
export class SimpleSnackBar implements TextOnlySnackBar {
constructor(
public snackBarRef: MatSnackBarRef<SimpleSnackBar>,
@Inject(MAT_SNACK_BAR_DATA) public data: {message: string; action: string},
Expand Down
6 changes: 3 additions & 3 deletions src/material-experimental/mdc-snack-bar/snack-bar.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {NoopAnimationsModule} from '@angular/platform-browser/animations';
import {
MAT_SNACK_BAR_DATA,
MAT_SNACK_BAR_DEFAULT_OPTIONS,
MatSimpleSnackBar,
SimpleSnackBar,
MatSnackBar,
MatSnackBarConfig,
MatSnackBarContainer,
Expand Down Expand Up @@ -239,7 +239,7 @@ describe('MatSnackBar', () => {

viewContainerFixture.detectChanges();

expect(snackBarRef.instance instanceof MatSimpleSnackBar)
expect(snackBarRef.instance instanceof SimpleSnackBar)
.withContext('Expected the snack bar content component to be SimpleSnackBar')
.toBe(true);
expect(snackBarRef.instance.snackBarRef)
Expand All @@ -266,7 +266,7 @@ describe('MatSnackBar', () => {

viewContainerFixture.detectChanges();

expect(snackBarRef.instance instanceof MatSimpleSnackBar)
expect(snackBarRef.instance instanceof SimpleSnackBar)
.withContext('Expected the snack bar content component to be SimpleSnackBar')
.toBe(true);
expect(snackBarRef.instance.snackBarRef)
Expand Down
28 changes: 23 additions & 5 deletions src/material-experimental/mdc-snack-bar/snack-bar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,36 @@
* found in the LICENSE file at https://angular.io/license
*/

import {Injectable} from '@angular/core';
import {MatSnackBar as BaseMatSnackBar} from '@angular/material/snack-bar';
import {LiveAnnouncer} from '@angular/cdk/a11y';
import {BreakpointObserver} from '@angular/cdk/layout';
import {Overlay} from '@angular/cdk/overlay';
import {Inject, Injectable, Injector, Optional, SkipSelf} from '@angular/core';
import {
MatSnackBarConfig,
MAT_SNACK_BAR_DEFAULT_OPTIONS,
_MatSnackBarBase,
} from '@angular/material/snack-bar';
import {MatSnackBarModule} from './module';
import {MatSimpleSnackBar} from './simple-snack-bar';
import {SimpleSnackBar} from './simple-snack-bar';
import {MatSnackBarContainer} from './snack-bar-container';

/**
* Service to dispatch Material Design snack bar messages.
*/
@Injectable({providedIn: MatSnackBarModule})
export class MatSnackBar extends BaseMatSnackBar {
protected override simpleSnackBarComponent = MatSimpleSnackBar;
export class MatSnackBar extends _MatSnackBarBase {
protected override simpleSnackBarComponent = SimpleSnackBar;
protected override snackBarContainerComponent = MatSnackBarContainer;
protected override handsetCssClass = 'mat-mdc-snack-bar-handset';

constructor(
overlay: Overlay,
live: LiveAnnouncer,
injector: Injector,
breakpointObserver: BreakpointObserver,
@Optional() @SkipSelf() parentSnackBar: MatSnackBar,
@Inject(MAT_SNACK_BAR_DEFAULT_OPTIONS) defaultConfig: MatSnackBarConfig,
) {
super(overlay, live, injector, breakpointObserver, parentSnackBar, defaultConfig);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {TestbedHarnessEnvironment} from '@angular/cdk/testing/testbed';
import {Component, TemplateRef, ViewChild} from '@angular/core';

describe('MDC-based MatSnackBarHarness', () => {
runHarnessTests(MatSnackBarModule, MatSnackBar, MatSnackBarHarness as any);
runHarnessTests(MatSnackBarModule, MatSnackBar as any, MatSnackBarHarness as any);
});

describe('MDC-based MatSnackBarHarness (MDC only behavior)', () => {
Expand Down
36 changes: 27 additions & 9 deletions src/material/snack-bar/snack-bar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,8 @@ export function MAT_SNACK_BAR_DEFAULT_OPTIONS_FACTORY(): MatSnackBarConfig {
return new MatSnackBarConfig();
}

/**
* Service to dispatch Material Design snack bar messages.
*/
@Injectable({providedIn: MatSnackBarModule})
export class MatSnackBar implements OnDestroy {
@Injectable()
export abstract class _MatSnackBarBase implements OnDestroy {
/**
* Reference to the current snack bar in the view *at this level* (in the Angular injector tree).
* If there is a parent snack-bar service, all operations should delegate to that parent
Expand All @@ -57,13 +54,13 @@ export class MatSnackBar implements OnDestroy {
private _snackBarRefAtThisLevel: MatSnackBarRef<any> | null = null;

/** The component that should be rendered as the snack bar's simple component. */
protected simpleSnackBarComponent: Type<TextOnlySnackBar> = SimpleSnackBar;
protected abstract simpleSnackBarComponent: Type<TextOnlySnackBar>;

/** The container component that attaches the provided template or component. */
protected snackBarContainerComponent: Type<_SnackBarContainer> = MatSnackBarContainer;
protected abstract snackBarContainerComponent: Type<_SnackBarContainer>;

/** The CSS class to apply for handset mode. */
protected handsetCssClass = 'mat-snack-bar-handset';
protected abstract handsetCssClass: string;

/** Reference to the currently opened snackbar at *any* level. */
get _openedSnackBarRef(): MatSnackBarRef<any> | null {
Expand All @@ -84,7 +81,7 @@ export class MatSnackBar implements OnDestroy {
private _live: LiveAnnouncer,
private _injector: Injector,
private _breakpointObserver: BreakpointObserver,
@Optional() @SkipSelf() private _parentSnackBar: MatSnackBar,
@Optional() @SkipSelf() private _parentSnackBar: _MatSnackBarBase,
@Inject(MAT_SNACK_BAR_DEFAULT_OPTIONS) private _defaultConfig: MatSnackBarConfig,
) {}

Expand Down Expand Up @@ -311,3 +308,24 @@ export class MatSnackBar implements OnDestroy {
});
}
}

/**
* Service to dispatch Material Design snack bar messages.
*/
@Injectable({providedIn: MatSnackBarModule})
export class MatSnackBar extends _MatSnackBarBase {
protected simpleSnackBarComponent = SimpleSnackBar;
protected snackBarContainerComponent = MatSnackBarContainer;
protected handsetCssClass = 'mat-snack-bar-handset';

constructor(
overlay: Overlay,
live: LiveAnnouncer,
injector: Injector,
breakpointObserver: BreakpointObserver,
@Optional() @SkipSelf() parentSnackBar: MatSnackBar,
@Inject(MAT_SNACK_BAR_DEFAULT_OPTIONS) defaultConfig: MatSnackBarConfig,
) {
super(overlay, live, injector, breakpointObserver, parentSnackBar, defaultConfig);
}
}
37 changes: 26 additions & 11 deletions tools/public_api_guard/material/snack-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,14 @@ export const MAT_SNACK_BAR_DEFAULT_OPTIONS: InjectionToken<MatSnackBarConfig<any
export function MAT_SNACK_BAR_DEFAULT_OPTIONS_FACTORY(): MatSnackBarConfig;

// @public
export class MatSnackBar implements OnDestroy {
constructor(_overlay: Overlay, _live: LiveAnnouncer, _injector: Injector, _breakpointObserver: BreakpointObserver, _parentSnackBar: MatSnackBar, _defaultConfig: MatSnackBarConfig);
dismiss(): void;
export class MatSnackBar extends _MatSnackBarBase {
constructor(overlay: Overlay, live: LiveAnnouncer, injector: Injector, breakpointObserver: BreakpointObserver, parentSnackBar: MatSnackBar, defaultConfig: MatSnackBarConfig);
// (undocumented)
protected handsetCssClass: string;
// (undocumented)
ngOnDestroy(): void;
open(message: string, action?: string, config?: MatSnackBarConfig): MatSnackBarRef<TextOnlySnackBar>;
get _openedSnackBarRef(): MatSnackBarRef<any> | null;
set _openedSnackBarRef(value: MatSnackBarRef<any> | null);
openFromComponent<T>(component: ComponentType<T>, config?: MatSnackBarConfig): MatSnackBarRef<T>;
openFromTemplate(template: TemplateRef<any>, config?: MatSnackBarConfig): MatSnackBarRef<EmbeddedViewRef<any>>;
protected simpleSnackBarComponent: Type<TextOnlySnackBar>;
protected snackBarContainerComponent: Type<_SnackBarContainer>;
protected simpleSnackBarComponent: typeof SimpleSnackBar;
// (undocumented)
protected snackBarContainerComponent: typeof MatSnackBarContainer;
// (undocumented)
static ɵfac: i0.ɵɵFactoryDeclaration<MatSnackBar, [null, null, null, null, { optional: true; skipSelf: true; }, null]>;
// (undocumented)
Expand All @@ -73,6 +68,26 @@ export const matSnackBarAnimations: {
readonly snackBarState: AnimationTriggerMetadata;
};

// @public (undocumented)
export abstract class _MatSnackBarBase implements OnDestroy {
constructor(_overlay: Overlay, _live: LiveAnnouncer, _injector: Injector, _breakpointObserver: BreakpointObserver, _parentSnackBar: _MatSnackBarBase, _defaultConfig: MatSnackBarConfig);
dismiss(): void;
protected abstract handsetCssClass: string;
// (undocumented)
ngOnDestroy(): void;
open(message: string, action?: string, config?: MatSnackBarConfig): MatSnackBarRef<TextOnlySnackBar>;
get _openedSnackBarRef(): MatSnackBarRef<any> | null;
set _openedSnackBarRef(value: MatSnackBarRef<any> | null);
openFromComponent<T>(component: ComponentType<T>, config?: MatSnackBarConfig): MatSnackBarRef<T>;
openFromTemplate(template: TemplateRef<any>, config?: MatSnackBarConfig): MatSnackBarRef<EmbeddedViewRef<any>>;
protected abstract simpleSnackBarComponent: Type<TextOnlySnackBar>;
protected abstract snackBarContainerComponent: Type<_SnackBarContainer>;
// (undocumented)
static ɵfac: i0.ɵɵFactoryDeclaration<_MatSnackBarBase, [null, null, null, null, { optional: true; skipSelf: true; }, null]>;
// (undocumented)
static ɵprov: i0.ɵɵInjectableDeclaration<_MatSnackBarBase>;
}

// @public
export class MatSnackBarConfig<D = any> {
announcementMessage?: string;
Expand Down