Fluent-Qt

Status & info

Shimmer

Shows a skeleton placeholder while content is loading.

Example

Shimmer: Built-in templates

Usage

Built-in templates

Built-in templates cover image cards, avatar rows, and text blocks.

#include <FluentQt/StatusInfo.h>
using namespace fluent::status_info;

auto* image = new Shimmer(this);
image->setShimmerTemplate(Shimmer::ShimmerTemplate::ImageCard);
image->setFixedSize(160, 92);

auto* row = new Shimmer(this);
row->setShimmerTemplate(Shimmer::ShimmerTemplate::AvatarTextRow);
row->setFixedSize(180, 56);

auto* text = new Shimmer(this);
text->setShimmerTemplate(Shimmer::ShimmerTemplate::TextBlock);
text->setFixedSize(220, 72);

fluent::status_info::Shimmer

Inherits QWidget · FluentElement · QMLPlus

Fluent skeleton loading placeholder with animated shimmer.

Constructors

Properties

bool active

Whether the loading skeleton is active.

Read isActive()Write setActive()Notify activeChanged()
bool animationEnabled

Whether shimmer motion is enabled.

Read isAnimationEnabled()Write setAnimationEnabled()Notify animationEnabledChanged()
qreal shimmerProgress

Current normalized shimmer animation progress.

Read shimmerProgress()Write setShimmerProgress()Notify shimmerProgressChanged()
int cycleDuration

Full shimmer cycle duration in milliseconds.

Read cycleDuration()Write setCycleDuration()Notify cycleDurationChanged()
ShimmerTemplate shimmerTemplate

Built-in element template used when custom elements are not supplied.

Read shimmerTemplate()Write setShimmerTemplate()Notify shimmerTemplateChanged()

Methods

bool isActive() const

Whether the loading skeleton is active.

void setActive(bool active)

Whether the loading skeleton is active.

bool isAnimationEnabled() const

Whether shimmer motion is enabled.

void setAnimationEnabled(bool enabled)

Whether shimmer motion is enabled.

qreal shimmerProgress() const

Current normalized shimmer animation progress.

void setShimmerProgress(qreal progress)

Current normalized shimmer animation progress.

int cycleDuration() const

Full shimmer cycle duration in milliseconds.

void setCycleDuration(int durationMs)

Full shimmer cycle duration in milliseconds.

ShimmerTemplate shimmerTemplate() const

Built-in element template used when custom elements are not supplied.

void setShimmerTemplate(ShimmerTemplate templateKind)

Built-in element template used when custom elements are not supplied.

Signals

void activeChanged(bool active)

Whether the loading skeleton is active.

void animationEnabledChanged(bool enabled)

Whether shimmer motion is enabled.

void shimmerProgressChanged(qreal progress)

Current normalized shimmer animation progress.

void cycleDurationChanged(int durationMs)

Full shimmer cycle duration in milliseconds.

void shimmerTemplateChanged(ShimmerTemplate templateKind)

Built-in element template used when custom elements are not supplied.

Enumerations

enum class ShimmerTemplate
  • Custom
  • ImageCard
  • AvatarTextRow
  • TextBlock

Destructors

Subclass interfaces

Methods

Inherited from fluent::FluentElement

Methods

static void setTheme(Theme theme)

Updates the global theme and notifies active FluentElement instances.

static void setThemeDeferred(Theme theme)

Schedules a visible-first batched theme refresh without blocking the current interaction.

static Theme currentTheme()

Returns the currently active global theme.

static bool themeUsesDarkAppearance(Theme theme)

Returns whether a theme uses dark-backed chrome and material tokens.

static void refreshTheme()

Re-broadcasts the current theme to repaint after a design-token change.

static int themeGeneration()

Monotonic counter bumped on every theme change, for staleness checks.

Theme effectiveTheme() const

Resolves the theme used by this element, honoring an inherited QWidget override.

bool effectiveThemeUsesDarkAppearance() const

Returns whether this element's effective theme uses dark-backed chrome.

QJsonObject themeOverrides() const

Returns this element's authored overrides.

void clearThemeOverrides()

Restores all token fields to global theme defaults.

const Colors& themeColorsRef() const

Non-copying access to the active color set (for hot paint paths).

Material::AcrylicToken themeAcrylic() const

Material, elevation, and adaptive layout tokens.

QColor themeBackdrop(bool active) const

Window-chrome backdrop color for the given activation state.

virtual void onThemeUpdated()

Called after the global theme changes.

Enumerations

enum Theme

Global visual theme used when resolving design tokens.

  • Light = 0
  • Dark = 1
  • HighContrast = 2

Types and aliases

struct Colors

Design token snapshots returned to components.

Inherited from fluent::QMLPlus

Methods

AnchorLayout::Anchors* anchors()

Returns mutable anchors for the QWidget host.

void setState(const QString& name)

Applies a named state, or clears state when name is empty.

void addState(const QMLState& state)

Registers or replaces a named state definition.

void evaluateStates()

Reevaluates conditions; the first registered true condition wins.

QMLPlusRuntime* runtime()

Returns the lazy host-owned state observation object.

void setAnchors(const AnchorLayout::Anchors& anchors)

Replaces all host anchors and invalidates the parent layout.

void resetAnchors()

Clears all host anchors and invalidates the parent layout.

void addTransition(const StateTransition& transition)

Registers a state transition in precedence order.

void setBehavior(const char* propertyName, const PropertyAnimation& animation)

Sets the default animation for this host's managed property writes.

void clearBehavior(const char* propertyName)

Removes the default animation for future managed writes.

bool writeProperty(const char* propertyName, const QVariant& value)

Writes a host property through Behavior without removing its binding.

All inherited Qt members:QWidget

fluent::status_info::ShimmerPainter

Painter helper for Fluent skeleton loading visuals.

Methods

static QVector<Element> avatarTextRowElements(const QRectF& bounds)

Skeleton template for an avatar plus text row.

Enumerations

enum class Shape

Shape used by a skeleton element.

  • Rectangle
  • RoundedRect
  • Circle
  • Line

Types and aliases

struct Palette

Theme-resolved colors used by shimmer painting.

struct Element

One skeleton shape in local target coordinates.

fluent::status_info::ShimmerPainter::Palette

Theme-resolved colors used by shimmer painting.

Fields

fluent::status_info::ShimmerPainter::Element

One skeleton shape in local target coordinates.

Constructors

Fields