Skip to content

feat(material/autocomplete): add panelClass default option #20429

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 3 commits into from
Sep 1, 2020
Merged

feat(material/autocomplete): add panelClass default option #20429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5730bb2
feat(material/autocomplete): add panelClass default option
andrewseguin Aug 27, 2020
d5b8f10
update goldens
andrewseguin Aug 27, 2020
4535efb
add tests to MDC
andrewseguin Aug 27, 2020
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
33 changes: 33 additions & 0 deletions src/material-experimental/mdc-autocomplete/autocomplete.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2124,6 +2124,39 @@ describe('MDC-based MatAutocomplete', () => {
}));
});

describe('with panel classes in the default options', () => {
it('should apply them if provided as string', fakeAsync(() => {
const fixture = createComponent(SimpleAutocomplete, [
{provide: MAT_AUTOCOMPLETE_DEFAULT_OPTIONS,
useValue: {overlayPanelClass: 'default1'}}
]);

fixture.detectChanges();
fixture.componentInstance.trigger.openPanel();
fixture.detectChanges();

const panelClassList =
overlayContainerElement.querySelector('.cdk-overlay-pane')!.classList;
expect(panelClassList).toContain('default1');
}));

it('should apply them if provided as array', fakeAsync(() => {
const fixture = createComponent(SimpleAutocomplete, [
{provide: MAT_AUTOCOMPLETE_DEFAULT_OPTIONS,
useValue: {overlayPanelClass: ['default1', 'default2']}}
]);

fixture.detectChanges();
fixture.componentInstance.trigger.openPanel();
fixture.detectChanges();

const panelClassList =
overlayContainerElement.querySelector('.cdk-overlay-pane')!.classList;
expect(panelClassList).toContain('default1');
expect(panelClassList).toContain('default2');
}));
});

describe('misc', () => {

it('should allow basic use without any forms directives', () => {
Expand Down
13 changes: 10 additions & 3 deletions src/material/autocomplete/autocomplete-trigger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,11 @@ import {MAT_FORM_FIELD, MatFormField} from '@angular/material/form-field';
import {defer, fromEvent, merge, Observable, of as observableOf, Subject, Subscription} from 'rxjs';
import {delay, filter, map, switchMap, take, tap} from 'rxjs/operators';

import {_MatAutocompleteBase} from './autocomplete';
import {
_MatAutocompleteBase,
MAT_AUTOCOMPLETE_DEFAULT_OPTIONS,
MatAutocompleteDefaultOptions
} from './autocomplete';
import {_MatAutocompleteOriginBase} from './autocomplete-origin';


Expand Down Expand Up @@ -208,7 +212,9 @@ export abstract class _MatAutocompleteTriggerBase implements ControlValueAccesso
@Optional() private _dir: Directionality,
@Optional() @Inject(MAT_FORM_FIELD) @Host() private _formField: MatFormField,
@Optional() @Inject(DOCUMENT) private _document: any,
private _viewportRuler: ViewportRuler) {
private _viewportRuler: ViewportRuler,
@Optional() @Inject(MAT_AUTOCOMPLETE_DEFAULT_OPTIONS)
private _defaults?: MatAutocompleteDefaultOptions) {
this._scrollStrategy = scrollStrategy;
}

Expand Down Expand Up @@ -638,7 +644,8 @@ export abstract class _MatAutocompleteTriggerBase implements ControlValueAccesso
positionStrategy: this._getOverlayPosition(),
scrollStrategy: this._scrollStrategy(),
width: this._getPanelWidth(),
direction: this._dir
direction: this._dir,
panelClass: this._defaults?.overlayPanelClass,
});
}

Expand Down
33 changes: 33 additions & 0 deletions src/material/autocomplete/autocomplete.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2119,6 +2119,39 @@ describe('MatAutocomplete', () => {
}));
});

