-
Notifications
You must be signed in to change notification settings - Fork 467
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(edit-ema): Add Language Selector #26821
* dev (dot-ema): add language selector to toolbar * dev (edit ema language selector): small styles tweaks * Update edit-ema-toolbar.component.scss * test (dot ema toolbar): add missing test cases * dev (dot ema language selector): add iso to language * dev (overlay panel): fix shadow * fix format for languages that doesn't have country code * dev (dot ema): refactor to change the approach of changing languages * fix broken test * dev (dot-ema): solve feedback * dev (dot-ema): add const * Update edit-ema-language-selector.component.ts * dev (dot-ema): solve feedback * dev (dot-ema): solve feedback
- Loading branch information
Showing
17 changed files
with
506 additions
and
198 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
14 changes: 14 additions & 0 deletions
14
...a/src/lib/components/edit-ema-language-selector/edit-ema-language-selector.component.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <p-button | ||
| [label]="selectedLanguage?.label" | ||
| (click)="op.toggle($event)" | ||
| styleClass="p-button-text" | ||
| icon="pi pi-globe" | ||
| data-testId="language-button"></p-button> | ||
| <p-overlayPanel #op styleClass="edit-ema-language-selector" data-testId="language-op"> | ||
| <p-listbox | ||
| [filter]="true" | ||
| [options]="languages$ | async" | ||
| (onChange)="onChange($event)" | ||
| optionLabel="label" | ||
| data-testId="language-listbox"></p-listbox> | ||
| </p-overlayPanel> |
22 changes: 22 additions & 0 deletions
22
...a/src/lib/components/edit-ema-language-selector/edit-ema-language-selector.component.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| @use "variables" as *; | ||
| :host { | ||
| display: flex; | ||
| } | ||
|
|
||
| ::ng-deep { | ||
| .p-overlaypanel.edit-ema-language-selector.p-component { | ||
| .p-overlaypanel-content { | ||
| padding: 0; | ||
|
|
||
| .p-listbox.p-component { | ||
| border: none; | ||
| border-radius: $border-radius-sm; | ||
|
|
||
| .p-listbox-header { | ||
| border-top-left-radius: $border-radius-sm; | ||
| border-top-right-radius: $border-radius-sm; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
81 changes: 81 additions & 0 deletions
81
...rc/lib/components/edit-ema-language-selector/edit-ema-language-selector.component.spec.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| import { Spectator, byTestId, createComponentFactory } from '@ngneat/spectator'; | ||
|
|
||
| import { HttpClientTestingModule } from '@angular/common/http/testing'; | ||
| import { By } from '@angular/platform-browser'; | ||
|
|
||
| import { DotLanguagesService } from '@dotcms/data-access'; | ||
| import { DotLanguagesServiceMock } from '@dotcms/utils-testing'; | ||
|
|
||
| import { EmaLanguageSelectorComponent } from './edit-ema-language-selector.component'; | ||
|
|
||
| describe('DotEmaLanguageSelectorComponent', () => { | ||
| let spectator: Spectator<EmaLanguageSelectorComponent>; | ||
| let component: EmaLanguageSelectorComponent; | ||
|
|
||
| const createComponent = createComponentFactory({ | ||
| component: EmaLanguageSelectorComponent, | ||
| imports: [HttpClientTestingModule], | ||
| providers: [{ provide: DotLanguagesService, useValue: new DotLanguagesServiceMock() }] | ||
| }); | ||
|
|
||
| beforeEach(() => { | ||
| spectator = createComponent({ | ||
| props: { | ||
| language: { | ||
| id: 1, | ||
| language: 'English', | ||
| countryCode: 'US', | ||
| languageCode: 'EN', | ||
| country: 'United States' | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| component = spectator.component; | ||
| }); | ||
|
|
||
| describe('DOM', () => { | ||
| it('should render a button with the language that comes from the page', () => { | ||
| spectator.detectChanges(); | ||
| expect(spectator.query(byTestId('language-button')).textContent).toBe('English - US'); | ||
| }); | ||
|
|
||
| it('should render a overlay panel', () => { | ||
| expect(spectator.query(byTestId('language-op'))).not.toBeNull(); | ||
| }); | ||
|
|
||
| it('should render a listbox of languages', () => { | ||
| const button = spectator.query(byTestId('language-button')); | ||
|
|
||
| spectator.click(button); | ||
|
|
||
| const list = spectator.query(byTestId('language-listbox')); | ||
|
|
||
| expect(list).not.toBeNull(); | ||
| }); | ||
| }); | ||
|
|
||
| describe('events', () => { | ||
| it('should trigger the languageChange emitter when the language changes', () => { | ||
| const button = spectator.query(byTestId('language-button')); | ||
| const languageChangeSpy = jest.spyOn(component.selected, 'emit'); | ||
|
|
||
| spectator.click(button); | ||
|
|
||
| const list = spectator.debugElement.query(By.css('[data-testId="language-listbox"]')); | ||
|
|
||
| spectator.triggerEventHandler(list, 'onChange', { | ||
| event: new Event('change'), | ||
| value: { | ||
| id: 2, | ||
| languageCode: 'IT', | ||
| countryCode: '', // It comes like this from the mock and is intended | ||
| language: 'Italian', | ||
| country: 'Italy' | ||
| } | ||
| }); | ||
|
|
||
| expect(languageChangeSpy).toHaveBeenCalledWith(2); | ||
| }); | ||
| }); | ||
| }); |
69 changes: 69 additions & 0 deletions
69
...ema/src/lib/components/edit-ema-language-selector/edit-ema-language-selector.component.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| import { CommonModule } from '@angular/common'; | ||
| import { Component, EventEmitter, Input, Output, inject } from '@angular/core'; | ||
|
|
||
| import { ButtonModule } from 'primeng/button'; | ||
| import { ListboxModule } from 'primeng/listbox'; | ||
| import { OverlayPanelModule } from 'primeng/overlaypanel'; | ||
|
|
||
| import { map } from 'rxjs/operators'; | ||
|
|
||
| import { DotLanguagesService } from '@dotcms/data-access'; | ||
| import { DotLanguage } from '@dotcms/dotcms-models'; | ||
|
|
||
| interface DotLanguageWithLabel extends DotLanguage { | ||
| label: string; | ||
| } | ||
|
|
||
| @Component({ | ||
| selector: 'dot-edit-ema-language-selector', | ||
| standalone: true, | ||
| imports: [CommonModule, OverlayPanelModule, ListboxModule, ButtonModule], | ||
| templateUrl: './edit-ema-language-selector.component.html', | ||
| styleUrls: ['./edit-ema-language-selector.component.scss'] | ||
| }) | ||
| export class EmaLanguageSelectorComponent { | ||
| @Output() selected: EventEmitter<number> = new EventEmitter(); | ||
| @Input() language: DotLanguage; | ||
|
|
||
| get selectedLanguage() { | ||
| return { | ||
| ...this.language, | ||
| label: this.createLanguageLabel(this.language) | ||
| }; | ||
| } | ||
|
|
||
| languages$ = inject(DotLanguagesService) | ||
| .get() | ||
| .pipe( | ||
| map((languages) => | ||
| languages.map((lang) => ({ | ||
| ...lang, | ||
| label: this.createLanguageLabel(lang) | ||
| })) | ||
| ) | ||
| ); | ||
|
|
||
| /** | ||
| * Handle the change of the language | ||
| * | ||
| * @param {{ event: Event; value:DotLanguageWithLabel }} { value } | ||
| * @memberof EmaLanguageSelectorComponent | ||
| */ | ||
| onChange({ value }: { event: Event; value: DotLanguageWithLabel }) { | ||
| this.selected.emit(value.id); | ||
| } | ||
|
|
||
| /** | ||
| * Create the label for the language | ||
| * | ||
| * @private | ||
| * @param {DotLanguage} lang | ||
| * @return {*} {string} | ||
| * @memberof EmaLanguageSelectorComponent | ||
| */ | ||
| private createLanguageLabel(lang: DotLanguage): string { | ||
| return lang.countryCode.trim().length | ||
| ? `${lang.language} - ${lang.countryCode}` | ||
| : lang.language; | ||
| } | ||
| } |
18 changes: 9 additions & 9 deletions
18
...libs/portlets/dot-ema/src/lib/components/edit-ema-toolbar/edit-ema-toolbar.component.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| <p-menu #menu [model]="items" [popup]="true"></p-menu> | ||
| <button | ||
| class="p-button-sm p-button-text" | ||
| [attr.aria-label]="label" | ||
| [label]="label" | ||
| (click)="menu.toggle($event)" | ||
| pButton | ||
| type="button" | ||
| icon="pi pi-globe"></button> | ||
| <ng-content select="[title]"></ng-content> | ||
| <p-toolbar> | ||
| <div class="p-toolbar-group-left" data-testId="toolbar-left-content"> | ||
| <ng-content select="[left]"></ng-content> | ||
| </div> | ||
| <div class="p-toolbar-group-right" data-testId="toolbar-right-content"> | ||
| <ng-content select="[right]"></ng-content> | ||
| </div> | ||
| </p-toolbar> |
15 changes: 14 additions & 1 deletion
15
...libs/portlets/dot-ema/src/lib/components/edit-ema-toolbar/edit-ema-toolbar.component.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,16 @@ | ||
| @use "variables" as *; | ||
|
|
||
| :host { | ||
| display: block; | ||
| border: solid 1px $color-palette-gray-100; | ||
| display: flex; | ||
| flex-direction: column; | ||
| justify-content: center; | ||
| height: fit-content; | ||
| } | ||
|
|
||
| .p-toolbar-group-left, | ||
| .p-toolbar-group-right { | ||
| display: flex; | ||
| align-items: center; | ||
| gap: $spacing-2; | ||
| } |
50 changes: 38 additions & 12 deletions
50
...s/portlets/dot-ema/src/lib/components/edit-ema-toolbar/edit-ema-toolbar.component.spec.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,48 @@ | ||
| import { ComponentFixture, TestBed } from '@angular/core/testing'; | ||
| import { Spectator, createComponentFactory, byTestId } from '@ngneat/spectator'; | ||
|
|
||
| import { Component } from '@angular/core'; | ||
|
|
||
| import { EditEmaToolbarComponent } from './edit-ema-toolbar.component'; | ||
|
|
||
| @Component({ | ||
| template: `<dot-edit-ema-toolbar> | ||
| <ng-container title><div data-testId="title-content"></div></ng-container> | ||
| <ng-container left><div data-testId="left-content"></div></ng-container> | ||
| <ng-container right><div data-testId="right-content"></div></ng-container> | ||
| </dot-edit-ema-toolbar>` | ||
| }) | ||
| class TestHostComponent {} | ||
|
|
||
| describe('EditEmaToolbarComponent', () => { | ||
| let component: EditEmaToolbarComponent; | ||
| let fixture: ComponentFixture<EditEmaToolbarComponent>; | ||
| let spectator: Spectator<TestHostComponent>; | ||
|
|
||
| beforeEach(async () => { | ||
| await TestBed.configureTestingModule({ | ||
| imports: [EditEmaToolbarComponent] | ||
| }).compileComponents(); | ||
| const createComponent = createComponentFactory({ | ||
| component: TestHostComponent, | ||
| imports: [EditEmaToolbarComponent], | ||
| providers: [] | ||
| }); | ||
|
|
||
| fixture = TestBed.createComponent(EditEmaToolbarComponent); | ||
| component = fixture.componentInstance; | ||
| fixture.detectChanges(); | ||
| beforeEach(() => { | ||
| spectator = createComponent(); | ||
| }); | ||
|
|
||
| it('should create', () => { | ||
| expect(component).toBeTruthy(); | ||
| describe('DOM', () => { | ||
| it('should have left-content on left', () => { | ||
| const leftContent = spectator.query(byTestId('toolbar-left-content')); | ||
|
|
||
| expect(leftContent.querySelector('[data-testId="left-content"]')).not.toBeNull(); | ||
| }); | ||
|
|
||
| it('should have right-content on right', () => { | ||
| const rightContent = spectator.query(byTestId('toolbar-right-content')); | ||
|
|
||
| expect(rightContent.querySelector('[data-testId="right-content"]')).not.toBeNull(); | ||
| }); | ||
|
|
||
| it('should have title-content on title', () => { | ||
| const titleContent = spectator.query(byTestId('title-content')); | ||
|
|
||
| expect(titleContent).not.toBeNull(); | ||
| }); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 17 additions & 15 deletions
32
core-web/libs/portlets/dot-ema/src/lib/feature/dot-ema.component.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.