Skip to main content

Function: bracket()

bracket(options?: object): ElementDecorator

Decorates an element with a grouping bracket (curly brace, square bracket, or corner frame).

Parameters​

ParameterTypeDescription
options{ className?: string; color?: string; dashed?: boolean; depth?: number; dotted?: boolean; glow?: string | boolean; label?: string; offset?: number; radius?: number; side?: "top" | "left" | "right" | "bottom"; strokeWidth?: number; style?: BracketStyle; }-
options.className?stringAdditional CSS class name.
options.color?stringSolid stroke color (default: "rgba(255, 255, 255, 0.25)").
options.dashed?booleanDashed stroke pattern.
options.depth?numberBracket depth / breadth in pixels (default: 16).
options.dotted?booleanDotted stroke pattern.
options.glow?string | booleanWhether the bracket emits a neon bloom glow (default: false).
options.label?stringOptional label text placed at the bracket apex/center.
options.offset?numberSpacing distance between element border and bracket in pixels (default: 8).
options.radius?numberCorner radius / curvature in pixels (default: 8).
options.side?"top" | "left" | "right" | "bottom"Which side the bracket sits on ("left"
options.strokeWidth?numberBracket stroke thickness in pixels (default: 1.5).
options.style?BracketStyleBracket style: "curly" (default), "square", "round", or "corners".

Returns​

ElementDecorator