5.0.113 • Published 5 months ago

@thi.ng/rstream-gestures v5.0.113

Weekly downloads
364
License
Apache-2.0
Repository
github
Last release
5 months ago

rstream-gestures

npm version npm downloads Twitter Follow

This project is part of the @thi.ng/umbrella monorepo.

About

Unified mouse, mouse wheel & multi-touch event stream abstraction. This is a support package for @thi.ng/rstream.

Status

STABLE - used in production

Search or submit any issues for this package

Breaking changes

Multi-touch support has been added in v2.0.0, resulting in a complete rewrite of gestureStream() and new event data formats.

Related packages

  • @thi.ng/hdom - Lightweight vanilla ES6 UI component trees with customizable branch-local behaviors
  • @thi.ng/rdom - Lightweight, reactive, VDOM-less UI/DOM components with async lifecycle and @thi.ng/hiccup compatible

Installation

yarn add @thi.ng/rstream-gestures

ES module import:

<script type="module" src="https://cdn.skypack.dev/@thi.ng/rstream-gestures"></script>

Skypack documentation

For Node.js REPL:

# with flag only for < v16
node --experimental-repl-await

> const rstreamGestures = await import("@thi.ng/rstream-gestures");

Package sizes (gzipped, pre-treeshake): ESM: 1.19 KB

Dependencies

Usage examples

Several demos in this repo's /examples directory are using this package.

A selection:

ScreenshotDescriptionLive demoSource
Canvas based dial widgetDemoSource
Interactive visualization of closest points on ellipsesDemoSource
Interactive inverse FFT toy synthDemoSource
Doodle w/ K-nearest neighbor search result visualizationDemoSource
Mouse gesture / stroke analysis, simplification, corner detectionDemoSource
Interactive pattern drawing demo using transducersDemoSource
Canvas based Immediate Mode GUI componentsDemoSource
Minimal IMGUI usage exampleDemoSource
Worker based, interactive Mandelbrot visualizationDemoSource
Basic rstream-gestures multi-touch demoDemoSource
Minimal rstream dataflow graphDemoSource
Minimal shader graph developed during livestream #2DemoSource

API

Generated API docs

GestureType

All native events are abstracted into one of the following event types:

  • move - movemove
  • start - mousedown / touchstart
  • drag - mousemove (whilst dragging) / touchmove
  • end - mouseup / touchend / touchcancel
  • zoom - wheel

GestureEvent

The stream emits GestureEvent objects of:

  • type - Current translated/abstracted event type (GestureType)
  • event - Original DOM event
  • pos - Event position (transformed as per GestureStreamOpts)
  • active - Active cursors (i.e. ongoing drag / touch gestures)
  • buttons - Mouse button bitmask (same as in standard MouseEvent), or, if isTouch is true, number of active touches.
  • zoom - Current zoom factor (as per GestureStreamOpts config)
  • zoomDelta - Last WheelEvent's transformed deltaY, wheelDeltaY
  • isTouch - True, if original event was a TouchEvent
// example mouse gesture event
{
  "type": "drag"
  "event": MouseEvent,
  "pos": [254, 169],
  "active": [
    {
      "id": 0, // always 0 for mouse gestures
      "start": [443, 37],
      "pos": [254, 169],
      "delta": [-189, 132]
    }
  ],
  "buttons": 2, // right button pressed
  "zoom": 1,
  "zoomDelta": 0,
  "isTouch": false
}

GestureStreamOpts

See the GestureStreamOpts config options for further details.

Basic usage

import { gestureStream } from "@thi.ng/rstream-gestures";
import { trace } from "@thi.ng/rstream";
import { comp, dedupe, filter, map, pluck } from "@thi.ng/transducers";

// create event stream with custom options
const gestures = gestureStream(document.body, { smooth: 0.01 });

// subscription logging zoom value changes
gestures.subscribe(
    // trace is simply logging received values to console
    trace("zoom"),
    // composed transducer, `dedupe` ensures only changed values are received
    comp(pluck("zoom"), dedupe())
);

// another subscription computing & logging drag gesture distance(s)
gestures.subscribe(
    trace("distance"),
    comp(
        filter((e) => e.type === "drag"),
        map((e) => e.active.map((g) => Math.hypot(...g.delta)))
    )
);

Authors

Maintainer

Contributors

If this project contributes to an academic publication, please cite it as:

@misc{thing-rstream-gestures,
  title = "@thi.ng/rstream-gestures",
  author = "Karsten Schmidt and others",
  note = "https://thi.ng/rstream-gestures",
  year = 2018
}

License

© 2018 - 2021 Karsten Schmidt // Apache Software License 2.0

5.0.113

5 months ago

5.0.112

5 months ago

5.0.110

5 months ago

5.0.111

5 months ago

5.0.106

6 months ago

5.0.107

6 months ago

5.0.108

6 months ago

5.0.109

6 months ago

5.0.105

6 months ago

5.0.103

7 months ago

5.0.104

7 months ago

5.0.102

7 months ago

5.0.101

7 months ago

5.0.100

8 months ago

5.0.99

8 months ago

5.0.98

8 months ago

5.0.97

8 months ago

