@pie-players/pie-tool-line-reader 0.3.5 → 0.3.7
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 +38 -0
- package/package.json +4 -4
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# @pie-players/pie-tool-line-reader
|
|
2
|
+
|
|
3
|
+
Draggable reading guide overlay tool for PIE assessment players.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
Provides a movable, resizable colored overlay strip that helps students focus on specific lines of text during assessments. Supports both highlight mode (colored strip) and obscure/masking mode (darkens everything except the reading window).
|
|
8
|
+
|
|
9
|
+
## Custom Element
|
|
10
|
+
|
|
11
|
+
Tag: `pie-tool-line-reader`
|
|
12
|
+
|
|
13
|
+
| Attribute | Type | Default | Description |
|
|
14
|
+
|---|---|---|---|
|
|
15
|
+
| `visible` | `boolean` | `false` | Controls visibility |
|
|
16
|
+
| `tool-id` | `string` | `'lineReader'` | Identifier used by the ToolCoordinator |
|
|
17
|
+
|
|
18
|
+
## Features
|
|
19
|
+
|
|
20
|
+
- Drag to reposition; bottom handle to resize height
|
|
21
|
+
- Two modes: **highlight** (colored overlay) and **obscure** (masks surrounding content)
|
|
22
|
+
- Five color options (yellow, blue, pink, green, orange) with adjustable opacity
|
|
23
|
+
- Full keyboard support:
|
|
24
|
+
- Arrow keys to move
|
|
25
|
+
- `+`/`-` to resize height
|
|
26
|
+
- `C` to cycle colors
|
|
27
|
+
- `[`/`]` to adjust opacity
|
|
28
|
+
- `M` to toggle highlight/masking mode
|
|
29
|
+
- Screen reader announcements for all state changes
|
|
30
|
+
- Connects to `AssessmentToolkitRuntimeContext` for ToolCoordinator integration
|
|
31
|
+
|
|
32
|
+
## Integration
|
|
33
|
+
|
|
34
|
+
Registered through the `ToolRegistry` as `lineReader`. Managed by `ToolkitCoordinator` via `tools.placement`.
|
|
35
|
+
|
|
36
|
+
## License
|
|
37
|
+
|
|
38
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pie-players/pie-tool-line-reader",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.7",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Reading guide overlay tool for PIE assessment player",
|
|
6
6
|
"repository": {
|
|
@@ -38,9 +38,9 @@
|
|
|
38
38
|
"unpkg": "./dist/tool-line-reader.js",
|
|
39
39
|
"jsdelivr": "./dist/tool-line-reader.js",
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@pie-players/pie-assessment-toolkit": "0.3.
|
|
42
|
-
"@pie-players/pie-context": "0.3.
|
|
43
|
-
"@pie-players/pie-players-shared": "0.3.
|
|
41
|
+
"@pie-players/pie-assessment-toolkit": "0.3.7",
|
|
42
|
+
"@pie-players/pie-context": "0.3.7",
|
|
43
|
+
"@pie-players/pie-players-shared": "0.3.7"
|
|
44
44
|
},
|
|
45
45
|
"types": "./dist/index.d.ts",
|
|
46
46
|
"scripts": {
|