Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • CreativeEffectOptions

Index

Properties

Optional limitProgress

limitProgress: number

Limit progress/offset to amount of side slides. If 1, then slides all slides after prev/next will have same state. If 2, then all slides after 2nd before/after active will have same state, etc.

default

1

Optional next

Next slide transformations.

example
{
  // Array with translate X, Y and Z values
  translate: (string | number)[];
  // Array with rotate X, Y and Z values (in deg)
  rotate?: number[];
  // Slide opacity
  opacity?: number;
  // Slide scale
  scale?: number;
  // Enables slide shadow
  shadow?: boolean;
  // Transform origin, e.g. `left bottom`
  origin?: string;
}

Optional perspective

perspective: boolean

Enable this parameter if your custom transforms require 3D transformations (translateZ, rotateX, rotateY )

default

true

Optional prev

Previous slide transformations. Accepts object of the following type:

example
{
  // Array with translate X, Y and Z values
  translate: (string | number)[];
  // Array with rotate X, Y and Z values (in deg)
  rotate?: number[];
  // Slide opacity
  opacity?: number;
  // Slide scale
  scale?: number;
  // Enables slide shadow
  shadow?: boolean;
  // Transform origin, e.g. `left bottom`
  origin?: string;
}

Optional progressMultiplier

progressMultiplier: number

Allows to multiply slides transformations and opacity.

default

1

Optional shadowPerProgress

shadowPerProgress: boolean

Splits shadow "opacity" per slide based on limitProgress (only if transformation shadows enabled). E.g. setting limitProgress: 2 and enabling shadowPerProgress, will set shadow opacity to 0.5 and 1 on two slides next to active. With this parameter disabled, all slides beside active will have shadow with 1 opacity

default

false

Optional transformEl

transformEl: CSSSelector

CSS selector of the element inside of the slide to transform instead of the slide itself. Useful to use with cssMode

default

null

Generated using TypeDoc