feat(carousel): implement circular layout and enhance navigation logic

This commit is contained in:
2026-07-23 12:09:21 -03:00
parent fb6ab2fca2
commit a1d5ecb6fa
4 changed files with 211 additions and 60 deletions

View File

@@ -3,17 +3,48 @@
<div <div
#viewport #viewport
class="carousel__viewport" class="carousel__viewport"
[class.carousel__viewport--circular]="isCircularLayout()"
tabindex="0" tabindex="0"
[style.gap.px]="resolvedGap()"
(scroll)="handleScroll()" (scroll)="handleScroll()"
(keydown)="handleKeydown($event)" (keydown)="handleKeydown($event)"
> >
@for (item of items(); track trackBy()($index, item); let index = $index) { @if (isCircularLayout()) {
<div class="carousel__item"> <div
<ng-container class="carousel__track"
[ngTemplateOutlet]="itemTemplate()" [class.carousel__track--previous]="transitionDirection() === -1"
[ngTemplateOutletContext]="{ $implicit: item, index }" [class.carousel__track--next]="transitionDirection() === 1"
/> [class.carousel__track--moving]="transitionDirection() !== 0"
(transitionend)="finishCircularTransition($event)"
(transitioncancel)="finishCircularTransition($event)"
>
@for (page of circularPages(); track page.slot) {
<div
class="carousel__page"
[style.gap.px]="resolvedGap()"
[attr.aria-hidden]="page.slot === 'current' ? null : 'true'"
[attr.inert]="page.slot === 'current' ? null : ''"
>
@for (entry of page.items; track trackBy()(entry.index, entry.item)) {
<div class="carousel__item">
<ng-container
[ngTemplateOutlet]="itemTemplate()"
[ngTemplateOutletContext]="{ $implicit: entry.item, index: entry.index }"
/>
</div>
}
</div>
}
</div>
} @else {
<div class="carousel__linear-track" [style.gap.px]="resolvedGap()">
@for (item of items(); track trackBy()($index, item); let index = $index) {
<div class="carousel__item">
<ng-container
[ngTemplateOutlet]="itemTemplate()"
[ngTemplateOutletContext]="{ $implicit: item, index }"
/>
</div>
}
</div> </div>
} }
</div> </div>

View File

@@ -13,7 +13,6 @@
} }
&__viewport { &__viewport {
display: flex;
width: 100%; width: 100%;
overflow-x: auto; overflow-x: auto;
overscroll-behavior-inline: contain; overscroll-behavior-inline: contain;
@@ -29,6 +28,39 @@
outline: 2px solid var(--color-primary, currentColor); outline: 2px solid var(--color-primary, currentColor);
outline-offset: 2px; outline-offset: 2px;
} }
&--circular {
overflow: hidden;
scroll-snap-type: none;
}
}
&__linear-track,
&__page {
display: flex;
}
&__track {
display: flex;
width: 300%;
transform: translateX(calc(-100% / 3));
&--moving {
transition: transform 300ms ease;
}
&--previous {
transform: translateX(0);
}
&--next {
transform: translateX(calc(-200% / 3));
}
}
&__page {
flex: 0 0 calc(100% / 3);
min-width: 0;
} }
&__item { &__item {
@@ -77,4 +109,8 @@
.carousel__viewport { .carousel__viewport {
scroll-behavior: auto; scroll-behavior: auto;
} }
.carousel__track--moving {
transition-duration: 1ms;
}
} }

View File

