@microsoft/sp-webpart-base package

SharePoint Framework prise en charge de la création de composants WebPart.

Classes

BaseClientSideWebPart	Cette classe abstraite implémente la fonctionnalité de base d’un composant WebPart côté client. Chaque composant WebPart côté client doit hériter de cette classe.
BaseWebPart	Cette classe abstraite implémente la fonctionnalité de base indépendante de l’interface utilisateur pour un composant WebPart côté client. L’objectif est d’autoriser un cœur commun entre les composants WebPart 2D et MR.
BaseWebPartContext	Objet de contexte de composant WebPart. Cet objet contient les services contextuels disponibles pour un composant WebPart. par exemple, une instance contextuelle au client HTTP. Cette base doit être étendue par la base du composant WebPart spécifique à l’interface utilisateur.
WebPartContext	Objet de contexte de composant WebPart. Cet objet contient les services contextuels disponibles pour un composant WebPart. par exemple, une instance contextuelle au client HTTP.

Interfaces

IClientSideWebPartStatusRenderer	Interface à implémenter par un composant qui doit afficher l’indicateur de chargement et les messages d’erreur pour un composant WebPart.
IDynamicDataSharedPropertyConfiguration	Configuration liée à une propriété partagée.
IDynamicDataSharedPropertyFilters	Filtres de propriétés de données dynamiques du volet de propriétés.
IDynamicDataSharedSourceConfiguration	Configuration liée à une source partagée.
IDynamicDataSharedSourceFilters	Filtres de source de données dynamiques du volet de propriétés.
IMicrosoftTeams	Fournit l’accès au KIT de développement logiciel (SDK) Teams et au contexte Teams. Fourni uniquement lorsque le composant WebPart est chargé dans Teams.
IPropertyPaneAccessor	Interface d’accesseur du volet de propriétés du contexte du composant WebPart. Fournit certaines opérations les plus couramment utilisées pour accéder au volet de propriétés et au panneau de contenu.
IPropertyPaneButtonProps	Propriétés du bouton PropertyPane
IPropertyPaneCheckboxProps	Propriétés du composant PropertyPane CheckBox
IPropertyPaneChoiceGroupOption	Propriétés de l’option PropertyPane ChoiceGroup
IPropertyPaneChoiceGroupOptionIconProps	Propriétés de l’icône PropertyPane ChoiceGroup.
IPropertyPaneChoiceGroupProps	Propriétés de PropertyPane ChoiceGroup
IPropertyPaneConditionalGroup	Groupe conditionnel du volet de propriétés.
IPropertyPaneConfiguration	Paramètres de configuration du composant WebPart
IPropertyPaneCustomFieldProps	Propriétés de PropertyPane CustomPropertyField
IPropertyPaneDropdownCalloutProps	Propriétés de la légende de la liste déroulante PropertyPane.
IPropertyPaneDropdownOption	Liste déroulante des options de PropertyPane
IPropertyPaneDropdownProps	Propriétés du composant de la liste déroulante PropertyPane
IPropertyPaneDynamicFieldFilters	Filtres de champs dynamiques du volet de propriétés qui sont une intersection des filtres source et de propriété.
IPropertyPaneDynamicFieldProps	Propriétés PropertyPaneDynamicField.
IPropertyPaneDynamicFieldSetProps	Propriétés DynamicFieldSet PropertyPane.
IPropertyPaneDynamicTextFieldProps	PropertyPaneDynamicData propriétés de composant.
IPropertyPaneField	Champ PropertyPane
IPropertyPaneGroup	Groupe PropertyPane. Le groupe fait partie de PropertyPanePage.
IPropertyPaneLabelProps	Propriétés du composant PropertyPaneLabel
IPropertyPaneLinkProps	Propriétés du composant PropertyPaneLink
IPropertyPanePage	Interface PropertyPanePage
IPropertyPanePageHeader	En-tête PropertyPane. Cet en-tête reste le même pour toutes les pages.
IPropertyPaneSliderProps	Propriétés du composant PropertyPaneSliderProps
IPropertyPaneTextFieldProps	Propriétés du composant PropertyPaneTextField
IPropertyPaneToggleProps	Propriétés du composant PropertyPaneToggle
ISDKs	Ensemble conditionnel de Kits de développement logiciel (SDK) fournis par SPFx dépendant de l’environnement.
ISerializedWebPartData	Cette structure représente la partie de l’état sérialisé d’un composant WebPart qui est contrôlé par le composant WebPart. Elle est complétée par IWebPartData qui contient des données supplémentaires ajoutées par l’infrastructure aux données sérialisées.
IWebPartContext	Interface contextuelle de base pour les composants WebPart côté client.
IWebPartData	Cette structure représente l’état sérialisé d’un composant WebPart.
IWebPartPropertiesMetadata	Cette structure est utilisée pour définir des métadonnées pour les propriétés du composant WebPart en tant que mappage de chaîne vers IWebPartPropertyMetadata
IWebPartPropertyMetadata	Il s’agit de la structure utilisée pour les valeurs de mappage dans IWebPartPropertiesMetadata

