/// <reference path="../common/constants.ts" />

/**
 * @module UI
 * @namespace ui
 */
namespace internal.ui {
    /**
     * UIInfo class which describes the details about a UI component
     *
     * Example:
     *
     *     // UIInfo used to render a UI component as an IFRAME
     *     var iframeUIInfo = {
     *         type: sdk.ui.HostType.IFRAME,
     *         containerSelector: "#iframe-container",
     *         accessibilityTitle: "My awesome component"
     *     };
     *
     *     // UIInfo used to render a UI component as a popup
     *     var popupUIInfo = {
     *         type: sdk.ui.HostType.POPUP,
     *         width: 600,
     *         height: 800
     *     };
     *
     * @class UIInfo
     * @static
     */
    export interface UIInfo {
        /**
         * A value from {{#crossLink "ui.HostType"}}{{/crossLink}}
         * @property {string} type
         */
        type: HostType;

        /**
         * Iframe container selector. Applicable when type is ui.HostType.IFRAME
         * @property {string} containerSelector
         */
        containerSelector?: string;

        /**
         * Iframe title value for accessibility. Applicable when type is ui.HostType.IFRAME
         * @property {string} containerSelector
         */
        accessibilityTitle?: string;

        /**
         * Width of the popup window. Applicable when type is ui.HostType.POPUP
         * @property {number} width
         */
        width?: number;

        /**
         * Height of the popup window. Applicable when type is ui.HostType.POPUP
         * @property {number} height
         */
        height?: number;
    }
}