@salla.sa/twilight-components 1.0.33 → 1.0.35

package/dist/types/components.d.ts

@@ -16,18 +16,52 @@ export namespace Components {
         "show": () => Promise<HTMLElement>;
     }
     interface SallaButton {
+        /**
+          * Button Style
+         */
         "btnStyle": 'primary' | 'outline' | 'outline-primary' | 'danger';
+        /**
+          * Add `disabled` attribute
+         */
         "disable": () => Promise<void>;
+        /**
+          * Is the button currently disabled
+         */
         "disabled": boolean;
+        /**
+          * Remove `disabled` attribute
+         */
         "enable": () => Promise<void>;
+        /**
+          * Run loading animation
+         */
         "load": () => Promise<HTMLElement>;
+        /**
+          * If there is need to change loader position, pass the position
+         */
         "loaderPosition": 'start' | 'end' | 'center' | 'before';
+        /**
+          * Is the button currently loading
+         */
         "loading": boolean;
+        /**
+          * Changing the body of the button
+          * @param html
+         */
         "setText": (html: string) => Promise<HTMLElement>;
+        /**
+          * Stop loading animation
+         */
         "stop": () => Promise<HTMLElement>;
+        /**
+          * Is the button wide
+         */
         "wide": boolean;
     }
     interface SallaInfiniteScroll {
+        /**
+          * Is there is need to autoload next page when scroll
+         */
         "autoload": boolean;
         /**
           * Class selector to know the container if it's not the host `<salla-infinite-scroll>`
@@ -43,7 +77,13 @@ export namespace Components {
         "nextPage": string;
     }
     interface SallaLocalization {
+        /**
+          * Hide the component
+         */
         "hide": () => Promise<HTMLElement>;
+        /**
+          * Show the component
+         */
         "show": () => Promise<HTMLElement>;
         "submit": () => Promise<void>;
     }
