avalynx-alert 0.0.6 → 0.0.7

package/README.md

@@ -102,15 +102,15 @@ new AvalynxAlert('Your message here', 'success', {
 
 AvalynxAlert allows the following options for customization:
 
-- `message`: The message to display in the alert.
-- `type`: The type of alert (`primary`, `secondary`, `success`, `danger`, `warning`, `info`, `light`, `dark`).
+- `message`: (string) The message to display in the alert (default: `''`).
+- `type`: (string) The type of alert. One of (`primary`, `secondary`, `success`, `danger`, `warning`, `info`, `light`, `dark`) (default: `'info'`).
 - `options`: An object containing the following keys:
-    - `duration`: Duration in milliseconds for the alert to be displayed (default: 5000).
-    - `position`: Position of the alert on the screen (default: `top-center`).
-    - `closeable`: Whether the alert can be closed by the user (default: true).
-    - `autoClose`: Whether the alert will close automatically after the duration (default: true).
-    - `width`: The width of the alert (default: `400px`).
-    - `onClose`: A callback function to be called when the alert is closed.
+    - `duration`: (number) Duration in milliseconds for the alert to be displayed (default: `5000`).
+    - `position`: (string) Position of the alert on the screen. One of `top-left`, `top-center`, `top-right`, `bottom-left`, `bottom-center`, `bottom-right` (default: `'top-right'`).
+    - `closeable`: (boolean) Whether the alert can be closed by the user (default: `true`).
+    - `autoClose`: (boolean) Whether the alert will close automatically after the duration (default: `true`).
+    - `width`: (string) The width of the alert (default: `400px`).
+    - `onClose`: (function) A callback function to execute when the alert is closed (default: `null`).
 
 ## Contributing
 

package/dist/css/avalynx-alert.css

@@ -3,7 +3,7 @@
  *
  * A simple alert system for web applications. Based on Bootstrap >=5.3 without any framework dependencies.
  *
- * @version 0.0.6
+ * @version 0.0.7
  * @license MIT
  * @author https://github.com/avalynx/avalynx-alert/graphs/contributors
  * @website https://github.com/avalynx/

package/dist/js/avalynx-alert.esm.js

@@ -3,21 +3,23 @@
  *
  * A simple alert system for web applications. Based on Bootstrap >=5.3 without any framework dependencies.
  *
- * @version 0.0.6
+ * @version 0.0.7
  * @license MIT
  * @author https://github.com/avalynx/avalynx-alert/graphs/contributors
  * @website https://github.com/avalynx/
  * @repository https://github.com/avalynx/avalynx-alert.git
  * @bugs https://github.com/avalynx/avalynx-alert/issues
  *
- * @param {string} message - The message to display in the alert.
- * @param {string} type - The type of alert. One of 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark'.
- * @param {object} options - The options for the alert.
- * @param {number} options.duration - The duration in milliseconds for the alert to be displayed. Default is 5000.
- * @param {string} options.position - The position of the alert. One of 'top-left', 'top-center', 'top-right', 'bottom-left', 'bottom-center', 'bottom-right'. Default is 'top-center'.
- * @param {boolean} options.closeable - Whether the alert can be closed by the user. Default is true.
- * @param {boolean} options.autoClose - Whether the alert will close automatically after the duration. Default is true.
- * @param {string} options.width - The width of the alert. Default is '400px'.
+ * @param {string} message - The message to display in the alert (default: '').
+ * @param {string} type - The type of alert. One of 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark' (default: 'info').
+ * @param {object} options - An object containing the following keys:
+ * @param {number} options.duration - Duration in milliseconds for the alert to be displayed (default: 5000).
+ * @param {string} options.position - Position of the alert on the screen. One of 'top-left', 'top-center', 'top-right', 'bottom-left', 'bottom-center', 'bottom-right' (default: 'top-center').
+ * @param {boolean} options.closeable - Whether the alert can be closed by the user (default: true).
+ * @param {boolean} options.autoClose - Whether the alert will close automatically after the duration (default: true).
+ * @param {string} options.width - The width of the alert (default: '400px').
+ * @param {function} options.onClose - A callback function to execute when the alert is closed (default: null).
+ *
  */
 
 export class AvalynxAlert {

package/dist/js/avalynx-alert.js

@@ -3,22 +3,23 @@
  *
  * A simple alert system for web applications. Based on Bootstrap >=5.3 without any framework dependencies.
  *
- * @version 0.0.6
+ * @version 0.0.7
  * @license MIT
  * @author https://github.com/avalynx/avalynx-alert/graphs/contributors
  * @website https://github.com/avalynx/
  * @repository https://github.com/avalynx/avalynx-alert.git
  * @bugs https://github.com/avalynx/avalynx-alert/issues
  *
- * @param {string} message - The message to display in the alert.
- * @param {string} type - The type of alert. One of 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark'.
- * @param {object} options - The options for the alert.
- * @param {number} options.duration - The duration in milliseconds for the alert to be displayed. Default is 5000.
- * @param {string} options.position - The position of the alert. One of 'top-left', 'top-center', 'top-right', 'bottom-left', 'bottom-center', 'bottom-right'. Default is 'top-center'.
- * @param {boolean} options.closeable - Whether the alert can be closed by the user. Default is true.
- * @param {boolean} options.autoClose - Whether the alert will close automatically after the duration. Default is true.
- * @param {string} options.width - The width of the alert. Default is '400px'.
- * @param {function} options.onClose - A callback function to be called when the alert is closed.
+ * @param {string} message - The message to display in the alert (default: '').
+ * @param {string} type - The type of alert. One of 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark' (default: 'info').
+ * @param {object} options - An object containing the following keys:
+ * @param {number} options.duration - Duration in milliseconds for the alert to be displayed (default: 5000).
+ * @param {string} options.position - Position of the alert on the screen. One of 'top-left', 'top-center', 'top-right', 'bottom-left', 'bottom-center', 'bottom-right' (default: 'top-center').
+ * @param {boolean} options.closeable - Whether the alert can be closed by the user (default: true).
+ * @param {boolean} options.autoClose - Whether the alert will close automatically after the duration (default: true).
+ * @param {string} options.width - The width of the alert (default: '400px').
+ * @param {function} options.onClose - A callback function to execute when the alert is closed (default: null).
+ *
  */
 
 class AvalynxAlert {

package/package.json

@@ -2,7 +2,7 @@
   "name": "avalynx-alert",
   "title": "AvalynxAlert",
   "description": "AvalynxAlert is a simple alert system for web applications. Based on Bootstrap >=5.3 without any framework dependencies.",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "license": "MIT",
   "main": "dist/js/avalynx-alert.js",
   "module": "dist/js/avalynx-alert.esm.js",