Skip to content

@phun-ky/arclace / ArcOptionsType

Type Alias: ArcOptionsType ​

ArcOptionsType = object

Defined in: src/types.ts:161

Options for a Arclace instance.

Properties ​

autoUpdate? ​

optional autoUpdate?: boolean | "frame"

Defined in: src/types.ts:177

Keep lines in sync with the page.

  • true: redraw on window resize, scroll, element resize and DOM or style changes inside the container (default)
  • 'frame': redraw on every animation frame, for CSS animations and transitions
  • false: only redraw when you call update()

className? ​

optional className?: string

Defined in: src/types.ts:187

Extra class names added to the SVG overlay.


container? ​

optional container?: ArcElementTargetType

Defined in: src/types.ts:166

The element the SVG overlay is added to. All connected elements should be inside it. Defaults to document.body.


defaults? ​

optional defaults?: ArcConnectionOptionsType

Defined in: src/types.ts:182

Default options for every connection made by this instance.

Released under the MIT License.