IClientSideWebPartStatusRenderer interface

Pacote:

@microsoft/sp-webpart-base

Interface a implementar por um componente que deve apresentar o indicador de carregamento e as mensagens de erro de uma peça Web.

Métodos

clearError(domElement)	Limpe a mensagem de erro da Web Part.
clearLoadingIndicator(domElement)	Desmarque o indicador de carregamento.
displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)	Exiba um controle giratório carregando.
renderError(domElement, error, clearDomElementCallback)	Renderize a mensagem de erro fornecida no contêiner div da Web Part.

Detalhes do método

clearError(domElement)

Limpe a mensagem de erro da Web Part.

clearError(domElement: HTMLElement): void;

Parâmetros

domElement

HTMLElement

a peça Web container div.

Retornos

void

clearLoadingIndicator(domElement)

Desmarque o indicador de carregamento.

clearLoadingIndicator(domElement: Element): void;

Parâmetros

domElement

Element

a peça Web container div.

Retornos

void

displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)

Exiba um controle giratório carregando.

displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number, clearDomElementCallback?: ClearDomElementCallback): void;

Parâmetros

domElement

Element

a peça Web container div.

loadingMessage

string

a mensagem a ser exibida quando a id do controle giratório é exibida.

timeout

number

o tempo limite para processar o indicador de carregamento. A predefinição é 1500ms.

clearDomElementCallback

@microsoft/sp-webpart-base!~ClearDomElementCallback:type

Chamada de retorno para limpar o nó dom antes de compor o indicador. A API DOM Padrão será utilizada após a chamada de retorno.

Retornos

void

renderError(domElement, error, clearDomElementCallback)

Renderize a mensagem de erro fornecida no contêiner div da Web Part.

renderError(domElement: HTMLElement, error: Error | string, clearDomElementCallback?: ClearDomElementCallback): void;

Parâmetros

domElement

HTMLElement

a peça Web container div.

error

Error | string

a mensagem de erro.

clearDomElementCallback

@microsoft/sp-webpart-base!~ClearDomElementCallback:type

Chamada de retorno para limpar o nó dom antes de compor o elemento de erro. A API DOM Padrão será utilizada após a chamada de retorno.

Retornos

void