/types

ES6 type definition for UI5

Primary LanguageTypeScriptMIT LicenseMIT

Open UI5 Types

CircleCI npm (scoped) Node CI codecov

Provide ES6 UI5 types definition. To support vscode Code IntelliSense.

how to

  1. npm install @ui5-next/types@latest
  2. include @type to jsconfig/tsconfig file
{
  "compilerOptions": {},
  "include": ["src","./node_modules/@ui5-next/types/bin/index.d.ts"]
}

types

  • class
  • class method
  • class static method
  • class constructor
  • class method parameters type
  • class method return type
  • enums
  • types
  • interfaces
  • namespace type
  • JSX props support
  • how to document
  • CI nightly test

comments

// following methods return type & parameters will be `any`
// because their parameters are different in parent-class & sub-class
export const skipMethods = [
  "sap.ui.base.Object.defineClass",
  "parseValue",
  "setVisible",
  "getDomRef",
  "getControlMessages",
  "clone",
  "setDatetime",
  "getTooltip",
  "setValue",
  "getSelectedIndex",
  "getValue",
  "setAuthorPicture",
  "setPriority",
  "addSelectionInterval",
  "publish",
  "subscribe",
  "validateValue",
  "refresh",
  "filter",
  "sort",
  "bindContext",
  "bindList",
  "fireChange",
  "getRootContexts",
  "setSelectedIndex",
  "setSelectionInterval",
  "setEnableGrouping",
  "getContextByIndex",
  "setGroupBy",
  "selectAll",
  "removeSelectionInterval",
  "sap.ui.core.mvc.XMLView.registerPreprocessor",
]

// those types are not exist in source
// so those types will be replace by 'any'
export const NotExistedTypes = [
  "sap.m.IconTabBarSelectList",
  "sap.ui.test.qunit",
  "sap.ui.core.support.Support",
  "appointmentsSorterCallback",
  "sap.m.TextField",
  "sap.m.P13nConditionOperation",
  "DomRef",
  "iScroll",

  "sap.ui.integration.CardActionType",
  "sap.ui.commons.form.SimpleFormLayout",
  "sap.ui.core.dnd.DragSession",
  "sap.m.SinglePlanningCalendarGrid",
  "sap.m.PlanningCalendarHeader",
  "sap.m.TimePickerSlider",
  "sap.ui.layout.ResponsiveSplitterPage",
  "sap.ui.comp.smartvariants.SmartVariantManagement",
  "sap.ui.commons.TitleLevel",
  "sap.m.LigthBox",
  "sap.ui.fl.Layer",

  "sap.ui.fl.write._internal.transport.TransportDialog"
];

CHANGELOG

LICENSE