API Referenceinterface

interface RenderEffect

An interface for render effects that can be applied to UI elements.

interface RenderEffect<TElement = unknown>;

Notes

• Effects respond to lifecycle changes: element created (but not inserted), element rendered, view unlinked.
• Register effects using RenderEffect.register and apply them using UIElement.ElementBuilder.effect.

Type members

• type RenderEffect.EffectName static
  Type definition for a set of default effect names.

Static members

• function register() static
  Registers a render effect with the specified name.
• function clear() static
  Clears all registered effects.
• function has() static
  Returns true if an effect with the specified name is registered.
• function create() static
  Returns a builder modifier function that applies a render effect to a UI element.

Instance members

• onElementCreated()
  Called when the element is created (but not inserted).
• onRendered()
  Called when the element has been rendered (inserted).
• onUnlinked()
  Called when the view is unlinked (for exit animations).