-
Notifications
You must be signed in to change notification settings - Fork 786
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
CI
committed
Dec 7, 2023
1 parent
24fdee8
commit 6e7a136
Showing
725 changed files
with
34,337 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
@interactjs | ||
|
||
# @interactjs | ||
|
||
## Table of contents | ||
|
||
### Modules | ||
|
||
- [auto-scroll/plugin](modules/auto_scroll_plugin.md) | ||
- [auto-start/base](modules/auto_start_base.md) | ||
- [core/BaseEvent](modules/core_BaseEvent.md) | ||
- [core/Eventable](modules/core_Eventable.md) | ||
- [core/InteractEvent](modules/core_InteractEvent.md) | ||
- [core/InteractStatic](modules/core_InteractStatic.md) | ||
- [core/Interactable](modules/core_Interactable.md) | ||
- [core/InteractableSet](modules/core_InteractableSet.md) | ||
- [core/Interaction](modules/core_Interaction.md) | ||
- [core/NativeTypes](modules/core_NativeTypes.md) | ||
- [core/interactablePreventDefault](modules/core_interactablePreventDefault.md) | ||
- [core/interactionFinder](modules/core_interactionFinder.md) | ||
- [core/options](modules/core_options.md) | ||
- [core/scope](modules/core_scope.md) | ||
- [core/types](modules/core_types.md) | ||
- [dev-tools/plugin](modules/dev_tools_plugin.md) | ||
- [inertia/plugin](modules/inertia_plugin.md) | ||
- [modifiers/Modification](modules/modifiers_Modification.md) | ||
- [modifiers/aspectRatio](modules/modifiers_aspectRatio.md) | ||
- [modifiers/base](modules/modifiers_base.md) | ||
- [modifiers/noop](modules/modifiers_noop.md) | ||
- [modifiers/types](modules/modifiers_types.md) | ||
- [pointer-events/PointerEvent](modules/pointer_events_PointerEvent.md) | ||
- [pointer-events/base](modules/pointer_events_base.md) | ||
- [snappers/edgeTarget](modules/snappers_edgeTarget.md) | ||
- [snappers/elements](modules/snappers_elements.md) | ||
- [snappers/grid](modules/snappers_grid.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,164 @@ | ||
[@interactjs](../README.md) / [core/BaseEvent](../modules/core_BaseEvent.md) / BaseEvent | ||
|
||
# Class: BaseEvent\<T\> | ||
|
||
[core/BaseEvent](../modules/core_BaseEvent.md).BaseEvent | ||
|
||
## Type parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `T` | extends [`ActionName`](../modules/core_types.md#actionname) \| ``null`` = `never` | | ||
|
||
## Hierarchy | ||
|
||
- **`BaseEvent`** | ||
|
||
↳ [`InteractEvent`](core_InteractEvent.InteractEvent.md) | ||
|
||
↳ [`PointerEvent`](pointer_events_PointerEvent.PointerEvent.md) | ||
|
||
## Table of contents | ||
|
||
### Properties | ||
|
||
- [currentTarget](core_BaseEvent.BaseEvent.md#currenttarget) | ||
- [immediatePropagationStopped](core_BaseEvent.BaseEvent.md#immediatepropagationstopped) | ||
- [interactable](core_BaseEvent.BaseEvent.md#interactable) | ||
- [interaction](core_BaseEvent.BaseEvent.md#interaction) | ||
- [propagationStopped](core_BaseEvent.BaseEvent.md#propagationstopped) | ||
- [target](core_BaseEvent.BaseEvent.md#target) | ||
- [timeStamp](core_BaseEvent.BaseEvent.md#timestamp) | ||
- [type](core_BaseEvent.BaseEvent.md#type) | ||
|
||
### Methods | ||
|
||
- [preventDefault](core_BaseEvent.BaseEvent.md#preventdefault) | ||
- [stopImmediatePropagation](core_BaseEvent.BaseEvent.md#stopimmediatepropagation) | ||
- [stopPropagation](core_BaseEvent.BaseEvent.md#stoppropagation) | ||
|
||
## Properties | ||
|
||
### currentTarget | ||
|
||
• **currentTarget**: `Node` | ||
|
||
#### Defined in | ||
|
||
[core/BaseEvent.ts:8](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/BaseEvent.ts#L8) | ||
|
||
___ | ||
|
||
### immediatePropagationStopped | ||
|
||
• **immediatePropagationStopped**: `boolean` = `false` | ||
|
||
#### Defined in | ||
|
||
[core/BaseEvent.ts:13](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/BaseEvent.ts#L13) | ||
|
||
___ | ||
|
||
### interactable | ||
|
||
• **interactable**: [`Interactable`](core_Interactable.Interactable.md) | ||
|
||
#### Defined in | ||
|
||
[core/BaseEvent.ts:9](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/BaseEvent.ts#L9) | ||
|
||
___ | ||
|
||
### interaction | ||
|
||
• **interaction**: [`InteractionProxy`](../modules/core_Interaction.md#interactionproxy)\<`T`\> | ||
|
||
#### Defined in | ||
|
||
[core/BaseEvent.ts:40](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/BaseEvent.ts#L40) | ||
|
||
___ | ||
|
||
### propagationStopped | ||
|
||
• **propagationStopped**: `boolean` = `false` | ||
|
||
#### Defined in | ||
|
||
[core/BaseEvent.ts:14](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/BaseEvent.ts#L14) | ||
|
||
___ | ||
|
||
### target | ||
|
||
• **target**: `EventTarget` | ||
|
||
#### Defined in | ||
|
||
[core/BaseEvent.ts:7](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/BaseEvent.ts#L7) | ||
|
||
___ | ||
|
||
### timeStamp | ||
|
||
• **timeStamp**: `number` | ||
|
||
#### Defined in | ||
|
||
[core/BaseEvent.ts:12](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/BaseEvent.ts#L12) | ||
|
||
___ | ||
|
||
### type | ||
|
||
• **type**: `string` | ||
|
||
#### Defined in | ||
|
||
[core/BaseEvent.ts:6](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/BaseEvent.ts#L6) | ||
|
||
## Methods | ||
|
||
### preventDefault | ||
|
||
▸ **preventDefault**(): `void` | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
#### Defined in | ||
|
||
[core/BaseEvent.ts:20](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/BaseEvent.ts#L20) | ||
|
||
___ | ||
|
||
### stopImmediatePropagation | ||
|
||
▸ **stopImmediatePropagation**(): `void` | ||
|
||
Don't call listeners on the remaining targets | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
#### Defined in | ||
|
||
[core/BaseEvent.ts:32](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/BaseEvent.ts#L32) | ||
|
||
___ | ||
|
||
### stopPropagation | ||
|
||
▸ **stopPropagation**(): `void` | ||
|
||
Don't call any other listeners (even on the current target) | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
#### Defined in | ||
|
||
[core/BaseEvent.ts:25](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/BaseEvent.ts#L25) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,160 @@ | ||
[@interactjs](../README.md) / [core/Eventable](../modules/core_Eventable.md) / Eventable | ||
|
||
# Class: Eventable | ||
|
||
[core/Eventable](../modules/core_Eventable.md).Eventable | ||
|
||
## Table of contents | ||
|
||
### Properties | ||
|
||
- [global](core_Eventable.Eventable.md#global) | ||
- [immediatePropagationStopped](core_Eventable.Eventable.md#immediatepropagationstopped) | ||
- [options](core_Eventable.Eventable.md#options) | ||
- [propagationStopped](core_Eventable.Eventable.md#propagationstopped) | ||
- [types](core_Eventable.Eventable.md#types) | ||
|
||
### Methods | ||
|
||
- [fire](core_Eventable.Eventable.md#fire) | ||
- [getRect](core_Eventable.Eventable.md#getrect) | ||
- [off](core_Eventable.Eventable.md#off) | ||
- [on](core_Eventable.Eventable.md#on) | ||
|
||
## Properties | ||
|
||
### global | ||
|
||
• **global**: `any` | ||
|
||
#### Defined in | ||
|
||
[core/Eventable.ts:23](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/Eventable.ts#L23) | ||
|
||
___ | ||
|
||
### immediatePropagationStopped | ||
|
||
• **immediatePropagationStopped**: `boolean` = `false` | ||
|
||
#### Defined in | ||
|
||
[core/Eventable.ts:22](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/Eventable.ts#L22) | ||
|
||
___ | ||
|
||
### options | ||
|
||
• **options**: `any` | ||
|
||
#### Defined in | ||
|
||
[core/Eventable.ts:19](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/Eventable.ts#L19) | ||
|
||
___ | ||
|
||
### propagationStopped | ||
|
||
• **propagationStopped**: `boolean` = `false` | ||
|
||
#### Defined in | ||
|
||
[core/Eventable.ts:21](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/Eventable.ts#L21) | ||
|
||
___ | ||
|
||
### types | ||
|
||
• **types**: `NormalizedListeners` = `{}` | ||
|
||
#### Defined in | ||
|
||
[core/Eventable.ts:20](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/Eventable.ts#L20) | ||
|
||
## Methods | ||
|
||
### fire | ||
|
||
▸ **fire**\<`T`\>(`event`): `void` | ||
|
||
#### Type parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `T` | extends `Object` | | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `event` | `T` | | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
#### Defined in | ||
|
||
[core/Eventable.ts:29](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/Eventable.ts#L29) | ||
|
||
___ | ||
|
||
### getRect | ||
|
||
▸ **getRect**(`_element`): [`Rect`](../interfaces/core_types.Rect.md) | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `_element` | `Element` | | ||
|
||
#### Returns | ||
|
||
[`Rect`](../interfaces/core_types.Rect.md) | ||
|
||
#### Defined in | ||
|
||
[core/Eventable.ts:73](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/Eventable.ts#L73) | ||
|
||
___ | ||
|
||
### off | ||
|
||
▸ **off**(`type`, `listener`): `void` | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `type` | `string` | | ||
| `listener` | [`ListenersArg`](../modules/core_types.md#listenersarg) | | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
#### Defined in | ||
|
||
[core/Eventable.ts:53](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/Eventable.ts#L53) | ||
|
||
___ | ||
|
||
### on | ||
|
||
▸ **on**(`type`, `listener`): `void` | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `type` | `string` | | ||
| `listener` | [`ListenersArg`](../modules/core_types.md#listenersarg) | | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
#### Defined in | ||
|
||
[core/Eventable.ts:45](https://github.com/taye/interact.js/blob/24fdee86/packages/@interactjs/core/Eventable.ts#L45) |
Oops, something went wrong.