vevet/src/core/types.ts

Vevet is a JavaScript library for creative development that simplifies crafting rich interactions like split text animations, carousels, marquees, preloading, and more.

import { TEasingType } from '@/utils/math/easing';

/**
 * Application configuration properties for initializing Vevet.
 */
export interface ICoreProps {
  /**
   * Medium breakpoint in pixels.
   * When changing this property, you need to
   * update the SASS variable: `$md`. The values must be equal.
   * @default 1199
   */
  md: number;

  /**
   * Small breakpoint in pixels.
   * When changing this property, you need to
   * update the SASS variable: `$sm`. The values must be equal.
   * @default 999
   */
  sm: number;

  /**
   * Timeout (in milliseconds) for viewport callbacks debouncing.
   * @default 0
   */
  resizeDebounce: number;

  /**
   * Default easing type. Accepts a bezier array, function or an easing name.
   * @default [0.25, 0.1, 0.25, 1]
   */
  easing?: TEasingType;

  /**
   * If need to apply class names for the root element: such as browser, OS name, etc.
   * @default false
   */
  applyClassNames: boolean;
}