Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/ai/src/Input.ts
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ type InputItemClickEventDetail = MenuItemClickEventDetail;
/**
* Fired when the user selects the version navigation buttons.
*
* @param {boolean} backwards - Indicates if navigation is backwards (true) or forwards (false, default)
* @param { boolean } backwards The text of the currently clicked menu item.
* @public
*/
@event("version-change")
Expand Down Expand Up @@ -234,9 +234,9 @@ class Input extends BaseInput {
/**
* Handles the version change event from the versioning component.
*
* @param {CustomEvent} e - The version change event
* @param e - The version change event
*/
_handleVersionChange(e: CustomEvent<{ backwards: boolean }>) {
_handleVersionChange(e: CustomEvent<InputVersionChangeEventDetail>): void {
this.fireDecoratorEvent("version-change", {
backwards: e.detail.backwards,
});
Expand Down
2 changes: 1 addition & 1 deletion packages/ai/src/ToolbarLabel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ class ToolbarLabel extends ToolbarItem {
text = "";

/**
* @override
* ToolbarLabel is not interactive.
* @override
*/
get isInteractive(): boolean {
return false;
Expand Down
4 changes: 2 additions & 2 deletions packages/fiori/src/FlexibleColumnLayout.ts
Original file line number Diff line number Diff line change
Expand Up @@ -208,12 +208,13 @@ type FCLAccessibilityAttributes = {

/**
* Fired when the `layoutsConfiguration` changes via user interaction by dragging the separators.
*
* **Note:** The `layout-configuration-change` event is in an experimental state and is a subject to change.
* @param {FCLLayout} layout The current layout
* @param {MEDIA} media The current media type
* @param {array} columnLayout The effective column layout, f.e ["67%", "33%", "0px"]
* @public
* @since 2.16.0
* @experimental
*/
@event("layout-configuration-change", {
bubbles: true,
Expand Down Expand Up @@ -288,7 +289,6 @@ class FlexibleColumnLayout extends UI5Element {
* @default {}
* @public
* @since 2.16.0
* @experimental
*/
@property({ type: Object })
layoutsConfiguration: LayoutConfiguration = {};
Expand Down
1 change: 1 addition & 0 deletions packages/fiori/src/NotificationListGroupList.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { isSpace } from "@ui5/webcomponents-base/dist/Keys.js";
* that is used to support keyboard navigation of the notification group internal list.
*
* @private
* @extends List
*/
@customElement("ui5-notification-group-list")
class NotificationListGroupList extends List {
Expand Down
1 change: 1 addition & 0 deletions packages/fiori/src/NotificationListInternal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import getActiveElement from "@ui5/webcomponents-base/dist/util/getActiveElement
* that is used to support keyboard navigation of the notification list internal list.
*
* @private
* @extends List
*/
@customElement("ui5-notification-list-internal")
class NotificationListInternal extends List {
Expand Down
1 change: 1 addition & 0 deletions packages/fiori/src/ShellBar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1212,6 +1212,7 @@ export {
export type {
/* Event Types */
ShellBarProfileClickEventDetail,
ShellBarSearchButtonEventDetail,
ShellBarSearchFieldClearEventDetail,
ShellBarSearchFieldToggleEventDetail,
ShellBarProductSwitchClickEventDetail,
Expand Down
6 changes: 3 additions & 3 deletions packages/main/src/Carousel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -752,7 +752,7 @@ class Carousel extends UI5Element {
* @since 1.0.0-rc.15
* @public
*/
navigateTo(itemIndex: number) {
navigateTo(itemIndex: number): void {
if (!this.isIndexInRange(itemIndex)) {
return;
}
Expand Down Expand Up @@ -998,10 +998,10 @@ class Carousel extends UI5Element {
/**
* Returns only visible (non-hidden) content items.
* Items with the 'hidden' attribute are automatically excluded from carousel navigation.
* @default []
* @private
* @returns {Array<HTMLElement>}
*/
get _visibleItems() {
get _visibleItems(): Array<HTMLElement> {
return this.content.filter(x => !x.hasAttribute("hidden"));
}

Expand Down
1 change: 1 addition & 0 deletions packages/main/src/DateTimeInput.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { isDesktop, isPhone, isTablet } from "@ui5/webcomponents-base/dist/Devic
* Intended to be used for the DateTime components.
*
* @class
* @extends Input
* @private
*/
@customElement({
Expand Down
4 changes: 2 additions & 2 deletions packages/main/src/ListItemCustom.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ class ListItemCustom extends ListItem {

/**
* Checks if this element is currently being dragged
* @returns {boolean} True if this element is being dragged
* @returns True if this element is being dragged
* @private
*/
_isDragging(): boolean {
Expand Down Expand Up @@ -143,7 +143,7 @@ class ListItemCustom extends ListItem {

/**
* Gets delete button nodes to process for accessibility
* @returns {Node[]} Array of nodes to process
* @returns Array of nodes to process
* @private
*/
private _getDeleteButtonNodes(): Node[] {
Expand Down
1 change: 1 addition & 0 deletions packages/main/src/dynamic-date-range-options/DateRange.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import DynamicDateRange from "../DynamicDateRange.js";

/**
* @class
* @implements {IDynamicDateRangeOption}
* @constructor
* @public
* @since 2.11.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const DEFAULT_DELIMITER = "-";

/**
* @class
* @implements {IDynamicDateRangeOption}
* @constructor
* @public
* @since 2.16.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import DynamicDateRange from "../DynamicDateRange.js";

/**
* @class
* @implements {IDynamicDateRangeOption}
* @constructor
* @public
* @since 2.11.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {

/**
* @class
* @implements {IDynamicDateRangeOption}
* @constructor
* @public
* @since 2.14.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {

/**
* @class
* @implements {IDynamicDateRangeOption}
* @constructor
* @public
* @since 2.14.0
Expand Down
1 change: 1 addition & 0 deletions packages/main/src/dynamic-date-range-options/SingleDate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import DynamicDateRange from "../DynamicDateRange.js";

/**
* @class
* @implements {IDynamicDateRangeOption}
* @constructor
* @public
* @since 2.11.0
Expand Down
1 change: 1 addition & 0 deletions packages/main/src/dynamic-date-range-options/ToDateTime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import DynamicDateRange from "../DynamicDateRange.js";

/**
* @class
* @implements {IDynamicDateRangeOption}
* @constructor
* @public
* @since 2.11.0
Expand Down
1 change: 1 addition & 0 deletions packages/main/src/dynamic-date-range-options/Today.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import DynamicDateRange from "../DynamicDateRange.js";

/**
* @class
* @implements {IDynamicDateRangeOption}
* @constructor
* @public
* @since 2.11.0
Expand Down
1 change: 1 addition & 0 deletions packages/main/src/dynamic-date-range-options/Tomorrow.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import DynamicDateRange from "../DynamicDateRange.js";

/**
* @class
* @implements {IDynamicDateRangeOption}
* @constructor
* @public
* @since 2.11.0
Expand Down
1 change: 1 addition & 0 deletions packages/main/src/dynamic-date-range-options/Yesterday.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import DynamicDateRange from "../DynamicDateRange.js";

/**
* @class
* @implements {IDynamicDateRangeOption}
* @constructor
* @public
* @since 2.11.0
Expand Down
2 changes: 1 addition & 1 deletion packages/tools/components-package/nps.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ const getScripts = (options) => {

const scripts = {
__ui5envs: {
UI5_CEM_MODE: options.dev,
UI5_CEM_MODE: typeof options.dev === "boolean" ? (options.dev ? "dev" : undefined) : options.dev,
UI5_TS: `${tsOption}`,
CSS_VARIABLES_TARGET: options.cssVariablesTarget ?? "root",
CYPRESS_COVERAGE: !!(options.internal?.cypress_code_coverage),
Expand Down
11 changes: 9 additions & 2 deletions packages/tools/lib/cem/custom-elements-manifest.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ const wrapPluginForQuietMode = (plugin) => {
...plugin,
packageLinkPhase(context) {
const originalLog = console.log;
console.log = () => {};
console.log = () => { };
try {
return originalPackageLinkPhase.call(plugin, context);
} finally {
Expand Down Expand Up @@ -135,6 +135,13 @@ function processClass(ts, classNode, moduleDoc) {
if (currClass.superclass?.name === "UI5Element") {
currClass.customElement = true;
}
} else if (currClass.customElement && classNode?.heritageClauses) {
// Find the extends clause (not implements)
const extendsClause = classNode.heritageClauses.find(clause => clause.token === ts.SyntaxKind.ExtendsKeyword);
if (extendsClause?.types?.[0]?.expression?.text) {
const extendedClass = extendsClause.types[0].expression.text;
logDocumentationError(moduleDoc.path, `Class extends ${extendedClass} but @extends tag is missing in JSDoc`);
}
}

if (!currClass._ui5implements.length) delete currClass._ui5implements;
Expand Down Expand Up @@ -417,7 +424,7 @@ const processPublicAPI = object => {
return true;
}
for (const key of keys) {
if ((key === "privacy" && object[key] !== "public") || (key === "_ui5privacy" && object[key] !== "public")) {
if (((key === "privacy" && object[key] !== "public") || (key === "_ui5privacy" && object[key] !== "public")) && !object.customElement) {
return true;
} else if (typeof object[key] === "object") {
if (key === "cssParts" || key === "attributes" || key === "_ui5implements") {
Expand Down
3 changes: 2 additions & 1 deletion packages/tools/lib/cem/utils.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,8 @@ const validateJSDocComment = (fieldType, jsdocComment, node, moduleDoc) => {
}

if (!isValid) {
logDocumentationError(moduleDoc.path, `Incorrect use of @${tag.tag}. Ensure it is part of ${fieldType} JSDoc tags.`)
const nodeName = node ? ` in '${node}'` : '';
logDocumentationError(moduleDoc.path, `Incorrect use of @${tag.tag}${nodeName}. Ensure it is part of ${fieldType} JSDoc tags.`)
}

return !!isValid;
Expand Down
Loading