Class ReifectHandler<ClassType>

ReifectHandler

Description

A class to handle reifects for an attached element.

Type Parameters

ClassType extends object = Node

Index

Constructors

constructor

new ReifectHandler<ClassType extends object = Node>(
attachedNode: ClassType,
): ReifectHandler<ClassType>
Type Parameters
- ClassType extends object = Node
Parameters
- attachedNode: ClassType
  The element to attach transitions to.
Returns ReifectHandler<ClassType>
- Defined in src/turboComponents/wrappers/reifectHandler/reifectHandler.ts:20

Accessors

enabled

get enabled(): ReifectEnabledObject
Returns ReifectEnabledObject
Description
The enabled state of the reifect (as a ReifectEnabledObject). Setting it to a boolean will accordingly update the value of enabled.global.
- Defined in src/turboComponents/wrappers/reifectHandler/reifectHandler.ts:151
set enabled(value: boolean | ReifectEnabledObject): void
Parameters
- value: boolean | ReifectEnabledObject
Returns void
- Defined in src/turboComponents/wrappers/reifectHandler/reifectHandler.ts:155

Methods

attach

attach(...reifects: StatefulReifect<any, ClassType>[]): this
attach
Parameters
- ...reifects: StatefulReifect<any, ClassType>[]
  The transition(s) to attach.
Returns this
The element's TransitionHandler instance.

Description
Attach one or more transitions to the element.
- Defined in src/turboComponents/wrappers/reifectHandler/reifectHandler.ts:35

detach

detach(...reifects: StatefulReifect<any, ClassType>[]): this
detach
Parameters
- ...reifects: StatefulReifect<any, ClassType>[]
  The transition(s) to detach.
Returns this
The element's TransitionHandler instance.

Description
Detach one or more transitions from the element.
- Defined in src/turboComponents/wrappers/reifectHandler/reifectHandler.ts:50

initialize

initialize<State extends string | number | symbol>(
    reifect: StatefulReifect<State, ClassType>,
    direction: State,
    options?: ReifectAppliedOptions<State, ClassType>,
): this
initialize
Type Parameters
- State extends string | number | symbol
Parameters
- reifect: StatefulReifect<State, ClassType>
  The transition to initialize.
- direction: State
  The direction of the transition.
- Optionaloptions: ReifectAppliedOptions<State, ClassType>
  Optional styles to override the defaults. Set to null to not set any styles on the element.
Returns this
The element's TransitionHandler instance.

Description
Initializes the element to the corresponding transition direction and styles.
- Defined in src/turboComponents/wrappers/reifectHandler/reifectHandler.ts:73

apply

apply<State extends string | number | symbol>(
    reifect: StatefulReifect<State, ClassType>,
    direction: State,
    options?: ReifectAppliedOptions<State, ClassType>,
): this
initialize
Type Parameters
- State extends string | number | symbol
Parameters
- reifect: StatefulReifect<State, ClassType>
  The transition to initialize.
- direction: State
  The direction of the transition.
- Optionaloptions: ReifectAppliedOptions<State, ClassType>
  Optional styles to override the defaults. Set to null to not set any styles on the element.
Returns this
The element's TransitionHandler instance.

Description
Initializes the element to the corresponding transition direction and styles.
- Defined in src/turboComponents/wrappers/reifectHandler/reifectHandler.ts:91

toggle

toggle<State extends string | number | symbol>(
reifect: StatefulReifect<State, ClassType>,
options?: ReifectAppliedOptions<State, ClassType>,
): this
initialize
Type Parameters
- State extends string | number | symbol
Parameters
- reifect: StatefulReifect<State, ClassType>
  The transition to initialize.
- Optionaloptions: ReifectAppliedOptions<State, ClassType>
  Optional styles to override the defaults. Set to null to not set any styles on the element.
Returns this
The element's TransitionHandler instance.

Description
Initializes the element to the corresponding transition direction and styles.
- Defined in src/turboComponents/wrappers/reifectHandler/reifectHandler.ts:108

reload

reload(): void
reload

Returns void
Description
Reloads all transitions attached to the element. Doesn't recompute styles.
- Defined in src/turboComponents/wrappers/reifectHandler/reifectHandler.ts:129

reloadTransitions

reloadTransitions(): void
reload

Returns void
Description
Reloads all transitions attached to the element. Doesn't recompute styles.
- Defined in src/turboComponents/wrappers/reifectHandler/reifectHandler.ts:139

getReifectEnabledState

getReifectEnabledState(
reifect: StatefulReifect<any, ClassType>,
): ReifectEnabledObject
Parameters
- reifect: StatefulReifect<any, ClassType>
Returns ReifectEnabledObject
- Defined in src/turboComponents/wrappers/reifectHandler/reifectHandler.ts:161

enableReifect

enableReifect(
reifect: StatefulReifect<any, ClassType>,
value: boolean | ReifectEnabledObject,
): void
Parameters
- reifect: StatefulReifect<any, ClassType>
- value: boolean | ReifectEnabledObject
Returns void
- Defined in src/turboComponents/wrappers/reifectHandler/reifectHandler.ts:165

Class ReifectHandler<ClassType>

Description

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ReifectHandler<ClassType>

Accessors

enabled

Returns ReifectEnabledObject

Description

Parameters

Returns void

Methods

attach

Parameters

Returns this

Description

detach

Parameters

Returns this

Description

initialize

Type Parameters

Parameters

Returns this

Description

apply

Type Parameters

Parameters

Returns this

Description

toggle

Type Parameters

Parameters

Returns this

Description

reload

Returns void

Description

reloadTransitions

Returns void

Description

getReifectEnabledState

Parameters

Returns ReifectEnabledObject

enableReifect

Parameters

Returns void

Settings

On This Page