Interface ISPFxWebPartProps

SPFx WebPart Properties

Hierarchy

ISPFxWebPartProps
- ISPFxListWebPartProps

Index

Properties

envType? onConfigFormDisplaying? onConfigFormFooterRendering? onConfigFormRendered? onConfigFormRendering? onConfigSaved? onConfigSaving? onModalRendered? onModalRendering? render? renderEdit? spfx?

Properties

`Optional` envType

envType?: number

The environment type.

`Optional` onConfigFormDisplaying

onConfigFormDisplaying?: ((wpCfg?) => void)

Type declaration

- (wpCfg?): void
- The event called when the modal is being displayed.
  Parameters
  - Optional wpCfg: ISPFxWebPartCfg
  Returns void

`Optional` onConfigFormFooterRendering

onConfigFormFooterRendering?: ((props, wpCfg?) => ITooltipGroupProps)

Type declaration

- (props, wpCfg?): ITooltipGroupProps
- The webpart configuration modal footer button properties.
  Parameters
  - props: ITooltipGroupProps
  - Optional wpCfg: ISPFxWebPartCfg
  Returns ITooltipGroupProps

`Optional` onConfigFormRendered

onConfigFormRendered?: ((form, wpCfg?) => void)

Type declaration

- (form, wpCfg?): void
- The webpart configuration modal form object.
  Parameters
  - form: IForm
  - Optional wpCfg: ISPFxWebPartCfg
  Returns void

`Optional` onConfigFormRendering

onConfigFormRendering?: ((props, wpCfg?) => IFormProps)

Type declaration

- (props, wpCfg?): IFormProps
- The webpart configuration modal form properties.
  Parameters
  - props: IFormProps
  - Optional wpCfg: ISPFxWebPartCfg
  Returns IFormProps

`Optional` onConfigSaved

onConfigSaved?: ((wpCfg?) => void)

Type declaration

- (wpCfg?): void
- The event called after the webpart configuration is saved.
  Parameters
  - Optional wpCfg: ISPFxWebPartCfg
  Returns void

`Optional` onConfigSaving

onConfigSaving?: ((wpCfg) => ISPFxWebPartCfg)

Type declaration

- (wpCfg): ISPFxWebPartCfg
- The event called prior to saving the webpart configuration.
  Parameters
  - wpCfg: ISPFxWebPartCfg
  Returns ISPFxWebPartCfg

`Optional` onModalRendered

onModalRendered?: ((modal) => void)

Type declaration

- (modal): void
- The webpart configuration modal properties.
  Parameters
  - modal: IModal
  Returns void

`Optional` onModalRendering

onModalRendering?: ((props) => IModalProps<HTMLElement>)

Type declaration

- (props): IModalProps<HTMLElement>
- The webpart configuration modal properties.
  Parameters
  - props: IModalProps<HTMLElement>
  Returns IModalProps<HTMLElement>

`Optional` render

render?: ((el?, cfg?) => void)

Type declaration

- (el?, cfg?): void
- The render event for the webpart.
  Parameters
  - Optional el: HTMLElement
  - Optional cfg: ISPFxWebPartCfg
  Returns void

`Optional` renderEdit

renderEdit?: ((el?, cfg?) => void)

Type declaration

- (el?, cfg?): void
- The render event for the webpart when the page is in edit mode.
  Parameters
  - Optional el: HTMLElement
  - Optional cfg: ISPFxWebPartCfg
  Returns void

`Optional` spfx

spfx?: {
    context: {
        domElement: HTMLElement;
        graphHttpClient: any;
        host: any;
        httpClient: any;
        instanceId: string;
        itemId?: number;
        list?: {
            title: string;
        };
        manifest: {
            alias: string;
            componentType: string;
            id: string;
            loaderConfig: any;
            manifestVersion: number;
            requiresCustomScript: boolean;
            supportedHosts: string[];
            supportsThemeVariants: boolean;
            version: string;
        };
        pageContext: any;
        propertyPane: any;
        serviceScope: any;
        spHttpClient: any;
        statusRenderer: any;
        webPartTag: string;
    };
    dataVersion: any;
    description: string;
    displayMode: number;
    domElement: HTMLElement;
    formClosed?: (() => void);
    formSaved?: (() => void);
    getPropertyPaneConfiguration: any;
    instanceId: string;
    isRenderAsync: boolean;
    previewImageUrl: string;
    properties: any;
    propertiesMetadata: any;
    title: string;
    width: number;
}

The spfx properties.

Type declaration

