Skip to content
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

Fixed #15546 - Galleria | Keyboard Trap within Galleria component #15547

Merged
merged 1 commit into from
May 14, 2024
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
23 changes: 21 additions & 2 deletions src/app/components/focustrap/focustrap.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { DomHandler } from 'primeng/dom';
import { CommonModule, DOCUMENT, isPlatformBrowser } from '@angular/common';
import { Directive, ElementRef, Input, NgModule, inject, booleanAttribute, PLATFORM_ID } from '@angular/core';
import { Directive, ElementRef, Input, NgModule, inject, booleanAttribute, PLATFORM_ID, SimpleChanges } from '@angular/core';

/**
* Focus Trap keeps focus within a certain DOM element while tabbing.
Expand Down Expand Up @@ -31,10 +31,29 @@ export class FocusTrap {

ngOnInit() {
if (isPlatformBrowser(this.platformId) && !this.pFocusTrapDisabled) {
this.createHiddenFocusableElements();
!this.firstHiddenFocusableElement && !this.lastHiddenFocusableElement && this.createHiddenFocusableElements();
}
}

ngOnChanges(changes: SimpleChanges) {
if (changes.pFocusTrapDisabled && isPlatformBrowser(this.platformId)) {
if (changes.pFocusTrapDisabled.currentValue) {
this.removeHiddenFocusableElements();
} else {
this.createHiddenFocusableElements();
}
}
}

removeHiddenFocusableElements() {
if (this.firstHiddenFocusableElement && this.firstHiddenFocusableElement.parentNode) {
this.firstHiddenFocusableElement.parentNode.removeChild(this.firstHiddenFocusableElement);
}

if (this.lastHiddenFocusableElement && this.lastHiddenFocusableElement.parentNode) {
this.lastHiddenFocusableElement.parentNode.removeChild(this.lastHiddenFocusableElement);
}
}
getComputedSelector(selector) {
return `:not(.p-hidden-focusable):not([data-p-hidden-focusable="true"])${selector ?? ''}`;
}
Expand Down
5 changes: 5 additions & 0 deletions src/app/components/galleria/galleria.css
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@
opacity: 1;
}

.p-galleria-item-nav-onhover .p-galleria-item-nav-focused {
pointer-events: all;
opacity: 1;
}

.p-galleria-item-nav-onhover .p-galleria-item-wrapper:hover .p-galleria-item-nav.p-disabled {
pointer-events: none;
}
Expand Down
41 changes: 38 additions & 3 deletions src/app/components/galleria/galleria.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
DoCheck,
ElementRef,
EventEmitter,
HostListener,
Inject,
Input,
KeyValueDiffers,
Expand Down Expand Up @@ -67,6 +68,7 @@ import { FocusTrapModule } from 'primeng/focustrap';
(maskHide)="onMaskHide()"
(activeItemChange)="onActiveItemChange($event)"
[ngStyle]="containerStyle"
[fullScreen]="fullScreen"
></p-galleriaContent>
</div>
</div>
Expand Down Expand Up @@ -417,6 +419,7 @@ export class Galleria implements OnChanges, OnDestroy {
[ngStyle]="!galleria.fullScreen ? galleria.containerStyle : {}"
[class]="galleriaClass()"
pFocusTrap
[pFocusTrapDisabled]="!fullScreen"
>
<button *ngIf="galleria.fullScreen" type="button" class="p-galleria-close p-link" (click)="maskHide.emit()" pRipple [attr.aria-label]="closeAriaLabel()" [attr.data-pc-section]="'closebutton'">
<TimesIcon *ngIf="!galleria.closeIconTemplate" [styleClass]="'p-galleria-close-icon'" />
Expand Down Expand Up @@ -480,6 +483,8 @@ export class GalleriaContent implements DoCheck {

@Input({ transform: numberAttribute }) numVisible: number | undefined;

@Input({ transform: booleanAttribute }) fullScreen: boolean;

@Output() maskHide: EventEmitter<boolean> = new EventEmitter();

@Output() activeItemChange: EventEmitter<number> = new EventEmitter();
Expand All @@ -498,11 +503,21 @@ export class GalleriaContent implements DoCheck {

private differ: any;

constructor(public galleria: Galleria, public cd: ChangeDetectorRef, private differs: KeyValueDiffers, public config: PrimeNGConfig) {
constructor(public galleria: Galleria, public cd: ChangeDetectorRef, private differs: KeyValueDiffers, public config: PrimeNGConfig, private elementRef: ElementRef) {
this.id = this.galleria.id || UniqueComponentId();
this.differ = this.differs.find(this.galleria).create();
}

// For custom fullscreen
@HostListener('document:fullscreenchange', ['$event'])
handleFullscreenChange(event: Event) {
if (document?.fullscreenElement === this.elementRef.nativeElement?.children[0]) {
this.fullScreen = true;
} else {
this.fullScreen = false;
}
}

ngDoCheck(): void {
if (isPlatformBrowser(this.galleria.platformId)) {
const changes = this.differ.diff(this.galleria as unknown as Record<string, unknown>);
Expand Down Expand Up @@ -649,10 +664,12 @@ export class GalleriaItemSlot {
*ngIf="showItemNavigators"
type="button"
role="navigation"
[ngClass]="{ 'p-galleria-item-prev p-galleria-item-nav p-link': true, 'p-disabled': this.isNavBackwardDisabled() }"
[ngClass]="{ 'p-galleria-item-prev p-galleria-item-nav p-link': true, 'p-galleria-item-nav-focused': leftButtonFocused, 'p-disabled': this.isNavBackwardDisabled() }"
(click)="navBackward($event)"
[disabled]="isNavBackwardDisabled()"
pRipple
(focus)="onButtonFocus('left')"
(blur)="onButtonBlur('left')"
>
<ChevronLeftIcon *ngIf="!galleria.itemPreviousIconTemplate" [styleClass]="'p-galleria-item-prev-icon'" />
<ng-template *ngTemplateOutlet="galleria.itemPreviousIconTemplate"></ng-template>
Expand All @@ -663,11 +680,13 @@ export class GalleriaItemSlot {
<button
*ngIf="showItemNavigators"
type="button"
[ngClass]="{ 'p-galleria-item-next p-galleria-item-nav p-link': true, 'p-disabled': this.isNavForwardDisabled() }"
[ngClass]="{ 'p-galleria-item-next p-galleria-item-nav p-link': true, 'p-galleria-item-nav-focused': rightButtonFocused, 'p-disabled': this.isNavForwardDisabled() }"
(click)="navForward($event)"
[disabled]="isNavForwardDisabled()"
pRipple
role="navigation"
(focus)="onButtonFocus('right')"
(blur)="onButtonBlur('right')"
>
<ChevronRightIcon *ngIf="!galleria.itemNextIconTemplate" [styleClass]="'p-galleria-item-next-icon'" />
<ng-template *ngTemplateOutlet="galleria.itemNextIconTemplate"></ng-template>
Expand Down Expand Up @@ -739,6 +758,10 @@ export class GalleriaItem implements OnChanges {

_activeIndex: number = 0;

leftButtonFocused: boolean = false;

rightButtonFocused: boolean = false;

constructor(public galleria: Galleria) {}

ngOnChanges({ autoPlay }: SimpleChanges): void {
Expand All @@ -763,6 +786,18 @@ export class GalleriaItem implements OnChanges {
this.onActiveIndexChange.emit(activeIndex);
}

onButtonFocus(pos: 'left' | 'right') {
if (pos === 'left') {
this.leftButtonFocused = true;
} else this.rightButtonFocused = true;
}

onButtonBlur(pos: 'left' | 'right') {
if (pos === 'left') {
this.leftButtonFocused = false;
} else this.rightButtonFocused = false;
}

stopTheSlideShow() {
if (this.slideShowActive && this.stopSlideShow) {
this.stopSlideShow.emit();
Expand Down
Loading