@hashrytech/quick-components-kit 0.20.1 → 0.20.4

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @hashrytech/quick-components-kit
 
+## 0.20.4
+
+### Patch Changes
+
+- add: new showErrorText property
+
+## 0.20.3
+
+### Patch Changes
+
+- add: adding navigation-state class
+
+## 0.20.2
+
+### Patch Changes
+
+- fix: adding step to input and null type to value of text area
+
 ## 0.20.1
 
 ### Patch Changes

package/dist/components/text-area/TextArea.svelte

@@ -33,7 +33,7 @@
     export type TextInputProps = {
         id: string;        
         name?: string;
-        value?: string|number;        
+        value?: string|number|null;        
         placeholder?: string;
         labelText?: string;
         labelPosition?: "top" | "left" | "right" | "bottom";

package/dist/components/text-area/TextArea.svelte.d.ts

@@ -30,7 +30,7 @@ export type InputMode = "none" | "text" | "decimal" | "numeric" | "tel" | "searc
 export type TextInputProps = {
     id: string;
     name?: string;
-    value?: string | number;
+    value?: string | number | null;
     placeholder?: string;
     labelText?: string;
     labelPosition?: "top" | "left" | "right" | "bottom";

package/dist/components/text-input/TextInput.svelte

@@ -42,7 +42,8 @@
         disabled?: boolean;
         required?: boolean;
         pattern?: string;
-        error?: string;        
+        error?: string;
+        showErrorText?: boolean;
         labelClass?: ClassNameValue;
         firstDivClass?: ClassNameValue;
         secondDivClass?: ClassNameValue;        
@@ -83,6 +84,7 @@
         required=false, 
         pattern,
         error,
+        showErrorText=true,
         firstDivClass, 
         secondDivClass,
         thirdDivClass,
@@ -193,7 +195,7 @@
             
             {#if leftIcon}<div class="h-full flex flex-col items-center justify-center {size == 'lg' ? 'pl-3' : 'pl-2.5'}">{@render leftIcon()}</div>{/if}
             
-            <input {disabled} {required} {type} {id} name={name ? name: id} {placeholder} {pattern} {onmouseup} bind:value {autocomplete} {inputmode} {min} {max} oninput={handleInput}
+            <input {disabled} {required} {type} {id} name={name ? name: id} {placeholder} {pattern} {onmouseup} bind:value {autocomplete} {inputmode} {step} {min} {max} oninput={handleInput}
                 class={twMerge("border-0 focus:border-0 focus:ring-0 active:border-0 outline-none p-0 bg-transparent placeholder:text-neutral-600/50 h-full w-full rounded-primary", sizeStyle[size], restProps.class)} />
 
             {#if rightIcon}<div class="h-full flex flex-col items-center justify-center {size == 'lg' ? 'pr-3' : 'pr-2.5'}">{@render rightIcon()}</div>{/if}
@@ -201,7 +203,7 @@
         
     </div>
     
-    {#if error}
+    {#if error && showErrorText}
     <p class="text-sm text-red-500 mt-0.5 bg-red-100/30 px-2 rounded-primary">{error}</p>
     {/if}
     

package/dist/components/text-input/TextInput.svelte.d.ts

@@ -40,6 +40,7 @@ export type TextInputProps = {
     required?: boolean;
     pattern?: string;
     error?: string;
+    showErrorText?: boolean;
     labelClass?: ClassNameValue;
     firstDivClass?: ClassNameValue;
     secondDivClass?: ClassNameValue;

package/dist/index.d.ts

@@ -24,6 +24,7 @@ export * from './modules/fetch-client.js';
 export * from './modules/api-proxy.js';
 export * from './modules/crypto.js';
 export * from './modules/problem-details.js';
+export * from './modules/navigation-state.js';
 export * from './functions/object-to-form-data.js';
 export * from './functions/compare-objects.js';
 export * from './functions/click-outside.js';

package/dist/index.js

@@ -27,6 +27,7 @@ export * from './modules/fetch-client.js';
 export * from './modules/api-proxy.js';
 export * from './modules/crypto.js';
 export * from './modules/problem-details.js';
+export * from './modules/navigation-state.js';
 // Functions
 export * from './functions/object-to-form-data.js';
 export * from './functions/compare-objects.js';

package/dist/modules/navigation-state.d.ts

@@ -0,0 +1,28 @@
+export type NavigationStateOptions = {
+    init?: string[][] | Record<string, string> | string | URLSearchParams;
+    onNavigateFns?: Array<(queryString?: string) => void | Promise<void>>;
+    defaultParams?: Record<string, string | number | boolean>;
+};
+export declare class NavigationState extends URLSearchParams {
+    static readonly SEARCH_PARAM: string;
+    static readonly LIMIT_PARAM: string;
+    static readonly OFFSET_PARAM: string;
+    private listeners;
+    private defaultParams?;
+    private onNavigateFns?;
+    constructor(opts?: NavigationStateOptions);
+    private emit;
+    onNavigate: (fn: (queryString?: string) => void) => () => boolean;
+    navigate: () => Promise<void>;
+    /** Make a copy (so we can return new instances for Svelte reactivity) */
+    clone: () => NavigationState;
+    /** Clear the specified keys (or everything if no keys passed) */
+    clear: (keyList?: string[]) => void;
+    setDefaultParam: (key: string, value: string) => void;
+    setDefaultParams: (params: Record<string, string | number | boolean>) => void;
+    clearPagination: () => void;
+    paginate: (values: Record<string, string>) => Promise<void>;
+    search: (term: string | number | null) => Promise<void>;
+    filter: (key: string, value: string | number | boolean | null | undefined | Array<string | number | boolean>) => Promise<void>;
+    removeFilter: (key: string, value?: string | number | boolean | null | undefined | Array<string | number | boolean>) => Promise<void>;
+}

package/dist/modules/navigation-state.js

@@ -0,0 +1,84 @@
+export class NavigationState extends URLSearchParams {
+    static SEARCH_PARAM = "q";
+    static LIMIT_PARAM = "limit";
+    static OFFSET_PARAM = "offset";
+    listeners = new Set();
+    defaultParams;
+    onNavigateFns;
+    constructor(opts = {}) {
+        super(opts.init);
+        this.defaultParams = opts.defaultParams ?? {};
+        this.onNavigateFns = opts.onNavigateFns ?? [];
+        if (opts.onNavigateFns) {
+            opts.onNavigateFns.forEach(fn => this.onNavigate(fn));
+        }
+        this.setDefaultParams(this.defaultParams);
+    }
+    /* NOTE we use arrow functions because we want to preserve 'this' context when using it as svelte 5 bindings or to pass as functions to components */
+    emit = () => {
+        //console.log("Nav Listeners: ", this.listeners.size);
+        for (const fn of this.listeners)
+            fn(this.toString());
+    };
+    onNavigate = (fn) => {
+        this.listeners.add(fn);
+        return () => this.listeners.delete(fn); // unsubscribe
+    };
+    navigate = async () => {
+        this.emit();
+    };
+    /** Make a copy (so we can return new instances for Svelte reactivity) */
+    clone = () => {
+        return new NavigationState({ init: this, onNavigateFns: this.onNavigateFns, defaultParams: this.defaultParams });
+    };
+    /** Clear the specified keys (or everything if no keys passed) */
+    clear = (keyList) => {
+        const all_keys = keyList && keyList.length > 0 ? keyList : Array.from(this.keys());
+        for (const akey in all_keys) {
+            const isDefaultkey = this.defaultParams && akey in this.defaultParams;
+            if (!isDefaultkey)
+                this.delete(akey);
+        }
+    };
+    setDefaultParam = (key, value) => {
+        this.set(key, value);
+    };
+    setDefaultParams = (params) => {
+        for (const key in params) {
+            this.set(key, String(params[key]));
+        }
+    };
+    clearPagination = () => {
+        this.delete(NavigationState.LIMIT_PARAM);
+        this.delete(NavigationState.OFFSET_PARAM);
+    };
+    /* The below emit events after performing their actions */
+    paginate = async (values) => {
+        this.clearPagination();
+        for (const key in values) {
+            this.set(key, values[key]);
+        }
+        this.emit();
+    };
+    search = async (term) => {
+        this.clearPagination();
+        this.delete(NavigationState.SEARCH_PARAM);
+        if (term)
+            this.set(NavigationState.SEARCH_PARAM, String(term));
+        this.emit();
+    };
+    filter = async (key, value) => {
+        this.clearPagination();
+        this.set(key, String(value));
+        this.emit();
+    };
+    removeFilter = async (key, value) => {
+        this.clearPagination();
+        this.getAll(key).forEach((v) => {
+            if (v === String(value)) {
+                this.delete(key);
+            }
+        });
+        this.emit();
+    };
+}

package/package.json

@@ -5,7 +5,7 @@
     "type": "git",
     "url": "git+https://github.com/hashrytech/quick-components-kit.git"
   },
-  "version": "0.20.1",
+  "version": "0.20.4",
   "license": "MIT",
   "author": "Hashry Tech",
   "files": [