Énumérations

DynamicDataSharedDepth	Énumérez les valeurs possibles de profondeur partagée de la référence de données dynamiques.
PropertyPaneButtonType	Énumération pour tous les types de boutons pris en charge.
PropertyPaneDropdownOptionType	Spécifie le type d’option dans un menu déroulant rendu par PropertyPaneDropdown().
PropertyPaneFieldType	Énumération pour tous les types de champs PropertyPane pris en charge. Les noms doivent être cohérents avec ceux dans office-ui-fabric-react, veillez à ce que la casse des lettres soit correcte.
WebPartFormFactor	Facteur de forme du composant WebPart.

Functions

PropertyPaneButton(targetProperty, properties)	Méthode d’assistance pour créer un bouton dans PropertyPane.
PropertyPaneCheckbox(targetProperty, properties)	Méthode d’assistance pour créer une case à cocher dans PropertyPane.
PropertyPaneChoiceGroup(targetProperty, properties)	Méthode d’assistance pour créer un groupe de choix dans PropertyPane.
PropertyPaneCustomField(properties)	Méthode d’assistance pour créer un champ personnalisé sur propertyPane.
PropertyPaneDropdown(targetProperty, properties)	Méthode d’assistance pour créer une liste déroulante dans PropertyPane.
PropertyPaneDynamicField(targetProperty, properties)	Méthode d’assistance permettant de créer un widget Données dynamiques sur propertyPane pour un champ dynamique.
PropertyPaneDynamicFieldSet(properties)	Méthode d’assistance pour créer un widget Données dynamiques dans le volet De propriétés pour un ensemble de champs dynamiques avec une source de données commune. Ces champs peuvent éventuellement partager la même propriété en fonction des filtres associés.
PropertyPaneDynamicTextField(targetProperty, properties)	Méthode d’assistance pour créer un champ de texte dynamique sur propertyPane.
PropertyPaneHorizontalRule()	Méthode d’assistance pour créer une règle horizontale dans PropertyPane.
PropertyPaneLabel(targetProperty, properties)	Méthode d’assistance pour créer une étiquette dans PropertyPane.
PropertyPaneLink(targetProperty, properties)	Méthode d’assistance pour créer un lien dans PropertyPane.
PropertyPaneSlider(targetProperty, properties)	Méthode d’assistance pour créer un curseur dans PropertyPane.
PropertyPaneTextField(targetProperty, properties)	Méthode d’assistance pour créer un champ de texte dans PropertyPane.
PropertyPaneToggle(targetProperty, properties)	Méthode d’assistance pour créer un bouton bascule dans PropertyPane.

Informations relatives à la fonction

PropertyPaneButton(targetProperty, properties)

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Méthode d’assistance pour créer un bouton dans PropertyPane.

export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField<IPropertyPaneButtonProps>;

Paramètres

targetProperty

string

Propriété cible à laquelle est associé ce bouton.

properties

IPropertyPaneButtonProps

Propriétés du bouton fortement typé.

Retours

IPropertyPaneField<IPropertyPaneButtonProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneCheckbox(targetProperty, properties)

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Méthode d’assistance pour créer une case à cocher dans PropertyPane.

export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField<IPropertyPaneCheckboxProps>;

Paramètres

targetProperty

string

Propriété cible à laquelle la case à cocher est associée.

properties

IPropertyPaneCheckboxProps

Propriétés de la case à cocher fortement typée.

Retours

IPropertyPaneField<IPropertyPaneCheckboxProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneChoiceGroup(targetProperty, properties)

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Méthode d’assistance pour créer un groupe de choix dans PropertyPane.

export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField<IPropertyPaneChoiceGroupProps>;

Paramètres

targetProperty

string

Propriété cible à laquelle le groupe de choix est associé.

properties

IPropertyPaneChoiceGroupProps

Propriétés du groupe de choix fortement typé.

Retours

IPropertyPaneField<IPropertyPaneChoiceGroupProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneCustomField(properties)

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Méthode d’assistance pour créer un champ personnalisé sur propertyPane.

export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField<IPropertyPaneCustomFieldProps>;

Paramètres

properties

IPropertyPaneCustomFieldProps

Propriétés de champ personnalisé fortement typées.

Retours

