@ue-too/board 0.9.2 → 0.9.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -12
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
<a href="#under-the-hood">Basic API Overview</a>
|
|
24
24
|
</p>
|
|
25
25
|
|
|
26
|
-
|
|
27
27
|
|
|
28
28
|
<p align="center">
|
|
29
29
|
A demonstration of uē-tôo's core functionality.
|
|
@@ -59,10 +59,6 @@ Even if you're not building a drawing app, `ue-too` is useful for any canvas tha
|
|
|
59
59
|
|
|
60
60
|
Additional examples in the [`devserver`](https://github.com/niuee/board/tree/main/devserver) directory show integration with pixi.js, fabric.js, and Konva (incomplete but providing general implementation guidance).
|
|
61
61
|
|
|
62
|
-
## Documentation
|
|
63
|
-
- [API Documentation](https://ue-too.github.io/ue-too/) (Deprecated)
|
|
64
|
-
- [中文文件連結](https://ue-too.github.io/ue-too/tw/index.html) (還在努力補沒翻完的，還要開發新功能，時間真的不太夠 u.u) (Deprecated)
|
|
65
|
-
|
|
66
62
|
## Installation and Usage
|
|
67
63
|
|
|
68
64
|
### Package Manager
|
|
@@ -143,7 +139,7 @@ The `Board` class handles:
|
|
|
143
139
|
|
|
144
140
|
All components and utility functions are accessible, allowing you to create your own board implementation without using the `requestAnimationFrame` callback method.
|
|
145
141
|
|
|
146
|
-
For detailed camera control information, refer to the [Board Camera](
|
|
142
|
+
For detailed camera control information, refer to the [Board Camera](https://github.com/ue-too/ue-too/tree/main/packages/board/src/camera) section.
|
|
147
143
|
|
|
148
144
|
## Development
|
|
149
145
|
|
|
@@ -151,7 +147,7 @@ For detailed camera control information, refer to the [Board Camera](./src/board
|
|
|
151
147
|
|
|
152
148
|
> Currently not ready for contribution. If you have any suggestions or ideas, please let me know by creating an issue.
|
|
153
149
|
|
|
154
|
-
Please refer to the [README](
|
|
150
|
+
Please refer to the [README](https://github.com/ue-too/ue-too/) in the root directory for the overall development setup.
|
|
155
151
|
|
|
156
152
|
1. This package is within a monorepo, and is managed by nx and pnpm. I am not super familiar with nx or monorepo; this is kind of an experiment and a learning experience for me. (if you have any suggestions on how to improve the setup, please let me know!)
|
|
157
153
|
2. Bundling the package is done through rollup and testing through jest.
|
|
@@ -166,15 +162,15 @@ ue-too consists of 3 core components:
|
|
|
166
162
|
- `User Input Interpretation`: This is the part that handles the user input events from the canvas element (pointer, keyboard, touch, etc.), and based on the events determine what the user intentions are.
|
|
167
163
|
|
|
168
164
|
To see detail of each component navigate to the respective readme in the subdirectories.
|
|
169
|
-
- [Board Camera](
|
|
170
|
-
- [Camera Mux](
|
|
171
|
-
- [User Input Interpreter](
|
|
165
|
+
- [Board Camera](https://github.com/ue-too/ue-too/tree/main/packages/board/src/camera)
|
|
166
|
+
- [Camera Mux](https://github.com/ue-too/ue-too/tree/main/packages/board/src/camera/camera-mux)
|
|
167
|
+
- [User Input Interpreter](https://github.com/ue-too/ue-too/tree/main/packages/board/src/input-interpretation)
|
|
172
168
|
|
|
173
|
-
It's recommended to start with the [Board Camera](
|
|
169
|
+
It's recommended to start with the [Board Camera](https://github.com/ue-too/ue-too/tree/main/packages/board/src/camera) since the other parts are built on top of it.
|
|
174
170
|
|
|
175
171
|
Below is a diagram showing from the user input to how the camera is updated and everything in the middle.
|
|
176
172
|
|
|
177
|
-
|
|
178
174
|
|
|
179
175
|
## TODO
|
|
180
176
|
- [x] Add a canvas position dimension publisher that can be used to get the position and dimension of the canvas.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ue-too/board",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.9.
|
|
4
|
+
"version": "0.9.4",
|
|
5
5
|
"exports": {
|
|
6
6
|
".": {
|
|
7
7
|
"types": "./index.d.ts",
|
|
@@ -14,8 +14,8 @@
|
|
|
14
14
|
"types": "./index.d.ts",
|
|
15
15
|
"module": "./index.js",
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@ue-too/being": "^0.9.
|
|
18
|
-
"@ue-too/math": "^0.9.
|
|
17
|
+
"@ue-too/being": "^0.9.4",
|
|
18
|
+
"@ue-too/math": "^0.9.4"
|
|
19
19
|
},
|
|
20
20
|
"repository": {
|
|
21
21
|
"type": "git",
|