Skip to content

fix(menu): make @Output names consistent #6677 #8053

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 4 commits into from
Oct 30, 2017
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
24 changes: 15 additions & 9 deletions src/lib/menu/menu-directive.ts
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,13 @@ export class MatMenu implements AfterContentInit, MatMenuPanel, OnDestroy {
}

/** Event emitted when the menu is closed. */
@Output() close = new EventEmitter<void | 'click' | 'keydown'>();
@Output() closed = new EventEmitter<void | 'click' | 'keydown'>();

/**
* Event emitted when the menu is closed.
* @deprecated Switch to `closed` instead
*/
@Output() close = this.closed;

constructor(
private _elementRef: ElementRef,
Expand All @@ -156,39 +162,39 @@ export class MatMenu implements AfterContentInit, MatMenuPanel, OnDestroy {

ngOnDestroy() {
this._tabSubscription.unsubscribe();
this.close.emit();
this.close.complete();
this.closed.emit();
this.closed.complete();
}

/** Stream that emits whenever the hovered menu item changes. */
hover(): Observable<MatMenuItem> {
_hovered(): Observable<MatMenuItem> {
if (this.items) {
return this.items.changes.pipe(
startWith(this.items),
switchMap(items => merge(...items.map(item => item.hover)))
switchMap(items => merge(...items.map(item => item._hovered)))
);
}

return this._ngZone.onStable
.asObservable()
.pipe(first(), switchMap(() => this.hover()));
.pipe(first(), switchMap(() => this._hovered()));
}

/** Handle a keyboard event from the menu, delegating to the appropriate action. */
_handleKeydown(event: KeyboardEvent) {
switch (event.keyCode) {
case ESCAPE:
this.close.emit('keydown');
this.closed.emit('keydown');
event.stopPropagation();
break;
case LEFT_ARROW:
if (this.parentMenu && this.direction === 'ltr') {
this.close.emit('keydown');
this.closed.emit('keydown');
}
break;
case RIGHT_ARROW:
if (this.parentMenu && this.direction === 'rtl') {
this.close.emit('keydown');
this.closed.emit('keydown');
}
break;
default:
Expand Down
6 changes: 3 additions & 3 deletions src/lib/menu/menu-item.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export class MatMenuItem extends _MatMenuItemMixinBase implements FocusableOptio
OnDestroy {

/** Stream that emits when the menu item is hovered. */
hover: Subject<MatMenuItem> = new Subject();
_hovered: Subject<MatMenuItem> = new Subject();

/** Whether the menu item is highlighted. */
_highlighted: boolean = false;
Expand All @@ -69,7 +69,7 @@ export class MatMenuItem extends _MatMenuItemMixinBase implements FocusableOptio
}

ngOnDestroy() {
this.hover.complete();
this._hovered.complete();
}

/** Used to set the `tabindex`. */
Expand All @@ -93,7 +93,7 @@ export class MatMenuItem extends _MatMenuItemMixinBase implements FocusableOptio
/** Emits to the hover stream. */
_emitHoverEvent() {
if (!this.disabled) {
this.hover.next(this);
this._hovered.next(this);
}
}

Expand Down
24 changes: 18 additions & 6 deletions src/lib/menu/menu-trigger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,22 @@ export class MatMenuTrigger implements AfterContentInit, OnDestroy {
@Input('matMenuTriggerFor') menu: MatMenuPanel;

/** Event emitted when the associated menu is opened. */
@Output() onMenuOpen = new EventEmitter<void>();
@Output() menuOpened = new EventEmitter<void>();

/**
* Event emitted when the associated menu is opened.
* @deprecated Switch to `menuOpened` instead
*/
@Output() onMenuOpen = this.menuOpened;

/** Event emitted when the associated menu is closed. */
@Output() onMenuClose = new EventEmitter<void>();
@Output() menuClosed = new EventEmitter<void>();

/**
* Event emitted when the associated menu is closed.
* @deprecated Switch to `menuClosed` instead
*/
@Output() onMenuClose = this.menuClosed;

constructor(private _overlay: Overlay,
private _element: ElementRef,
Expand All @@ -133,13 +145,13 @@ export class MatMenuTrigger implements AfterContentInit, OnDestroy {

// If a click closed the menu, we should close the entire chain of nested menus.
if (reason === 'click' && this._parentMenu) {
this._parentMenu.close.emit(reason);
this._parentMenu.closed.emit(reason);
}
});

if (this.triggersSubmenu()) {
// Subscribe to changes in the hovered item in order to toggle the panel.
this._hoverSubscription = this._parentMenu.hover()
this._hoverSubscription = this._parentMenu._hovered()
.pipe(filter(active => active === this._menuItemInstance))
.subscribe(() => {
this._openedByMouse = true;
Expand Down Expand Up @@ -273,7 +285,7 @@ export class MatMenuTrigger implements AfterContentInit, OnDestroy {
// set state rather than toggle to support triggers sharing a menu
private _setIsMenuOpen(isOpen: boolean): void {
this._menuOpen = isOpen;
this._menuOpen ? this.onMenuOpen.emit() : this.onMenuClose.emit();
this._menuOpen ? this.menuOpened.emit() : this.menuClosed.emit();

if (this.triggersSubmenu()) {
this._menuItemInstance._highlighted = isOpen;
Expand Down Expand Up @@ -388,7 +400,7 @@ export class MatMenuTrigger implements AfterContentInit, OnDestroy {
private _menuClosingActions() {
const backdrop = this._overlayRef!.backdropClick();
const parentClose = this._parentMenu ? this._parentMenu.close : observableOf();
const hover = this._parentMenu ? this._parentMenu.hover().pipe(
const hover = this._parentMenu ? this._parentMenu._hovered().pipe(
filter(active => active !== this._menuItemInstance),
filter(() => this._menuOpen)
) : observableOf();
Expand Down
2 changes: 1 addition & 1 deletion src/lib/menu/menu.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
class="mat-menu-panel"
[ngClass]="_classList"
(keydown)="_handleKeydown($event)"
(click)="close.emit('click')"
(click)="closed.emit('click')"
[@transformMenu]="_panelAnimationState"
(@transformMenu.done)="_onAnimationDone($event)"
tabindex="-1"
Expand Down
6 changes: 3 additions & 3 deletions src/lib/menu/menu.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@ describe('MatMenu', () => {
const emitCallback = jasmine.createSpy('emit callback');
const completeCallback = jasmine.createSpy('complete callback');

fixture.componentInstance.menu.close.subscribe(emitCallback, null, completeCallback);
fixture.componentInstance.menu.closed.subscribe(emitCallback, null, completeCallback);
fixture.destroy();

expect(emitCallback).toHaveBeenCalledWith(undefined);
Expand Down Expand Up @@ -625,7 +625,7 @@ describe('MatMenu', () => {
fixture.detectChanges();

const spy = jasmine.createSpy('hover spy');
const subscription = instance.rootMenu.hover().subscribe(spy);
const subscription = instance.rootMenu._hovered().subscribe(spy);
const menuItems = overlay.querySelectorAll('[mat-menu-item]');

dispatchMouseEvent(menuItems[0], 'mouseenter');
Expand Down Expand Up @@ -1112,7 +1112,7 @@ describe('MatMenu default overrides', () => {
@Component({
template: `
<button [matMenuTriggerFor]="menu" #triggerEl>Toggle menu</button>
<mat-menu class="custom-one custom-two" #menu="matMenu" (close)="closeCallback($event)">
<mat-menu class="custom-one custom-two" #menu="matMenu" (closed)="closeCallback($event)">
<button mat-menu-item> Item </button>
<button mat-menu-item disabled> Disabled </button>
<button mat-menu-item>
Expand Down