@openui5/sap.m/src/sap/m/rules/Button.support.js

OpenUI5 UI Library sap.m

/*!
 * OpenUI5
 * (c) Copyright 2026 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

	// Controls that internally have sap.m.Button instances.
	var aExcludeListControls = [
		"sap.ui.comp.smartvariants.SmartVariantManagement",
		"sap.m.SplitButton"
	];

	function isControlExcludeListed(oControl) {
		if (oControl) {
			for (var i = 0; i < aExcludeListControls.length; i++) {
				if (oControl.isA(aExcludeListControls[i])) {
					return true;
				}
			}
		}
		return false;
	}

	function isInsideExcludeListedControl(oButton) {
		if (!oButton) {
			return false;
		}

		// Check one level up.
		if (isControlExcludeListed(oButton.getParent())) {
			return true;
		}
		// Check two levels up.
		if (oButton.getParent() && isControlExcludeListed(oButton.getParent().getParent())) {
			return true;
		}

		return false;
	}

	//**********************************************************
	// 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.Accessibility],
		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();

						if (!isInsideExcludeListedControl(oElement)) {
							oIssueManager.addIssue({
								severity: Severity.Medium,
								details: "Button '" + sElementName + "' (" + sElementId + ") consists of only an icon but has no tooltip",
								context: {
									id: sElementId
								}
							});
						}
					}
				});
		}
	};

	return [oButtonRule];

}, true);