Class TurboSelector<Type>

Type Parameters

Type extends Node = Node

Hierarchy

Node
- TurboSelector

Index

Constructors

Properties

boundListeners bypassManagerOn childHandler childNodesArray childrenArray siblingNodes siblings reifects showTransition isShown closestRoot currentSubstrate onSubstrateChange element

Methods

addClass removeClass toggleClass hasClass setProperties setMvc destroy setAttribute removeAttribute blur focus on onTool executeAction hasListener hasToolListener hasListenersByType removeListener removeToolListener removeListenersByType removeAllListeners preventDefault bringToFront sendToBack remove addToParent addChild remChild addChildBefore removeChildAt removeAllChildren childAt indexOfChild hasChild findInSubTree findInParents indexInParent closest execute show setStyle appendStyle setStyles makeSubstrate getSubstrates getSubstrateObjectList setSubstrateObjectList addObjectToSubstrate removeObjectFromSubstrate hasObjectInSubstrate wasObjectProcessedBySubstrate setSubstrate onSubstrateActivate onSubstrateDeactivate addSolver removeSolver clearSolvers resolveSubstrate makeTool isTool getToolNames getToolName onToolActivate onToolDeactivate addToolBehavior hasToolBehavior removeToolBehaviors applyTool clearToolBehaviors embedTool isEmbeddedTool getEmbeddedToolTarget ignoreTool isToolIgnored

Constructors

constructor

new TurboSelector<Type extends Node = Node>(): TurboSelector<Type>
Type Parameters
- Type extends Node = Node
Returns TurboSelector<Type>
- Defined in src/turboFunctions/turboSelector.ts:4

Properties

`Readonly`boundListeners

boundListeners: Set<ListenerEntry>

Description

Readonly set of listeners bound to this node.

bypassManagerOn

bypassManagerOn: (e: Event) => boolean | TurboEventManagerStateProperties

Type Declaration

- (e: Event): boolean | TurboEventManagerStateProperties
- Parameters
  - e: Event
    The event.
  Returns boolean | TurboEventManagerStateProperties

Description

If you want the element to bypass the event manager and allow native events to seep through, you can set this field to a predicate that defines when to bypass the manager.

childHandler

childHandler: ChildHandler

Description

The child handler object associated with the node. It is the node itself (if it is handling its children) or its shadow root (if defined). Set it to change the node where the children are added/ removed/queried from when manipulating the node's children.

`Readonly`childNodesArray

childNodesArray: Node[]

Description

Static array of all the child nodes of the node.

`Readonly`childrenArray

childrenArray: Element[]

Description

Static array of all the child elements of the node.

`Readonly`siblingNodes

siblingNodes: Node[]

Description

Static array of all the sibling nodes (including the node itself) of the node.

`Readonly`siblings

siblings: Element[]

Description

Static array of all the sibling elements (including the element itself, if it is one) of the node.

`Readonly`reifects

reifects: ReifectHandler

Description

Handler for all Reifects attached to this element.

showTransition

showTransition: StatefulReifect<Shown>

Description

The transition used by the element's show() and isShown methods. Directly modifying its value will modify all elements' default showTransition. Unless this is the desired outcome, set it to a new custom StatefulReifect.

`Readonly`isShown

isShown: boolean

Description

Boolean indicating whether the element is shown or not, based on its showTransition.

`Readonly`closestRoot

closestRoot: StylesRoot

Description

