@microsoft/sp-webpart-base package

SharePoint Framework compatibilidad con la creación de elementos web.

Clases

BaseClientSideWebPart	Esta clase abstracta implementa la funcionalidad base de un elemento web del lado cliente. Cada elemento web del lado cliente debe heredar de esta clase.
BaseWebPart	Esta clase abstracta implementa la funcionalidad base independiente de la interfaz de usuario para un elemento web del lado cliente. El propósito es permitir un núcleo común entre 2D y MR WebParts.
BaseWebPartContext	Objeto de contexto de elemento web. Este objeto contiene los servicios contextuales disponibles para un elemento web. Por ejemplo, una instancia contextual para el cliente http. Esta base se va a ampliar mediante la base de WebPart específica de la interfaz de usuario.
WebPartContext	Objeto de contexto de elemento web. Este objeto contiene los servicios contextuales disponibles para un elemento web. Por ejemplo, una instancia contextual para el cliente http.

Interfaces

IClientSideWebPartStatusRenderer	Interfaz que va a implementar un componente que debe mostrar el indicador de carga y los mensajes de error de un elemento web.
IDynamicDataSharedPropertyConfiguration	Configuración relacionada con una propiedad compartida.
IDynamicDataSharedPropertyFilters	Filtros de propiedades de datos dinámicos del panel de propiedades.
IDynamicDataSharedSourceConfiguration	Configuración relacionada con un origen compartido.
IDynamicDataSharedSourceFilters	Filtros de origen de datos dinámicos del panel de propiedades.
IMicrosoftTeams	Proporciona acceso al SDK de Teams y al contexto de Teams. Solo se proporciona cuando el elemento web se carga en Teams.
IPropertyPaneAccessor	Interfaz de descriptor de acceso del panel de propiedades de contexto del elemento web. Proporciona algunas de las operaciones más usadas para acceder al panel de propiedades y al panel de contenido.
IPropertyPaneButtonProps	Propiedades del botón del panel de propiedades.
IPropertyPaneCheckboxProps	Propiedades del componente de casilla del panel de propiedades.
IPropertyPaneChoiceGroupOption	Propiedades de la opción de grupo de opciones del panel de propiedades.
IPropertyPaneChoiceGroupOptionIconProps	PropiedadesPropiedad de icono de Grupo de opciones del panel de propiedades.
IPropertyPaneChoiceGroupProps	Propiedades del grupo de opciones del panel de propiedades.
IPropertyPaneConditionalGroup	Grupo condicional del panel de propiedades.
IPropertyPaneConfiguration	Opciones de configuración del elemento web.
IPropertyPaneCustomFieldProps	Propiedades del campo de propiedades personalizado del panel de propiedades.
IPropertyPaneDropdownCalloutProps	Propiedades de llamada desplegable del panel de propiedades.
IPropertyPaneDropdownOption	Opciones desplegables del panel de propiedades.
IPropertyPaneDropdownProps	Propiedades del componente desplegable del panel de propiedades.
IPropertyPaneDynamicFieldFilters	Filtros de campo dinámico del panel de propiedades, que es una intersección de filtros de origen y de propiedad.
IPropertyPaneDynamicFieldProps	PropertyPaneDynamicField props.
IPropertyPaneDynamicFieldSetProps	Propiedades Props DynamicFieldSet de PropertyPane.
IPropertyPaneDynamicTextFieldProps	PropertyPaneDynamicData componentes props.
IPropertyPaneField	Campo del panel de propiedades.
IPropertyPaneGroup	Grupo del panel de propiedades. El grupo forma parte de la página del panel de propiedades.
IPropertyPaneLabelProps	Propiedades del componente de etiqueta del panel de propiedades.
IPropertyPaneLinkProps	Propiedades del componente de vínculo del panel de propiedades.
IPropertyPanePage	Interfaz de la página del panel de propiedades.
IPropertyPanePageHeader	Encabezado del panel de propiedades. Este encabezado es igual en todas las páginas.
IPropertyPaneSliderProps	Propiedades del componente de propiedades del control deslizante del panel de propiedades.
IPropertyPaneTextFieldProps	Propiedades del componente de campo de texto del panel de propiedades.
IPropertyPaneToggleProps	Propiedades del componente de botón de alternancia del panel de propiedades.
ISDKs	Conjunto condicional de SDK proporcionados por SPFx que dependen del entorno.
ISerializedWebPartData	Esta estructura representa la parte del estado serializado de un elemento web que está controlada por el elemento web. Se extiende mediante IWebPartData, que contiene datos adicionales que agrega el marco de trabajo a los datos serializados.
IWebPartContext	Interfaz de contexto base para elementos web del lado cliente.
IWebPartData	Esta estructura representa el estado serializado de un elemento web.
IWebPartPropertiesMetadata	Esta estructura se usa para definir metadatos para las propiedades del elemento web como un mapa de cadena para IWebPartPropertyMetadata
IWebPartPropertyMetadata	Esta es la estructura que se usa para los valores de mapa en IWebPartPropertiesMetadata

