webchalk-animate - v0.31.0
    Preparing search index...

    An object containing details about how the DOM element is modified beyond just the effect of the animation (such as modifying CSS classes). Returned by AnimClip.getModifiers.

    interface AnimClipModifiers {
        commitsStyles: boolean;
        composite: CompositeOperation;
        cssClasses: Partial<CssClassOptions>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    commitsStyles: boolean

    Determines whether the effects of the animation will persist after the clip finishes.

    • If false, the effects of the animation will not persist after the clip finishes.
    • If true, the effects will attempt to be committed. If the element is not rendered by the time the clip finishes because of the CSS class "webchalk-display-none", the clip will try to forcefully apply the styles by instantly unhiding the element, committing the animation styles, then re-hiding the element (necessary because JavaScript does not allow animation results to be saved to unrendered elements).
      • If the element is unrendered for any reason other than having the "webchalk-display-none" class by the time the clip finishes, then this will fail, and an error will be thrown.
    composite: CompositeOperation

    Resolves how the element's animation impacts the element's underlying property values.

    An object containing arrays of CSS classes that should be added to or removed from the element.

    • The array of classes to add is added first, and then the array of classes to remove is removed.
    • Changes are automatically undone in the appropriate order when the clip is rewound.