@@ -1,4 +1,4 @@
import { Component, TemplateRef, viewChild } from '@angular/core'; import { Component, signal, TemplateRef, viewChild } from '@angular/core';
import { ComponentFixture, TestBed } from '@angular/core/testing'; import { ComponentFixture, TestBed } from '@angular/core/testing';
import { beforeEach, describe, expect, it, vi } from 'vitest'; import { beforeEach, describe, expect, it, vi } from 'vitest';
import { CarouselComponent, CarouselItemContext } from './carousel.component'; import { CarouselComponent, CarouselItemContext } from './carousel.component';
@@ -20,13 +20,13 @@ interface TestItem {
[itemTemplate]="itemTemplate" [itemTemplate]="itemTemplate"
[scrollStep]="120" [scrollStep]="120"
[gap]="16" [gap]="16"
[circular]="circular" [circular]="circular()"
ariaLabel="Productos destacados" ariaLabel="Productos destacados"
/> />
`, `,
}) })
class TestHostComponent { class TestHostComponent {
circular = false; readonly circular = signal(false);
readonly items: TestItem[] = [ readonly items: TestItem[] = [
{ id: 1, label: 'Primero' }, { id: 1, label: 'Primero' },
@@ -121,46 +121,44 @@ describe('CarouselComponent', () => {
}); });
it('vuelve al extremo opuesto cuando circular está habilitado', () => { it('vuelve al extremo opuesto cuando circular está habilitado', () => {
fixture.componentInstance.circular = true; fixture.componentInstance.circular.set(true);
fixture.detectChanges(); fixture.detectChanges();
expect(fixture.componentInstance.carousel().circular()).toBe(true);
const viewport = fixture.nativeElement.querySelector('.carousel__viewport') as HTMLElement; const host = fixture.nativeElement.querySelector('app-carousel') as HTMLElement;
const scrollTo = vi.fn(); const firstItem = fixture.nativeElement.querySelector('.carousel__item') as HTMLElement;
Object.defineProperties(viewport, { Object.defineProperty(host, 'clientWidth', {
clientWidth: { configurable: true,
configurable: true, value: 250,
value: 300,
},
scrollWidth: {
configurable: true,
value: 900,
},
scrollLeft: {
configurable: true,
writable: true,
value: 600,
},
}); });
viewport.scrollTo = scrollTo; firstItem.getBoundingClientRect = vi.fn(
() =>
({
width: 100,
}) as DOMRect,
);
viewport.dispatchEvent(new Event('scroll')); fixture.componentInstance.carousel().ngAfterViewInit();
fixture.detectChanges(); fixture.detectChanges();
const pages = fixture.nativeElement.querySelectorAll('.carousel__page');
expect(pages).toHaveLength(3);
expect(pages[0].textContent).toContain('Tercero');
expect(pages[1].textContent).toContain('Primero');
expect(pages[2].textContent).toContain('Tercero');
fixture.componentInstance.carousel().next(); fixture.componentInstance.carousel().next();
expect(scrollTo).toHaveBeenNthCalledWith(1, {
left: 0,
behavior: 'smooth',
});
viewport.scrollLeft = 0;
viewport.dispatchEvent(new Event('scroll'));
fixture.detectChanges(); fixture.detectChanges();
fixture.componentInstance.carousel().previous();
expect(scrollTo).toHaveBeenNthCalledWith(2, { const track = fixture.nativeElement.querySelector('.carousel__track') as HTMLElement;
left: 600, expect(track.classList).toContain('carousel__track--next');
behavior: 'smooth',
}); track.dispatchEvent(new TransitionEvent('transitionend', { propertyName: 'transform' }));
fixture.detectChanges();
const recenteredPages = fixture.nativeElement.querySelectorAll('.carousel__page');
expect(track.classList).not.toContain('carousel__track--next');
expect(recenteredPages[1].textContent).toContain('Tercero');
}); });
}); });

View File

