Skip to content

fix(overlay): default to global directionality #9994

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
2 changes: 1 addition & 1 deletion src/cdk-experimental/dialog/dialog-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export class DialogConfig<D = any> {
data?: D | null = null;

/** The layout direction for the dialog content. */
direction?: Direction = 'ltr';
direction?: Direction;

/** ID of the element that describes the dialog. */
ariaDescribedBy?: string | null = null;
Expand Down
2 changes: 1 addition & 1 deletion src/cdk/overlay/overlay-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export class OverlayConfig {
maxHeight?: number | string;

/** The direction of the text in the overlay panel. */
direction?: Direction = 'ltr';
direction?: Direction;

constructor(config?: OverlayConfig) {
if (config) {
Expand Down
23 changes: 21 additions & 2 deletions src/cdk/overlay/overlay.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import {async, fakeAsync, tick, ComponentFixture, inject, TestBed} from '@angular/core/testing';
import {Component, NgModule, ViewChild, ViewContainerRef} from '@angular/core';
import {Direction, Directionality} from '@angular/cdk/bidi';
import {
ComponentPortal,
PortalModule,
Expand All @@ -24,10 +25,20 @@ describe('Overlay', () => {
let overlayContainerElement: HTMLElement;
let overlayContainer: OverlayContainer;
let viewContainerFixture: ComponentFixture<TestComponentWithTemplatePortals>;
let dir: Direction;

beforeEach(async(() => {
dir = 'ltr';
TestBed.configureTestingModule({
imports: [OverlayModule, PortalModule, OverlayTestModule]
imports: [OverlayModule, PortalModule, OverlayTestModule],
providers: [{
provide: Directionality,
useFactory: () => {
const fakeDirectionality = {};
Object.defineProperty(fakeDirectionality, 'value', {get: () => dir});
return fakeDirectionality;
}
}],
}).compileComponents();
}));

Expand Down Expand Up @@ -132,13 +143,21 @@ describe('Overlay', () => {
.toBeFalsy('Expected cake to still be on top.');
}));

it('should take the default direction from the global Directionality', () => {
dir = 'rtl';
overlay.create().attach(componentPortal);

const pane = overlayContainerElement.children[0] as HTMLElement;
expect(pane.getAttribute('dir')).toBe('rtl');
});

it('should set the direction', () => {
const config = new OverlayConfig({direction: 'rtl'});

overlay.create(config).attach(componentPortal);

const pane = overlayContainerElement.children[0] as HTMLElement;
expect(pane.getAttribute('dir')).toEqual('rtl');
expect(pane.getAttribute('dir')).toBe('rtl');
});

it('should emit when an overlay is attached', () => {
Expand Down
9 changes: 7 additions & 2 deletions src/cdk/overlay/overlay.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import {OverlayKeyboardDispatcher} from './keyboard/overlay-keyboard-dispatcher'
import {OverlayContainer} from './overlay-container';
import {ScrollStrategyOptions} from './scroll/index';
import {DOCUMENT} from '@angular/common';
import {Directionality} from '@angular/cdk/bidi';


/** Next overlay unique ID. */
Expand All @@ -47,7 +48,8 @@ export class Overlay {
private _appRef: ApplicationRef,
private _injector: Injector,
private _ngZone: NgZone,
@Inject(DOCUMENT) private _document: any) { }
@Inject(DOCUMENT) private _document: any,
private _directionality: Directionality) { }

/**
* Creates an overlay.
Expand All @@ -57,11 +59,14 @@ export class Overlay {
create(config?: OverlayConfig): OverlayRef {
const pane = this._createPaneElement();
const portalOutlet = this._createPortalOutlet(pane);
const overlayConfig = new OverlayConfig(config);

overlayConfig.direction = overlayConfig.direction || this._directionality.value;

return new OverlayRef(
portalOutlet,
pane,
new OverlayConfig(config),
overlayConfig,
this._ngZone,
this._keyboardDispatcher,
this._document
Expand Down
2 changes: 1 addition & 1 deletion src/lib/bottom-sheet/bottom-sheet-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export class MatBottomSheetConfig<D = any> {
panelClass?: string | string[];

/** Text layout direction for the bottom sheet. */
direction?: Direction = 'ltr';
direction?: Direction;

/** Data being injected into the child component. */
data?: D | null = null;
Expand Down
2 changes: 1 addition & 1 deletion src/lib/dialog/dialog-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export class MatDialogConfig<D = any> {
data?: D | null = null;

/** Layout direction for the dialog's content. */
direction?: Direction = 'ltr';
direction?: Direction;

/** ID of the element that describes the dialog. */
ariaDescribedBy?: string | null = null;
Expand Down
2 changes: 1 addition & 1 deletion src/lib/snack-bar/snack-bar-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export class MatSnackBarConfig<D = any> {
extraClasses?: string | string[];

/** Text layout direction for the snack bar. */
direction?: Direction = 'ltr';
direction?: Direction;

/** Data being injected into the child component. */
data?: D | null = null;
Expand Down