Partager via

IClientSideWebPartStatusRenderer interface

  • Référence
Paquet:
@microsoft/sp-webpart-base

Interface à implémenter par un composant qui doit afficher l’indicateur de chargement et les messages d’erreur pour un composant WebPart.

Méthodes

clearError(domElement)

Effacez le message d’erreur du composant WebPart.
clearLoadingIndicator(domElement)

Effacer l’indicateur de chargement.
displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)

Afficher un compteur de chargement.
renderError(domElement, error, clearDomElementCallback)

Afficher le message d’erreur fourni dans le DIV du conteneur du composant WebPart

Détails de la méthode

clearError(domElement)

Effacez le message d’erreur du composant WebPart.

clearError(domElement: HTMLElement): void;

Paramètres

domElement

HTMLElement

conteneur du composant WebPart div.

Retours

void

clearLoadingIndicator(domElement)

Effacer l’indicateur de chargement.

clearLoadingIndicator(domElement: Element): void;

Paramètres

domElement

Element

conteneur du composant WebPart div.

Retours

void

displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)

Afficher un compteur de chargement.

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

Paramètres

domElement

Element

conteneur du composant WebPart div.

loadingMessage

string

message à afficher lorsque l’ID du compteur de chargement s’affiche.

timeout

number

__ Délai d’attente pour le rendu de l’indicateur de chargement. La valeur par défaut est 1500 ms.

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

Rappel pour effacer le nœud dom avant le rendu de l’indicateur. L’API DOM standard sera utilisée après le rappel.

Retours

void

renderError(domElement, error, clearDomElementCallback)

Afficher le message d’erreur fourni dans le DIV du conteneur du composant WebPart

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

Paramètres

domElement

HTMLElement

conteneur du composant WebPart div.

error

Error | string

message d’erreur.

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

Rappel pour effacer le nœud dom avant le rendu de l’élément error. L’API DOM standard sera utilisée après le rappel.

Retours

void