@@ -21,6 +21,16 @@ export interface CarouselItemContext<T> {
export type CarouselTrackBy<T> = (index: number, item: T) => unknown; export type CarouselTrackBy<T> = (index: number, item: T) => unknown;
interface CarouselPageItem<T> {
item: T;
index: number;
}
interface CarouselPage<T> {
slot: 'previous' | 'current' | 'next';
items: CarouselPageItem<T>[];
}
@Component({ @Component({
selector: 'app-carousel', selector: 'app-carousel',
imports: [NgTemplateOutlet], imports: [NgTemplateOutlet],
@@ -48,8 +58,25 @@ export class CarouselComponent<T> implements AfterViewInit {
protected readonly canScrollNext = signal(false); protected readonly canScrollNext = signal(false);
protected readonly hasOverflow = signal(false); protected readonly hasOverflow = signal(false);
protected readonly viewportWidth = signal<number | null>(null); protected readonly viewportWidth = signal<number | null>(null);
protected readonly itemsPerPage = signal(Number.MAX_SAFE_INTEGER);
protected readonly currentPage = signal(0);
protected readonly transitionDirection = signal<-1 | 0 | 1>(0);
protected readonly hasMultipleItems = computed(() => this.items().length > 1); protected readonly hasMultipleItems = computed(() => this.items().length > 1);
protected readonly resolvedGap = computed(() => Math.max(this.gap(), 0)); protected readonly resolvedGap = computed(() => Math.max(this.gap(), 0));
protected readonly pageCount = computed(() =>
Math.max(1, Math.ceil(this.items().length / this.itemsPerPage())),
);
protected readonly isCircularLayout = computed(() => this.circular() && this.pageCount() > 1);
protected readonly circularPages = computed<CarouselPage<T>[]>(() => {
const pageCount = this.pageCount();
const currentPage = this.normalizePage(this.currentPage(), pageCount);
return [
this.createPage('previous', currentPage - 1),
this.createPage('current', currentPage),
this.createPage('next', currentPage + 1),
];
});
protected readonly isPreviousDisabled = computed( protected readonly isPreviousDisabled = computed(
() => !this.hasOverflow() || (!this.circular() && !this.canScrollPrevious()), () => !this.hasOverflow() || (!this.circular() && !this.canScrollPrevious()),
); );
@@ -73,7 +100,7 @@ export class CarouselComponent<T> implements AfterViewInit {
typeof MutationObserver === 'undefined' typeof MutationObserver === 'undefined'
? null ? null
: new MutationObserver(() => this.refreshLayout()); : new MutationObserver(() => this.refreshLayout());
mutationObserver?.observe(viewport, { childList: true }); mutationObserver?.observe(viewport, { childList: true, subtree: true });
this.destroyRef.onDestroy(() => { this.destroyRef.onDestroy(() => {
resizeObserver?.disconnect(); resizeObserver?.disconnect();
@@ -82,8 +109,8 @@ export class CarouselComponent<T> implements AfterViewInit {
} }
previous(): void { previous(): void {
if (this.circular() && this.hasOverflow() && !this.canScrollPrevious()) { if (this.circular()) {
this.scrollToEdge('end'); this.moveCircular(-1);
return; return;
} }
@@ -91,8 +118,8 @@ export class CarouselComponent<T> implements AfterViewInit {
} }
next(): void { next(): void {
if (this.circular() && this.hasOverflow() && !this.canScrollNext()) { if (this.circular()) {
this.scrollToEdge('start'); this.moveCircular(1);
return; return;
} }
@@ -100,6 +127,16 @@ export class CarouselComponent<T> implements AfterViewInit {
} }
scrollTo(index: number): void { scrollTo(index: number): void {
if (this.circular()) {
if (index < 0 || index >= this.items().length) {
return;
}
this.currentPage.set(Math.floor(index / this.itemsPerPage()));
this.transitionDirection.set(0);
return;
}
const item = this.viewport().nativeElement.children.item(index) as HTMLElement | null; const item = this.viewport().nativeElement.children.item(index) as HTMLElement | null;
item?.scrollIntoView({ item?.scrollIntoView({
@@ -110,9 +147,28 @@ export class CarouselComponent<T> implements AfterViewInit {
} }
protected handleScroll(): void { protected handleScroll(): void {
if (this.circular()) {
return;
}
this.refreshNavigation(); this.refreshNavigation();
} }
protected finishCircularTransition(event: TransitionEvent): void {
if (event.target !== event.currentTarget || event.propertyName !== 'transform') {
return;
}
const direction = this.transitionDirection();
if (direction === 0) {
return;
}
this.currentPage.update((page) => this.normalizePage(page + direction, this.pageCount()));
this.transitionDirection.set(0);
}
protected handleKeydown(event: KeyboardEvent): void { protected handleKeydown(event: KeyboardEvent): void {
if (event.key === 'ArrowLeft') { if (event.key === 'ArrowLeft') {
event.preventDefault(); event.preventDefault();
@@ -139,6 +195,14 @@ export class CarouselComponent<T> implements AfterViewInit {
}); });
} }
private moveCircular(direction: -1 | 1): void {
if (!this.hasOverflow() || this.transitionDirection() !== 0) {
return;
}
this.transitionDirection.set(direction);
}
private refreshNavigation(): void { private refreshNavigation(): void {
const viewport = this.viewport().nativeElement; const viewport = this.viewport().nativeElement;
const maxScrollLeft = Math.max(viewport.scrollWidth - viewport.clientWidth, 0); const maxScrollLeft = Math.max(viewport.scrollWidth - viewport.clientWidth, 0);
@@ -149,18 +213,9 @@ export class CarouselComponent<T> implements AfterViewInit {
this.canScrollNext.set(viewport.scrollLeft < maxScrollLeft - tolerance); this.canScrollNext.set(viewport.scrollLeft < maxScrollLeft - tolerance);
} }
private scrollToEdge(edge: 'start' | 'end'): void {
const viewport = this.viewport().nativeElement;
viewport.scrollTo({
left: edge === 'start' ? 0 : viewport.scrollWidth - viewport.clientWidth,
behavior: 'smooth',
});
}
private refreshLayout(): void { private refreshLayout(): void {
const viewport = this.viewport().nativeElement; const viewport = this.viewport().nativeElement;
const firstItem = viewport.firstElementChild as HTMLElement | null; const firstItem = viewport.querySelector<HTMLElement>('.carousel__item');
const availableWidth = this.host.nativeElement.clientWidth; const availableWidth = this.host.nativeElement.clientWidth;
if (!firstItem || availableWidth <= 0) { if (!firstItem || availableWidth <= 0) {
@@ -179,10 +234,41 @@ export class CarouselComponent<T> implements AfterViewInit {
const gap = this.resolvedGap(); const gap = this.resolvedGap();
const fittingItems = Math.max(1, Math.floor((availableWidth + gap) / (itemWidth + gap))); const fittingItems = Math.max(1, Math.floor((availableWidth + gap) / (itemWidth + gap)));
const visibleItems = Math.min(fittingItems, viewport.children.length); const visibleItems = Math.min(fittingItems, this.items().length);
const fittedWidth = visibleItems * itemWidth + Math.max(visibleItems - 1, 0) * gap; const fittedWidth = visibleItems * itemWidth + Math.max(visibleItems - 1, 0) * gap;
if (this.itemsPerPage() !== fittingItems) {
this.itemsPerPage.set(fittingItems);
this.currentPage.set(0);
this.transitionDirection.set(0);
}
this.viewportWidth.set(Math.min(Math.ceil(fittedWidth), availableWidth)); this.viewportWidth.set(Math.min(Math.ceil(fittedWidth), availableWidth));
this.refreshNavigation(); if (this.circular()) {
const hasOverflow = this.items().length > fittingItems;
this.hasOverflow.set(hasOverflow);
this.canScrollPrevious.set(hasOverflow);
this.canScrollNext.set(hasOverflow);
} else {
this.refreshNavigation();
}
}
private createPage(slot: CarouselPage<T>['slot'], page: number): CarouselPage<T> {
const pageCount = this.pageCount();
const normalizedPage = this.normalizePage(page, pageCount);
const start = normalizedPage * this.itemsPerPage();
const end = Math.min(start + this.itemsPerPage(), this.items().length);
const items: CarouselPageItem<T>[] = [];
for (let index = start; index < end; index += 1) {
items.push({ item: this.items()[index], index });
}
return { slot, items };
}
private normalizePage(page: number, pageCount: number): number {
return ((page % pageCount) + pageCount) % pageCount;
} }
} }