Interface IPlayer

This property allows you to discover customizable colors or update them within a processed icon.

Example (list all supported colors by the icon):

{ ...iconElement.playerInstance.colors }
Copy

Example (update a single color):

iconElement.playerInstance.colors.primary = '#ff0000';
Copy

Example (update multiple colors at once):

iconElement.playerInstance.colors = { primary: 'red', secondary: 'blue' };
Copy

Example (reset all colors to default):

iconElement.playerInstance.colors = null;
Copy

The 'direction' property lets you influence the direction of the animation playback, whether it plays forward (1) or in reverse (-1).

The 'duration' property provides the value of the animation length in seconds.

Access the player frame. You can manually control the animation playback by changing this frame.

The 'frames' property provides the value of the animation length in terms of the number of frames.

The player is currently playing the animation.

The player is ready.

This property allows you to control whether the player should loop the animation.

Access to read or modify multiple properties at once. Resets to default any properties that are not provided.

Param

Properties to assign.

This property allows you to control the speed of the icon animation.

This property allows you to control the state (motion type) of the icon. States enable switching between multiple animations built into a single icon file.

The 'states' property provides a list of supported states by a processed icon.

The 'stroke' property gives you the value of the icon's stroke width.