Header menu logo fable-electron-docs-api

GetAnimationSettings Type

Constructors

Constructor Description

GetAnimationSettings(shouldRenderRichAnimation, scrollAnimationsEnabledBySystem, prefersReducedMotion)

Full Usage: GetAnimationSettings(shouldRenderRichAnimation, scrollAnimationsEnabledBySystem, prefersReducedMotion)

Parameters:
    shouldRenderRichAnimation : bool - Returns true if rich animations should be rendered. Looks at session type (e.g. remote desktop) and accessibility settings to give guidance for heavy animations.
    scrollAnimationsEnabledBySystem : bool - Determines on a per-platform basis whether scroll animations (e.g. produced by home/end key) should be enabled.
    prefersReducedMotion : bool - Determines whether the user desires reduced motion based on platform APIs.

Returns: GetAnimationSettings
shouldRenderRichAnimation : bool

Returns true if rich animations should be rendered. Looks at session type (e.g. remote desktop) and accessibility settings to give guidance for heavy animations.

scrollAnimationsEnabledBySystem : bool

Determines on a per-platform basis whether scroll animations (e.g. produced by home/end key) should be enabled.

prefersReducedMotion : bool

Determines whether the user desires reduced motion based on platform APIs.

Returns: GetAnimationSettings

Instance members

Instance member Description

this.prefersReducedMotion

Full Usage: this.prefersReducedMotion

Determines whether the user desires reduced motion based on platform APIs.

this.scrollAnimationsEnabledBySystem

Full Usage: this.scrollAnimationsEnabledBySystem

Determines on a per-platform basis whether scroll animations (e.g. produced by home/end key) should be enabled.

this.shouldRenderRichAnimation

Full Usage: this.shouldRenderRichAnimation

Returns true if rich animations should be rendered. Looks at session type (e.g. remote desktop) and accessibility settings to give guidance for heavy animations.

Type something to start searching.