Enumeraciones

DynamicDataSharedDepth	Enumeración de los valores posibles de profundidad compartida de la referencia de datos dinámica.
PropertyPaneButtonType	Enumeración de todos los tipos de botón compatibles.
PropertyPaneDropdownOptionType	Especifica el tipo de opción en un menú desplegable representado por PropertyPaneDropdown().
PropertyPaneFieldType	Enumeración para todos los tipos de campo PropertyPane admitidos. Los nombres deben ser coherentes con los de office-ui-fabric-react, tenga cuidado de que las mayúsculas y minúsculas sean correctas.
WebPartFormFactor	Factor de forma del elemento web.

Funciones

PropertyPaneButton(targetProperty, properties)	Método auxiliar para crear un botón en el panel de propiedades.
PropertyPaneCheckbox(targetProperty, properties)	Método auxiliar para crear una casilla en el panel de propiedades.
PropertyPaneChoiceGroup(targetProperty, properties)	Método auxiliar para crear un grupo de opciones en el panel de propiedades.
PropertyPaneCustomField(properties)	Método auxiliar para crear un campo personalizado en propertypane.
PropertyPaneDropdown(targetProperty, properties)	Método auxiliar para crear una lista desplegable en el panel de propiedades.
PropertyPaneDynamicField(targetProperty, properties)	Método auxiliar para crear un widget datos dinámicos en el panel de propiedades para un campo dinámico.
PropertyPaneDynamicFieldSet(properties)	Método auxiliar para crear un widget datos dinámicos en el panel de propiedades para un conjunto de campos dinámicos con un origen de datos común. Es posible que estos campos compartan la misma propiedad en función de los filtros asociados.
PropertyPaneDynamicTextField(targetProperty, properties)	Método auxiliar para crear un elemento TextField dinámico en el panel de propiedades.
PropertyPaneHorizontalRule()	Método auxiliar para crear una regla horizontal en el panel de propiedades.
PropertyPaneLabel(targetProperty, properties)	Método auxiliar para crear una etiqueta en el panel de propiedades.
PropertyPaneLink(targetProperty, properties)	Método auxiliar para crear un vínculo en el panel de propiedades.
PropertyPaneSlider(targetProperty, properties)	Método auxiliar para crear un control deslizante en el panel de propiedades.
PropertyPaneTextField(targetProperty, properties)	Método auxiliar para crear un campo de texto en el panel de propiedades.
PropertyPaneToggle(targetProperty, properties)	Método auxiliar para crear un botón de alternancia en el panel de propiedades.

Detalles de la función

PropertyPaneButton(targetProperty, properties)

Advertencia

Esta API ya está en desuso.

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

Método auxiliar para crear un botón en el panel de propiedades.

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

Parámetros

targetProperty

string

Propiedad de destino a la que se asocia el botón.

properties

IPropertyPaneButtonProps

Propiedades de botón fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneButtonProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneCheckbox(targetProperty, properties)

Advertencia

Esta API ya está en desuso.

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

Método auxiliar para crear una casilla en el panel de propiedades.

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

Parámetros

targetProperty

string

Propiedad de destino a la que se asocia la casilla.

properties

IPropertyPaneCheckboxProps

Propiedades de casilla fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneCheckboxProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneChoiceGroup(targetProperty, properties)

Advertencia

Esta API ya está en desuso.

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

Método auxiliar para crear un grupo de opciones en el panel de propiedades.

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

Parámetros

targetProperty

string

Propiedad de destino a la que se asocia el grupo de opciones.

properties

IPropertyPaneChoiceGroupProps

Propiedades de grupo de opciones fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneChoiceGroupProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneCustomField(properties)

