kitzo 1.0.0 → 1.0.3
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 +25 -16
- package/package.json +1 -1
- /package/dist/{zero-kitzo.d.ts → kitzo.d.ts} +0 -0
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# kitzo
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/kitzo)
|
|
4
4
|
|
|
@@ -20,24 +20,33 @@ npm i kitzo
|
|
|
20
20
|
> or
|
|
21
21
|
|
|
22
22
|
```javascript
|
|
23
|
-
<script src="https://cdn.jsdelivr.net/npm/kitzo@1.0.
|
|
23
|
+
<script src="https://cdn.jsdelivr.net/npm/kitzo@1.0.3/dist/kitzo.umd.min.js"></script>
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
+
> Attach this script tag in the html head tag and you are good to go.
|
|
27
|
+
|
|
26
28
|
---
|
|
27
29
|
|
|
28
30
|
#### Quick usage overview
|
|
29
31
|
|
|
30
|
-
| [NPM](#npm-usage) | [CDN](#cdn-usage)
|
|
31
|
-
| -------------------------------- |
|
|
32
|
-
| [`kitzoCopy()`](#copy-api
|
|
33
|
-
| [`kitzoTooltip()`](#tooltip-api) | `kitzo.tooltip()`
|
|
34
|
-
| [`kitzoRipple()`](#ripple-api) | `kitzo.ripple()`
|
|
35
|
-
| [`kitzoDebounce()`](#debounce) | `kitzo.debounce()` |
|
|
32
|
+
| [NPM](#npm-usage) | [CDN](#cdn-usage) |
|
|
33
|
+
| -------------------------------- | ------------------------------------- |
|
|
34
|
+
| [`kitzoCopy()`](#copy-api) | [`kitzo.copy()`](#copy-api-1) |
|
|
35
|
+
| [`kitzoTooltip()`](#tooltip-api) | [`kitzo.tooltip()`](#tooltip-api-1) |
|
|
36
|
+
| [`kitzoRipple()`](#ripple-api) | [`kitzo.ripple()`](#ripple-api-1) |
|
|
37
|
+
| [`kitzoDebounce()`](#debounce) | [`kitzo.debounce()`](#debounce-api-1) |
|
|
36
38
|
|
|
37
39
|
#### NPM usage
|
|
38
40
|
|
|
39
41
|
```javascript
|
|
40
|
-
import { kitzoCopy, kitzoTooltip, kitzoRipple } from 'kitzo';
|
|
42
|
+
import { kitzoCopy, kitzoTooltip, kitzoRipple, kitzoDebounce } from 'kitzo';
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
```javascript
|
|
46
|
+
kitzoCopy();
|
|
47
|
+
kitzoTooltip();
|
|
48
|
+
kitzoRipple();
|
|
49
|
+
kitzoDebounce();
|
|
41
50
|
```
|
|
42
51
|
|
|
43
52
|
> Use a modern build tool. **vite** - recommended
|
|
@@ -90,11 +99,11 @@ kitzoDebounce(callback, delayInMilliseconds);
|
|
|
90
99
|
```javascript
|
|
91
100
|
// Log only after typing stops for 500ms
|
|
92
101
|
const logSearch = kitzoDebounce((text) => {
|
|
93
|
-
console.log(
|
|
102
|
+
console.log('Searching for:', text);
|
|
94
103
|
}, 500);
|
|
95
104
|
|
|
96
105
|
// Attach to input
|
|
97
|
-
document.querySelector(
|
|
106
|
+
document.querySelector('#search').addEventListener('input', (e) => {
|
|
98
107
|
logSearch(e.target.value);
|
|
99
108
|
});
|
|
100
109
|
```
|
|
@@ -109,12 +118,11 @@ document.querySelector("#search").addEventListener("input", (e) => {
|
|
|
109
118
|
<script src="https://cdn.jsdelivr.net/npm/kitzo@1.0.0/dist/kitzo.umd.min.js"></script>
|
|
110
119
|
```
|
|
111
120
|
|
|
112
|
-
> Attach this script tag in the html head tag and you are good to go.
|
|
113
|
-
|
|
114
121
|
```javascript
|
|
115
122
|
kitzo.copy();
|
|
116
123
|
kitzo.tooltip();
|
|
117
124
|
kitzo.ripple();
|
|
125
|
+
kitzo.debounce();
|
|
118
126
|
```
|
|
119
127
|
|
|
120
128
|
##### Copy API:
|
|
@@ -155,14 +163,15 @@ kitzo.ripple(selectors | element | NodeList, {
|
|
|
155
163
|
```javascript
|
|
156
164
|
kitzo.debounce(callback, delayInMilliseconds);
|
|
157
165
|
```
|
|
166
|
+
|
|
158
167
|
```javascript
|
|
159
168
|
// Log only after typing stops for 500ms
|
|
160
169
|
const logSearch = kitzo.debounce((text) => {
|
|
161
|
-
console.log(
|
|
170
|
+
console.log('Searching for:', text);
|
|
162
171
|
}, 500);
|
|
163
172
|
|
|
164
173
|
// Attach to input
|
|
165
|
-
document.querySelector(
|
|
174
|
+
document.querySelector('#search').addEventListener('input', (e) => {
|
|
166
175
|
logSearch(e.target.value);
|
|
167
176
|
});
|
|
168
|
-
```
|
|
177
|
+
```
|
package/package.json
CHANGED
|
File without changes
|