For AI agents: the complete documentation index is available at https://rickyshin93.github.io/tao-ui/llms.txt, the full documentation bundle is available at https://rickyshin93.github.io/tao-ui/llms-full.txt, and this page is available as Markdown at https://rickyshin93.github.io/tao-ui/components/border-beam.md.
v0.0.57
  • English
  • BorderBeam

    General@rockshin/tao-ui

    Highlights an active surface with a moving border light.

    This native tao-ui component follows the public API of Ant Design 6.7.0. Appearance, theme tokens and Semantic DOM customization belong to tao-ui; configure themes with TaoProvider.

    Props follow the 6.7.0 beam API. The child must expose a native DOM ref or nativeElement handle. Motion uses transform and respects reduced-motion preferences.

    When to use

    Use sparingly for a meaningful active or processing state. Keep an explicit text status alongside the effect.

    Examples

    Active card

    Processing
    12 tasks are running.
    TSX

    Count and duration

    Two beams
    Two highlights follow the same border with evenly spaced phases.
    TSX

    Custom gradient and item overrides

    Independent beams
    Each item controls its own color, size and line width.
    TSX

    Inset and nonuniform corners

    Activity stream
    The effect follows the top rounded corners and the square bottom corners.
    TSX

    Toggle a meaningful active state

    Syncing changes
    The border animation follows the current state.
    TSX

    API

    BorderBeam

    PropertyDescriptionTypeDefault Value
    classNameAdditional css classstring | undefined-
    styleAdditional styleCSSProperties | undefined-