IScrimProps
interface
Overlay & Feedback
Minimal prop mixin that adds a backdrop/scrim control to overlay components. A boolean true shows the default semi-transparent backdrop; a string value is treated as a CSS color override for the scrim surface.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- scrimboolean | string
- Controls the backdrop behind the overlay. Pass true for the default semi-transparent scrim, false/undefined to disable, or a CSS color string to override the scrim color.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Extending IScrimProps on a custom overlay