Skip to content

Effects

An Effects object holds shadow and blur definitions. It appears on the effects style property as an alternative to a TokenReference.

interface Effects {
shadows?: Shadow[];
layerBlur?: Blur;
backgroundBlur?: Blur;
}

Properties

NameCategoryDescription
shadowsshadowArray of drop and inner shadow definitions
layerBlurblurLayer blur (filter: blur())
backgroundBlurblurBackground blur (backdrop-filter: blur())

Values

NameDescriptionExample
ShadowA single shadow definition{ visible: true, offsetX: 0, offsetY: 2, blur: 4, spread: 0, color: "#00000040" }
BlurA blur definition{ visible: true, radius: 8 }

Shadow

PropertyTypeRequiredDescription
visiblebooleanYesWhether the shadow is active
insetbooleanNotrue for inner shadow; absent or false for drop shadow
offsetXnumber | TokenReferenceYesHorizontal offset
offsetYnumber | TokenReferenceYesVertical offset
blurnumber | TokenReferenceYesBlur radius
spreadnumber | TokenReferenceYesSpread distance
colorstring | TokenReferenceYesShadow color (#RRGGBBAA or token)

Blur

PropertyTypeRequiredDescription
visiblebooleanYesWhether the blur is active
radiusnumber | TokenReferenceYesBlur radius

Example

shadows:
- visible: true
offsetX: 0
offsetY: 4
blur: 8
spread: 0
color:
$token: DS Color.Shadow.Default
$type: color
- visible: true
inset: true
offsetX: 0
offsetY: 1
blur: 0
spread: 1
color: "#0000001A"
backgroundBlur:
visible: true
radius: 12

Further Reading