@@ -51,56 +91,150 @@ export namespace Components {
         "isEmailAllowed": boolean;
         "isEmailRequired": boolean;
         "isMobileAllowed": boolean;
+        /**
+          * Show login component
+         */
         "show": () => Promise<HTMLElement>;
     }
     interface SallaModal {
         "error": boolean;
+        /**
+          * hide the modal
+         */
         "hide": () => Promise<HTMLElement>;
+        /**
+          * Icon css class, default for types `error` is `sicon-alert-engine`, `success` is `sicon-check-circle2`
+         */
         "icon": string;
+        /**
+          * url of an image
+         */
         "imageIcon": string;
         "isClosable": boolean;
+        /**
+          * Show loading in the middle
+         */
         "isLoading": boolean;
+        /**
+          * Start loading
+         */
         "loading": () => Promise<HTMLElement>;
         "noPadding": boolean;
-        "position": 'top' | 'middel' | 'bottom';
+        /**
+          * The position of the modal
+         */
+        "position": 'top' | 'middle' | 'bottom';
         "primary": boolean;
+        /**
+          * Change the title
+          * @param title
+         */
         "setTitle": (title: any) => Promise<HTMLElement>;
+        /**
+          * Show the modal
+         */
         "show": () => Promise<HTMLElement>;
+        /**
+          * Stop the loading
+         */
         "stopLoading": () => Promise<HTMLElement>;
         "subTitle": string;
         "subTitleFirst": boolean;
         "success": boolean;
+        /**
+          * Show the modal on rendering
+         */
         "visible": boolean;
+        /**
+          * The size of the modal
+         */
         "width": 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'full';
     }
     interface SallaOffer {
-        "show": (productId: number) => Promise<any>;
+        /**
+          * Show the available offers for the product
+          * @param product_id
+         */
+        "show": (product_id: number) => Promise<any>;
+        /**
+          * Show offer details
+          * @param offer
+         */
         "showOffer": (offer: any) => Promise<HTMLElement>;
     }
     interface SallaProductAvailability {
-        "channels": string;
+        /**
+          * Notification channels
+         */
+        "channels": 'sms' | 'mobile' | 'sms,mobile';
+        /**
+          * is current user already subscribed
+         */
         "isSubscribed": boolean;
+        /**
+          * product id that can visitor subscribe to its availability notification
+         */
         "productId": number;
     }
     interface SallaRating {
+        /**
+          * Show the rating modal
+         */
         "hide": () => Promise<HTMLElement>;
+        /**
+          * The order id, to rate on its products & shipping
+         */
+        "orderId": number;
+        /**
+          * Show the rating modal
+         */
         "show": () => Promise<NodeJS.Timeout>;
     }
     interface SallaSearch {
     }
     interface SallaTelInput {
+        /**
+          * Current country_code
+         */
         "countryCode": string;
         "countryKey": string;
+        /**
+          * Get current values
+          * @return
+         */
         "getValues": () => Promise<{ mobile: string; countryCode: string; countryKey: string; }>;
+        /**
+          * Is current data valid or not
+          * @return
+         */
         "isValid": () => Promise<boolean>;
+        /**
+          * Current mobile number
+         */
         "mobile": string;
     }
     interface SallaVerify {
+        /**
+          * should auto reloading the page after success verification
+         */
         "autoReload": boolean;
-        "by": string;
+        /**
+          * Verifying method
+         */
+        "by": 'sms' | 'email';
+        /**
+          * Get current code
+          * @return
+         */
         "getCode": () => Promise<string>;
-        "isShowBack": boolean;
+        /**
+          * Show verifying modal
+          * @param data
+         */
         "show": (data: any) => Promise<void>;
+        /**
+          * Submitting url, default will use salla api auth: `salla.api.auth.verify`
+         */
         "url"?: string;
         /**
           * Should render component without modal
@@ -205,13 +339,31 @@ declare namespace LocalJSX {
         "position"?: string;
     }
     interface SallaButton {
+        /**
+          * Button Style
+         */
         "btnStyle"?: 'primary' | 'outline' | 'outline-primary' | 'danger';
+        /**
+          * Is the button currently disabled
+         */
         "disabled"?: boolean;
+        /**
+          * If there is need to change loader position, pass the position
+         */
         "loaderPosition"?: 'start' | 'end' | 'center' | 'before';
+        /**
+          * Is the button currently loading
+         */
         "loading"?: boolean;
+        /**
+          * Is the button wide
+         */
         "wide"?: boolean;
     }
     interface SallaInfiniteScroll {
+        /**
+          * Is there is need to autoload next page when scroll
+         */
         "autoload"?: boolean;
         /**
           * Class selector to know the container if it's not the host `<salla-infinite-scroll>`
@@ -235,44 +387,91 @@ declare namespace LocalJSX {
     }
     interface SallaModal {
         "error"?: boolean;
+        /**
+          * Icon css class, default for types `error` is `sicon-alert-engine`, `success` is `sicon-check-circle2`
+         */
         "icon"?: string;
+        /**
+          * url of an image
+         */
         "imageIcon"?: string;
         "isClosable"?: boolean;
+        /**
+          * Show loading in the middle
+         */
         "isLoading"?: boolean;
         "noPadding"?: boolean;
         "onModalClosed"?: (event: CustomEvent<any>) => void;
         "onModalOpened"?: (event: CustomEvent<any>) => void;
-        "position"?: 'top' | 'middel' | 'bottom';
+        /**
+          * The position of the modal
+         */
+        "position"?: 'top' | 'middle' | 'bottom';
         "primary"?: boolean;
         "subTitle"?: string;
         "subTitleFirst"?: boolean;
         "success"?: boolean;
+        /**
+          * Show the modal on rendering
+         */
         "visible"?: boolean;
+        /**
+          * The size of the modal
+         */
         "width"?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'full';
     }
     interface SallaOffer {
     }
     interface SallaProductAvailability {
-        "channels"?: string;
+        /**
+          * Notification channels
+         */
+        "channels"?: 'sms' | 'mobile' | 'sms,mobile';
+        /**
+          * is current user already subscribed
+         */
         "isSubscribed"?: boolean;
+        /**
+          * product id that can visitor subscribe to its availability notification
+         */
         "productId"?: number;
     }
     interface SallaRating {
+        /**
+          * The order id, to rate on its products & shipping
+         */
+        "orderId"?: number;
     }
     interface SallaSearch {
     }
     interface SallaTelInput {
+        /**
+          * Current country_code
+         */
         "countryCode"?: string;
         "countryKey"?: string;
+        /**
+          * Current mobile number
+         */
         "mobile"?: string;
         "onEnterClicked"?: (event: CustomEvent<any>) => void;
     }
     interface SallaVerify {
+        /**
+          * should auto reloading the page after success verification
+         */
         "autoReload"?: boolean;
-        "by"?: string;
-        "isShowBack"?: boolean;
-        "onBackClicked"?: (event: CustomEvent<any>) => void;
+        /**
+          * Verifying method
+         */
+        "by"?: 'sms' | 'email';
+        /**
+          * Event when success verification
+         */
         "onVerified"?: (event: CustomEvent<any>) => void;
+        /**
+          * Submitting url, default will use salla api auth: `salla.api.auth.verify`
+         */
         "url"?: string;
         /**
           * Should render component without modal

package/example/currencies

@@ -0,0 +1,23 @@
+{"data":[
+  {
+    "code"        : "SAR",
+    "name"        : "ريال سعودي",
+    "symbol"      : "ر.س",
+    "amount"      : 1,
+    "country_code": "sa"
+  },
+  {
+    "code"        : "EUR",
+    "name"        : "يورو",
+    "symbol"      : "€",
+    "amount"      : 0.22,
+    "country_code": "eu"
+  },
+  {
+    "code"        : "USD",
+    "name"        : "دولار أمريكي",
+    "symbol"      : "$",
+    "amount"      : 0.27,
+    "country_code": "us"
+  }
+]}