vscroll 1.6.3 → 1.8.0

package/dist/typings/classes/domRoutines.d.ts

@@ -1,36 +1,36 @@
-import { Settings } from './settings';
-import { Direction } from '../inputs/index';
-import { IRoutines, ItemAdapter } from '../interfaces/index';
-export declare class Routines implements IRoutines {
-  readonly settings: IRoutines['settings'];
-  readonly element: HTMLElement;
-  readonly viewport: HTMLElement;
-  constructor(element: HTMLElement, settings: Settings);
-  checkElement(element: HTMLElement): void;
-  getViewportElement(): HTMLElement;
-  onInit(settings: Settings): void;
-  findElementBySelector(element: HTMLElement, selector: string): HTMLElement | null;
-  findPaddingElement(direction: Direction): HTMLElement | null;
-  findItemElement(id: string): HTMLElement | null;
-  findItemChildBySelector(id: string, selector: string): HTMLElement | null;
-  getScrollPosition(): number;
-  setScrollPosition(value: number): void;
-  getElementParams(element: HTMLElement): DOMRect;
-  getWindowParams(): DOMRect;
-  getSize(element: HTMLElement): number;
-  getScrollerSize(): number;
-  getViewportSize(): number;
-  getSizeStyle(element: HTMLElement): number;
-  setSizeStyle(element: HTMLElement, value: number): void;
-  getEdge(element: HTMLElement, direction: Direction): number;
-  getViewportEdge(direction: Direction): number;
-  makeElementVisible(element: HTMLElement): void;
-  hideElement(element: HTMLElement): void;
-  getOffset(): number;
-  scrollTo(element: HTMLElement, argument?: boolean | ScrollIntoViewOptions): void;
-  render(cb: () => void, params: {
-    items: ItemAdapter[];
-  }): () => void;
-  animate(cb: () => void): () => void;
-  onScroll(handler: EventListener): () => void;
-}
+import { Settings } from './settings';
+import { Direction } from '../inputs/index';
+import { IRoutines, ItemAdapter } from '../interfaces/index';
+export declare class Routines implements IRoutines {
+  readonly settings: IRoutines['settings'];
+  readonly element: HTMLElement;
+  readonly viewport: HTMLElement;
+  constructor(element: HTMLElement, settings: Settings);
+  checkElement(element: HTMLElement): void;
+  getViewportElement(): HTMLElement;
+  onInit(settings: Settings): void;
+  findElementBySelector(element: HTMLElement, selector: string): HTMLElement | null;
+  findPaddingElement(direction: Direction): HTMLElement | null;
+  findItemElement(id: string): HTMLElement | null;
+  findItemChildBySelector(id: string, selector: string): HTMLElement | null;
+  getScrollPosition(): number;
+  setScrollPosition(value: number): void;
+  getElementParams(element: HTMLElement): DOMRect;
+  getWindowParams(): DOMRect;
+  getSize(element: HTMLElement): number;
+  getScrollerSize(): number;
+  getViewportSize(): number;
+  getSizeStyle(element: HTMLElement): number;
+  setSizeStyle(element: HTMLElement, value: number): void;
+  getEdge(element: HTMLElement, direction: Direction): number;
+  getViewportEdge(direction: Direction): number;
+  makeElementVisible(element: HTMLElement): void;
+  hideElement(element: HTMLElement): void;
+  getOffset(): number;
+  scrollTo(element: HTMLElement, argument?: boolean | ScrollIntoViewOptions): void;
+  render(cb: () => void, _params: {
+    items: ItemAdapter[];
+  }): () => void;
+  animate(cb: () => void): () => void;
+  onScroll(handler: EventListener): () => void;
+}

package/dist/typings/classes/item.d.ts

