Skip to main content

Function: shine()

shine(options?: object): ShineEffect

Creates one reflection shared by all elements decorated with it.

Parameters​

ParameterTypeDescription
options{ angle?: number; color?: string; highlight?: string; intensity?: number; progress?: number; surface?: "fill" | "auto" | "outline"; width?: number; }-
options.angle?numberTravel direction in degrees; 0 goes right, positive goes clockwise. Default: -20.
options.color?stringCSS shoulder colour. Default: the stage theme's secondary colour.
options.highlight?stringCSS core colour. Default: a lighter version of color.
options.intensity?numberNonnegative strength multiplier. Default: 1.
options.progress?numberSweep fraction from 0 to 1. Both endpoints are clear. Default: 0.
options.surface?"fill" | "auto" | "outline"Receiving surface. Auto uses outlines for ghost shapes and fills otherwise. Default: "auto".
options.width?numberBand width as a fraction of the receivers' projected span. Default: 0.22.

Returns​

ShineEffect