describe('with panel classes in the default options', () => {
Copy link
Member

Choose a reason for hiding this comment

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

Can you copy these tests into the MDC autocomplete too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh yeah for sure, good call

it('should apply them if provided as string', fakeAsync(() => {
const fixture = createComponent(SimpleAutocomplete, [
{provide: MAT_AUTOCOMPLETE_DEFAULT_OPTIONS,
useValue: {overlayPanelClass: 'default1'}}
]);

fixture.detectChanges();
fixture.componentInstance.trigger.openPanel();
fixture.detectChanges();

const panelClassList =
overlayContainerElement.querySelector('.cdk-overlay-pane')!.classList;
expect(panelClassList).toContain('default1');
}));

it('should apply them if provided as array', fakeAsync(() => {
const fixture = createComponent(SimpleAutocomplete, [
{provide: MAT_AUTOCOMPLETE_DEFAULT_OPTIONS,
useValue: {overlayPanelClass: ['default1', 'default2']}}
]);

fixture.detectChanges();
fixture.componentInstance.trigger.openPanel();
fixture.detectChanges();

const panelClassList =
overlayContainerElement.querySelector('.cdk-overlay-pane')!.classList;
expect(panelClassList).toContain('default1');
expect(panelClassList).toContain('default2');
}));
});

describe('misc', () => {

it('should allow basic use without any forms directives', () => {
Expand Down
3 changes: 3 additions & 0 deletions src/material/autocomplete/autocomplete.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ const _MatAutocompleteMixinBase: CanDisableRippleCtor & typeof MatAutocompleteBa
export interface MatAutocompleteDefaultOptions {
/** Whether the first option should be highlighted when an autocomplete panel is opened. */
autoActiveFirstOption?: boolean;

/** Class or list of classes to be applied to the autocomplete's overlay panel. */
overlayPanelClass?: string | string[];
}

/** Injection token to be used to override the default options for `mat-autocomplete`. */
Expand Down
5 changes: 3 additions & 2 deletions tools/public_api_guard/material/autocomplete.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export declare abstract class _MatAutocompleteTriggerBase implements ControlValu
get panelClosingActions(): Observable<MatOptionSelectionChange | null>;
get panelOpen(): boolean;
position: 'auto' | 'above' | 'below';
constructor(_element: ElementRef<HTMLInputElement>, _overlay: Overlay, _viewContainerRef: ViewContainerRef, _zone: NgZone, _changeDetectorRef: ChangeDetectorRef, scrollStrategy: any, _dir: Directionality, _formField: MatFormField, _document: any, _viewportRuler: ViewportRuler);
constructor(_element: ElementRef<HTMLInputElement>, _overlay: Overlay, _viewContainerRef: ViewContainerRef, _zone: NgZone, _changeDetectorRef: ChangeDetectorRef, scrollStrategy: any, _dir: Directionality, _formField: MatFormField, _document: any, _viewportRuler: ViewportRuler, _defaults?: MatAutocompleteDefaultOptions | undefined);
_handleFocus(): void;
_handleInput(event: KeyboardEvent): void;
_handleKeydown(event: KeyboardEvent): void;
Expand All @@ -73,7 +73,7 @@ export declare abstract class _MatAutocompleteTriggerBase implements ControlValu
writeValue(value: any): void;
static ngAcceptInputType_autocompleteDisabled: BooleanInput;
static ɵdir: i0.ɵɵDirectiveDefWithMeta<_MatAutocompleteTriggerBase, never, never, { "autocomplete": "matAutocomplete"; "position": "matAutocompletePosition"; "connectedTo": "matAutocompleteConnectedTo"; "autocompleteAttribute": "autocomplete"; "autocompleteDisabled": "matAutocompleteDisabled"; }, {}, never>;
static ɵfac: i0.ɵɵFactoryDef<_MatAutocompleteTriggerBase, [null, null, null, null, null, null, { optional: true; }, { optional: true; host: true; }, { optional: true; }, null]>;
static ɵfac: i0.ɵɵFactoryDef<_MatAutocompleteTriggerBase, [null, null, null, null, null, null, { optional: true; }, { optional: true; host: true; }, { optional: true; }, null, { optional: true; }]>;
}

export declare const AUTOCOMPLETE_OPTION_HEIGHT = 48;
Expand Down Expand Up @@ -114,6 +114,7 @@ export interface MatAutocompleteActivatedEvent {

export interface MatAutocompleteDefaultOptions {
autoActiveFirstOption?: boolean;
overlayPanelClass?: string | string[];
}

export declare class MatAutocompleteModule {
Expand Down