@tanstack/angular-virtual/src/types.ts

Headless UI for virtualizing scrollable elements in Angular

import type { Signal } from '@angular/core'
import type { Virtualizer } from '@tanstack/virtual-core'

export type AngularVirtualizer<
  TScrollElement extends Element | Window,
  TItemElement extends Element,
> = Omit<
  Virtualizer<TScrollElement, TItemElement>,
  | 'getTotalSize'
  | 'getVirtualItems'
  | 'isScrolling'
  | 'options'
  | 'range'
  | 'scrollDirection'
  | 'scrollElement'
  | 'scrollOffset'
  | 'scrollRect'
  | 'measurementsCache'
> & {
  (): Virtualizer<TScrollElement, TItemElement>
  getTotalSize: Signal<
    ReturnType<Virtualizer<TScrollElement, TItemElement>['getTotalSize']>
  >
  getVirtualItems: Signal<
    ReturnType<Virtualizer<TScrollElement, TItemElement>['getVirtualItems']>
  >
  isScrolling: Signal<Virtualizer<TScrollElement, TItemElement>['isScrolling']>
  measurementsCache: Signal<
    Virtualizer<TScrollElement, TItemElement>['measurementsCache']
  >
  options: Signal<Virtualizer<TScrollElement, TItemElement>['options']>
  range: Signal<Virtualizer<TScrollElement, TItemElement>['range']>
  scrollDirection: Signal<
    Virtualizer<TScrollElement, TItemElement>['scrollDirection']
  >
  scrollElement: Signal<
    Virtualizer<TScrollElement, TItemElement>['scrollElement']
  >
  scrollOffset: Signal<
    Virtualizer<TScrollElement, TItemElement>['scrollOffset']
  >
  scrollRect: Signal<Virtualizer<TScrollElement, TItemElement>['scrollRect']>
}