5.0.96

9 months ago

5.0.95

10 months ago

5.0.92

11 months ago

5.0.93

10 months ago

5.0.94

10 months ago

5.0.90

11 months ago

5.0.91

11 months ago

5.0.81

1 year ago

5.0.82

1 year ago

5.0.83

1 year ago

5.0.84

12 months ago

5.0.85

12 months ago

5.0.86

12 months ago

5.0.87

12 months ago

5.0.88

12 months ago

5.0.89

11 months ago

5.0.80

1 year ago

5.0.75

1 year ago

5.0.76

1 year ago

5.0.77

1 year ago

5.0.78

1 year ago

5.0.79

1 year ago

5.0.74

1 year ago

5.0.73

1 year ago

5.0.72

1 year ago

5.0.71

1 year ago

5.0.70

1 year ago

5.0.69

1 year ago

5.0.68

1 year ago

5.0.67

1 year ago

5.0.66

1 year ago

5.0.65

1 year ago

5.0.64

1 year ago

5.0.63

1 year ago

5.0.62

1 year ago

5.0.61

1 year ago

5.0.60

1 year ago

5.0.59

1 year ago

5.0.58

1 year ago

5.0.55

1 year ago

5.0.56

1 year ago

5.0.57

1 year ago

5.0.53

1 year ago

5.0.54

1 year ago

5.0.52

1 year ago

5.0.51

1 year ago

5.0.50

1 year ago

5.0.49

1 year ago

5.0.46

2 years ago

5.0.47

2 years ago

5.0.48

2 years ago

5.0.44

2 years ago

5.0.43

2 years ago

5.0.41

2 years ago

5.0.42

2 years ago

5.0.38

2 years ago

5.0.39

2 years ago

5.0.40

2 years ago

5.0.37

2 years ago

5.0.36

2 years ago

5.0.30

2 years ago

5.0.32

2 years ago

5.0.33

2 years ago

5.0.34

2 years ago

5.0.35

2 years ago

5.0.20

2 years ago

5.0.21

2 years ago

5.0.22

2 years ago

5.0.23

2 years ago

5.0.24

2 years ago

5.0.25

2 years ago

5.0.26

2 years ago

5.0.27

2 years ago

5.0.28

2 years ago

5.0.29

2 years ago

5.0.9

2 years ago

5.0.8

2 years ago

5.0.6

2 years ago

5.0.5

2 years ago

5.0.10

2 years ago

5.0.11

2 years ago

5.0.12

2 years ago

5.0.13

2 years ago

5.0.14

2 years ago

5.0.15

2 years ago

5.0.16

2 years ago

5.0.17

2 years ago

5.0.18

2 years ago

5.0.19

2 years ago

5.0.4

2 years ago

5.0.3

2 years ago

5.0.2

2 years ago

5.0.1

2 years ago

5.0.0

2 years ago

4.1.44

2 years ago

4.1.45

2 years ago

4.1.46

2 years ago

4.1.47

2 years ago

4.1.48

2 years ago

4.1.42

2 years ago

4.1.43

2 years ago

4.1.41

2 years ago

4.1.38

2 years ago

4.1.40

2 years ago

4.1.33

3 years ago

4.1.34

3 years ago

4.1.35

3 years ago

4.1.36

3 years ago

4.1.37

3 years ago

4.1.30

3 years ago

4.1.31

3 years ago

4.1.32

3 years ago

4.1.22

3 years ago

4.1.27

3 years ago

4.1.28

3 years ago

4.1.29

3 years ago

4.1.23

3 years ago

4.1.24

3 years ago

4.1.25

3 years ago

4.1.26

3 years ago

4.1.20

3 years ago

4.1.21

3 years ago

4.1.19

3 years ago

4.1.11

3 years ago

4.1.16

3 years ago

4.1.17

3 years ago

4.1.18

3 years ago

4.1.12

3 years ago

4.1.13

3 years ago

4.1.14

3 years ago

4.1.15

3 years ago

4.1.8

3 years ago

4.1.7

3 years ago

4.1.9

3 years ago

4.1.10

3 years ago

4.1.6

3 years ago

4.1.5

3 years ago

4.0.9

4 years ago

4.1.4

4 years ago

4.1.3

4 years ago

4.1.0

4 years ago

4.1.2

4 years ago

4.1.1

4 years ago

4.0.8

4 years ago

4.0.4

4 years ago

4.0.7

4 years ago

4.0.1

4 years ago

4.0.0

4 years ago

4.0.3

4 years ago

3.0.34

4 years ago

3.0.32

4 years ago

3.0.33

4 years ago

3.0.31

4 years ago

3.0.30

4 years ago

3.0.27

4 years ago

3.0.28

4 years ago

3.0.29

4 years ago

3.0.25

4 years ago

3.0.26

4 years ago

3.0.24

4 years ago

3.0.23

4 years ago

3.0.22

4 years ago

3.0.21

4 years ago

3.0.20

4 years ago

3.0.19

4 years ago

3.0.18

4 years ago

3.0.17

4 years ago

3.0.16

4 years ago

3.0.15

4 years ago

3.0.14

4 years ago

3.0.13

