@ui5/webcomponents-react/wrappers/webComponents/IllustratedMessage/index.d.ts

React Wrapper for UI5 Web Components and additional components

import '@ui5/webcomponents-fiori/dist/IllustratedMessage.js';
import type IllustrationMessageDesign from '@ui5/webcomponents-fiori/dist/types/IllustrationMessageDesign.js';
import type { CommonProps, Ui5DomRef, UI5WCSlotsNode } from '@ui5/webcomponents-react-base';
import type { ReactNode } from 'react';
interface IllustratedMessageAttributes {
    /**
     * Receives id(or many ids) of the elements that label the component.
     *
     * **Note:** Available since [v1.7.0](https://github.com/UI5/webcomponents/releases/tag/v1.7.0) of **@ui5/webcomponents-fiori**.
     * @default undefined
     */
    accessibleNameRef?: string | undefined;
    /**
     * Defines whether the illustration is decorative.
     *
     * When set to `true`, the attributes `role="presentation"` and `aria-hidden="true"` are applied to the SVG element.
     *
     * **Note:** Available since [v2.10.0](https://github.com/UI5/webcomponents/releases/tag/v2.10.0) of **@ui5/webcomponents-fiori**.
     * @default false
     */
    decorative?: boolean;
    /**
     * Determines which illustration breakpoint variant is used.
     *
     * As `IllustratedMessage` adapts itself around the `Illustration`, the other
     * elements of the component are displayed differently on the different breakpoints/illustration designs.
     *
     * **Note:** Available since [v2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-fiori**.
     * @default "Auto"
     */
    design?: IllustrationMessageDesign | keyof typeof IllustrationMessageDesign;
    /**
     * Defines the illustration name that will be displayed in the component.
     *
     * Example:
     *
     * `name='BeforeSearch'`, `name='UnableToUpload'`, etc..
     *
     * **Note:** To use the TNT illustrations,
     * you need to set the `tnt` or `Tnt` prefix in front of the icon's name.
     *
     * Example:
     *
     * `name='tnt/Avatar'` or `name='TntAvatar'`.
     *
     * **Note:** By default the `BeforeSearch` illustration is loaded.
     * When using an illustration type, other than the default, it should be loaded in addition:
     *
     * `import "@ui5/webcomponents-fiori/dist/illustrations/NoData.js";`
     *
     * For TNT illustrations:
     *
     * `import "@ui5/webcomponents-fiori/dist/illustrations/tnt/SessionExpired.js";`
     * @default "BeforeSearch"
     */
    name?: string;
    /**
     * Defines the subtitle of the component.
     *
     * **Note:** Using this property, the default subtitle text of illustration will be overwritten.
     *
     * **Note:** Using `subtitle` slot, the default of this property will be overwritten.
     * @default undefined
     */
    subtitleText?: string | undefined;
    /**
     * Defines the title of the component.
     *
     * **Note:** Using this property, the default title text of illustration will be overwritten.
     * @default undefined
     */
    titleText?: string | undefined;
}
interface IllustratedMessageDomRef extends Required<IllustratedMessageAttributes>, Ui5DomRef {
}
interface IllustratedMessagePropTypes extends IllustratedMessageAttributes, Omit<CommonProps, keyof IllustratedMessageAttributes | 'children' | 'subtitle' | 'title'> {
    /**
     * Defines the component actions.
     *
     * **Note:** Not displayed when the `design` property is set to `Base`.
     *
     * __Supported Node Type/s:__ `Array<IButton>`
     */
    children?: ReactNode | ReactNode[];
    /**
     * Defines the subtitle of the component.
     *
     * **Note:** Using this slot, the default subtitle text of illustration and the value of `subtitleText` property will be overwritten.
     *
     * __Note:__ The content of the prop will be rendered into a [&lt;slot&gt;](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/slot) by assigning the respective [slot](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/slot) attribute (`slot="subtitle"`).
     * Since you can't change the DOM order of slots when declaring them within a prop, it might prove beneficial to manually mount them as part of the component's children, especially when facing problems with the reading order of screen readers.
     *
     * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component.
     * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs).
     *
     * __Supported Node Type/s:__ `Array<HTMLElement>`
     */
    subtitle?: UI5WCSlotsNode;
    /**
     * Defines the title of the component.
     *
     * **Note:** Using this slot, the default title text of illustration and the value of `title` property will be overwritten.
     *
     * __Note:__ The content of the prop will be rendered into a [&lt;slot&gt;](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/slot) by assigning the respective [slot](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/slot) attribute (`slot="title"`).
     * Since you can't change the DOM order of slots when declaring them within a prop, it might prove beneficial to manually mount them as part of the component's children, especially when facing problems with the reading order of screen readers.
     *
     * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component.
     * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs).
     *
     * **Note:** Available since [v1.7.0](https://github.com/UI5/webcomponents/releases/tag/v1.7.0) of **@ui5/webcomponents-fiori**.
     *
     * __Supported Node Type/s:__ `Array<HTMLElement> & string`
     */
    title?: UI5WCSlotsNode;
}
/**
 * An IllustratedMessage is a recommended combination of a solution-oriented message, an engaging
 * illustration, and conversational tone to better communicate an empty or a success state than just show
 * a message alone.
 *
 * Each illustration has default internationalised title and subtitle texts. Also they can be managed with
 * `titleText` and `subtitleText` properties.
 *
 * To display the desired illustration, use the `name` property, where you can find the list of all available illustrations.
 *
 * **Note:** By default the “BeforeSearch” illustration is loaded. To use other illustrations, make sure you import them in addition, for example:
 *
 * `import "@ui5/webcomponents-fiori/dist/illustrations/NoData.js"`
 *
 * **Note:** Illustrations starting with the “Tnt” prefix are part of another illustration set. For example to use the “TntSuccess” illustration, add the following import::
 *
 * `import "@ui5/webcomponents-fiori/dist/illustrations/tnt/Success.js"`
 *
 * ### Structure
 * The IllustratedMessage consists of the following elements, which are displayed below each other in the following order:
 *
 * - Illustration
 * - Title
 * - Subtitle
 * - Actions
 *
 * ### Usage
 * `IllustratedMessage` is meant to be used inside container component, for example a `ui5-card`,
 * a `ui5-dialog` or a `Page`
 *
 *
 *
 * __Note:__ This is a UI5 Web Component! [IllustratedMessage UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/IllustratedMessage) | [Repository](https://github.com/UI5/webcomponents)
 */
declare const IllustratedMessage: import("react").ForwardRefExoticComponent<IllustratedMessagePropTypes & import("@ui5/webcomponents-react-base").WithWebComponentPropTypes & import("react").RefAttributes<IllustratedMessageDomRef>>;
export { IllustratedMessage };
export type { IllustratedMessageDomRef, IllustratedMessagePropTypes };