|
| 1 | +- [TinyDialog](#tinydialog) |
| 2 | + - [Description](#description) |
| 3 | + - [Using on Node Js](#using-on-node-js) |
| 4 | + - [Example with HTML](#example-with-html) |
| 5 | +- [Docs](#docs) |
| 6 | + - [Types \& Interfaces](#types--interfaces) |
| 7 | + - [Options](#options) |
| 8 | + - [Prototype public functions](#prototype-public-functions) |
| 9 | + - [ClassName](#classname) |
| 10 | + |
| 11 | + |
| 12 | +# TinyDialog |
| 13 | +Tiny Javascript dialog box made with TypeScript |
| 14 | + |
| 15 | +<img width="473" alt="image" src="https://user-images.githubusercontent.com/92580505/206837730-44fe4c07-0089-473f-aabd-22d7508d929b.png"> |
| 16 | + |
| 17 | +<!-- <img width="372" alt="image" src="https://user-images.githubusercontent.com/92580505/206837838-917b2d5b-ae1c-4506-9261-a51b72894e1c.png"> --> |
| 18 | + |
| 19 | + |
| 20 | + |
| 21 | +## Description |
| 22 | +Tiny, flexible and featured javascript dialog box wrote in TypeScript. |
| 23 | +You can add it to any web project with Angular, Vue, React, and others Front-End Framework. |
| 24 | +Fully compatible with FontAwesome Icons. |
| 25 | + |
| 26 | +## Using on Node Js |
| 27 | +```sh |
| 28 | +npm install @lbgm/tiny-dialog |
| 29 | +``` |
| 30 | + |
| 31 | +```ts |
| 32 | +// import style only once |
| 33 | +import "@lbgm/tiny-dialog/style" |
| 34 | + |
| 35 | +import { TinyDialog } from "@lbgm/tiny-dialog"; |
| 36 | + |
| 37 | +const mydialog = new TinyDialog({ |
| 38 | + closeIcon: true, |
| 39 | + ctrlOpen: false, |
| 40 | + timer: "ok|36000", |
| 41 | + icon: "far fa-grin-beam", |
| 42 | + title: "", |
| 43 | + content: "Are you confirming your participation for the Friday event?", |
| 44 | + buttons: { |
| 45 | + ok: { |
| 46 | + className: "as-button btn-accept", |
| 47 | + text: '<i class="fa fa-check-circle"></i> Confirm', |
| 48 | + action: function () { |
| 49 | + // do something |
| 50 | + } |
| 51 | + }, |
| 52 | + cancel: { |
| 53 | + hide: false, |
| 54 | + className: "as-button btn-cancel", |
| 55 | + text: '<i class="fa fa-times"></i> Refuse', |
| 56 | + action: function () { |
| 57 | + // do something |
| 58 | + } |
| 59 | + } |
| 60 | + }, |
| 61 | + onContentReady: function () { |
| 62 | + // do something |
| 63 | + }, |
| 64 | + onOpenBefore: function () { |
| 65 | + // do something |
| 66 | + }, |
| 67 | + onOpen: function () { |
| 68 | + // do something |
| 69 | + }, |
| 70 | + onAction: function () { |
| 71 | + // do something |
| 72 | + }, |
| 73 | + onClose: function () { |
| 74 | + // do something |
| 75 | + }, |
| 76 | + onDestroy: function () { |
| 77 | + // do something |
| 78 | + } |
| 79 | +}); |
| 80 | +``` |
| 81 | + |
| 82 | + |
| 83 | +## Example with HTML |
| 84 | + |
| 85 | +- clone and build by running `npm run compile`; |
| 86 | +- Copy `build/src`(`c.js|js.map`, `index.js|js.map`) into your destination. |
| 87 | + |
| 88 | +```html |
| 89 | +<script type="module" src="https://domain.com/previous-destination/c.js?your_hash"></script> |
| 90 | + |
| 91 | +<script type="text/javascript"> |
| 92 | +
|
| 93 | +const mydialog = new TinyDialog({ |
| 94 | + closeIcon: true, |
| 95 | + ctrlOpen: false, |
| 96 | + timer: "ok|36000", |
| 97 | + title: "", |
| 98 | + content: "Are you confirming your participation for the Friday event?", |
| 99 | + buttons: { |
| 100 | + ok: { |
| 101 | + className: "as-button btn-accept", |
| 102 | + text: '<i class="fa fa-check-circle"></i> Confirm', |
| 103 | + action: function () { |
| 104 | + // do something |
| 105 | + } |
| 106 | + }, |
| 107 | + cancel: { |
| 108 | + hide: false, |
| 109 | + className: "as-button btn-cancel", |
| 110 | + text: '<i class="fa fa-times"></i> Refuse', |
| 111 | + action: function () { |
| 112 | + // do something |
| 113 | + } |
| 114 | + } |
| 115 | + }, |
| 116 | +}); |
| 117 | +
|
| 118 | +</script> |
| 119 | +``` |
| 120 | + |
| 121 | +# Docs |
| 122 | + |
| 123 | +## Types & Interfaces |
| 124 | + |
| 125 | +```ts |
| 126 | +type TinyDialogContent = string | HTMLElement | Node | Node[]; |
| 127 | +export type TinyDialogButton = { |
| 128 | + hide?: boolean; |
| 129 | + className?: string; |
| 130 | + text?: TinyDialogContent; |
| 131 | + action: (...args: any[]) => any; |
| 132 | +}; |
| 133 | +export type TinyDialogButtons = { |
| 134 | + [id_button: string]: TinyDialogButton; |
| 135 | +}; |
| 136 | +export interface TinyDialogArg { |
| 137 | + closeIcon?: boolean; |
| 138 | + ctrlOpen?: boolean; |
| 139 | + timer?: string; |
| 140 | + title?: string; |
| 141 | + content?: TinyDialogContent; |
| 142 | + icon?: string; |
| 143 | + buttons?: TinyDialogButtons; |
| 144 | + onContentReady?: (...args: any[]) => any; |
| 145 | + onOpenBefore?: (...args: any[]) => any; |
| 146 | + onOpen?: (...args: any[]) => any; |
| 147 | + onAction?: (...args: any[]) => any; |
| 148 | + onClose?: (...args: any[]) => any; |
| 149 | + onDestroy?: (...args: any[]) => any; |
| 150 | +} |
| 151 | +export declare class TinyDialog { |
| 152 | + #private; |
| 153 | + arg: TinyDialogArg; |
| 154 | + $$content: HTMLDivElement; |
| 155 | + $$title: HTMLDivElement; |
| 156 | + $$buttons: HTMLDivElement; |
| 157 | + $$icon: HTMLDivElement; |
| 158 | + constructor(arg: TinyDialogArg); |
| 159 | + destroy(): boolean; |
| 160 | + close(): boolean | void; |
| 161 | + open(): boolean | void; |
| 162 | + isOpen(): boolean; |
| 163 | + domResized(): void; |
| 164 | +} |
| 165 | +``` |
| 166 | + |
| 167 | +## Options |
| 168 | + |
| 169 | +| Option | Type | Description | |
| 170 | +| :--- | :--- | :--- | |
| 171 | +| closeIcon | `boolean` | This option displays an icon to close the box. the widget is directly linked to the close and action functions `onClose`, `onAction`. Code inside these functions will be executed. | |
| 172 | +| ctrlOpen | `boolean` | This option controls the automatic opening of the box. it is linked to the pre-opening and opening functions `onOpenBefore`, `onOpen`. Code inside these functions will be executed. When the option is `true` you must call `.open()` to open the box. If it is `false`, the box will open automatically. | |
| 173 | +| timer | `string` | `id_button\|delay_time`<br>This option automatically executes a `click` on a button `id_button` located on the box after a given time in milliseconds `delay_time`. This function is linked to the `onAction` function, and the action function linked to the targeted button. Code found inside these functions will be executed. | |
| 174 | +| icon | `string` | This option displays a main icon. use a [fontAwesome](https://fontawesome.com/) className or a className displaying a personal icon. The displayed content is accessible via `this.$$icon` | |
| 175 | +| title | `string` | `text or html`<br>This option displays a main title. The displayed content is accessible via `this.$$title` . | |
| 176 | +| content | `string` | `text or html`<br>This option displays html or text content in the main container. The displayed content is accessible via `this.$$content` . | |
| 177 | +| buttons | `TinyDialogButtons` | This option creates buttons.<br><ul><li>`id_button`: button identifier equal to `id_button` for the timer option.</li><li>`hide`: to hide the button.< /li><li>`className`: One or more to style the button.</li><li>`text`: text or html content to be displayed on the button.</li><li>` action`: javascript function which will be executed when the button is clicked. the function passes the event and the button as parameters. The dialog box accessible with `this`. </li></ul>The buttons are accessible via their parent `this.$$buttons`. A button is accessible via `this.$$id_button`. | |
| 178 | +| onContentReady | `Function` | This function runs when the box instance is created and ready for use. Code inside this function will be executed. within the function, `this` refers to the box instance. Thus its elements like `this.$$title`, `this.$$icon`, `this.$$buttons`, `this.$$content` are accessible (the same for the functions below). | |
| 179 | +| onOpenBefore | `Function` | This function runs before opening the box. Code inside this function will be executed. | |
| 180 | +| onOpen | `Function` | This function runs when the box is opened. Code inside this function will be executed. | |
| 181 | +| onAction | `Function` | This function is executed when an action is triggered on the box. Code inside this function will be executed. | |
| 182 | +| onClose | `Function` | This function runs when the box is closed. Code inside this function will be executed. | |
| 183 | +| onDestroy | `Function` | This function is executed when the box is destroyed. Code inside this function will be executed. | |
| 184 | + |
| 185 | +## Prototype public functions |
| 186 | + |
| 187 | +| Function | Description | |
| 188 | +| :--- | :--- | |
| 189 | +| .open() | This function opens the box. It returns true on success or void on failure. | |
| 190 | +| .close() | This function closes the box. It returns true on success or void on failure. Note that closing does not destroy the box on DOM. We can reopen the box by calling .open() | |
| 191 | +| .destroy() | This function closes and destroys the box on DOM. It returns true on success or false on failure. | |
| 192 | +| .isOpen() | This function checks if the box is open or closed. It returns true or false. | |
| 193 | + |
| 194 | +## ClassName |
| 195 | + |
| 196 | +| Name | Description | |
| 197 | +| :--- | :--- | |
| 198 | +| tiny-dialog-cross | svg icon className of closeIcon option. If you need to change the color of the icon, use the `tiny-dialog-cross-path` className then define some css. <br> ex: `fill: #fff;`. | |
| 199 | +| tiny-dialog-closer | container className of the button to close the box. | |
| 200 | +| tiny-dialog-icon | container className of box icon. | |
| 201 | +| tiny-dialog-wrp | box overlay className. | |
| 202 | +| tiny-dialog-bw | className of the box container. Flexible, centered and no selection of content possible. | |
| 203 | +| tiny-dialog-head | header container className. It extends over the available width. | |
| 204 | +| tiny-dialog-title | box title container className. It extends over the available width. | |
| 205 | +| tiny-dialog-content | className of the container of the content you are displaying. It extends over the available width. | |
| 206 | +| tiny-dialog-btns | Dialog button container className. Flexible, it extends over the available width. | |
| 207 | + |
| 208 | +> All containers are `HTMLDivElement` |
0 commit comments