IWidgetInstance

Definition

export interface IWidgetInstance {
    _id: string,
    id: string,
    key: string,
    name: string,
    widget: any,
    props?: { [key: string]: any },
    layout: ILayout | any,
    configs?: IWidgetConfigs,
    hasConfigured: boolean,
    defaultProps?: { [propName: string]: any }
    external?: {
        styles?: { [key: string]: string }
        scripts?: { [key: string]: string }
    }
    sourceUrl?: string,
    installed?: boolean,
    isTemplate?: boolean,
    isDefaultTemplate?: boolean,
    templateKey?: string
    templateType?: string
    category?: string,
    usecaseId?: string,
    usecaseName?: string,
    definitionPath?: string,
    description?: string
    preloaded?: boolean // indicates a widget has been loaded ,
    isNotAvalable?: boolean,
    direction?: 'ltr' | 'rtl',
    localizedName?: string,
    localizedDescription?: string
}

Usage

import { IWidgetInstance } from 'uxp/components';

Related Types

• ILayout

• IWidgetConfigs

• DynamicFormFieldProps

• FormValue

• IFormData

• CustomValidateResponse

• FormSectionProps

• IConfigPanelProps

• IContextProvider

• IPartialContextProvider

• Language

• ICustomThemes

• IThemeProps

• ThemeType

• UserDetails

• NavigationLink

• Routes

• ConfiguredPage

• ComponentType

• IUXPFunctions

• ViewOverride

• Environment

• ExecutionOptions

• CachingOptions

• IDataFunction

• QueryParams

• ExecutionResult

• ExecuteMicroserviceConfig

• ExecuteConfigBase

• LucyQueryResult

• IWidgetPreloader