@tanstack/angular-virtual
Version:
Headless UI for virtualizing scrollable elements in Angular
77 lines • 12.5 kB
JavaScript
import { AfterRenderPhase, DestroyRef, afterNextRender, computed, effect, inject, signal, untracked, } from '@angular/core';
import { Virtualizer, elementScroll, observeElementOffset, observeElementRect, observeWindowOffset, observeWindowRect, windowScroll, } from '@tanstack/virtual-core';
import { proxyVirtualizer } from './proxy';
export * from '@tanstack/virtual-core';
export * from './types';
function createVirtualizerBase(options) {
let virtualizer;
function lazyInit() {
virtualizer ??= new Virtualizer(options());
return virtualizer;
}
const virtualizerSignal = signal(virtualizer, { equal: () => false });
// two-way sync options
effect(() => {
const _options = options();
lazyInit();
virtualizerSignal.set(virtualizer);
virtualizer.setOptions({
..._options,
onChange: (instance, sync) => {
// update virtualizerSignal so that dependent computeds recompute.
virtualizerSignal.set(instance);
_options.onChange?.(instance, sync);
},
});
// update virtualizerSignal so that dependent computeds recompute.
virtualizerSignal.set(virtualizer);
}, { allowSignalWrites: true });
const scrollElement = computed(() => options().getScrollElement());
// let the virtualizer know when the scroll element is changed
effect(() => {
const el = scrollElement();
if (el) {
untracked(virtualizerSignal)._willUpdate();
}
}, { allowSignalWrites: true });
let cleanup;
afterNextRender(() => (virtualizer ?? lazyInit())._didMount(), {
phase: AfterRenderPhase.Read,
});
inject(DestroyRef).onDestroy(() => cleanup?.());
return proxyVirtualizer(virtualizerSignal, lazyInit);
}
export function injectVirtualizer(options) {
const resolvedOptions = computed(() => {
return {
observeElementRect: observeElementRect,
observeElementOffset: observeElementOffset,
scrollToFn: elementScroll,
getScrollElement: () => {
const elementOrRef = options().scrollElement;
return ((isElementRef(elementOrRef)
? elementOrRef.nativeElement
: elementOrRef) ?? null);
},
...options(),
};
});
return createVirtualizerBase(resolvedOptions);
}
function isElementRef(elementOrRef) {
return elementOrRef != null && 'nativeElement' in elementOrRef;
}
export function injectWindowVirtualizer(options) {
const resolvedOptions = computed(() => {
return {
getScrollElement: () => (typeof document !== 'undefined' ? window : null),
observeElementRect: observeWindowRect,
observeElementOffset: observeWindowOffset,
scrollToFn: windowScroll,
initialOffset: () => typeof document !== 'undefined' ? window.scrollY : 0,
...options(),
};
});
return createVirtualizerBase(resolvedOptions);
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,QAAQ,EACR,MAAM,EACN,MAAM,EACN,MAAM,EACN,SAAS,GACV,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,WAAW,EACX,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,YAAY,GACb,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAK1C,cAAc,wBAAwB,CAAA;AACtC,cAAc,SAAS,CAAA;AAEvB,SAAS,qBAAqB,CAI5B,OAAiE;IAEjE,IAAI,WAAsD,CAAA;IAC1D,SAAS,QAAQ;QACf,WAAW,KAAK,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC,CAAA;QAC1C,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,MAAM,iBAAiB,GAAG,MAAM,CAAC,WAAY,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,CAAA;IAEtE,uBAAuB;IACvB,MAAM,CACJ,GAAG,EAAE;QACH,MAAM,QAAQ,GAAG,OAAO,EAAE,CAAA;QAC1B,QAAQ,EAAE,CAAA;QACV,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;QAClC,WAAW,CAAC,UAAU,CAAC;YACrB,GAAG,QAAQ;YACX,QAAQ,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;gBAC3B,kEAAkE;gBAClE,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;gBAC/B,QAAQ,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;YACrC,CAAC;SACF,CAAC,CAAA;QACF,kEAAkE;QAClE,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IACpC,CAAC,EACD,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAC5B,CAAA;IAED,MAAM,aAAa,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAClE,8DAA8D;IAC9D,MAAM,CACJ,GAAG,EAAE;QACH,MAAM,EAAE,GAAG,aAAa,EAAE,CAAA;QAC1B,IAAI,EAAE,EAAE;YACN,SAAS,CAAC,iBAAiB,CAAC,CAAC,WAAW,EAAE,CAAA;SAC3C;IACH,CAAC,EACD,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAC5B,CAAA;IAED,IAAI,OAA+B,CAAA;IACnC,eAAe,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,IAAI,QAAQ,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE;QAC7D,KAAK,EAAE,gBAAgB,CAAC,IAAI;KAC7B,CAAC,CAAA;IAEF,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IAE/C,OAAO,gBAAgB,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAA;AACtD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAI/B,OAKC;IAED,MAAM,eAAe,GAAG,QAAQ,CAAC,GAAG,EAAE;QACpC,OAAO;YACL,kBAAkB,EAAE,kBAAkB;YACtC,oBAAoB,EAAE,oBAAoB;YAC1C,UAAU,EAAE,aAAa;YACzB,gBAAgB,EAAE,GAAG,EAAE;gBACrB,MAAM,YAAY,GAAG,OAAO,EAAE,CAAC,aAAa,CAAA;gBAC5C,OAAO,CACL,CAAC,YAAY,CAAC,YAAY,CAAC;oBACzB,CAAC,CAAC,YAAY,CAAC,aAAa;oBAC5B,CAAC,CAAC,YAAY,CAAC,IAAI,IAAI,CAC1B,CAAA;YACH,CAAC;YACD,GAAG,OAAO,EAAE;SACb,CAAA;IACH,CAAC,CAAC,CAAA;IACF,OAAO,qBAAqB,CAA+B,eAAe,CAAC,CAAA;AAC7E,CAAC;AAED,SAAS,YAAY,CACnB,YAA2C;IAE3C,OAAO,YAAY,IAAI,IAAI,IAAI,eAAe,IAAI,YAAY,CAAA;AAChE,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,OAMC;IAED,MAAM,eAAe,GAAG,QAAQ,CAAC,GAAG,EAAE;QACpC,OAAO;YACL,gBAAgB,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;YACzE,kBAAkB,EAAE,iBAAiB;YACrC,oBAAoB,EAAE,mBAAmB;YACzC,UAAU,EAAE,YAAY;YACxB,aAAa,EAAE,GAAG,EAAE,CAClB,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACtD,GAAG,OAAO,EAAE;SACb,CAAA;IACH,CAAC,CAAC,CAAA;IACF,OAAO,qBAAqB,CAAuB,eAAe,CAAC,CAAA;AACrE,CAAC","sourcesContent":["import {\n  AfterRenderPhase,\n  DestroyRef,\n  afterNextRender,\n  computed,\n  effect,\n  inject,\n  signal,\n  untracked,\n} from '@angular/core'\nimport {\n  Virtualizer,\n  elementScroll,\n  observeElementOffset,\n  observeElementRect,\n  observeWindowOffset,\n  observeWindowRect,\n  windowScroll,\n} from '@tanstack/virtual-core'\nimport { proxyVirtualizer } from './proxy'\nimport type { ElementRef, Signal } from '@angular/core'\nimport type { PartialKeys, VirtualizerOptions } from '@tanstack/virtual-core'\nimport type { AngularVirtualizer } from './types'\n\nexport * from '@tanstack/virtual-core'\nexport * from './types'\n\nfunction createVirtualizerBase<\n  TScrollElement extends Element | Window,\n  TItemElement extends Element,\n>(\n  options: Signal<VirtualizerOptions<TScrollElement, TItemElement>>,\n): AngularVirtualizer<TScrollElement, TItemElement> {\n  let virtualizer: Virtualizer<TScrollElement, TItemElement>\n  function lazyInit() {\n    virtualizer ??= new Virtualizer(options())\n    return virtualizer\n  }\n\n  const virtualizerSignal = signal(virtualizer!, { equal: () => false })\n\n  // two-way sync options\n  effect(\n    () => {\n      const _options = options()\n      lazyInit()\n      virtualizerSignal.set(virtualizer)\n      virtualizer.setOptions({\n        ..._options,\n        onChange: (instance, sync) => {\n          // update virtualizerSignal so that dependent computeds recompute.\n          virtualizerSignal.set(instance)\n          _options.onChange?.(instance, sync)\n        },\n      })\n      // update virtualizerSignal so that dependent computeds recompute.\n      virtualizerSignal.set(virtualizer)\n    },\n    { allowSignalWrites: true },\n  )\n\n  const scrollElement = computed(() => options().getScrollElement())\n  // let the virtualizer know when the scroll element is changed\n  effect(\n    () => {\n      const el = scrollElement()\n      if (el) {\n        untracked(virtualizerSignal)._willUpdate()\n      }\n    },\n    { allowSignalWrites: true },\n  )\n\n  let cleanup: () => void | undefined\n  afterNextRender(() => (virtualizer ?? lazyInit())._didMount(), {\n    phase: AfterRenderPhase.Read,\n  })\n\n  inject(DestroyRef).onDestroy(() => cleanup?.())\n\n  return proxyVirtualizer(virtualizerSignal, lazyInit)\n}\n\nexport function injectVirtualizer<\n  TScrollElement extends Element,\n  TItemElement extends Element,\n>(\n  options: () => PartialKeys<\n    Omit<VirtualizerOptions<TScrollElement, TItemElement>, 'getScrollElement'>,\n    'observeElementRect' | 'observeElementOffset' | 'scrollToFn'\n  > & {\n    scrollElement: ElementRef<TScrollElement> | TScrollElement | undefined\n  },\n): AngularVirtualizer<TScrollElement, TItemElement> {\n  const resolvedOptions = computed(() => {\n    return {\n      observeElementRect: observeElementRect,\n      observeElementOffset: observeElementOffset,\n      scrollToFn: elementScroll,\n      getScrollElement: () => {\n        const elementOrRef = options().scrollElement\n        return (\n          (isElementRef(elementOrRef)\n            ? elementOrRef.nativeElement\n            : elementOrRef) ?? null\n        )\n      },\n      ...options(),\n    }\n  })\n  return createVirtualizerBase<TScrollElement, TItemElement>(resolvedOptions)\n}\n\nfunction isElementRef<T extends Element>(\n  elementOrRef: ElementRef<T> | T | undefined,\n): elementOrRef is ElementRef<T> {\n  return elementOrRef != null && 'nativeElement' in elementOrRef\n}\n\nexport function injectWindowVirtualizer<TItemElement extends Element>(\n  options: () => PartialKeys<\n    VirtualizerOptions<Window, TItemElement>,\n    | 'getScrollElement'\n    | 'observeElementRect'\n    | 'observeElementOffset'\n    | 'scrollToFn'\n  >,\n): AngularVirtualizer<Window, TItemElement> {\n  const resolvedOptions = computed(() => {\n    return {\n      getScrollElement: () => (typeof document !== 'undefined' ? window : null),\n      observeElementRect: observeWindowRect,\n      observeElementOffset: observeWindowOffset,\n      scrollToFn: windowScroll,\n      initialOffset: () =>\n        typeof document !== 'undefined' ? window.scrollY : 0,\n      ...options(),\n    }\n  })\n  return createVirtualizerBase<Window, TItemElement>(resolvedOptions)\n}\n"]}