IPropertyPaneField<IPropertyPaneCustomFieldProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneDropdown(targetProperty, properties)

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Méthode d’assistance pour créer une liste déroulante dans PropertyPane.

export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField<IPropertyPaneDropdownProps>;

Paramètres

targetProperty

string

Propriété cible à laquelle est associée la liste déroulante.

properties

IPropertyPaneDropdownProps

Propriétés de la liste déroulante fortement typée.

Retours

IPropertyPaneField<IPropertyPaneDropdownProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneDynamicField(targetProperty, properties)

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Méthode d’assistance permettant de créer un widget Données dynamiques sur propertyPane pour un champ dynamique.

export declare function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): IPropertyPaneField<IPropertyPaneDynamicFieldProps>;

Paramètres

targetProperty

string

Propriété cible à laquelle le widget Données dynamiques est associé.

properties

IPropertyPaneDynamicFieldProps

Retours

IPropertyPaneField<IPropertyPaneDynamicFieldProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneDynamicFieldSet(properties)

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Méthode d’assistance pour créer un widget Données dynamiques dans le volet De propriétés pour un ensemble de champs dynamiques avec une source de données commune.

Ces champs peuvent éventuellement partager la même propriété en fonction des filtres associés.

export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>;

Paramètres

properties

IPropertyPaneDynamicFieldSetProps

Contient des entrées et des options, décrites comme suit : entrées : ensemble d’entrées à configurer par le widget. Chaque entrée inclut la propriété cible et, éventuellement, l’étiquette à afficher. options : options permettant d’activer des valeurs personnalisées pour le rappel, les filtres, etc., pour l’ensemble donné de champs dynamiques.

Retours

IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneDynamicTextField(targetProperty, properties)

Avertissement

Cette API est à présent déconseillée.

This has been replaced by PropertyPaneDynamicField and moved to @microsoft/sp-property-pane. Please consume it from there.

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Méthode d’assistance pour créer un champ de texte dynamique sur propertyPane.

export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>;

Paramètres

targetProperty

string

Propriété cible à laquelle le champ de texte dynamique est associé.

properties

IPropertyPaneDynamicTextFieldProps

Propriétés du PropertyPaneDynamicTextField.

Retours

IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneHorizontalRule()

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Méthode d’assistance pour créer une règle horizontale dans PropertyPane.

export declare function PropertyPaneHorizontalRule(): IPropertyPaneField<void>;

Retours

IPropertyPaneField<void>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneLabel(targetProperty, properties)

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Méthode d’assistance pour créer une étiquette dans PropertyPane.

export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField<IPropertyPaneLabelProps>;

Paramètres

targetProperty

string

Propriété cible à laquelle est associée l’étiquette.

properties

IPropertyPaneLabelProps

Propriétés de l’étiquette fortement typée.

Retours

IPropertyPaneField<IPropertyPaneLabelProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneLink(targetProperty, properties)

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Méthode d’assistance pour créer un lien dans PropertyPane.

export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField<IPropertyPaneLinkProps>;

Paramètres

targetProperty

string

Propriété cible à laquelle est associé le lien.

properties

IPropertyPaneLinkProps

Propriétés du lien fortement typé.

Retours

IPropertyPaneField<IPropertyPaneLinkProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneSlider(targetProperty, properties)

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Méthode d’assistance pour créer un curseur dans PropertyPane.

export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField<IPropertyPaneSliderProps>;

Paramètres

targetProperty

string

Propriété cible à laquelle est associé le curseur.

properties

IPropertyPaneSliderProps

Propriétés du curseur fortement typé.

Retours

IPropertyPaneField<IPropertyPaneSliderProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneTextField(targetProperty, properties)

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Méthode d’assistance pour créer un champ de texte dans PropertyPane.

export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField<IPropertyPaneTextFieldProps>;

Paramètres

targetProperty

string

Propriété cible à laquelle est associé le champ de texte.

properties

IPropertyPaneTextFieldProps

Propriétés du champ de texte fortement typé.

Retours

IPropertyPaneField<IPropertyPaneTextFieldProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.

PropertyPaneToggle(targetProperty, properties)

Avertissement

Cette API est à présent déconseillée.

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

Méthode d’assistance pour créer un bouton bascule dans PropertyPane.

export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField<IPropertyPaneToggleProps>;

Paramètres

targetProperty

string

Propriété cible à laquelle est associé le bouton bascule.

properties

IPropertyPaneToggleProps

Propriétés du bouton bascule fortement typé.

Retours

IPropertyPaneField<IPropertyPaneToggleProps>

Remarques

Nous avons laissé l’implémentation d’origine ici pour éviter de rompre le contrat d’API publique.