@interactjs / modifiers/base
Module: modifiers/base
Table of contents
Functions
Functions
addEventModifiers
▸ addEventModifiers(«destructured»): void
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› iEvent | InteractEvent<any, keyof PhaseMap> |
› interaction | Interaction<any> |
Returns
void
Defined in
makeModifier
â–¸ makeModifier<Defaults, State, Name, Result>(module, name?): (_options?: Partial<Defaults>) => Modifier<Defaults, State, Name, Result>
Type parameters
| Name | Type |
|---|---|
Defaults | extends Object |
State | extends Object |
Name | extends string |
Result | Result |
Parameters
| Name | Type |
|---|---|
module | ModifierModule<Defaults, State, Result> |
name? | Name |
Returns
fn
â–¸ (_options?): Modifier<Defaults, State, Name, Result>
Parameters
| Name | Type |
|---|---|
_options? | Partial<Defaults> |
Returns
Modifier<Defaults, State, Name, Result>
| Name | Type |
|---|---|
_defaults | Defaults |
_methods | { beforeEnd: (arg: ModifierArg<State>) => void | Point = module.beforeEnd; set: (arg: ModifierArg<State>) => Result = module.set; start: (arg: ModifierArg<State>) => void = module.start; stop: (arg: ModifierArg<State>) => void = module.stop } |
_methods.beforeEnd | (arg: ModifierArg<State>) => void | Point |
_methods.set | (arg: ModifierArg<State>) => Result |
_methods.start | (arg: ModifierArg<State>) => void |
_methods.stop | (arg: ModifierArg<State>) => void |