Advertencia

Esta API ya está en desuso.

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

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Método auxiliar para crear un campo personalizado en propertypane.

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

Parámetros

properties

IPropertyPaneCustomFieldProps

Propiedades de campo personalizado fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneCustomFieldProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneDropdown(targetProperty, properties)

Advertencia

Esta API ya está en desuso.

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

Método auxiliar para crear una lista desplegable en el panel de propiedades.

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

Parámetros

targetProperty

string

Propiedad de destino a la que se asocia la lista desplegable.

properties

IPropertyPaneDropdownProps

Propiedades de lista desplegable fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneDropdownProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneDynamicField(targetProperty, properties)

Advertencia

Esta API ya está en desuso.

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

Método auxiliar para crear un widget datos dinámicos en el panel de propiedades para un campo dinámico.

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

Parámetros

targetProperty

string

Propiedad de destino a la que está asociado el widget Datos dinámicos.

properties

IPropertyPaneDynamicFieldProps

Devoluciones

IPropertyPaneField<IPropertyPaneDynamicFieldProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneDynamicFieldSet(properties)

Advertencia

Esta API ya está en desuso.

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

Método auxiliar para crear un widget datos dinámicos en el panel de propiedades para un conjunto de campos dinámicos con un origen de datos común.

Es posible que estos campos compartan la misma propiedad en función de los filtros asociados.

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

Parámetros

properties

IPropertyPaneDynamicFieldSetProps

Contiene entradas y opciones, que se describen a continuación: entradas: un conjunto de entradas que el widget debe configurar. Cada entrada incluye la propiedad de destino y, opcionalmente, la etiqueta que se va a mostrar. options: opciones que habilitan valores personalizados para la devolución de llamada, filtros, etc., para el conjunto determinado de campos dinámicos.

Devoluciones

IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneDynamicTextField(targetProperty, properties)

Advertencia

Esta API ya está en desuso.

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

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Método auxiliar para crear un elemento TextField dinámico en el panel de propiedades.

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

Parámetros

targetProperty

string

Propiedad de destino a la que está asociado el campo de texto dinámico.

properties

IPropertyPaneDynamicTextFieldProps

Propiedades de PropertyPaneDynamicTextField.

Devoluciones

IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneHorizontalRule()

Advertencia

Esta API ya está en desuso.

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

Método auxiliar para crear una regla horizontal en el panel de propiedades.

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

Devoluciones

IPropertyPaneField<void>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneLabel(targetProperty, properties)

Advertencia

Esta API ya está en desuso.

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

Método auxiliar para crear una etiqueta en el panel de propiedades.

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

Parámetros

targetProperty

string

Propiedad de destino a la que se asocia la etiqueta.

properties

IPropertyPaneLabelProps

Propiedades de etiqueta fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneLabelProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneLink(targetProperty, properties)

Advertencia

Esta API ya está en desuso.

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

Método auxiliar para crear un vínculo en el panel de propiedades.

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

Parámetros

targetProperty

string

Propiedad de destino a la que se asocia el vínculo.

properties

IPropertyPaneLinkProps

Propiedades de vínculo fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneLinkProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneSlider(targetProperty, properties)

Advertencia

Esta API ya está en desuso.

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

Método auxiliar para crear un control deslizante en el panel de propiedades.

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

Parámetros

targetProperty

string

Propiedad de destino a la que se asocia el control deslizante.

properties

IPropertyPaneSliderProps

Propiedades de control deslizante fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneSliderProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneTextField(targetProperty, properties)

Advertencia

Esta API ya está en desuso.

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

Método auxiliar para crear un campo de texto en el panel de propiedades.

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

Parámetros

targetProperty

string

Propiedad de destino a la que se asocia el campo de texto.

properties

IPropertyPaneTextFieldProps

Propiedades de campo de texto fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneTextFieldProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.

PropertyPaneToggle(targetProperty, properties)

Advertencia

Esta API ya está en desuso.

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

Método auxiliar para crear un botón de alternancia en el panel de propiedades.

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

Parámetros

targetProperty

string

Propiedad de destino a la que se asocia el botón de alternancia.

properties

IPropertyPaneToggleProps

Propiedades de botón de alternancia fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneToggleProps>

Comentarios

Hemos dejado la implementación original aquí para evitar la interrupción del contrato de API pública.