react-native-showtime 0.0.3 → 0.0.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 +46 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
# react-native-showtime
|
|
2
2
|
|
|
3
|
-
React Native wrapper for [ShowTime](https://github.com/KaneCheshire/ShowTime)
|
|
4
|
-
|
|
5
|
-
ShowTime works by visualizing touches as they happen, with zero setup required.
|
|
3
|
+
React Native wrapper for [ShowTime](https://github.com/KaneCheshire/ShowTime). ShowTime is a library that displays all your taps and gestures on screen. Useful for recordings, demos, and presentations.
|
|
6
4
|
|
|
7
5
|
<img src="./demo.webp" alt="Demo" width="402" />
|
|
8
6
|
|
|
@@ -14,9 +12,9 @@ npm install react-native-showtime
|
|
|
14
12
|
|
|
15
13
|
## Usage
|
|
16
14
|
|
|
17
|
-
ShowTime
|
|
15
|
+
ShowTime works automatically once installed. No additional setup is required.
|
|
18
16
|
|
|
19
|
-
|
|
17
|
+
The touch indicators can be optionally customized by calling `configure`:
|
|
20
18
|
|
|
21
19
|
```js
|
|
22
20
|
import { configure } from 'react-native-showtime';
|
|
@@ -39,19 +37,49 @@ configure({
|
|
|
39
37
|
|
|
40
38
|
Configures ShowTime's appearance and behavior. All options are optional.
|
|
41
39
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
40
|
+
- **`enabled`** - `'always' | 'never' | 'debugOnly'` (default: `'always'`)
|
|
41
|
+
|
|
42
|
+
Whether ShowTime is enabled.
|
|
43
|
+
|
|
44
|
+
- **`fillColor`** - `ColorValue | 'auto'` (default: `'auto'`)
|
|
45
|
+
|
|
46
|
+
The fill (background) color of a visual touch. When set to `'auto'`, ShowTime automatically uses the stroke color with 50% alpha.
|
|
47
|
+
|
|
48
|
+
- **`strokeColor`** - `ColorValue` (default: `'#3699EC'`)
|
|
49
|
+
|
|
50
|
+
The color of the stroke (outline) of a visual touch.
|
|
51
|
+
|
|
52
|
+
- **`strokeWidth`** - `number` (default: `3`)
|
|
53
|
+
|
|
54
|
+
The width (thickness) of the stroke around a visual touch.
|
|
55
|
+
|
|
56
|
+
- **`size`** - `number` (default: `44`)
|
|
57
|
+
|
|
58
|
+
The size of a visual touch.
|
|
59
|
+
|
|
60
|
+
- **`disappearAnimation`** - `'standard' | 'scaleDown' | 'scaleUp'` (default: `'standard'`)
|
|
61
|
+
|
|
62
|
+
The style of animation to use when a visual touch disappears.
|
|
63
|
+
|
|
64
|
+
- **`disappearDelay`** - `number` (default: `0.2`)
|
|
65
|
+
|
|
66
|
+
The delay, in seconds, before the visual touch disappears after a touch ends.
|
|
67
|
+
|
|
68
|
+
- **`shouldShowMultipleTapCount`** - `boolean` (default: `false`)
|
|
69
|
+
|
|
70
|
+
Whether visual touches should indicate a multiple tap (i.e. show a number 2 for a double tap).
|
|
71
|
+
|
|
72
|
+
- **`multipleTapCountTextColor`** - `ColorValue` (default: `'#000000'`)
|
|
73
|
+
|
|
74
|
+
The color of the text to use when showing multiple tap counts.
|
|
75
|
+
|
|
76
|
+
- **`shouldShowForce`** - `boolean` (default: `true`)
|
|
77
|
+
|
|
78
|
+
Whether visual touches should visually show how much force is applied.
|
|
79
|
+
|
|
80
|
+
- **`shouldIgnoreApplePencilEvents`** - `boolean` (default: `true`)
|
|
81
|
+
|
|
82
|
+
Whether touch events from Apple Pencil are ignored.
|
|
55
83
|
|
|
56
84
|
## License
|
|
57
85
|
|
package/package.json
CHANGED