ahdjs 0.0.19 → 0.0.21
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 +30 -25
- package/build/css/index.css +1 -1
- package/build/index.js +2 -2
- package/build/index.js.map +1 -1
- package/package.json +1 -1
- package/testing.html +29 -10
package/README.md
CHANGED
|
@@ -2,10 +2,36 @@
|
|
|
2
2
|
|
|
3
3
|
<a href="https://www.npmjs.com/package/@hodgef/ts-library-boilerplate-basic"><img src="https://badgen.net/npm/v/@hodgef/ts-library-boilerplate-basic?color=blue" alt="npm version"></a> <a href="https://github.com/hodgef/ts-library-boilerplate"><img src="https://img.shields.io/github/last-commit/hodgef/ts-library-boilerplate" alt="latest commit"></a> <a href="https://github.com/hodgef/ts-library-boilerplate-basic/actions"><img alt="Build Status" src="https://github.com/hodgef/ts-library-boilerplate-basic/workflows/Build/badge.svg?color=green" /></a> <a href="https://github.com/hodgef/ts-library-boilerplate-basic/actions"> <img alt="Publish Status" src="https://github.com/hodgef/ts-library-boilerplate-basic/workflows/Publish/badge.svg?color=green" /></a>
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
# To get started
|
|
6
6
|
|
|
7
|
-
</div>
|
|
8
7
|
|
|
8
|
+
### npm Installtion
|
|
9
|
+
```
|
|
10
|
+
npm install @ishaan-puniani/ahdjs
|
|
11
|
+
```
|
|
12
|
+
### app components
|
|
13
|
+
```
|
|
14
|
+
import AHDjs from 'ahdjs';
|
|
15
|
+
const libraryInstance = new MyLibrary();
|
|
16
|
+
|
|
17
|
+
const ahdJS = new AHDjs(undefined, {applicationId: '<Application ID from Back office>'});
|
|
18
|
+
...
|
|
19
|
+
|
|
20
|
+
ahdJS.updatePageUrl(props.url, false); <<-- to connect with router
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### self-host/cdn
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
<script src="build/index.js"></script>
|
|
27
|
+
|
|
28
|
+
const AHDjs = window.AHDjs.default;
|
|
29
|
+
const ahdJS = new AHDjs();
|
|
30
|
+
...
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
# For development and contribution
|
|
9
35
|
## ⭐️ Features
|
|
10
36
|
|
|
11
37
|
- Webpack 5
|
|
@@ -20,7 +46,8 @@
|
|
|
20
46
|
## 📦 Getting Started
|
|
21
47
|
|
|
22
48
|
```
|
|
23
|
-
git clone https://github.com/
|
|
49
|
+
git clone https://github.com/ishaan-puniani/ahdjs.git
|
|
50
|
+
cd ahdjs
|
|
24
51
|
npm install
|
|
25
52
|
```
|
|
26
53
|
|
|
@@ -37,28 +64,6 @@ npm install
|
|
|
37
64
|
1. `npm publish`
|
|
38
65
|
2. Your users can include your library as usual
|
|
39
66
|
|
|
40
|
-
### npm
|
|
41
|
-
|
|
42
|
-
```
|
|
43
|
-
import MyLibrary from 'my-library';
|
|
44
|
-
const libraryInstance = new MyLibrary();
|
|
45
|
-
...
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
### self-host/cdn
|
|
49
|
-
|
|
50
|
-
```
|
|
51
|
-
<script src="build/index.js"></script>
|
|
52
|
-
|
|
53
|
-
const MyLibrary = window.MyLibrary.default;
|
|
54
|
-
const libraryInstance = new MyLibrary();
|
|
55
|
-
...
|
|
56
|
-
```
|
|
57
|
-
|
|
58
67
|
## ✅ Libraries built with this boilerplate
|
|
59
68
|
|
|
60
69
|
> Made a library using this starter kit? Share it here by [submitting a pull request](https://github.com/hodgef/ts-library-boilerplate-basic/pulls)!
|
|
61
|
-
|
|
62
|
-
- [simple-keyboard](https://github.com/hodgef/simple-keyboard) - Javascript Virtual Keyboard
|
|
63
|
-
- [react-simple-keyboard](https://github.com/hodgef/react-simple-keyboard) - React Virtual Keyboard
|
|
64
|
-
- [simple-keyboard-layouts](https://github.com/hodgef/simple-keyboard-layouts) - Keyboard layouts for simple-keyboard
|