kitzo 1.1.0 → 1.1.2

package/README.md

@@ -21,7 +21,7 @@ npm i kitzo
 or
 
 ```javascript
-<script src="https://cdn.jsdelivr.net/npm/kitzo@1.1.0/dist/kitzo.umd.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/kitzo@1.1.2/dist/kitzo.umd.min.js"></script>
 ```
 
 > Attach this script tag in the html head tag and you are good to go.
@@ -30,10 +30,6 @@ or
 
 #### Quick usage overview
 
-```javascript
-// NPM usage
-import kitzo from 'kitzo';
-```
 
 | [API](#apis)                        |
 | ----------------------------------- |
@@ -41,11 +37,13 @@ import kitzo from 'kitzo';
 | [`kitzo.tooltip()`](#tooltip-api)   |
 | [`kitzo.ripple()`](#ripple-api)     |
 | [`kitzo.debounce()`](#debounce-api) |
-| [`kitzo.clippath()`](#clippath-api)     |
+| [`kitzo.clippath()`](#clippath-api) |
 
 #### APIs
-
 ```javascript
+// NPM usage
+import kitzo from 'kitzo';
+
 kitzo.copy();
 kitzo.tooltip();
 kitzo.ripple();

package/dist/kitzo.d.ts

@@ -1,4 +1,5 @@
-export function tooltip(
+// Tooltip
+export type tooltip = (
   element: string | Element | NodeListOf<Element>,
   config?: {
     /**
@@ -27,64 +28,77 @@ export function tooltip(
     customClass?: string;
 
     /**
-     * Inline styles to apply (excluding top, left, right, bottom, position, zIndex, opacity, transform, translate, scale, rotate, perspective)
+     * Inline styles to apply (excluding positioning/z-index/transform stuff)
      */
     style?: Partial<CSSStyleDeclaration>;
   }
-): void;
+) => void;
 
-export function ripple(
+// Ripple
+export type ripple = (
   element: string | Element | NodeListOf<Element>,
   config?: {
-    /**
-     * Ripple opacity (0 to 1). Default: 0.5
-     */
+    /** Ripple opacity (0 to 1). Default: 0.5 */
     opacity?: number;
-    /**
-     * Animation duration in seconds ('s'). Default: 1
-     */
+
+    /** Animation duration in seconds. Default: 1 */
     duration?: number;
-    /**
-     * Ripple color (CSS color). Default: 'white'
-     */
+
+    /** Ripple color (CSS color). Default: 'white' */
     color?: string;
-    /**
-     * Ripple size in pixels ('px'). If null, auto-scales based on button size. Default: null
-     */
+
+    /** Ripple size in pixels. If null, auto-scales. Default: null */
     size?: number | null;
   }
-): void;
+) => void;
 
-export function copy(
+// Copy
+export type copy = (
   element: string | Element | NodeListOf<Element>,
-  config: {
-    /**
-     * The text to be copied to the clipboard.
-     * Must be a non-empty string.
-     */
+  config?: {
+    /** The text to copy to clipboard (default: element textContent) */
     doc?: string;
 
     /**
-     * The DOM event that triggers the copy action.
-     * Only the following events are allowed:
-     * - 'click' (default)
-     * - 'dblclick'
-     * - 'contextmenu'
-     * - 'mouseup'
-     * - 'touchend'
+     * The DOM event that triggers the copy action
+     * Only allowed: 'click' | 'dblclick' | 'contextmenu' | 'mouseup' | 'touchend'
+     * Default: 'click'
      */
     event?: 'click' | 'dblclick' | 'contextmenu' | 'mouseup' | 'touchend';
   }
-): void;
+) => void;
 
-export function debounce<Args extends any[]>(fn: (...args: Args) => any, delay?: number): (...args: Args) => void;
+// Debounce
+export type debounce = <Args extends any[]>(
+  fn: (...args: Args) => any,
+  delay?: number
+) => (...args: Args) => void;
 
-export function clippath(
+// Clippath
+export type clippath = (
   element: string | Element | NodeListOf<Element>,
   config?: {
-    text?: String;
-    clippathSize?: String | Number;
-    smooth?: Boolean;
+    /** Optional text inside the clippath element */
+    text?: string;
+
+    /** Size of the clippath circle (px or %). Default: '20%' */
+    clippathSize?: string | number;
+
+    /** Enable smooth transition (default: true) */
+    smooth?: boolean;
+
+    /** Custom inline styles */
     style?: Partial<CSSStyleDeclaration>;
   }
-): void;
+) => void;
+
+// Kitzo Bundle
+export interface Kitzo {
+  tooltip: tooltip;
+  ripple: ripple;
+  copy: copy;
+  debounce: debounce;
+  clippath: clippath;
+}
+
+export const kitzo: Kitzo;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kitzo",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "A lightweight JavaScript UI micro-library.",
   "type": "module",
   "main": "./dist/kitzo.umd.js",