Interface Literal<TemplateSpecType, Key>

Animation Settings object literal

Remarks

See Animation Attributes for more information.

interface Literal<
    TemplateSpecType = Lightning.Element.TemplateSpec,
    Key = keyof TemplateSpecType | AnimationForceLiteral,
> {
    actions: (
        Key extends AnimationForceLiteral
            ? Lightning.types.AnimationActionSettings.Literal<
                Key<Key>,
                AnimationForceType<Key<Key>>,
            >
            : Key extends keyof TemplateSpecType
                ? Lightning.types.AnimationActionSettings.Literal<
                    Key<Key>,
                    ExtractAnimatableValueTypes<TemplateSpecType[Key<Key>]>,
                >
                : never
    )[];
    autostop?: boolean;
    delay?: number;
    duration: number;
    repeat?: number;
    repeatDelay?: number;
    repeatOffset?: number;
    stopDelay?: number;
    stopDuration?: number;
    stopMethod?: StopMethod;
}

Type Parameters

Properties

actions autostop? delay? duration repeat? repeatDelay? repeatOffset? stopDelay? stopDuration? stopMethod?

Properties

actions

actions: (
    Key extends AnimationForceLiteral
        ? Lightning.types.AnimationActionSettings.Literal<
            Key<Key>,
            AnimationForceType<Key<Key>>,
        >
        : Key extends keyof TemplateSpecType
            ? Lightning.types.AnimationActionSettings.Literal<
                Key<Key>,
                ExtractAnimatableValueTypes<TemplateSpecType[Key<Key>]>,
            >
            : never
)[]

Animation Actions

Remarks

Each member of this array defines how a particular property will animate during the animation's duration. Any number of properties may be animated at the same time.

Default Value

[]

Optionalautostop

autostop?: boolean

Automatic Stop

Remarks

If true, after the animation is finished, it is automatically stopped.

Default Value

false

Optionaldelay

delay?: number

Delay (in seconds)

Remarks

Number of seconds to delay an animation from actually beginning after it's triggered to start.

Default Value

0

duration

duration: number

Duration (in seconds)

Remarks

Number of seconds to run the animation after any delay.

Default Value

1

Optionalrepeat

repeat?: number

Repeat Count

Remarks

Number of times to repeat the animation after it finishes for the first time.

  • -1 = Repeat infinitely
  • 0 = Animate once, but do not repeat
  • >= 1 = Repeat animation this number of times

Default Value

0

OptionalrepeatDelay

repeatDelay?: number

Repeat Delay (in seconds)

Remarks

Number of seconds to delay every repeat of an animation.

Default Value

0

OptionalrepeatOffset

repeatOffset?: number

Repeat Offset

Remarks

A progress value between 0 and 1.0 where the animation will restart before each repeat.

Default Value

0

OptionalstopDelay

stopDelay?: number

Stop Delay

Remarks

Delay in seconds before stopping.

Default Value

0

OptionalstopDuration

stopDuration?: number

Stop Duration

Remarks

Duration in seconds of stopping

Default Value

0 (use duration)

OptionalstopMethod

stopMethod?: StopMethod

Stop Method

Remarks

Method that defines the behavior of the animation when it is stopped.

Default Value

fade

See

AnimationSettings.STOP_METHODS

Settings

Member Visibility

On This Page

Properties