@@ -1,28 +1,28 @@
-import { Routines } from './domRoutines';
-import { Direction } from '../inputs/index';
-import { Item as _Item, ItemAdapter } from '../interfaces/index';
-export declare class Item<Data = unknown> implements _Item<Data> {
-  nodeId: string;
-  routines: Routines;
-  preSize: number;
-  size: number;
-  invisible: boolean;
-  toRemove: boolean;
-  toInsert: boolean;
-  removeDirection: Direction;
-  private container;
-  get $index(): number;
-  set $index(value: number);
-  get data(): Data;
-  set data(value: Data);
-  get element(): HTMLElement;
-  set element(value: HTMLElement);
-  constructor($index: number, data: Data, routines: Routines);
-  dispose(): void;
-  setSize(preSize?: number): void;
-  makeVisible(): void;
-  hide(): void;
-  scrollTo(argument?: boolean | ScrollIntoViewOptions): void;
-  updateIndex(index: number): void;
-  get(): ItemAdapter<Data>;
-}
+import { Routines } from './domRoutines';
+import { Direction } from '../inputs/index';
+import { Item as _Item, ItemAdapter } from '../interfaces/index';
+export declare class Item<Data = unknown> implements _Item<Data> {
+  nodeId: string;
+  routines: Routines;
+  preSize: number;
+  size: number;
+  invisible: boolean;
+  toRemove: boolean;
+  toInsert: boolean;
+  removeDirection: Direction;
+  private container;
+  get $index(): number;
+  set $index(value: number);
+  get data(): Data;
+  set data(value: Data);
+  get element(): HTMLElement;
+  set element(value: HTMLElement);
+  constructor($index: number, data: Data, routines: Routines);
+  dispose(): void;
+  setSize(preSize?: number): void;
+  makeVisible(): void;
+  hide(): void;
+  scrollTo(argument?: boolean | ScrollIntoViewOptions): void;
+  updateIndex(index: number): void;
+  get(): ItemAdapter<Data>;
+}

package/dist/typings/classes/logger.d.ts

@@ -1,28 +1,32 @@
-import { Scroller } from '../scroller';
-import { IPackages, ProcessSubject } from '../interfaces/index';
-export declare class Logger {
-  readonly debug: boolean;
-  readonly immediateLog: boolean;
-  readonly logTime: boolean;
-  readonly getTime: () => string;
-  readonly getStat: () => string;
-  readonly getFetchRange: () => string;
-  readonly getWorkflowCycleData: () => string;
-  readonly getLoopId: () => string;
-  readonly getLoopIdNext: () => string;
-  readonly getScrollPosition: () => number;
-  private logs;
-  constructor(scroller: Scroller, packageInfo: IPackages, adapter?: {
-    id: number;
-  });
-  object(str: string, obj: unknown, stringify?: boolean): void;
-  stat(str?: string): void;
-  fetch(str?: string): void;
-  prepareForLog(data: unknown): unknown;
-  logProcess(data: ProcessSubject): void;
-  logCycle(start?: boolean): void;
-  logError(str: string): void;
-  logAdapterMethod: (methodName: string, args?: unknown, add?: string) => void;
-  log(...args: unknown[]): void;
-  logForce(...args: unknown[]): void;
-}
+import { Scroller } from '../scroller';
+import { IPackages, ProcessSubject } from '../interfaces/index';
+type LogType = [unknown?, ...unknown[]];
+export declare class Logger {
+  readonly debug: boolean;
+  readonly immediateLog: boolean;
+  readonly logTime: boolean;
+  readonly logColor: boolean;
+  readonly getTime: () => string;
+  readonly getStat: () => string;
+  readonly getFetchRange: () => string;
+  readonly getWorkflowCycleData: () => string;
+  readonly getLoopId: () => string;
+  readonly getLoopIdNext: () => string;
+  readonly getScrollPosition: () => number;
+  private logs;
+  constructor(scroller: Scroller, packageInfo: IPackages, adapter?: {
+    id: number;
+  });
+  object(str: string, obj: unknown, stringify?: boolean): void;
+  stat(str?: string): void;
+  fetch(str?: string): void;
+  prepareForLog(data: unknown): unknown;
+  logProcess(data: ProcessSubject): void;
+  logCycle(start?: boolean): void;
+  logError(str: string): void;
+  logAdapterMethod: (methodName: string, args?: unknown, add?: string) => void;
+  log(...args: unknown[]): void;
+  logForce(...args: unknown[]): void;
+  getLogs(): LogType[];
+}
+export {};

package/dist/typings/classes/paddings.d.ts

