gd-bs/src/components/jumbotron/types.d.ts

Bootstrap JavaScript, TypeScript and Web Components library.

/**
 * <div id="demo"></div>
 * <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/gd-sprest-bs/5.0.3/gd-sprest-bs.min.js"></script>
 * <script type="text/javascript">
 *     // Wait for the window to be loaded
 *     window.addEventListener("load", function() {
 *         // Render the jumbotron
 *         $REST.Components.Jumbotron({
 *             el: document.querySelector("#demo"),
 *             title: "My Jumbotron",
 *             lead: "This is a jumbotron"
 *         });
 *     });
 * </script>
 */

/**
 * ### Jumbotron
 * 
 * ```ts
 * import { Components } from "gd-sprest-bs";
 * 
 * // Create the jumbotron
 * let el = document.querySelector("#jumbotron");
 * let jumbotron = Components.Jumbotron({
 *     el: el,
 *     title: "My Jumbotron",
 *     lead: "This is a jumbotron"
 * });
 * ```
 */
export const Jumbotron: (props: IJumbotronProps, template?: string) => IJumbotron;
export const JumbotronSize: IJumbotronSize;
export const JumbotronTypes: IJumbotronTypes;

import { IBaseProps } from "../types";

/**
 * Jumbotron
 */
export interface IJumbotron {
    /** The element. */
    el: HTMLElement;

    /** Hides the jumbotron. */
    hide: () => void;

    /** Shows the jumbotron. */
    show: () => void;
}

/**
 * Jumbotron Properties
 */
export interface IJumbotronProps<T = Element> extends IBaseProps<IJumbotron> {
    content?: string | T;
    isFluid?: boolean;
    lead?: string;
    onRenderContent?: (el?: HTMLElement) => void;
    size?: number;
    title?: string;
    type?: number;
}

/**
 * Jumbotron Size
 */
export type IJumbotronSize = {
    XSmall: number;
    Small: number;
    Medium: number;
    Large: number;
    XLarge: number;
}
/**
 * Jumbotron Types
 */
export type IJumbotronTypes = {
    Danger: number;
    Dark: number;
    Info: number;
    Light: number;
    Primary: number;
    Secondary: number;
    Success: number;
    Warning: number;
}