ids-enterprise-typings 10.9.0 → 10.11.0

package/index.d.ts

@@ -71,6 +71,7 @@
 /// <reference path='lib/stepchart/soho-stepchart.d.ts' />
 /// <reference path='lib/stepprocess/soho-stepprocess.d.ts' />
 /// <reference path='lib/swaplist/soho-swaplist.d.ts' />
+/// <reference path='lib/swipe-action/soho-swipe-action.d.ts' />
 /// <reference path='lib/tabs/soho-tabs.d.ts' />
 /// <reference path='lib/tag/soho-tag.d.ts' />
 /// <reference path='lib/textarea/soho-textarea.d.ts' />

package/lib/accordion/soho-accordion.d.ts

@@ -8,10 +8,10 @@
 
 type SohoAccordionExpanderType = 'classic' | 'plus-minus' | 'chevron';
 
- /**
- * Soho Accordion Control Options
- */
- interface SohoAccordionOptions {
+/**
+* Soho Accordion Control Options
+*/
+interface SohoAccordionOptions {
   /**
    * If set to true, allows only one pane of the Accordion to be open at a time.
    * If an Accordion pane is open, and that pane contains sub-headers,
@@ -35,32 +35,37 @@ type SohoAccordionExpanderType = 'classic' | 'plus-minus' | 'chevron';
    */
   rerouteOnLinkClick?: boolean;
 
+  /**
+   * Add a alert badge to the accordion header (used for App menu)
+   */
+  notificationBadge?: boolean;
+
   /**
    * A callback function that when implemented provided a call back for "ajax loading"
    * of tab contents on open.
    */
   source?: Function;
 
-   /**
-    *  Set true to use panels with header selection
-    */
-   hasPanels?: boolean;
-
-   /**
-    * Sets the color scheme to inverse
-    */
-   inverse?: boolean;
-
-   /**
-    * Sets the color scheme to alternate
-    */
-   alternate?: boolean;
-
-   /**
-    * Enables tooltips for longer text that is handled with ellipsis
-    */
-   enableTooltips?: boolean;
- }
+  /**
+   *  Set true to use panels with header selection
+   */
+  hasPanels?: boolean;
+
+  /**
+   * Sets the color scheme to inverse
+   */
+  inverse?: boolean;
+
+  /**
+   * Sets the color scheme to alternate
+   */
+  alternate?: boolean;
+
+  /**
+   * Enables tooltips for longer text that is handled with ellipsis
+   */
+  enableTooltips?: boolean;
+}
 
 /**
  * This interface represents the public API exposed by the

package/lib/application-menu/soho-application-menu.d.ts

@@ -36,6 +36,12 @@ interface SohoApplicationMenuOptions {
   /** Is this application menu filterable. */
   filterable?: boolean;
 
+  /** Is this application menu resizable. */
+  resizable?: boolean;
+
+  /** Is this application menu resizable. */
+  savePosition?: boolean;
+
   /** Open the menu when the screen width is larger that the breakpoint. */
   openOnLarge: boolean | undefined;
 

package/lib/button/soho-button.d.ts

@@ -4,7 +4,6 @@
  * This file contains the Typescript mappings for the public
  * interface of the Soho button control.
  */
-
 type SohoButtonOptionsStyle = 'default' | 'btn' | 'btn-primary' | 'btn-secondary' | 'btn-tertiary' | 'btn-destructive' | null | undefined;
 
 type SohoButtonOptionsType = 'default' | 'btn-icon' | 'btn-menu' | 'btn-actions' | 'btn-toggle' |