4 years ago

3.0.12

4 years ago

3.0.8

4 years ago

3.0.7

4 years ago

3.0.6

4 years ago

3.0.5

5 years ago

3.0.4

5 years ago

3.0.3

5 years ago

3.0.2

5 years ago

3.0.1

5 years ago

3.0.0

5 years ago

2.0.45

5 years ago

2.0.44

5 years ago

2.0.43

5 years ago

2.0.42

5 years ago

2.0.41

5 years ago

2.0.40

5 years ago

2.0.39

5 years ago

2.0.38

5 years ago

2.0.37

5 years ago

2.0.36

5 years ago

2.0.35

5 years ago

2.0.34

5 years ago

2.0.33

5 years ago

2.0.32

5 years ago

2.0.31

5 years ago

2.0.30

5 years ago

2.0.28

5 years ago

2.0.29

5 years ago

2.0.27

5 years ago

2.0.26

5 years ago

2.0.25

5 years ago

2.0.24

5 years ago

2.0.23

5 years ago

2.0.22

5 years ago

2.0.21

5 years ago

2.0.19

5 years ago

2.0.18

5 years ago

2.0.20

5 years ago

2.0.17

5 years ago

2.0.16

5 years ago

2.0.15

5 years ago

2.0.14

5 years ago

2.0.13

5 years ago

2.0.11

5 years ago

2.0.12

5 years ago

2.0.10

5 years ago

2.0.9

5 years ago

2.0.8

5 years ago

2.0.7

5 years ago

2.0.6

5 years ago

2.0.5

5 years ago

2.0.4

5 years ago

2.0.1

6 years ago

2.0.0

6 years ago

1.3.0

6 years ago

1.2.6

6 years ago

1.2.5

6 years ago

1.2.4

6 years ago

1.2.3

6 years ago

1.2.2

6 years ago

1.2.1

6 years ago

1.2.0

6 years ago

1.1.4

6 years ago

1.1.3

6 years ago

1.1.2

6 years ago

1.1.1

6 years ago

1.1.0

6 years ago

1.0.21

6 years ago

1.0.20

6 years ago

1.0.19

6 years ago

1.0.18

6 years ago

1.0.17

6 years ago

1.0.16

6 years ago

1.0.15

6 years ago

1.0.14

6 years ago

1.0.13

6 years ago

1.0.12

6 years ago

1.0.11

6 years ago

1.0.10

6 years ago

1.0.9

6 years ago

1.0.8

6 years ago

1.0.7

6 years ago

1.0.6

6 years ago

1.0.5

6 years ago

1.0.4

6 years ago

1.0.3

6 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago

0.6.9

7 years ago

0.6.8

7 years ago

0.6.7

7 years ago

0.6.6

7 years ago

0.6.5

7 years ago

0.6.4

7 years ago

0.6.3

7 years ago

0.6.2

7 years ago

0.6.1

7 years ago

0.6.0

7 years ago

0.5.18

7 years ago

0.5.17

7 years ago

0.5.16

7 years ago

0.5.15

7 years ago

0.5.14

7 years ago

0.5.13

7 years ago

0.5.12

7 years ago

0.5.11

7 years ago

0.5.10

7 years ago

0.5.9

7 years ago

0.5.8

7 years ago

0.5.8-alpha.1

7 years ago

0.5.8-alpha.0

7 years ago

0.5.7

7 years ago

0.5.6

7 years ago

0.5.5

7 years ago

0.5.4

7 years ago

0.5.3

7 years ago

0.5.2

7 years ago

0.5.1

7 years ago

0.5.0

7 years ago

0.4.18

7 years ago

0.4.17

7 years ago

0.4.16

7 years ago

0.4.15

7 years ago

0.4.14

7 years ago

0.4.13

7 years ago

0.4.12

7 years ago

0.4.11

7 years ago

0.4.10

7 years ago

0.4.9

7 years ago

0.4.8

7 years ago

0.4.7

7 years ago

0.4.6

7 years ago

0.4.5

7 years ago

0.4.4

7 years ago

0.4.3

7 years ago

0.4.2

7 years ago

0.4.1

7 years ago

0.4.0

7 years ago

0.3.16

7 years ago

0.3.15

7 years ago

0.3.14

7 years ago

0.3.13

7 years ago

0.3.12

7 years ago

0.3.11

7 years ago

0.3.10

7 years ago

0.3.9

7 years ago

0.3.7

7 years ago

0.3.6

7 years ago

0.3.5

7 years ago

0.3.4

7 years ago

0.3.3

7 years ago

0.3.2

7 years ago

0.3.1

7 years ago

0.3.0

7 years ago

0.2.5

7 years ago

0.2.4

7 years ago

0.2.3

7 years ago

0.2.2

7 years ago

0.2.1

7 years ago

0.2.0

7 years ago

0.1.9

7 years ago

0.1.8

7 years ago

0.1.7

7 years ago

0.1.6

7 years ago

0.1.5

7 years ago

0.1.4

7 years ago

0.1.3

7 years ago

0.1.2

7 years ago

0.1.1

7 years ago

0.1.0

7 years ago

0.0.1

7 years ago