2.0 alpha
These docs describe 2.0. Install it with @once-ui-system/core@alpha.
On 1.8.x? Read the 1.x docs
TrademarkTrademarkDocs
Ctrl k
Search docs...
Effects

ShineFx

Updated: October 14, 2025
View on GitHub
ShineFx creates a smooth, animated shine effect that sweeps across text. The effect uses a gradient that moves horizontally, creating a shimmering appearance ideal for drawing attention to important text. Adjust the animation speed with the speed (milliseconds) prop. Higher values create slower animations, while lower values make the shine effect faster. Use the inverse prop to invert the shine effect. Control the base text visibility with the baseOpacity prop (0-1). Higher values improve readability and accessibility, while lower values create a more subtle effect. Disable the animation with the disabled prop to show static text without the shine effect. ShineFx works with all Text component variants and styling props. ShineFx automatically detects low-end devices and the prefers-reduced-motion system setting. When either is detected, the shine animation is disabled (equivalent to disabled={true}). You can override this with the reducedMotion prop. See useReducedMotion for details.
Prop
Type
Default
speed
How long one pass takes, in milliseconds. This was seconds before 2.0.
number1000
disabled
Stop the shine.
booleanfalse
inverse
Run it the other way.
booleanfalse
baseOpacity
Opacity of the content the shine passes over.
number0.3
reducedMotion
"auto" follows the reader's system setting, which is the right default for anything ambient.
booleanauto
auto
children
React.ReactNode
…and every FlexProps propinherited
…and every TextProps propinherited
Edit this page on GitHub
TrademarkTrademark
Built with curiosity by Lorant One and the Design Engineers Club