@@ -1,22 +1,22 @@
-import { Routines } from './domRoutines';
-import { Settings } from './settings';
-import { Direction } from '../inputs/index';
-export declare class Padding {
-  element: HTMLElement;
-  direction: Direction;
-  routines: Routines;
-  constructor(direction: Direction, routines: Routines);
-  reset(size?: number): void;
-  get size(): number;
-  set size(value: number);
-}
-export declare class Paddings {
-  settings: Settings;
-  forward: Padding;
-  backward: Padding;
-  constructor(routines: Routines, settings: Settings);
-  byDirection(direction: Direction, opposite?: boolean): Padding;
-  reset(viewportSize: number, startIndex: number, offset: number): void;
-  getPositiveSize(startIndex: number, viewportSize: number, offset: number): number;
-  getNegativeSize(startIndex: number): number;
-}
+import { Routines } from './domRoutines';
+import { Settings } from './settings';
+import { Direction } from '../inputs/index';
+export declare class Padding {
+  element: HTMLElement;
+  direction: Direction;
+  routines: Routines;
+  constructor(direction: Direction, routines: Routines);
+  reset(size?: number): void;
+  get size(): number;
+  set size(value: number);
+}
+export declare class Paddings {
+  settings: Settings;
+  forward: Padding;
+  backward: Padding;
+  constructor(routines: Routines, settings: Settings);
+  byDirection(direction: Direction, opposite?: boolean): Padding;
+  reset(viewportSize: number, startIndex: number, offset: number): void;
+  getPositiveSize(startIndex: number, viewportSize: number, offset: number): number;
+  getNegativeSize(startIndex: number): number;
+}

package/dist/typings/classes/reactive.d.ts

@@ -1,21 +1,21 @@
-type On<T> = (value: T) => void;
-type Off = () => void;
-interface Options {
-  emitOnSubscribe?: boolean;
-  emitEqual?: boolean;
-}
-export declare class Reactive<T> {
-  private initialValue;
-  private value;
-  private id;
-  private options;
-  private subscriptions;
-  constructor(value?: T, options?: Options);
-  set(value: T): void;
-  get(): T;
-  on(func: On<T>): Off;
-  once(func: On<T>): Off;
-  reset(): void;
-  dispose(): void;
-}
-export {};
+type On<T> = (value: T) => void;
+type Off = () => void;
+interface Options {
+  emitOnSubscribe?: boolean;
+  emitEqual?: boolean;
+}
+export declare class Reactive<T> {
+  private initialValue;
+  private value;
+  private id;
+  private options;
+  private subscriptions;
+  constructor(value?: T, options?: Options);
+  set(value: T): void;
+  get(): T;
+  on(func: On<T>): Off;
+  once(func: On<T>): Off;
+  reset(): void;
+  dispose(): void;
+}
+export {};

package/dist/typings/classes/settings.d.ts

