Skip to content

Commit 32bed02

Browse files
hesprshesprs
authored
docs: update README and comparison table (#49)
- Add SynthKernel architecture reference in README and whats-pointeract.md - Expand comparison table in both files, including D3 Drag and D3 Zoom - Improve description in package.json
1 parent bda5bbf commit 32bed02

3 files changed

Lines changed: 28 additions & 26 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555

5656
Pointeract is a tiny JavaScript/TypeScript utility library focusing on one thing - handling user interactions with DOM elements, e.g. multitouch and touchpad.
5757

58-
With the unique strength of versatile typings in TypeScript and its dynamic nature, Pointeract has achieved a highly _modular, extendable and efficient_ architecture. Its core bundle size is only **1KB** minified + gzipped, functionalities come from also byte-sized modules. It's fully **tree-shakable**, the fewer modules you use, the smaller your bundle is.
58+
Powered by [SynthKernel architecture](https://hesprs.github.io/researches/synthkernel), Pointeract has achieved a highly _modular, extensible and efficient_ architecture. Its core bundle size is only **1KB** minified + gzipped, functionalities come from also byte-sized modules. It's fully **tree-shakable**, the fewer modules you use, the smaller your bundle is.
5959

6060
## Advantages
6161

@@ -122,25 +122,26 @@ Missing your desired interaction? [Write your own module](https://pointeract.con
122122

123123
## How Pointeract Stands Out?
124124

125-
There're already plenty of interaction libraries out there, most famous ones are `Interact.js` and `Hammer.js`, but Pointeract is different.
125+
There're already plenty of interaction libraries out there, most famous ones are `d3-drag` + `d3-zoom`, `Interact.js` and `Hammer.js`, but Pointeract is different.
126126

127-
| Criteria | Pointeract | [Hammer.js](https://hammerjs.github.io) | [Interact.js](https://interactjs.io) |
128-
| :--------------------------------------------------------------------------------------- | :---------------------------------------------------: | :---------------------------------------------: | :--------------------------------------------------: |
129-
| Written in TypeScript? | βœ… | ❌ | βœ… |
130-
| Tree-shakeable? | βœ… | ❌ | ❌ |
131-
| Total Bundle Size (Minified + Gzipped) | πŸ‘‘ [3KB](https://bundlejs.com/?q=pointeract%40latest) | [7KB](https://bundlejs.com/?q=hammerjs%402.0.8) | [28KB](https://bundlejs.com/?q=interactjs%401.10.27) |
132-
| Last Updated | πŸ‘‘ Actively Maintained | 2015 | 2023 |
133-
| Features | Pointer and Wheel Related + Some Utils | Pointer Related | πŸ‘‘ Pointer and Wheel Related + Comprehensive Utils |
134-
| Robust? (See [Testing](https://pointeract.consensia.cc/development/testing#monkey-test)) | βœ… | ❌ Element Jerks | ❌ Element Ignores the Second Touch |
135-
| Extensible? | βœ… | ❌ | ❌ |
127+
| Criteria | Pointeract | [D3 Drag](https://github.com/d3/d3-drag) + [D3 Zoom](https://github.com/d3/d3-zoom) | [Hammer.js](https://hammerjs.github.io) | [Interact.js](https://interactjs.io) |
128+
| :--------------------------------------------------------------------------------------------- | :---------------------------------------------------: | :---------------------------------------------------------------------------------: | :---------------------------------------------: | :--------------------------------------------------: |
129+
| Written in TypeScript? | βœ… | ❌ | ❌ | βœ… |
130+
| Tree-shakeable? | βœ… | ❌ | ❌ | ❌ |
131+
| Total Bundle Size (Minified + Gzipped) | πŸ‘‘ [3KB](https://bundlejs.com/?q=pointeract%40latest) | [17KB](https://bundlejs.com/?q=d3-drag%403.0.0%2Cd3-zoom%403.0.0) | [7KB](https://bundlejs.com/?q=hammerjs%402.0.8) | [28KB](https://bundlejs.com/?q=interactjs%401.10.27) |
132+
| Last Updated | πŸ‘‘ Actively Maintained | 2021 | 2015 | 2023 |
133+
| Versatility | Pointer and Wheel Related + Some Utils | πŸ‘‘ Pointer and Wheel Related + Ecosystem | Pointer Related | Pointer Related + Comprehensive Utils |
134+
| Support | πŸ‘‘ Mouse, Mouse Wheel, Touch, and Touchpad | ⚠️ No Touchpad Support | ⚠️ No Touchpad or Mouse Wheel Support | ⚠️ No Touchpad or Mouse Wheel Support |
135+
| Robust (Passes [Monkey Test](https://pointeract.consensia.cc/development/testing#monkey-test)) | βœ… | βœ… | ❌ Element Jerks | ❌ Element Ignores the Second Touch |
136+
| Extensible? | βœ… | ❌ | ❌ | ❌ |
136137

137138
## Get Involved
138139

139140
This project welcomes anyone that has ideas to improve it.
140141

141142
- [Open a pull request](https://github.com/hesprs/pointeract/compare) for a new module, event standard, documentation update, and so on.
142-
- [Open an issue](https://github.com/hesprs/pointeract/issues/new) if you find a bug.
143-
- [Start a new thread in Discussions](https://github.com/hesprs/pointeract/discussions/new) if you have feature requests or questions, please avoid posting them in Issues.
143+
- [Open an issue](https://github.com/hesprs/pointeract/issues/new) if you find a bug or have a feature request.
144+
- [Start a new thread in Discussions](https://github.com/hesprs/pointeract/discussions/new) if you have feature requests or questions want to discuss.
144145
- [Report a vulnerability](https://github.com/hesprs/pointeract/security/advisories/new) if you find one, please do not disclose it publicly.
145146

146147
## Copyright and License

β€Ždocs/en/whats-pointeract.mdβ€Ž

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Pointeract is a tiny JavaScript/TypeScript utility library focusing on one thing - handling user interactions with DOM elements, e.g. multitouch and touchpad.
44

5-
With the unique strength of versatile typings in TypeScript and its dynamic nature, Pointeract have achieved a highly _modular, extendable and efficient_ architecture. Its core bundle size is only **1KB** minified + gzipped, functionalities come from also byte-sized modules. It's fully **tree-shakable**, the fewer modules you use, the smaller your bundle is.
5+
Powered by [SynthKernel architecture](https://hesprs.github.io/researches/synthkernel), Pointeract have achieved a highly _modular, extensible and efficient_ architecture. Its core bundle size is only **1KB** minified + gzipped, functionalities come from also byte-sized modules. It's fully **tree-shakable**, the fewer modules you use, the smaller your bundle is.
66

77
To use it, one only needs to bind a DOM element and load some modules, and it will start monitoring user interactions and dispatch consumable events like `pan` and `zoom`.
88

@@ -29,17 +29,18 @@ Missing your desired interaction? [Write your own module](/development/custom-mo
2929

3030
## How Pointeract Stands Out?
3131

32-
There're already plenty of interaction libraries out there, most famous ones are `Interact.js` and `Hammer.js`, but Pointeract is different.
33-
34-
| Criteria | Pointeract | [Hammer.js](https://hammerjs.github.io) | [Interact.js](https://interactjs.io) |
35-
| :-------------------------------------------------------- | :---------------------------------------------------: | :---------------------------------------------: | :--------------------------------------------------: |
36-
| Written in TypeScript? | βœ… | ❌ | βœ… |
37-
| Tree-shakeable? | βœ… | ❌ | ❌ |
38-
| Total Bundle Size (Minified + Gzipped) | πŸ‘‘ [3KB](https://bundlejs.com/?q=pointeract%40latest) | [7KB](https://bundlejs.com/?q=hammerjs%402.0.8) | [28KB](https://bundlejs.com/?q=interactjs%401.10.27) |
39-
| Last Updated | πŸ‘‘ Actively Maintained | 2015 | 2023 |
40-
| Features | Pointer and Wheel Related + Some Utils | Pointer Related | πŸ‘‘ Pointer and Wheel Related + Comprehensive Utils |
41-
| Robust? (See [Testing](/development/testing#monkey-test)) | βœ… | ❌ Element Jerks | ❌ Element Ignores the Second Touch |
42-
| Extensible? | βœ… | ❌ | ❌ |
32+
There're already plenty of interaction libraries out there, most famous ones are `d3-drag` + `d3-zoom`, `Interact.js` and `Hammer.js`, but Pointeract is different.
33+
34+
| Criteria | Pointeract | [D3 Drag](https://github.com/d3/d3-drag) + [D3 Zoom](https://github.com/d3/d3-zoom) | [Hammer.js](https://hammerjs.github.io) | [Interact.js](https://interactjs.io) |
35+
| :--------------------------------------------------------------------------------------------- | :---------------------------------------------------: | :---------------------------------------------------------------------------------: | :---------------------------------------------: | :--------------------------------------------------: |
36+
| Written in TypeScript? | βœ… | ❌ | ❌ | βœ… |
37+
| Tree-shakeable? | βœ… | ❌ | ❌ | ❌ |
38+
| Total Bundle Size (Minified + Gzipped) | πŸ‘‘ [3KB](https://bundlejs.com/?q=pointeract%40latest) | [17KB](https://bundlejs.com/?q=d3-drag%403.0.0%2Cd3-zoom%403.0.0) | [7KB](https://bundlejs.com/?q=hammerjs%402.0.8) | [28KB](https://bundlejs.com/?q=interactjs%401.10.27) |
39+
| Last Updated | πŸ‘‘ Actively Maintained | 2021 | 2015 | 2023 |
40+
| Versatility | Pointer and Wheel Related + Some Utils | πŸ‘‘ Pointer and Wheel Related + Ecosystem | Pointer Related | Pointer Related + Comprehensive Utils |
41+
| Support | πŸ‘‘ Mouse, Mouse Wheel, Touch, and Touchpad | ⚠️ No Touchpad Support | ⚠️ No Touchpad or Mouse Wheel Support | ⚠️ No Touchpad or Mouse Wheel Support |
42+
| Robust (Passes [Monkey Test](https://pointeract.consensia.cc/development/testing#monkey-test)) | βœ… | βœ… | ❌ Element Jerks | ❌ Element Ignores the Second Touch |
43+
| Extensible? | βœ… | ❌ | ❌ | ❌ |
4344

4445
## License
4546

β€Žpackage.jsonβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "pointeract",
33
"version": "1.1.2",
4-
"description": "A 3KB, tree-shakable, TypeScript-native alternative to Hammer.js for robust pan/zoom gestures β€” runtime-flexible and extensible.",
4+
"description": "A 3KB, tree-shakable, TypeScript-native human interaction library for robust tap/pan/zoom gestures β€” runtime-flexible and extensible.",
55
"keywords": [
66
"frontend",
77
"gesture-detection",

0 commit comments

Comments
Β (0)