AmbientGlowDecorator

Decorates content with a contained accent bloom and a traveling border highlight.

Type

public sealed class AmbientGlowDecorator : ContentControl

Namespace: RoyalApps.Community.Avalonia.Common.Controls

View source

Remarks

Use transparent child backgrounds to reveal the interior glow. Content is not clipped to the rounded corners, but is clipped to the control's rectangular bounds by default. Set Avalonia.Visual.ClipToBounds to false to allow content overflow.

Properties

AmbientColor (Color)

Gets or sets the fallback color for both themes. Semantic classes or the default theme supply it unless explicitly set.

AmbientColorDark (Color?)

Gets or sets the dark-theme override. Null derives from AmbientGlowDecorator.AmbientColorLight, or falls back to AmbientGlowDecorator.AmbientColor.

AmbientColorLight (Color?)

Gets or sets the light-theme override. When the dark override is absent, its dark variant blends 25% toward white, preserving alpha.

CycleDuration (TimeSpan)

Gets or sets the positive duration of one clockwise revolution. Defaults to nine seconds.

EffectiveAmbientColor (Color)

Gets the color used by the effect in the current theme. Bind accompanying tints to this property.

GlowGradientStops (GradientStops?)

Gets or sets custom stops for the broad rotating conic glow. Null or empty uses the generated gradient.

Uses the same offset and update rules as AmbientGlowDecorator.HighlightGradientStops. Does not change the interior bloom.

GlowOpacity (double)

Gets or sets the bloom and broad glow intensity from zero to one, without dimming the sharp highlight.

HighlightGradientStops (GradientStops?)

Gets or sets custom stops for the thin rotating conic highlight. Null or empty uses the generated gradient.

One stop gives a uniform color. Changes to collections and stops update attached controls. Finite offsets are clamped to zero through one and stably sorted; nonfinite offsets are ignored. Custom colors are used without theme adjustment.

HighlightOpacity (double)

Gets or sets thin highlight opacity from zero to one. Defaults to one; does not dim the broad glow or interior bloom.

HighlightThickness (double)

Gets or sets the positive, finite highlight width in device-independent pixels. Defaults to 0.5.

InvertBorderGradient (bool)

Gets or sets whether generated border gradients swap base and highlight colors. Defaults to false.

Does not alter custom stops, interior bloom, animation direction, or phase.

IsAnimationEnabled (bool)

Gets or sets local motion permission, also gated by AmbientGlowDecorator.IsMotionAllowed.

IsMotionAllowed (bool)

Gets or sets host motion permission, independently of local animation permission. Defaults to true.

Methods

Constructor()

Creates a decoration whose theme supplies the default visual composition.

Fields

AmbientColorDarkProperty (StyledProperty<Color?>)

Identifies AmbientGlowDecorator.AmbientColorDark.

AmbientColorLightProperty (StyledProperty<Color?>)

Identifies AmbientGlowDecorator.AmbientColorLight.

AmbientColorProperty (StyledProperty<Color>)

Identifies AmbientGlowDecorator.AmbientColor.

CycleDurationProperty (StyledProperty<TimeSpan>)

Identifies AmbientGlowDecorator.CycleDuration.

EffectiveAmbientColorProperty (DirectProperty<AmbientGlowDecorator, Color>)

Identifies the read-only AmbientGlowDecorator.EffectiveAmbientColor property.

GlowGradientStopsProperty (StyledProperty<GradientStops?>)

Identifies AmbientGlowDecorator.GlowGradientStops.

GlowOpacityProperty (StyledProperty<double>)

Identifies AmbientGlowDecorator.GlowOpacity.

HighlightGradientStopsProperty (StyledProperty<GradientStops?>)

Identifies AmbientGlowDecorator.HighlightGradientStops.

HighlightOpacityProperty (StyledProperty<double>)

Identifies AmbientGlowDecorator.HighlightOpacity.

HighlightThicknessProperty (StyledProperty<double>)

Identifies AmbientGlowDecorator.HighlightThickness.

InvertBorderGradientProperty (StyledProperty<bool>)

Identifies AmbientGlowDecorator.InvertBorderGradient.

IsAnimationEnabledProperty (StyledProperty<bool>)

Identifies AmbientGlowDecorator.IsAnimationEnabled.

IsMotionAllowedProperty (StyledProperty<bool>)

Identifies AmbientGlowDecorator.IsMotionAllowed.

Back to API index