@openui5/sap.m
Version:
OpenUI5 UI Library sap.m
62 lines (55 loc) • 2.02 kB
JavaScript
/*!
* UI development toolkit for HTML5 (OpenUI5)
* (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
* Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
*/
/**
* Defines support rules of the Button control of sap.m library.
*/
sap.ui.define(["sap/ui/support/library"],
function(SupportLib) {
"use strict";
// shortcuts
var Categories = SupportLib.Categories, // Accessibility, Performance, Memory, ...
Severity = SupportLib.Severity, // Hint, Warning, Error
Audiences = SupportLib.Audiences; // Control, Internal, Application
//**********************************************************
// Rule Definitions
//**********************************************************
/**
*Checks, if a button consisting of only an icon has a tooltip (design guideline)
*/
var oButtonRule = {
id : "onlyIconButtonNeedsTooltip",
audiences: [Audiences.Control],
categories: [Categories.Usability],
enabled: true,
minversion: "1.28",
title: "Button: Consists of only an icon, needs a tooltip",
description: "A button without text needs a tooltip, so that the user knows what the button does",
resolution: "Add a value to the tooltip property of the button",
resolutionurls: [{
text: "SAP Fiori Design Guidelines: Button",
href: "https://experience.sap.com/fiori-design-web/button/#guidelines"
}],
check: function (oIssueManager, oCoreFacade, oScope) {
oScope.getElementsByClassName("sap.m.Button")
.forEach(function(oElement) {
if (oElement.getProperty("icon")
&& !oElement.getProperty("text")
&& !oElement.getAggregation("tooltip")) {
var sElementId = oElement.getId(),
sElementName = oElement.getMetadata().getElementName();
oIssueManager.addIssue({
severity: Severity.Medium,
details: "Button '" + sElementName + "' (" + sElementId + ") consists of only an icon but has no tooltip",
context: {
id: sElementId
}
});
}
});
}
};
return [oButtonRule];
}, true);