@apptane/react-ui-cue/dist/types/Cue.types.d.ts

Visual cue component in Apptane React UI framework

/// <reference types="react" />
import { TriggerOption } from "@apptane/react-ui-behaviors";
import { Color, Intent, MarginProps, PaletteTextSlot, Placement } from "@apptane/react-ui-core";
import { IconData } from "@apptane/react-ui-icon";
import { TooltipAppearance } from "@apptane/react-ui-theme";
import PropTypes from "prop-types";
export interface CueProps extends MarginProps {
    /**
     * Content.
     */
    children?: React.ReactNode;
    /**
     * Header.
     */
    header?: React.ReactNode;
    /**
     * Visual appearance. Defaults to `dark`.
     */
    appearance?: TooltipAppearance;
    /**
     * Preferred placement of the tooltip or popover. Defaults to `top-left`.
     * May be overridden by the positioner if conflicts with the viewport.
     */
    placement?: Placement;
    /**
     * Overrides maximum width specified by the theme.
     */
    maxWidth?: number;
    /**
     * Visual intent. Defaults to `none`.
     * Determines default presentation.
     */
    intent?: Intent;
    /**
     * Trigger options.
     */
    trigger?: TriggerOption | TriggerOption[];
    /**
     * Color of the icon. Overrides the color specified by `intent`.
     */
    color?: Color | PaletteTextSlot;
    /**
     * Name of the icon. See `Icon` component.
     */
    name?: string;
    /**
     * Vector data of the icon. If specified overrides `iconName` property.
     */
    data?: IconData;
    /**
     * Size of the icon in pixels. Icon has the same width and height.
     * Defaults to 16px.
     */
    size?: number;
    /**
     * Z-index (passed to `Trigger` layer).
     */
    zIndex?: number;
    /**
     * Indicates whether it must be rendered as an inline element.
     */
    inline?: boolean;
}
export declare const CuePropTypes: {
    children: PropTypes.Requireable<any>;
    header: PropTypes.Requireable<any>;
    appearance: PropTypes.Requireable<TooltipAppearance>;
    placement: PropTypes.Requireable<Placement>;
    maxWidth: PropTypes.Requireable<number>;
    intent: PropTypes.Requireable<Intent>;
    trigger: PropTypes.Requireable<TriggerOption | TriggerOption[]>;
    color: PropTypes.Requireable<string>;
    name: PropTypes.Requireable<string>;
    data: PropTypes.Requireable<PropTypes.InferProps<{
        viewBox: PropTypes.Requireable<string>;
        svg: PropTypes.Requireable<PropTypes.ReactNodeLike>;
    }>>;
    size: PropTypes.Requireable<number>;
    zIndex: PropTypes.Requireable<number>;
    inline: PropTypes.Requireable<boolean>;
    margin: PropTypes.Requireable<string | number>;
    marginTop: PropTypes.Requireable<string | number>;
    marginRight: PropTypes.Requireable<string | number>;
    marginBottom: PropTypes.Requireable<string | number>;
    marginLeft: PropTypes.Requireable<string | number>;
    m: PropTypes.Requireable<string | number>;
    mt: PropTypes.Requireable<string | number>;
    mr: PropTypes.Requireable<string | number>;
    mb: PropTypes.Requireable<string | number>;
    ml: PropTypes.Requireable<string | number>;
};