calcite_scrim: Create a Calcite Scrim Component

In calcite: Bindings to the Calcite Design System 'JavaScript' Component Library

Create a Calcite Scrim Component

Description

Scrims are an overlay placed on top of content to show disabled or loading states. By default, Scrim positions to the extent of its closest parent. To display a Scrim with custom positioning, add position: relative styling to its closest parent container.

Usage

calcite_scrim(..., id = NULL, loading = FALSE)

Arguments

...	Main content for the scrim (default slot — primarily loading information)
id	Component ID (required for Shiny reactivity)
loading	When TRUE, a busy indicator is displayed in the center. Default: FALSE.

Details

Shiny Integration

When given an id, the scrim reports its state as input$id — a named list:

• ⁠$loading⁠ — logical, whether the loading indicator is shown

Use update_calcite(id, loading = TRUE/FALSE) to toggle the loading state from the server.

Positioning

Scrim fills its closest positioned parent. Wrap the area you want to cover in a container with position: relative so the scrim covers the right region.

Value

An object of class calcite_component which is a subclass of shiny.tag

References

Official Documentation

Examples

calcite_scrim(id = "my_scrim", loading = TRUE)

calcite documentation built on March 3, 2026, 5:07 p.m.