| 1 | # Guideline Tip Id
|
| 2 |
|
| 3 | Simple guideline tip, coach mark
|
| 4 |
|
| 5 | ## Installation
|
| 6 |
|
| 7 | ```bash
|
| 8 | npm i guideline-tip-id
|
| 9 | ```
|
| 10 |
|
| 11 | **or**
|
| 12 |
|
| 13 | ```bash
|
| 14 | yarn add guideline-tip-id
|
| 15 | ```
|
| 16 |
|
| 17 | ### Args function init
|
| 18 | No | Value | Type | Default | Description
|
| 19 | --- | --- | --- | --- | ---
|
| 20 | 2 | dataGuideline | Array<{}> | [] | For the data list that will be given instructions
|
| 21 |
|
| 22 | #### Object of dataGuideline
|
| 23 | No | Value | Type | Default | Description
|
| 24 | --- | --- | --- | --- | ---
|
| 25 | 1 | dataID | string | "" | id of element html
|
| 26 | 2 | positionTip | "left", "right", "top", "bottom" | "" | the position of the guidelines
|
| 27 | 3 | content | any | "" | content from guidelines
|
| 28 |
|
| 29 | <hr/>
|
| 30 |
|
| 31 | #### Demo
|
| 32 | [Vanilla](https://stackblitz.com/edit/web-platform-z7ot74?file=index.html)
|
| 33 |
|
| 34 | <br/>
|
| 35 |
|
| 36 | [React](https://github.com/ugiispoyo/example-guideline-tip-id-react/blob/master/src/App.js)
|
| 37 |
|
| 38 | <br/>
|
| 39 |
|
| 40 | [Vue - on version guideline >= 1.2.1](https://stackblitz.com/edit/vitejs-vite-esx3tn?file=src%2FApp.vue)
|
| 41 |
|
| 42 | <br/>
|
| 43 |
|
| 44 | #### Note:
|
| 45 | For `Vue` it only supports `>= vue 3`, and only supports guideline-tip-id with version `>= 1.2.1` |
| \ | No newline at end of file |