@@ -1,119 +1,126 @@
-import { SizeStrategy, Direction } from '../inputs/index';
-import { Settings as ISettings, DevSettings as IDevSettings, ICommonProps, ItemsProcessor } from '../interfaces/index';
-export declare class Settings<Data = unknown> implements ISettings, IDevSettings {
-  adapter: boolean;
-  startIndex: number;
-  minIndex: number;
-  maxIndex: number;
-  itemSize: number;
-  bufferSize: number;
-  padding: number;
-  infinite: boolean;
-  horizontal: boolean;
-  windowViewport: boolean;
-  viewportElement: HTMLElement | (() => void) | null;
-  inverse: boolean;
-  onBeforeClip: ItemsProcessor | null;
-  sizeStrategy: SizeStrategy;
-  /**
-   * Development setting.
-   * If true, logging is enabled.
-   * Default value: false.
-   * @type {boolean}
-   */
-  debug: boolean;
-  /**
-   * Development setting.
-   * If false, in-memory logging is enabled, Adapter.showLog() method should be called to print the log.
-   * Default value: true.
-   * @type {boolean}
-   */
-  immediateLog: boolean;
-  /**
-   * Development setting.
-   * If true, time differences will be logged.
-   * Default value: false.
-   * @type {boolean}
-   */
-  logTime: boolean;
-  /**
-   * Development setting.
-   * If true, process fire/run info will be logged.
-   * Default value: false.
-   * @type {boolean}
-   */
-  logProcessRun: boolean;
-  /**
-   * Development setting.
-   * If set, scroll event handling is throttled (ms).
-   * Default value: 40. Minimal value: 0.
-   * @type {number} ms
-   */
-  throttle: number;
-  /**
-   * Development setting.
-   * If set, the Workflow initialization will be postponed (ms).
-   * Default value: 1. Minimal value: 0.
-   * @type {number} ms
-   */
-  initDelay: number;
-  /**
-   * Development setting.
-   * If set and the entire window is scrollable, the Workflow initialization will be postponed (ms).
-   * Default value: 40. Minimal value: 0.
-   * @type {number} ms
-   */
-  initWindowDelay: number;
-  /**
-   * Development setting.
-   * If true, item's data will be cached along with item's size and index.
-   * Default value: false.
-   * @type {boolean}
-   */
-  cacheData: boolean;
-  /**
-   * Development setting.
-   * If true, cache will not be flushed on reload.
-   * Default value: false.
-   * @type {boolean}
-   */
-  cacheOnReload: boolean;
-  /**
-   * Development setting.
-   * If true, the viewport will receive "overflowAnchor: none" css property.
-   * Default value: false.
-   * @type {boolean}
-   */
-  dismissOverflowAnchor: boolean;
-  /**
-   * Development setting.
-   * Determines the strategy of fixing the difference between estimated and real (rendered) sizes
-   * on scroll position adjustments. If set to 'backward', the difference is always resolved in favour of the
-   * backward direction: top/left content is fixed and appears in accordance with pre-render expectations.
-   * If set to 'forward', both directions could be used, and there is a case when bottom/right content is fixed:
-   * new items are to the left of the previously rendered
-   * and at least one previously rendered item remains.
-   * Default value: 'backward'. Allowed values: 'backward', 'forward'.
-   * @type {string}
-   */
-  directionPriority: Direction;
-  /**
-   * Internal setting. Stores the index of the Scroller instance.
-   * @type {number}
-   */
-  instanceIndex: number;
-  /**
-   * Internal setting. Stores the Workflow initialization delay based on initDelay and initWindowDelay settings.
-   * @type {number}
-   */
-  initializeDelay: number;
-  /**
-   * Internal setting. Stores the viewport based on viewportElement setting (which can be element or function).
-   * @type {HTMLElement|null}
-   */
-  viewport: HTMLElement | null;
-  constructor(settings: ISettings<Data> | undefined, devSettings: IDevSettings | undefined, instanceIndex: number);
-  parseInput(input: ISettings<Data> | IDevSettings | undefined, props: ICommonProps<PropertyKey>): void;
-  getInitializeDelay(): number;
-  getViewport(): HTMLElement | null;
-}
+import { SizeStrategy, Direction } from '../inputs/index';
+import { Settings as ISettings, DevSettings as IDevSettings, ICommonProps, ItemsProcessor } from '../interfaces/index';
+export declare class Settings<Data = unknown> implements ISettings, IDevSettings {
+  adapter: boolean;
+  startIndex: number;
+  minIndex: number;
+  maxIndex: number;
+  itemSize: number;
+  bufferSize: number;
+  padding: number;
+  infinite: boolean;
+  horizontal: boolean;
+  windowViewport: boolean;
+  viewportElement: HTMLElement | (() => void) | null;
+  inverse: boolean;
+  onBeforeClip: ItemsProcessor | null;
+  sizeStrategy: SizeStrategy;
+  /**
+   * Development setting.
+   * If true, logging is enabled.
+   * Default value: false.
+   * @type {boolean}
+   */
+  debug: boolean;
+  /**
+   * Development setting.
+   * If false, in-memory logging is enabled, Adapter.showLog() method should be called to print the log.
+   * Default value: true.
+   * @type {boolean}
+   */
+  immediateLog: boolean;
+  /**
+   * Development setting.
+   * If true, time differences will be logged.
+   * Default value: false.
+   * @type {boolean}
+   */
+  logTime: boolean;
+  /**
+   * Development setting.
+   * If true, process fire/run info will be logged.
+   * Default value: false.
+   * @type {boolean}
+   */
+  logProcessRun: boolean;
+  /**
+   * Development setting.
+   * If true, console color formatting will be used in logs.
+   * Default value: true.
+   * @type {boolean}
+   */
+  logColor: boolean;
+  /**
+   * Development setting.
+   * If set, scroll event handling is throttled (ms).
+   * Default value: 40. Minimal value: 0.
+   * @type {number} ms
+   */
+  throttle: number;
+  /**
+   * Development setting.
+   * If set, the Workflow initialization will be postponed (ms).
+   * Default value: 1. Minimal value: 0.
+   * @type {number} ms
+   */
+  initDelay: number;
+  /**
+   * Development setting.
+   * If set and the entire window is scrollable, the Workflow initialization will be postponed (ms).
+   * Default value: 40. Minimal value: 0.
+   * @type {number} ms
+   */
+  initWindowDelay: number;
+  /**
+   * Development setting.
+   * If true, item's data will be cached along with item's size and index.
+   * Default value: false.
+   * @type {boolean}
+   */
+  cacheData: boolean;
+  /**
+   * Development setting.
+   * If true, cache will not be flushed on reload.
+   * Default value: false.
+   * @type {boolean}
+   */
+  cacheOnReload: boolean;
+  /**
+   * Development setting.
+   * If true, the viewport will receive "overflowAnchor: none" css property.
+   * Default value: false.
+   * @type {boolean}
+   */
+  dismissOverflowAnchor: boolean;
+  /**
+   * Development setting.
+   * Determines the strategy of fixing the difference between estimated and real (rendered) sizes
+   * on scroll position adjustments. If set to 'backward', the difference is always resolved in favour of the
+   * backward direction: top/left content is fixed and appears in accordance with pre-render expectations.
+   * If set to 'forward', both directions could be used, and there is a case when bottom/right content is fixed:
+   * new items are to the left of the previously rendered
+   * and at least one previously rendered item remains.
+   * Default value: 'backward'. Allowed values: 'backward', 'forward'.
+   * @type {string}
+   */
+  directionPriority: Direction;
+  /**
+   * Internal setting. Stores the index of the Scroller instance.
+   * @type {number}
+   */
+  instanceIndex: number;
+  /**
+   * Internal setting. Stores the Workflow initialization delay based on initDelay and initWindowDelay settings.
+   * @type {number}
+   */
+  initializeDelay: number;
+  /**
+   * Internal setting. Stores the viewport based on viewportElement setting (which can be element or function).
+   * @type {HTMLElement|null}
+   */
+  viewport: HTMLElement | null;
+  constructor(settings: ISettings<Data> | undefined, devSettings: IDevSettings | undefined, instanceIndex: number);
+  parseInput(input: ISettings<Data> | IDevSettings | undefined, props: ICommonProps<PropertyKey>): void;
+  getInitializeDelay(): number;
+  getViewport(): HTMLElement | null;
+}