context: {
    domElement: HTMLElement;
    graphHttpClient: any;
    host: any;
    httpClient: any;
    instanceId: string;
    itemId?: number;
    list?: {
        title: string;
    };
    manifest: {
        alias: string;
        componentType: string;
        id: string;
        loaderConfig: any;
        manifestVersion: number;
        requiresCustomScript: boolean;
        supportedHosts: string[];
        supportsThemeVariants: boolean;
        version: string;
    };
    pageContext: any;
    propertyPane: any;
    serviceScope: any;
    spHttpClient: any;
    statusRenderer: any;
    webPartTag: string;
}
- domElement: HTMLElement
- graphHttpClient: any
- host: any
- httpClient: any
- instanceId: string
- Optional itemId?: number
- Optional list?: {
  title: string;
  }
  - title: string
- manifest: {
      alias: string;
      componentType: string;
      id: string;
      loaderConfig: any;
      manifestVersion: number;
      requiresCustomScript: boolean;
      supportedHosts: string[];
      supportsThemeVariants: boolean;
      version: string;
  }
  - alias: string
  - componentType: string
  - id: string
  - loaderConfig: any
  - manifestVersion: number
  - requiresCustomScript: boolean
  - supportedHosts: string[]
  - supportsThemeVariants: boolean
  - version: string
- pageContext: any
- propertyPane: any
- serviceScope: any
- spHttpClient: any
- statusRenderer: any
- webPartTag: string
dataVersion: any
description: string
displayMode: number
domElement: HTMLElement
Optional formClosed?: (() => void)
- - (): void
  - Returns void
Optional formSaved?: (() => void)
- - (): void
  - Returns void
getPropertyPaneConfiguration: any
instanceId: string
isRenderAsync: boolean
previewImageUrl: string
properties: any
propertiesMetadata: any
title: string
width: number

Interface ISPFxWebPartProps

Hierarchy

Index

Properties

Properties

Optional envType

Optional onConfigFormDisplaying

Type declaration

Parameters

Optional wpCfg: ISPFxWebPartCfg

Returns void

Optional onConfigFormFooterRendering

Type declaration

Parameters

props: ITooltipGroupProps

Optional wpCfg: ISPFxWebPartCfg

Returns ITooltipGroupProps

Optional onConfigFormRendered

Type declaration

Parameters

form: IForm

Optional wpCfg: ISPFxWebPartCfg

Returns void

Optional onConfigFormRendering

Type declaration

Parameters

props: IFormProps

Optional wpCfg: ISPFxWebPartCfg

Returns IFormProps

Optional onConfigSaved

Type declaration

Parameters

Optional wpCfg: ISPFxWebPartCfg

Returns void

Optional onConfigSaving

Type declaration

Parameters

wpCfg: ISPFxWebPartCfg

Returns ISPFxWebPartCfg

Optional onModalRendered

Type declaration

Parameters

modal: IModal

Returns void

Optional onModalRendering

Type declaration

Parameters

props: IModalProps<HTMLElement>

Returns IModalProps<HTMLElement>

Optional render

Type declaration

Parameters

Optional el: HTMLElement

Optional cfg: ISPFxWebPartCfg

Returns void

Optional renderEdit

Type declaration

Parameters

Optional el: HTMLElement

Optional cfg: ISPFxWebPartCfg

Returns void

Optional spfx

Type declaration

domElement: HTMLElement

graphHttpClient: any

host: any

httpClient: any

instanceId: string

Optional itemId?: number

Optional list?: { title: string; }

title: string

manifest: { alias: string; componentType: string; id: string; loaderConfig: any; manifestVersion: number; requiresCustomScript: boolean; supportedHosts: string[]; supportsThemeVariants: boolean; version: string; }

alias: string

componentType: string

id: string

loaderConfig: any

manifestVersion: number

requiresCustomScript: boolean

supportedHosts: string[]

supportsThemeVariants: boolean

`Optional` envType

`Optional` onConfigFormDisplaying

`Optional` wpCfg: ISPFxWebPartCfg

`Optional` onConfigFormFooterRendering

`Optional` wpCfg: ISPFxWebPartCfg

`Optional` onConfigFormRendered

`Optional` wpCfg: ISPFxWebPartCfg

`Optional` onConfigFormRendering

`Optional` wpCfg: ISPFxWebPartCfg

`Optional` onConfigSaved

`Optional` wpCfg: ISPFxWebPartCfg

`Optional` onConfigSaving

`Optional` onModalRendered

`Optional` onModalRendering

`Optional` render

`Optional` el: HTMLElement

`Optional` cfg: ISPFxWebPartCfg

`Optional` renderEdit

`Optional` el: HTMLElement

`Optional` cfg: ISPFxWebPartCfg

`Optional` spfx

`Optional` itemId?: number

`Optional` list?: {
title: string;
}

manifest: {
alias: string;
componentType: string;
id: string;
loaderConfig: any;
manifestVersion: number;
requiresCustomScript: boolean;
supportedHosts: string[];
supportsThemeVariants: boolean;
version: string;
}

`Optional` formClosed?: (() => void)

`Optional` formSaved?: (() => void)