@lemonadejs/dropdown 3.0.10 → 3.0.13

package/README.md

@@ -0,0 +1,89 @@
+# LemonadeJS Dropdown
+
+[Official website and documentation is here](https://lemonadejs.net/components/dropdown)
+
+Compatible with Vanilla JavaScript, LemonadeJS, React, Vue or Angular.
+
+The LemonadeJS Dropdown is a versatile solution for efficient option management. It is a framework-agnostic JavaScript plugin designed for seamless integration with Vue, React, and Angular. This feature-rich dropdown incorporates autocomplete for swift selections, grouping for organized options, and lazy loading for optimized performance, contributing to a smooth and improved user experience.
+
+## Features
+
+-   Lightweight: The JavaScript Dropdown is only about 2 KBytes;
+-   Integration: It can be used as a standalone library or integrated with any modern framework;
+
+## Getting Started
+
+You can install using NPM or using directly from a CDN.
+
+### npm Installation
+
+To install it in your project using npm, run the following command:
+
+```bash
+$ npm install @lemonadejs/dropdown
+```
+
+### CDN
+
+To use Dropdown via a CDN, include the following script tags in your HTML file:
+
+```html
+<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/lemonadejs/dist/lemonade.min.js"></script>
+<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@lemonadejs/dropdown/dist/index.min.js"></script>
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@lemonadejs/dropdown/dist/style.min.css" />
+```
+
+### Usage
+
+Quick example with Lemonade
+
+```javascript
+import Dropdown from '@lemonadejs/dropdown';
+import '@lemonadejs/dropdown/dist/style.css'
+import '@lemonadejs/modal/dist/style.css';
+
+export default function App() {
+    const self = this;
+
+    self.data = [
+        { text: "Red", value: 1 },
+        { text: "Blue", value: 2 },
+        { text: "Green", value: 3 },
+        { text: "Yellow", value: 4 },
+        { text: "Purple", value: 5 },
+        { text: "Gray", value: 6 },
+    ]
+
+    return `<div>
+        <Dropdown :data="self.data" :value="1" />
+    </div>`
+}
+```
+
+### Settings
+
+| Attribute | Description |
+|-----------|-------------|
+| data: Item[]  | An array of options to be displayed. Each item should follow the structure defined in the 'Item Details' section. |
+| multiple?: boolean | If provided, enables the multiple selection mode, allowing users to select more than one option simultaneously. |
+| autocomplete?: boolean | If provided, enables the autocomplete feature, displaying an input field that allows users to filter and quickly find options in the Dropdown. |
+| value?: string | Represents the current value or selected option in the Dropdown. |
+| type?: string | Specifies the type of display the Dropdown will use. It can be "searchbar" for a search bar interface, "picker" for a selection picker, or "default" for the default dropdown appearance. |
+
+### Item Details
+
+| Attribute | Description |
+| --------- | ----------- |
+| value?: number or string | Represents the identifier or unique value associated with the option. |
+| group?: string | Indicates the group to which the option belongs, allowing for segregation and organization. |
+| text?: string | Displays the label or text associated with the option. |
+| image?: string | Specifies the image URL to be displayed alongside the option. |
+
+## License
+
+The [LemonadeJS](https://lemonadejs.net) LemonadeJS Dropdown is released under the MIT.
+
+## Other Tools
+
+-   [jSuites](https://jsuites.net/v4/)
+-   [Jspreadsheet Data Grid](https://jspreadsheet.com)

package/dist/index.d.ts

@@ -1,58 +1,70 @@
-interface DropdownItem {
-    /** Value of the selected item. */
-    value?: string | number;
-    /** Description of the item */
-    text?: string;
-    /** Icon of the item */
-    image?: string;
-    /** Name of the group where the item belongs to */
-    group?: string;
-    /** Keywords to help finding one item */
-    synonym?: string[];
-    /** Item is disabled */
-    disabled?: boolean;
-    /** Color for the item */
-    color?: string;
-}
+/**
+ * Official Type definitions for LemonadeJS plugins
+ * https://lemonadejs.net
+ * Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+ */
+
+declare function Dropdown(el: HTMLElement, options?: Dropdown.Options): Dropdown.Instance;
+
+declare namespace Dropdown {
+    interface Item {
+        /** Value of the selected item. */
+        value?: string | number;
+        /** Description of the item */
+        text?: string;
+        /** Icon of the item */
+        image?: string;
+        /** Name of the group where the item belongs to */
+        group?: string;
+        /** Keywords to help finding one item */
+        synonym?: string[];
+        /** Item is disabled */
+        disabled?: boolean;
+        /** Color for the item */
+        color?: string;
+    }
+
+    interface Options {
+        /** Preloaded data items for the dropdown */
+        data?: Item[];
+        /** Format type of the data, typically { id: name } or { value: text } */
+        format?: number;
+        /** Indicates if multiple item selection is allowed */
+        multiple?: boolean;
+        /** Enables the autocomplete feature for user input */
+        autocomplete?: boolean;
+        /** Rendering style of the dropdown: 'default', 'picker', 'searchbar' or inline */
+        type?: 'default' | 'picker' | 'searchbar' | 'inline',
+        /** Defines the dropdown's width */
+        width?: number;
+        /** The initial value of the dropdown */
+        value?: string | string[] | number | number[];
+        /** Placeholder text for the dropdown */
+        placeholder?: string;
+        /** Event handler for value changes */
+        onchange?: (obj: object, newValue: string|number) => void;
+        /** Event handler for when the dropdown is ready */
+        onload?: (obj: object) => void;
+        /** Event handler for when the dropdown opens */
+        onopen?: (obj: object) => void;
+        /** Event handler for when the dropdown closes */
+        onclose?: (obj: object) => void;
+        /** Event handler for when a new option is added to the dropdown */
+        oninsert?: (obj: object, item: Item) => void;
+        /** Event handler for just before a new option is added to the dropdown */
+        onbeforeinsert?: (obj: object, item: Item) => void;
+        /** Event handler for before a search on autocomplete is performed */
+        onbeforesearch?: (obj: object, ajaxRequest: object) => boolean | null;
+        /** Event handler for processing search results */
+        onsearch?: (obj: object, result: object) => void;
+    }
 
-interface DropdownOptions {
-    /** Preloaded data items for the dropdown */
-    data?: DropdownItem[];
-    /** Format type of the data, typically { id: name } or { value: text } */
-    format?: number;
-    /** Indicates if multiple item selection is allowed */
-    multiple?: boolean;
-    /** Enables the autocomplete feature for user input */
-    autocomplete?: boolean;
-    /** Rendering style of the dropdown: 'default', 'picker', 'searchbar' or inline */
-    type?: 'default' | 'picker' | 'searchbar' | 'inline',
-    /** Defines the dropdown's width */
-    width?: number;
-    /** The initial value of the dropdown */
-    value?: string | string[] | number | number[];
-    /** Placeholder text for the dropdown */
-    placeholder?: string;
-    /** Event handler for value changes */
-    onchange?: (el: HTMLElement, obj: Dropdown, oldValue: string, newValue: string) => void;
-    /** Event handler for when the dropdown is ready */
-    onload?: (el: HTMLElement, obj: Dropdown, data: any, val: any) => void;
-    /** Event handler for when the dropdown opens */
-    onopen?: (el: HTMLElement) => void;
-    /** Event handler for when the dropdown closes */
-    onclose?: (el: HTMLElement) => void;
-    /** Event handler for when a new option is added to the dropdown */
-    oninsert?: (obj: Dropdown, item: DropdownItem, newItem: DropdownItem) => void;
-    /** Event handler for just before a new option is added to the dropdown */
-    onbeforeinsert?: (obj: Dropdown, item: DropdownItem) => void;
-    /** Event handler for before a search on autocomplete is performed */
-    onbeforesearch?: (obj: Dropdown, ajaxRequest: object) => boolean | null;
-    /** Event handler for processing search results */
-    onsearch?: (obj: Dropdown, result: object) => void;
+    interface Instance {
+        /** Internal type */
+        type: 'dropdown';
+        /** Current internal value */
+        value: Record<number, string>;
+    }
 }
 
-export type Dropdown = (el: HTMLElement, options: DropdownOptions) => {
-    /** Internal type */
-    type: 'dropdown';
-    /** Current internal value */
-    value: Record<number, string>;
-}
+export default Dropdown;

package/dist/index.js

@@ -238,31 +238,38 @@ if (!Modal && typeof (require) === 'function') {
         // Lazy loading global instance
         let lazyloading = null;
 
+        let onload = self.load;
+        let onchange = self.onchange;
+
         const setData = function() {
-            // Re-order to make sure groups are in sequence
-            self.data.sort((a, b) => {
-                // Compare groups
-                if (a.group && b.group) {
-                    return a.group.localeCompare(b.group);
-                }
-                return 0;
-            });
-            let group = '';
-            // Define group headers
-            self.data.map((v) => {
-                // Compare groups
-                if (v.group && v.group !== group) {
-                    v.header = true;
-                    group = v.group;
-                }
-            });
             // Estimate width
             let width = self.width;
-            // Width && values
-            self.data.map(function (s) {
-                // Estimated width of the element
-                width = Math.max(width, s.text.length * 8);
-            });
+            // Re-order to make sure groups are in sequence
+            if (self.data && self.data.length) {
+                self.data.sort((a, b) => {
+                    // Compare groups
+                    if (a.group && b.group) {
+                        return a.group.localeCompare(b.group);
+                    }
+                    return 0;
+                });
+                let group = '';
+                // Define group headers
+                self.data.map((v) => {
+                    // Compare groups
+                    if (v && v.group && v.group !== group) {
+                        v.header = true;
+                        group = v.group;
+                    }
+                });
+                // Width && values
+                self.data.map(function (s) {
+                    // Estimated width of the element
+                    if (s.text) {
+                        width = Math.max(width, s.text.length * 8);
+                    }
+                });
+            }
             // Adjust the width
             let w = self.input.offsetWidth;
             if (width < w) {
@@ -388,13 +395,26 @@ if (!Modal && typeof (require) === 'function') {
 
             // Update label
             updateLabel();
+
+            // Component onchange
+            if (typeof(onchange) === 'function') {
+                onchange(self, self.value);
+            }
         }
 
         const getValue = function() {
-            if (value && value.length) {
-                return value.filter(v => v.selected).map(i => i.value);
+            if (self.multiple) {
+                if (value && value.length) {
+                    return value.filter(v => v.selected).map(i => i.value);
+                }
+                return [];
+            } else {
+                if (value && value.length) {
+                    return value[0].value;
+                } else {
+                    return '';
+                }
             }
-            return [];
         }
 
         const onclose = function() {
@@ -415,6 +435,10 @@ if (!Modal && typeof (require) === 'function') {
             self.value = getValue();
             // Identify the new state of the dropdown
             self.state = false;
+
+            if (typeof(self.onclose) === 'function') {
+                self.onclose(self);
+            }
         }
 
         const onopen = function() {
@@ -440,6 +464,10 @@ if (!Modal && typeof (require) === 'function') {
                 // Focus on the item
                 self.input.focus();
             }
+
+            if (typeof(self.onopen) === 'function') {
+                self.onopen(self);
+            }
         }
 
         self.search = function() {
@@ -607,6 +635,10 @@ if (!Modal && typeof (require) === 'function') {
                     e.stopImmediatePropagation();
                 }
             });
+
+            if (typeof(onload) === 'function') {
+                onload(self);
+            }
         }
 
         self.onchange = function(prop) {
@@ -621,7 +653,7 @@ if (!Modal && typeof (require) === 'function') {
             }
         }
 
-        return `<div class="lm-dropdown" data-type="{{self.type}}" data-state="{{self.state}}">
+        return `<div class="lm-dropdown" data-type="{{self.type}}" data-state="{{self.state}}" :value="self.value">
             <div class="lm-dropdown-header">
                 <div class="lm-dropdown-input" oninput="self.search" onfocus="self.open" onclick="self.click" placeholder="{{self.placeholder}}" :ref="self.input" tabindex="0"></div>
                 <button onclick="self.close" class="lm-dropdown-done">Done</button>

package/dist/react.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Official Type definitions for the LemonadeJS plugins
+ * https://lemonadejs.net
+ * Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+ */
+import Component from './index';
+
+interface Dropdown {
+    (): any
+    [key: string]: any
+}
+
+declare function Dropdown<Dropdown>(props: Component.Options): any;
+
+export default Dropdown;

package/dist/style.css

@@ -57,7 +57,7 @@
     top: 2px;
     background-repeat: no-repeat;
     background-image: url("data:image/svg+xml,%0A%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24'%3E%3Cpath fill='none' d='M0 0h24v24H0V0z'/%3E%3Cpath d='M7 10l5 5 5-5H7z' fill='gray'/%3E%3C/svg%3E");
-    transition: transform .2s ease-in-out;
+    transition: transform .1s ease-in-out;
 }
 
 

package/package.json

@@ -15,8 +15,9 @@
     ],
     "dependencies": {
         "lemonadejs": "^4.0.7",
-        "@lemonadejs/modal": "^2.4.0"
+        "@lemonadejs/modal": "^2.4.9"
     },
     "main": "dist/index.js",
-    "version": "3.0.10"
+    "types": "dist/index.d.ts",
+    "version": "3.0.13"
 }