cumulocity-cypress/shared/types.d.ts

Cypress commands for Cumulocity IoT

/**
 * Tenant ID of a Cumulocity tenant.
 * @example t123456
 */
export type C8yTenant = string;
/**
 * Base URL of a Cumulocity tenant.
 * @example https://tenant.eu-latest.cumulocity.com
 */
export type C8yBaseUrl = string;
export interface C8yHighlightOptions {
    /**
     * The border style. Use any valid CSS border style. If provided an object, keys override the default border style.
     * @examples ["1px solid red"]
     */
    border?: string | any;
    /**
     * The CSS styles to apply to the DOM element. Use any valid CSS styles.
     * @examples [["background-color: yellow", "outline: dashed", "outline-offset: +3px"]]
     */
    styles?: any;
    /**
     * Overwrite the width of the highlighted element. If smaller than 1, the value is used as percentage of the element width.
     */
    width?: number;
    /**
     * Overwrite the height of the highlighted element. If smaller than 1, the value is used as percentage of the element height.
     */
    height?: number;
    /**
     * If true, existing highlights will be cleared before highlighting. The default is false.
     * @default false
     */
    clear?: boolean;
    /**
     * If true, the highlight is applied to all elements in the selection. The default is false.
     * @default false
     */
    multiple?: boolean;
    /**
     * If true, the highlight styles are applied to a detached <div> element instead of the target element. This is done automatically for elements with rounded corners or disabled elements to avoid visual issues. Use detached:true to force detached highlights.
     * @default false
     */
    detached?: boolean;
}
/**
 * Default highlight options used by the cy.highlight() command. Use this object to override the default highlight style.
 *
 * Highligh style can be any css style or an object with css properties.
 */
export declare const C8yHighlightStyleDefaults: {
    readonly outline: "2px";
    readonly "outline-style": "solid";
    readonly "outline-offset": "-2px";
    readonly "outline-color": "#FF9300";
};
export type C8yTestHierarchyTree<T> = {
    [key: string]: T | C8yTestHierarchyTree<T>;
};