The closest root to the element in the document (the closest ShadowRoot, or the document's head).

currentSubstrate

currentSubstrate: string

`Readonly`onSubstrateChange

onSubstrateChange: Delegate<(prev: string, next: string) => void>

element

element: Type

Methods

addClass

addClass(classes?: string | string[]): this
Parameters
- Optionalclasses: string | string[]
  String of classes separated by spaces, or array of strings.
Returns this
Itself, allowing for method chaining.

Description
Add one or more CSS classes to the element.
- Defined in src/turboFunctions/class/class.types.ts:8

removeClass

removeClass(classes?: string | string[]): this
Parameters
- Optionalclasses: string | string[]
  String of classes separated by spaces, or array of strings.
Returns this
Itself, allowing for method chaining.

Description
Remove one or more CSS classes from the element.
- Defined in src/turboFunctions/class/class.types.ts:15

toggleClass

toggleClass(classes?: string | string[], force?: boolean): this
Parameters
- Optionalclasses: string | string[]
  String of classes separated by spaces, or array of strings.
- Optionalforce: boolean
  (Optional) Boolean that turns the toggle into a one way-only operation. If set to false, then the class will only be removed, but not added. If set to true, then token will only be added, but not removed.
Returns this
Itself, allowing for method chaining.

Description
Toggle one or more CSS classes in the element.
- Defined in src/turboFunctions/class/class.types.ts:24

hasClass

hasClass(classes?: string | string[]): boolean
Parameters
- Optionalclasses: string | string[]
  String of classes separated by spaces, or array of strings
Returns boolean
A boolean indicating whether the provided classes are included

Description
Check if the element's class list contains the provided class(es).
- Defined in src/turboFunctions/class/class.types.ts:31

setProperties

setProperties<
    Tag extends
        | "symbol"
        | "filter"
        | "set"
        | "animate"
        | "animateMotion"
        | "animateTransform"
        | "circle"
        | "clipPath"
        | "defs"
        | "desc"
        | "ellipse"
        | "feBlend"
        | "feColorMatrix"
        | "feComponentTransfer"
        | "feComposite"
        | "feConvolveMatrix"
        | "feDiffuseLighting"
        | "feDisplacementMap"
        | "feDistantLight"
        | "feDropShadow"
        | "feFlood"
        | "feFuncA"
        | "feFuncB"
        | "feFuncG"
        | "feFuncR"
        | "feGaussianBlur"
        | "feImage"
        | "feMerge"
        | "feMergeNode"
        | "feMorphology"
        | "feOffset"
        | "fePointLight"
        | "feSpecularLighting"
        | "feSpotLight"
        | "feTile"
        | "feTurbulence"
        | "foreignObject"
        | "g"
        | "image"
        | "line"
        | "linearGradient"
        | "marker"
        | "mask"
        | "metadata"
        | "mpath"
        | "path"
        | "pattern"
        | "polygon"
        | "polyline"
        | "radialGradient"
        | "rect"
        | "stop"
        | "svg"
        | "switch"
        | "text"
        | "textPath"
        | "tspan"
        | "use"
        | "view"
        | (keyof HTMLElementTagNameMap)
        | (keyof MathMLElementTagNameMap)
        | (keyof TurboElementTagNameMap),
>(
    properties: TurboProperties<Tag>,
    setOnlyBaseProperties?: boolean,
): this
Sets the declared properties to the element.
Type Parameters
- Tag extends
      | "symbol"
      | "filter"
      | "set"
      | "animate"
      | "animateMotion"
      | "animateTransform"
      | "circle"
      | "clipPath"
      | "defs"
      | "desc"
      | "ellipse"
      | "feBlend"
      | "feColorMatrix"
      | "feComponentTransfer"
      | "feComposite"
      | "feConvolveMatrix"
      | "feDiffuseLighting"
      | "feDisplacementMap"
      | "feDistantLight"
      | "feDropShadow"
      | "feFlood"
      | "feFuncA"
      | "feFuncB"
      | "feFuncG"
      | "feFuncR"
      | "feGaussianBlur"
      | "feImage"
      | "feMerge"
      | "feMergeNode"
      | "feMorphology"
      | "feOffset"
      | "fePointLight"
      | "feSpecularLighting"
      | "feSpotLight"
      | "feTile"
      | "feTurbulence"
      | "foreignObject"
      | "g"
      | "image"
      | "line"
      | "linearGradient"
      | "marker"
      | "mask"
      | "metadata"
      | "mpath"
      | "path"
      | "pattern"
      | "polygon"
      | "polyline"
      | "radialGradient"
      | "rect"
      | "stop"
      | "svg"
      | "switch"
      | "text"
      | "textPath"
      | "tspan"
      | "use"
      | "view"
      | (keyof HTMLElementTagNameMap)
      | (keyof MathMLElementTagNameMap)
      | (keyof TurboElementTagNameMap)
Parameters
- properties: TurboProperties<Tag>
  The properties object.
- OptionalsetOnlyBaseProperties: boolean
  If set to true, will only set the base turbo properties (classes, text, style, id, children, parent, etc.) and ignore all other properties not explicitly defined in TurboProperties.
Returns this
Itself, allowing for method chaining.
- Defined in src/turboFunctions/element/element.types.ts:109

setMvc

setMvc(properties: MvcGenerationProperties): this
Parameters
- properties: MvcGenerationProperties
Returns this
- Defined in src/turboFunctions/element/element.types.ts:111

destroy

destroy(): this
Returns this
Itself, allowing for method chaining.

Description
Destroys the node by removing it from the document and removing all its bound listeners.
- Defined in src/turboFunctions/element/element.types.ts:117

setAttribute

setAttribute(name: string, value?: string | number | boolean): this
Parameters
- name: string
  The name of the attribute.
- Optionalvalue: string | number | boolean
  The value of the attribute. Can be left blank to represent a true boolean.
Returns this
Itself, allowing for method chaining.

Description
Sets the value of an attribute on the underlying element.
- Defined in src/turboFunctions/element/element.types.ts:126

removeAttribute

removeAttribute(name: string): this
Parameters
- name: string
  The name of the attribute to remove.
Returns this
Itself, allowing for method chaining.

Description
Removes an attribute from the underlying element.
- Defined in src/turboFunctions/element/element.types.ts:133

blur

blur(): this
Returns this
Itself, allowing for method chaining.

Description
Causes the element to lose focus.
- Defined in src/turboFunctions/element/element.types.ts:139

focus

focus(): this
Returns this
Itself, allowing for method chaining.

Description
Sets focus on the element.
- Defined in src/turboFunctions/element/element.types.ts:145

on

on<Type extends Node>(
    type: string,
    listener: (e: Event, el: Type) => boolean | void,
    options?: AddEventListenerOptions,
    manager?: TurboEventManager,
): this
Type Parameters
- Type extends Node
Parameters
- type: string
  The type of the event.
- listener: (e: Event, el: Type) => boolean | void
  The function that receives a notification.
- Optionaloptions: AddEventListenerOptions
  An options object that specifies characteristics about the event listener.
- Optionalmanager: TurboEventManager
  The associated event manager. Defaults to the first created manager, or a new instantiated one if none already exist.
Returns this
Itself, allowing for method chaining.

Description
Adds an event listener to the element.
- Defined in src/turboFunctions/event/event.types.ts:61

onTool

onTool<Type extends Node>(
    type: string,
    toolName: string,
    listener: (e: Event, el: Type) => boolean | void,
    options?: AddEventListenerOptions,
    manager?: TurboEventManager,
): this
Type Parameters
- Type extends Node
Parameters
- type: string
  The type of the event.
- toolName: string
  The name of the tool. Set to null or undefined to check for listeners not bound to a tool.
- listener: (e: Event, el: Type) => boolean | void
  The function that receives a notification.
- Optionaloptions: AddEventListenerOptions
  An options object that specifies characteristics about the event listener.
- Optionalmanager: TurboEventManager
  The associated event manager. Defaults to the first created manager, or a new instantiated one if none already exist.
Returns this
Itself, allowing for method chaining.

Description
Adds an event listener to the element.
- Defined in src/turboFunctions/event/event.types.ts:75

executeAction

executeAction(
    type: string,
    toolName: string,
    event: Event,
    options?: AddEventListenerOptions,
    manager?: TurboEventManager,
): boolean
Parameters
- type: string
- toolName: string
- event: Event
- Optionaloptions: AddEventListenerOptions
- Optionalmanager: TurboEventManager
Returns boolean
- Defined in src/turboFunctions/event/event.types.ts:79

hasListener

hasListener(
    type: string,
    listener: (e: Event, el: this) => boolean | void,
    manager?: TurboEventManager,
): boolean
Parameters
- type: string
  The type of the event. Set to null or undefined to get all event types.
- listener: (e: Event, el: this) => boolean | void
  The function that receives a notification.
- Optionalmanager: TurboEventManager
  The associated event manager. Defaults to the first created manager, or a new instantiated one if none already exist.
Returns boolean
- Whether the element has the given listener.
Description
Checks if the given event listener is bound to the element (in its boundListeners list).
- Defined in src/turboFunctions/event/event.types.ts:89

hasToolListener

hasToolListener(
    type: string,
    toolName: string,
    listener: (e: Event, el: this) => boolean | void,
    manager?: TurboEventManager,
): boolean
Parameters
- type: string
  The type of the event. Set to null or undefined to get all event types.
- toolName: string
  The name of the tool the listener is attached to. Set to null or undefined to check for listeners not bound to a tool.
- listener: (e: Event, el: this) => boolean | void
  The function that receives a notification.
- Optionalmanager: TurboEventManager
  The associated event manager. Defaults to the first created manager, or a new instantiated one if none already exist.
Returns boolean
- Whether the element has the given listener.
Description
Checks if the given event listener is bound to the element (in its boundListeners list).
- Defined in src/turboFunctions/event/event.types.ts:101

hasListenersByType

hasListenersByType(
    type: string,
    toolName?: string,
    manager?: TurboEventManager,
): boolean
Parameters
- type: string
  The type of the event. Set to null or undefined to get all event types.
- OptionaltoolName: string
  The name of the tool to consider (if any). Set to null or undefined to check for listeners not bound to a tool.
- Optionalmanager: TurboEventManager
  The associated event manager. Defaults to the first created manager, or a new instantiated one if none already exist.
Returns boolean
- Whether the element has the given listener.
Description
Checks if the element has bound listeners of the given type (in its boundListeners list).
- Defined in src/turboFunctions/event/event.types.ts:113

removeListener

removeListener(
    type: string,
    listener: (e: Event, el: this) => boolean | void,
    manager?: TurboEventManager,
): this
Parameters
- type: string
  The type of the event.
- listener: (e: Event, el: this) => boolean | void
  The function that receives a notification.
- Optionalmanager: TurboEventManager
  The associated event manager. Defaults to the first created manager, or a new instantiated one if none already exist.
Returns this
Itself, allowing for method chaining.

Description
Removes an event listener that is bound to the element (in its boundListeners list).
- Defined in src/turboFunctions/event/event.types.ts:123

removeToolListener

removeToolListener(
    type: string,
    toolName: string,
    listener: (e: Event, el: this) => boolean | void,
    manager?: TurboEventManager,
): this
Parameters
- type: string
  The type of the event.
- toolName: string
  The name of the tool the listener is attached to. Set to null or undefined to check for listeners not bound to a tool.
- listener: (e: Event, el: this) => boolean | void
  The function that receives a notification.
- Optionalmanager: TurboEventManager
  The associated event manager. Defaults to the first created manager, or a new instantiated one if none already exist.
Returns this
Itself, allowing for method chaining.

Description
Removes an event listener that is bound to the element (in its boundListeners list).
- Defined in src/turboFunctions/event/event.types.ts:135

removeListenersByType

removeListenersByType(
    type: string,
    toolName?: string,
    manager?: TurboEventManager,
): this
Parameters
- type: string
  The type of the event. Set to null or undefined to consider all types.
- OptionaltoolName: string
  The name of the tool associated (if any). Set to null or undefined to check for listeners not bound to a tool.
- Optionalmanager: TurboEventManager
  The associated event manager. Defaults to the first created manager, or a new instantiated one if none already exist.
Returns this
Itself, allowing for method chaining.

Description
Removes all event listeners bound to the element (in its boundListeners list) assigned to the specified type.
- Defined in src/turboFunctions/event/event.types.ts:148

removeAllListeners

removeAllListeners(manager?: TurboEventManager): this
Parameters
- Optionalmanager: TurboEventManager
  The associated event manager. Defaults to the first created manager, or a new instantiated one if none already exist.
Returns this
Itself, allowing for method chaining.

Description
Removes all event listeners bound to the element (in its boundListeners list).
- Defined in src/turboFunctions/event/event.types.ts:156

preventDefault

preventDefault(options?: PreventDefaultOptions): this
Parameters
- Optionaloptions: PreventDefaultOptions
  An options object to customize the behavior of the function.
Returns this
Description
Prevent default browser behavior on the provided event types. By default, all basic input events will be processed.
- Defined in src/turboFunctions/event/event.types.ts:163

bringToFront

bringToFront(): this
Returns this
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:43

sendToBack

sendToBack(): this
Returns this
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:45

remove

remove(): this
Returns this
Itself, allowing for method chaining.

Description
Removes the node from the document.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:51
remove(): this
Returns this
Itself, allowing for method chaining.

Description
Removes the element from the document.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:170

addToParent

addToParent(
    parent?: Node,
    index?: number,
    referenceList?: Node[] | NodeListOf<Node>,
): this
Parameters
- Optionalparent: Node
  Array of (or single) child nodes.
- Optionalindex: number
  The position at which to add the child relative to the parent's child list. Leave undefined to add the child at the end.
- OptionalreferenceList: Node[] | NodeListOf<Node>
  The child list to use as computation reference for index placement. Defaults to the node's childrenArray.
Returns this
Itself, allowing for method chaining.

Description
Add one or more children to the referenced parent node.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:64

addChild

addChild(
    children?: Node | Node[],
    index?: number,
    referenceList?: Node[] | NodeListOf<Node>,
): this
Parameters
- Optionalchildren: Node | Node[]
  Array of (or single) child nodes.
- Optionalindex: number
  The position at which to add the child relative to the parent's child list. Leave undefined to add the child at the end.
- OptionalreferenceList: Node[] | NodeListOf<Node>
  The child list to use as computation reference for index placement. Defaults to the node's childrenArray.
Returns this
Itself, allowing for method chaining.

Description
Add one or more children to the referenced parent node.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:77

remChild

remChild(children?: Node | Node[]): this
Parameters
- Optionalchildren: Node | Node[]
  Array of (or single) child nodes.
Returns this
Itself, allowing for method chaining.

Description
Remove one or more children from the referenced parent node.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:84

addChildBefore

addChildBefore(children?: Node | Node[], sibling?: Node): this
Parameters
- Optionalchildren: Node | Node[]
  Array of (or single) child nodes to insert before sibling.
- Optionalsibling: Node
  The sibling node to insert the children before.
Returns this
Itself, allowing for method chaining.

Description
Add one or more children to the referenced parent node before the provided sibling. If the sibling is not found in the parent's children, the nodes will be added to the end of the parent's child list.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:93

removeChildAt

removeChildAt(
    index?: number,
    count?: number,
    referenceList?: Node[] | NodeListOf<Node>,
): this
Parameters
- Optionalindex: number
  The index of the child(ren) to remove.
- Optionalcount: number
  The number of children to remove.
- OptionalreferenceList: Node[] | NodeListOf<Node>
  The child list to use as computation reference for index placement and count. Defaults to the node's childrenArray.
Returns this
Itself, allowing for method chaining.

Description
Remove one or more child nodes from the referenced parent node.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:103

removeAllChildren

removeAllChildren(referenceList?: Node[] | NodeListOf<Node>): this
Parameters
- OptionalreferenceList: Node[] | NodeListOf<Node>
  The child list to representing all the nodes to remove. Defaults to the node's childrenArray.
Returns this
Itself, allowing for method chaining.

Description
Remove all children of the node.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:111

childAt

childAt<ChildType extends Element | Node>(
index?: number,
referenceList?: NodeListOf<ChildType> | ChildType[],
): ChildType
Type Parameters
- ChildType extends Element | Node
Parameters
- Optionalindex: number
  The index of the child to retrieve.
- OptionalreferenceList: NodeListOf<ChildType> | ChildType[]
  The child list to use as computation reference for index placement. Defaults to the node's childrenArray.
Returns ChildType
The child at the given index, or null if the index is invalid.

Description
Returns the child of the parent node at the given index. Any number inputted (including negatives) will be reduced modulo length of the list size.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:123

indexOfChild

indexOfChild(child?: Node, referenceList?: Node[] | NodeListOf<Node>): number
Parameters
- Optionalchild: Node
  The child element to find.
- OptionalreferenceList: Node[] | NodeListOf<Node>
  The child list to use as computation reference for index placement. Defaults to the node's childrenArray.
Returns number
The index of the child node in the provided list, or -1 if the child is not found.

Description
Returns the index of the given child.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:133

hasChild

hasChild(children?: Node | Node[]): boolean
Parameters
- Optionalchildren: Node | Node[]
  Array of (or single) child nodes.
Returns boolean
A boolean indicating whether the provided nodes belong to the parent or not.

Description
Identify whether one or more children belong to this parent node.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:140

findInSubTree

findInSubTree(children?: Node | Node[]): boolean
Parameters
- Optionalchildren: Node | Node[]
  The child or children to check.
Returns boolean
True if the children belong to the node, false otherwise.

Description
Finds whether one or more children belong to this node.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:147

findInParents

findInParents(parents?: Node | Node[]): boolean
Parameters
- Optionalparents: Node | Node[]
  The parent(s) to check.
Returns boolean
True if the node is within the given parents, false otherwise.

Description
Finds whether this node is within the given parent(s).
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:156

indexInParent

indexInParent(referenceList?: Node[]): number
Parameters
- OptionalreferenceList: Node[]
  The siblings list to use as computation reference for index placement. Defaults to the node's siblings.
Returns number
True if the children belong to the node, false otherwise.

Description
Finds whether one or more children belong to this node.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:164

closest

closest<
    Type extends
        | "symbol"
        | "filter"
        | "set"
        | "animate"
        | "animateMotion"
        | "animateTransform"
        | "circle"
        | "clipPath"
        | "defs"
        | "desc"
        | "ellipse"
        | "feBlend"
        | "feColorMatrix"
        | "feComponentTransfer"
        | "feComposite"
        | "feConvolveMatrix"
        | "feDiffuseLighting"
        | "feDisplacementMap"
        | "feDistantLight"
        | "feDropShadow"
        | "feFlood"
        | "feFuncA"
        | "feFuncB"
        | "feFuncG"
        | "feFuncR"
        | "feGaussianBlur"
        | "feImage"
        | "feMerge"
        | "feMergeNode"
        | "feMorphology"
        | "feOffset"
        | "fePointLight"
        | "feSpecularLighting"
        | "feSpotLight"
        | "feTile"
        | "feTurbulence"
        | "foreignObject"
        | "g"
        | "image"
        | "line"
        | "linearGradient"
        | "marker"
        | "mask"
        | "metadata"
        | "mpath"
        | "path"
        | "pattern"
        | "polygon"
        | "polyline"
        | "radialGradient"
        | "rect"
        | "stop"
        | "svg"
        | "switch"
        | "text"
        | "textPath"
        | "tspan"
        | "use"
        | "view"
        | (keyof HTMLElementTagNameMap)
        | (keyof MathMLElementTagNameMap)
        | (keyof TurboElementTagNameMap),
>(
    type: Type,
): ValidElement<Type>
Finds the closest ancestor of the current element (or the current element itself) that matches the provided CSS selector or element type.
Type Parameters
- Type extends
      | "symbol"
      | "filter"
      | "set"
      | "animate"
      | "animateMotion"
      | "animateTransform"
      | "circle"
      | "clipPath"
      | "defs"
      | "desc"
      | "ellipse"
      | "feBlend"
      | "feColorMatrix"
      | "feComponentTransfer"
      | "feComposite"
      | "feConvolveMatrix"
      | "feDiffuseLighting"
      | "feDisplacementMap"
      | "feDistantLight"
      | "feDropShadow"
      | "feFlood"
      | "feFuncA"
      | "feFuncB"
      | "feFuncG"
      | "feFuncR"
      | "feGaussianBlur"
      | "feImage"
      | "feMerge"
      | "feMergeNode"
      | "feMorphology"
      | "feOffset"
      | "fePointLight"
      | "feSpecularLighting"
      | "feSpotLight"
      | "feTile"
      | "feTurbulence"
      | "foreignObject"
      | "g"
      | "image"
      | "line"
      | "linearGradient"
      | "marker"
      | "mask"
      | "metadata"
      | "mpath"
      | "path"
      | "pattern"
      | "polygon"
      | "polyline"
      | "radialGradient"
      | "rect"
      | "stop"
      | "svg"
      | "switch"
      | "text"
      | "textPath"
      | "tspan"
      | "use"
      | "view"
      | (keyof HTMLElementTagNameMap)
      | (keyof MathMLElementTagNameMap)
      | (keyof TurboElementTagNameMap)
Parameters
- type: Type
  The (valid) CSS selector string, or element constructor/class to match.
Returns ValidElement<Type>
The matching ancestor element, or null if no match is found.
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:179
closest<Type extends Element>(type: new (...args: any[]) => Type): Type
Type Parameters
- Type extends Element
Parameters
- type: new (...args: any[]) => Type
Returns Type
- Defined in src/turboFunctions/hierarchy/hierarchy.types.ts:180

execute

execute(callback: (el: this) => void): this
Parameters
- callback: (el: this) => void
  The function to execute, with 1 parameter representing the instance itself.
Returns this
Itself, allowing for method chaining.

Description
Execute a callback on the node while still benefiting from chaining.
- Defined in src/turboFunctions/misc/misc.types.ts:9

show

show(b: boolean): this
Parameters
- b: boolean
  Whether to show the element or not
Returns this
Itself, allowing for method chaining.

Description
Show or hide the element (based on CSS) by transitioning in/out of the element's showTransition.
- Defined in src/turboFunctions/reifect/reifect.types.ts:29

setStyle

setStyle(
    attribute: keyof CSSStyleDeclaration,
    value: string | number,
    instant?: boolean,
): this
Parameters
- attribute: keyof CSSStyleDeclaration
  A string representing the style attribute to set.
- value: string | number
  A string representing the value to set the attribute to.
- Optionalinstant: boolean
  If true, will set the fields directly. Otherwise, will set them on next animation frame.
Returns this
Itself, allowing for method chaining.

Description
Set a certain style attribute of the element to the provided value.
- Defined in src/turboFunctions/style/style.types.ts:31

appendStyle

appendStyle(
    attribute: keyof CSSStyleDeclaration,
    value: string | number,
    separator?: string,
    instant?: boolean,
): this
Parameters
- attribute: keyof CSSStyleDeclaration
  A string representing the style attribute to set.
- value: string | number
  A string representing the value to set the attribute to.
- Optionalseparator: string
  The separator to use between the existing and new value.
- Optionalinstant: boolean
  If true, will set the fields directly. Otherwise, will set them on next animation frame.
Returns this
Itself, allowing for method chaining.

Description
Set a certain style attribute of the element to the provided value.
- Defined in src/turboFunctions/style/style.types.ts:42

setStyles

setStyles(styles: StylesType, instant?: boolean): this
Parameters
- styles: StylesType
  A CSS string of style attributes and their values, seperated by semicolons, or an object of CSS properties. Use the css literal function for autocompletion.
- Optionalinstant: boolean
  If true, will set the fields directly. Otherwise, will set them on next animation frame.
Returns this
Itself, allowing for method chaining.

Description
Parses and applies the given CSS to the element's inline styles.
- Defined in src/turboFunctions/style/style.types.ts:53

makeSubstrate

makeSubstrate(name: string, options?: MakeSubstrateOptions): this
Parameters
- name: string
- Optionaloptions: MakeSubstrateOptions
Returns this
- Defined in src/turboFunctions/substrate/substrate.types.ts:26

getSubstrates

getSubstrates(): string[]
Returns string[]
- Defined in src/turboFunctions/substrate/substrate.types.ts:27

getSubstrateObjectList

getSubstrateObjectList(substrate?: string): Set<object>
Parameters
- Optionalsubstrate: string
Returns Set<object>
- Defined in src/turboFunctions/substrate/substrate.types.ts:29

setSubstrateObjectList

setSubstrateObjectList(
list: Set<object> | HTMLCollection | NodeList,
substrate?: string,
): this
Parameters
- list: Set<object> | HTMLCollection | NodeList
- Optionalsubstrate: string
Returns this
- Defined in src/turboFunctions/substrate/substrate.types.ts:30

addObjectToSubstrate

addObjectToSubstrate(object: object, substrate?: string): this
Parameters
- object: object
- Optionalsubstrate: string
Returns this
- Defined in src/turboFunctions/substrate/substrate.types.ts:32

removeObjectFromSubstrate

removeObjectFromSubstrate(object: object, substrate?: string): this
Parameters
- object: object
- Optionalsubstrate: string
Returns this
- Defined in src/turboFunctions/substrate/substrate.types.ts:33

hasObjectInSubstrate

hasObjectInSubstrate(object: object, substrate?: string): boolean
Parameters
- object: object
- Optionalsubstrate: string
Returns boolean
- Defined in src/turboFunctions/substrate/substrate.types.ts:35

wasObjectProcessedBySubstrate

wasObjectProcessedBySubstrate(object: object, substrate?: string): boolean
Parameters
- object: object
- Optionalsubstrate: string
Returns boolean
- Defined in src/turboFunctions/substrate/substrate.types.ts:36

setSubstrate

setSubstrate(name: string): this
Parameters
- name: string
Returns this
- Defined in src/turboFunctions/substrate/substrate.types.ts:38

onSubstrateActivate

onSubstrateActivate(name?: string): Delegate<() => void>
Parameters
- Optionalname: string
Returns Delegate<() => void>
- Defined in src/turboFunctions/substrate/substrate.types.ts:42

onSubstrateDeactivate

onSubstrateDeactivate(name?: string): Delegate<() => void>
Parameters
- Optionalname: string
Returns Delegate<() => void>
- Defined in src/turboFunctions/substrate/substrate.types.ts:43

addSolver

addSolver(callback: SubstrateSolver, name?: string): this
Parameters
- callback: SubstrateSolver
- Optionalname: string
Returns this
- Defined in src/turboFunctions/substrate/substrate.types.ts:45

removeSolver

removeSolver(callback: SubstrateSolver, name?: string): this
Parameters
- callback: SubstrateSolver
- Optionalname: string
Returns this
- Defined in src/turboFunctions/substrate/substrate.types.ts:46

clearSolvers

clearSolvers(name?: string): this
Parameters
- Optionalname: string
Returns this
- Defined in src/turboFunctions/substrate/substrate.types.ts:47

resolveSubstrate

resolveSubstrate(properties?: SubstrateSolverProperties): this
Parameters
- Optionalproperties: SubstrateSolverProperties
Returns this
- Defined in src/turboFunctions/substrate/substrate.types.ts:49

makeTool

makeTool(toolName: string, options?: MakeToolOptions): this
Parameters
- toolName: string
  The unique name of the tool to register under the manager.
- Optionaloptions: MakeToolOptions
  Tool creation options (activation, click mode, key mapping, manager).
Returns this
Description
Turns the element into a tool identified by toolName, optionally wiring activation and key mapping.
- Defined in src/turboFunctions/tool/tool.types.ts:65

isTool

isTool(manager?: TurboEventManager): boolean
Parameters
- Optionalmanager: TurboEventManager
  The associated event manager (defaults to TurboEventManager.instance).
Returns boolean
True if the element is a tool, false otherwise.

Description
Whether this element is registered as a tool for the provided manager.
- Defined in src/turboFunctions/tool/tool.types.ts:72

getToolNames

getToolNames(manager?: TurboEventManager): string[]
Parameters
- Optionalmanager: TurboEventManager
  The associated event manager (defaults to TurboEventManager.instance).
Returns string[]
The list of tool names.

Description
Returns all tool names registered on this element for the provided manager.
- Defined in src/turboFunctions/tool/tool.types.ts:79

getToolName

getToolName(manager?: TurboEventManager): string
Parameters
- Optionalmanager: TurboEventManager
  The associated event manager (defaults to TurboEventManager.instance).
Returns string
The first tool name, if any.

Description
Returns the first registered tool name on this element for the provided manager.
- Defined in src/turboFunctions/tool/tool.types.ts:86

onToolActivate

onToolActivate(
toolName: string,
manager?: TurboEventManager,
): Delegate<() => void>
Parameters
- toolName: string
- Optionalmanager: TurboEventManager
Returns Delegate<() => void>
Description
Delegate fired when this tool is activated (selected + activated by the manager).
- Defined in src/turboFunctions/tool/tool.types.ts:97

onToolDeactivate

onToolDeactivate(
toolName: string,
manager?: TurboEventManager,
): Delegate<() => void>
Parameters
- toolName: string
- Optionalmanager: TurboEventManager
Returns Delegate<() => void>
Description
Delegate fired when this tool is deactivated.
- Defined in src/turboFunctions/tool/tool.types.ts:102

addToolBehavior

addToolBehavior(
    type: string,
    callback: ToolBehaviorCallback,
    toolName?: string,
    manager?: TurboEventManager,
): this
Parameters
- type: string
  The behavior type/event name (e.g., "pointerdown", "click", custom turbo event).
- callback: ToolBehaviorCallback
  The behavior function. Return true to consume.
- OptionaltoolName: string
  Tool name to bind the behavior to. Defaults to this element's first tool.
- Optionalmanager: TurboEventManager
  The manager under which the behavior is registered.
Returns this
Description
Adds a behavior callback for a given tool and a given type. It is applied to all instances of the tool.
- Defined in src/turboFunctions/tool/tool.types.ts:120

hasToolBehavior

hasToolBehavior(
    type: string,
    toolName?: string,
    manager?: TurboEventManager,
): boolean
Parameters
- type: string
  The behavior/event type to check.
- OptionaltoolName: string
  The tool name to check under.
- Optionalmanager: TurboEventManager
  The associated manager.
Returns boolean
True if one or more behaviors are registered.

Description
Checks whether there is at least one behavior for (type, toolName).
- Defined in src/turboFunctions/tool/tool.types.ts:130

removeToolBehaviors

removeToolBehaviors(
    type: string,
    toolName?: string,
    manager?: TurboEventManager,
): this
Parameters
- type: string
  The behavior/event type to clear.
- OptionaltoolName: string
  The tool name whose behaviors will be removed.
- Optionalmanager: TurboEventManager
  The associated manager.
Returns this
Description
Removes all behaviors for (type, toolName) under the given manager.
- Defined in src/turboFunctions/tool/tool.types.ts:139

applyTool

applyTool(
    toolName: string,
    type: string,
    event: Event,
    manager?: TurboEventManager,
): boolean
Parameters
- toolName: string
  The tool whose behaviors should run.
- type: string
  The behavior/event type to execute.
- event: Event
  The triggering event instance.
- Optionalmanager: TurboEventManager
  The associated manager.
Returns boolean
True if at least one behavior returned true (consumed).

Description
Executes all behaviors registered for (toolName, type) against this element.
- Defined in src/turboFunctions/tool/tool.types.ts:149

clearToolBehaviors

clearToolBehaviors(manager?: TurboEventManager): this
Parameters
- Optionalmanager: TurboEventManager
Returns this
- Defined in src/turboFunctions/tool/tool.types.ts:151

embedTool

embedTool(target: Node, manager?: TurboEventManager): this
Parameters
- target: Node
  The node to manipulate when interacting with the element itself.
- Optionalmanager: TurboEventManager
  The associated manager (defaults to TurboEventManager.instance).
Returns this
Description
Embeds this tool into a target node, so interactions on the tool apply to the target.
- Defined in src/turboFunctions/tool/tool.types.ts:167

isEmbeddedTool

isEmbeddedTool(manager?: TurboEventManager): boolean
Parameters
- Optionalmanager: TurboEventManager
  The associated manager (defaults to TurboEventManager.instance).
Returns boolean
True if an embedded target is present.

Description
Whether this tool is embedded under the provided manager.
- Defined in src/turboFunctions/tool/tool.types.ts:174

getEmbeddedToolTarget

getEmbeddedToolTarget(manager?: TurboEventManager): Node
Parameters
- Optionalmanager: TurboEventManager
  The associated manager (defaults to TurboEventManager.instance).
Returns Node
The embedded target node, if any.

Description
Returns the target node for this embedded tool under the provided manager.
- Defined in src/turboFunctions/tool/tool.types.ts:181

ignoreTool

ignoreTool(
    toolName: string,
    type?: string,
    ignore?: boolean,
    manager?: TurboEventManager,
): this
Parameters
- toolName: string
- Optionaltype: string
- Optionalignore: boolean
- Optionalmanager: TurboEventManager
Returns this
- Defined in src/turboFunctions/tool/tool.types.ts:183

isToolIgnored

isToolIgnored(
    toolName: string,
    type?: string,
    manager?: TurboEventManager,
): boolean
Parameters
- toolName: string
- Optionaltype: string
- Optionalmanager: TurboEventManager
Returns boolean
- Defined in src/turboFunctions/tool/tool.types.ts:184

Class TurboSelector<Type>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns TurboSelector<Type>

Properties

ReadonlyboundListeners

Description

bypassManagerOn

Type Declaration

Parameters

Returns boolean | TurboEventManagerStateProperties

Description

childHandler

Description

ReadonlychildNodesArray

Description

ReadonlychildrenArray

Description

ReadonlysiblingNodes

Description

Readonlysiblings

Description

Readonlyreifects

Description

showTransition

Description

ReadonlyisShown

Description

ReadonlyclosestRoot

Description

currentSubstrate

ReadonlyonSubstrateChange

element

Methods

addClass

Parameters

Returns this

Description

removeClass

Parameters

Returns this

Description

toggleClass

Parameters

Returns this

Description

hasClass

Parameters

Returns boolean

Description

setProperties

Type Parameters

Parameters

Returns this

setMvc

Parameters

Returns this

destroy

Returns this

Description

setAttribute

Parameters

Returns this

Description

removeAttribute

Parameters

Returns this

Description

blur

Returns this

Description

focus

Returns this

`Readonly`boundListeners

`Readonly`childNodesArray

`Readonly`childrenArray

`Readonly`siblingNodes

`Readonly`siblings

`Readonly`reifects

`Readonly`isShown

`Readonly`closestRoot

`Readonly`onSubstrateChange