ISkeletonProps
interface
Component Props
Props contract for <OrigamSkeleton> — a loading-state placeholder with configurable shape (variant, width, height, rounded), color, and animation (pulse).
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- variantTSkeletonVariant
- Shape preset for the skeleton placeholder (e.g. text, avatar, card, button).
- widthstring | number
- Explicit width of the skeleton block. Accepts px numbers or any CSS length string.
- loadingboolean
- When false the default slot is revealed instead of the skeleton. Drives a loading-gate pattern.
- animationTSkeletonAnimation
- heightstring | number
- Explicit height of the skeleton block. Accepts px numbers or any CSS length string.
- labelstring
- pulseboolean
- Enables the pulsing animation on the skeleton surface.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Avatar skeleton with pulse