@egjs/flicking
Version:
Everyday 30 million people experience. It's reliable, flexible and extendable carousel.
68 lines (67 loc) • 2.36 kB
TypeScript
/**
* An object with all possible predefined literal string for the {@link Flicking.align | align} option
*/
export declare const ALIGN: {
/** left/top align */
readonly PREV: "prev";
/** center align */
readonly CENTER: "center";
/** right/bottom align */
readonly NEXT: "next";
};
/**
* An object of directions
*/
export declare const DIRECTION: {
/** "left" when {@link Flicking.horizontal | horizontal} is true, and "top" when {@link Flicking.horizontal | horizontal} is false */
readonly PREV: "PREV";
/** "right" when {@link Flicking.horizontal | horizontal} is true, and "bottom" when {@link Flicking.horizontal | horizontal} is false */
readonly NEXT: "NEXT";
/** This value usually means it's the same position */
readonly NONE: null;
};
/**
* An object with all possible {@link Flicking.moveType | moveType}s
*/
export declare const MOVE_TYPE: {
/** Flicking's {@link Flicking.moveType | moveType} that enables {@link SnapControl} as a Flicking's {@link Flicking.control | control} */
readonly SNAP: "snap";
/** Flicking's {@link Flicking.moveType | moveType} that enables {@link FreeControl} as a Flicking's {@link Flicking.control | control} */
readonly FREE_SCROLL: "freeScroll";
/** Flicking's {@link Flicking.moveType | moveType} that enables {@link StrictControl} as a Flicking's {@link Flicking.control | control} */
readonly STRICT: "strict";
};
export declare const CLASS: {
VIEWPORT: string;
CAMERA: string;
VERTICAL: string;
HIDDEN: string;
DEFAULT_VIRTUAL: string;
};
/**
* An object with all possible {@link Flicking.circularFallback | circularFallback}s
*/
export declare const CIRCULAR_FALLBACK: {
/** "linear" */
readonly LINEAR: "linear";
/** "bound" */
readonly BOUND: "bound";
};
/**
* An object for identifying {@link https://developer.mozilla.org/en-US/docs/Web/CSS/direction | direction} CSS property applied to the camera element(`.flicking-camera`)
*/
export declare const ORDER: {
/** "ltr" */
readonly LTR: "ltr";
/** "rtl" */
readonly RTL: "rtl";
};
/**
* An object that contains the direction that {@link Flicking} is moving
*/
export declare const MOVE_DIRECTION: {
/** horizontal */
readonly HORIZONTAL: "horizontal";
/** vertical */
readonly VERTICAL: "vertical";
};