@@ -38,6 +37,15 @@ interface SohoButtonOptions {
   /** Ripple */
   ripple?: boolean;
 
+  /** Add bigger hit area (for mobile) */
+  hitbox?: boolean;
+
+  /** Used to set a notification badge on the button */
+  notificationBadge?: boolean;
+
+  /** Set the position and color of the notification badge on the button */
+  notificationBadgeOptions?: SohoNotificationBadgeOptions;
+
   /** validate? */
   validate?: boolean;
 

package/lib/calendar/soho-calendar.d.ts

@@ -137,6 +137,7 @@ interface SohoCalendarOptions {
   dayLegend?: Array<SohoDatePickerLegend>;
   attributes?: Array<Object> | Object;
   displayRange?: Object;
+  firstDayOfWeek?: number;
 }
 
 interface SohoCalendar {

package/lib/column/soho-column.d.ts

@@ -60,6 +60,17 @@ interface SohoColumnOptions {
 
   /** Add extra attributes like id's to the component **/
   attributes?: Array<Object> | Object;
+
+  /** Option to a label to one of the four sides. For Example
+  * `{left: 'Left axis label', top: 'Top axis label',
+  * right: 'Right axis label', bottom: 'Bottom axis label'}` */
+  axisLabels?: any;
+
+  /** If true no dots are shown. */
+  hideDots?: boolean;
+
+  /** The ability to use line chart if set to true. This will need a target value to the dataset. */
+  useLine?: boolean;
 }
 
 interface SohoColumnSelectEvent {

package/lib/datagrid/soho-datagrid.d.ts

@@ -1164,7 +1164,7 @@ interface SohoDataGridStatic {
 
   exportToExcel(fileName: string, worksheetName: string | null | undefined, customDs: Object[] | null | undefined): void;
 
-  exportToCsv(fileName: string, customDs: Object[], separator: string): void;
+  exportToCsv(fileName: string, customDs: Object[], separator: string, format?: boolean): void;
 
   /**
    * Returns an array of all the rows in the grid marked as dirty.
@@ -1568,3 +1568,8 @@ interface SohoDataGridKeyDownEvent {
   args: SohoDataGridKeyDownArgs;
   response: Function;
 }
+
+interface SohoDataGridScrollEvent {
+  percent: number;
+  percentScrolled: number;
+}

package/lib/message/soho-message.d.ts

@@ -37,6 +37,9 @@ interface SohoMessageOptions {
   /** Set allowed tags */
   allowedTags?: string;
 
+  /* Show close icon button on the top right of the message. */
+  showCloseBtn?: boolean;
+
   /** The buttons to create. */
   buttons?: SohoModalButton[];
 

package/lib/modal-dialog/soho-modal-dialog.d.ts

@@ -63,6 +63,8 @@ interface SohoModalOptions {
   /** If true the an x will be shown on the modal**/
   showCloseBtn?: boolean;
 
+  closeBtnOptions?: CloseBtnOptions;
+
   // The maximum width to show for the modal, regardless of content.
   maxWidth?: number;
 
@@ -84,6 +86,9 @@ interface SohoModalOptions {
   /**  if true, causes this modal instance to become hidden when another modal is displayed over top. **/
   hideUnderneath?: boolean;
 
+  /**  if true, causes the modal to not exit when the enter key is pressed. **/
+  suppressEnterKey?: boolean;
+
   /** If true, causes the modal's trigger element not to become focused once the modal is closed. **/
   noRefocus?: boolean;
 
@@ -129,6 +134,18 @@ interface SohoModalButton {
 
   /** Align the button (CAP Centered Tooltip) **/
   align?: 'left' | 'center' | 'right';
+
+  tabindex?: number;
+}
+
+interface CloseBtnOptions {
+  /** Tooltip message */
+  closeBtnTooltip?: string;
+
+  /** Add extra attributes for the close button
+   * [{ name: 'tabIndex', value: '-1' }]
+   */
+  attributes?: Array<Object>;
 }
 
 /**

package/lib/notification/soho-notification.d.ts

@@ -13,6 +13,9 @@ type SohoNotificationType = 'error' | 'alert' | 'info' | 'success';
 * Notification Options
 */
 interface SohoNotificationOptions {
+  /** ID of notification */
+  id?: string;
+
   /** The title string in the notification. */
   message: string;
 

package/lib/notification-badge/soho-notification-badge.d.ts

@@ -33,6 +33,16 @@ interface SohoNotificationBadgeOptions {
 
 interface SohoNotificationBadge {
   settings: SohoNotificationBadgeOptions;
+
+  /**
+   * Show the NotificationBadge
+   */
+  show(): void;
+
+  /**
+  * Hide the NotificationBadge
+  */
+  hide(): void;
 }
 
 interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {

package/lib/radar/soho-radar.d.ts

@@ -100,7 +100,6 @@ interface SohoRadarSelectEvent {
  * Radar Api.
  */
 interface SohoRadar {
-
   /** The settings option */
   settings: SohoRadarOptions;
 

package/lib/swipe-action/soho-swipe-action.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Soho Swap Action Control.
+ * 
+ * This file contains the Typescript mappings for the public
+ * interface of the Soho jQuery swipe action control.
+ */
+
+type SohoSwipeType = 'continuous' | 'reveal' | undefined;
+
+interface SohoSwipeActionOptions {
+  swipeType?: SohoSwipeType;
+}
+
+interface SohoSwipeActionStatic {
+  settings: SohoSwipeActionOptions;
+
+  updated(settings?: SohoSwipeActionOptions): void;
+
+  destroy(): void;
+}
+
+interface JQueryStatic {
+  swipeaction: SohoSwipeActionStatic;
+}
+
+interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
+  swipeaction(options?: SohoSwipeActionOptions): JQuery;
+}

package/lib/tag/soho-tag.d.ts

@@ -39,9 +39,13 @@ interface SohoTag {
   destroy(): void;
 }
 
-interface SohoTagBeforeRemoveEvent extends JQuery.TriggeredEvent {}
+interface SohoTagBeforeRemoveEvent extends JQuery.TriggeredEvent {
+  tag?: SohoTag;
+}
 
-interface SohoTagAfterRemoveEvent extends JQuery.TriggeredEvent {}
+interface SohoTagAfterRemoveEvent extends JQuery.TriggeredEvent {
+  tag?: SohoTag;
+}
 
 interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
   tag(options?: SohoTagOptions): JQuery;

package/lib/utils/soho-utils.d.ts

@@ -9,10 +9,11 @@ interface SohoUtilsExcelStatic {
    * @param fileName The desired export filename in the download.
    * @param customDs An optional customized version of the data to use.
    * @param separator The separator to use in the cvs file, defaults to 'sep=,'
+   * @param format if true, date and number values will be formatted based on the locale
    * @param self The grid api to use (if customDs is not used)
    * @returns void
    */
-  exportToCsv(fileName?: string, customDs?: any, separator?: string, self?: any): void;
+  exportToCsv(fileName?: string, customDs?: any, separator?: string, format?: boolean, self?: any): void;
 
   /**
    * Export the grid contents to xls format. This may give a warning when opening the file.
@@ -20,10 +21,11 @@ interface SohoUtilsExcelStatic {
    * @param fileName The desired export filename in the download.
    * @param worksheetName A name to give the excel worksheet tab.
    * @param customDs An optional customized version of the data to use.
+   * @param format if true, date and number values will be formatted based on the locale
    * @param self The grid api if customDS is not used
    * @returns void
    */
-  exportToExcel(fileName?: string, worksheetName?: string, customDs?: any, self?: any): void;
+  exportToExcel(fileName?: string, worksheetName?: string, customDs?: any, format?: boolean, self?: any): void;
 }
 
 interface SohoUtilsStatic {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ids-enterprise-typings",
   "slug": "ids-enterprise-typings",
-  "version": "10.9.0",
+  "version": "10.11.0",
   "declaration": true,
   "types": "index.d.ts",
   "dependencies": {