@ui5/webcomponents-fiori 1.3.1 → 1.6.0

package/src/types/IllustrationMessageSize.js

@@ -0,0 +1,71 @@
+import DataType from "@ui5/webcomponents-base/dist/types/DataType.js";
+
+/**
+ * Different types of IllustrationMessageSize.
+ * @lends sap.ui.webcomponents.fiori.types.IllustrationMessageSize.prototype
+ * @public
+ * @since 1.5.0
+ */
+const IllustrationMessageSizes = {
+	/**
+	 * Automatically decides the <code>Illustration</code> size (<code>Base</code>, <code>Spot</code>,
+	 * <code>Dialog</code>, or <code>Scene</code>) depending on the <code>IllustratedMessage</code> container width.
+	 *
+	 * <b>Note:</b> <code>Auto</code> is the only option where the illustration size is changed according to
+	 * the available container width. If any other <code>IllustratedMessageSize</code> is chosen, it remains
+	 * until changed by the app developer.
+	 *
+	 * @public
+	 * @type {Auto}
+	 */
+	Auto: "Auto",
+	/**
+	 * Base <code>Illustration</code> size (XS breakpoint). Suitable for cards (two columns).
+	 *
+	 * <b>Note:</b> When <code>Base</code> is in use, no illustration is displayed.
+	 *
+	 * @public
+	 * @type {Base}
+	 */
+	Base: "Base",
+
+	/**
+	 * Spot <code>Illustration</code> size (S breakpoint). Suitable for cards (four columns).
+	 * @public
+	 * @type {Spot}
+	 */
+	Spot: "Spot",
+
+	/**
+	 * Dialog <code>Illustration</code> size (M breakpoint). Suitable for dialogs.
+	 * @public
+	 * @type {Dialog}
+	 */
+	Dialog: "Dialog",
+
+	/**
+	 * Scene <code>Illustration</code> size (L breakpoint). Suitable for a <code>Page</code> or a table.
+	 * @public
+	 * @type {Scene}
+	 */
+	Scene: "Scene",
+};
+
+/**
+ * @class
+ * Different types of IllustrationMessageSize.
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.fiori.types.IllustrationMessageSize
+ * @public
+ * @enum {string}
+ */
+class IllustrationMessageSize extends DataType {
+	static isValid(value) {
+		return !!IllustrationMessageSizes[value];
+	}
+}
+
+IllustrationMessageSize.generateTypeAccessors(IllustrationMessageSizes);
+
+export default IllustrationMessageSize;