package/dist/typings/classes/state/clip.d.ts

@@ -1,9 +1,9 @@
-export declare class ClipModel {
-  doClip: boolean;
-  callCount: number;
-  forceForward: boolean;
-  forceBackward: boolean;
-  get force(): boolean;
-  constructor();
-  reset(force?: boolean): void;
-}
+export declare class ClipModel {
+  doClip: boolean;
+  callCount: number;
+  forceForward: boolean;
+  forceBackward: boolean;
+  get force(): boolean;
+  constructor();
+  reset(force?: boolean): void;
+}

package/dist/typings/classes/state/cycle.d.ts

@@ -1,29 +1,29 @@
-import { ProcessName } from '../../interfaces/index';
-import { Reactive } from '../reactive';
-declare class InnerLoopModel {
-  total: number;
-  count: number;
-  isInitial: boolean;
-  busy: Reactive<boolean>;
-  get first(): boolean;
-  constructor(total: number);
-  done(): void;
-  start(): void;
-  dispose(): void;
-}
-export declare class WorkflowCycleModel {
-  instanceIndex: number;
-  count: number;
-  isInitial: boolean;
-  initiator: ProcessName;
-  innerLoop: InnerLoopModel;
-  interrupter: ProcessName | null;
-  busy: Reactive<boolean>;
-  get loopId(): string;
-  get loopIdNext(): string;
-  constructor(instanceIndex: number, cycle?: WorkflowCycleModel);
-  start(isInitial: boolean, initiator: ProcessName): void;
-  end(count: number): void;
-  dispose(forever?: boolean): void;
-}
-export {};
+import { ProcessName } from '../../interfaces/index';
+import { Reactive } from '../reactive';
+declare class InnerLoopModel {
+  total: number;
+  count: number;
+  isInitial: boolean;
+  busy: Reactive<boolean>;
+  get first(): boolean;
+  constructor(total: number);
+  done(): void;
+  start(): void;
+  dispose(): void;
+}
+export declare class WorkflowCycleModel {
+  instanceIndex: number;
+  count: number;
+  isInitial: boolean;
+  initiator: ProcessName;
+  innerLoop: InnerLoopModel;
+  interrupter: ProcessName | null;
+  busy: Reactive<boolean>;
+  get loopId(): string;
+  get loopIdNext(): string;
+  constructor(instanceIndex: number, cycle?: WorkflowCycleModel);
+  start(isInitial: boolean, initiator: ProcessName): void;
+  end(count: number): void;
+  dispose(forever?: boolean): void;
+}
+export {};