@microsoft/sp-property-pane package

Referencia

SharePoint Framework panel de propiedades.

Interfaces

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.
IGuidSet	Conjunto de GUID que representan un elemento de lista.
IPopupWindowProps	Propiedades de ventana emergente.
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.
IPropertyPaneDebounceProperty	Definición de una propiedad del panel de propiedades, que debe tener el `onPropertyPaneFieldChanged` evento debounced.
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.
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.
IPropertyPaneHeadingProps	Propiedades del componente PropertyPaneHeader.
IPropertyPaneIconPickerProps	Propiedades del componente PropertyPaneIconPicker
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.
IPropertyPaneThumbnailPickerProps	Propiedades del componente PropertyPaneThumbnailPicker
IPropertyPaneToggleProps	Propiedades del componente de botón de alternancia del panel de propiedades.
IThumbnailFabricReactIcon	Opciones relacionadas con la miniatura del icono de tejido.
IThumbnailIconSizeImage	Opciones relacionadas con la miniatura de imagen de tamaño de icono.
IThumbnailImage	Opciones relacionadas con la miniatura de imagen.

Alias de tipos

ImageFit	Los métodos posibles que se pueden usar para ajustarse a la imagen.
IPropertyPaneDynamicFieldFilters	Filtros de campo dinámico del panel de propiedades, que es una intersección de filtros de origen y de propiedad.
IThumbnail	Tipo de imagen en miniatura que se está configurando.
PropertyPaneHeadingLevel	Tipo para los niveles de encabezado, h1-h6
ThumbnailType	Tipos de imagen en miniatura admitidos.

Enumeraciones

DynamicDataSharedDepth	Enumeración de los valores posibles de profundidad compartida de la referencia de datos dinámica.
PopupWindowPosition	Posición de la ventana emergente.
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.

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.
PropertyPaneHeading(targetProperty, properties)	Método auxiliar para crear un encabezado en propertypane. Solución temporal a la espera del rediseño
PropertyPaneHorizontalRule()	Método auxiliar para crear una regla horizontal en el panel de propiedades.
PropertyPaneIconPicker(targetProperty, properties)	Método auxiliar para crear un IconPicker en propertypane.
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.
PropertyPaneThumbnailPicker(targetProperty, properties)	Método auxiliar para crear un ThumbnailPicker en el PropertyPane.
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)

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>

PropertyPaneCheckbox(targetProperty, properties)

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>

PropertyPaneChoiceGroup(targetProperty, properties)

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>

PropertyPaneCustomField(properties)

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

El propósito del campo personalizado es ayudar al desarrollador del elemento web a agregar un control personalizado al panel de propiedades. PropertyPane admite un host de tipos de campo integrados. Aunque esta lista satisface las demandas de la mayoría de los elementos web, pero hay casos excepcionales en los que los elementos web tienen necesidades especiales y necesitan un control especial. El campo personalizado ayuda a rellenar esa brecha.

PropertyPaneDropdown(targetProperty, properties)

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>

PropertyPaneDynamicField(targetProperty, properties)

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>

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.

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>

PropertyPaneDynamicTextField(targetProperty, properties)

Advertencia

Esta API ya está en desuso.

This has been replaced by PropertyPaneDynamicField

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>

PropertyPaneHeading(targetProperty, properties)

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 encabezado en propertypane. Solución temporal a la espera del rediseño

export declare function PropertyPaneHeading(targetProperty: string, properties: IPropertyPaneHeadingProps): IPropertyPaneField<IPropertyPaneHeadingProps>;

Parámetros

targetProperty: string

Propiedad de destino a la que se asocia la etiqueta.

properties: IPropertyPaneHeadingProps

Propiedades de etiqueta fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneHeadingProps>

PropertyPaneHorizontalRule()

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

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

Devoluciones

IPropertyPaneField<void>

PropertyPaneIconPicker(targetProperty, properties)

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 IconPicker en propertypane.

export declare function PropertyPaneIconPicker(targetProperty: string, properties: IPropertyPaneIconPickerProps): IPropertyPaneField<IPropertyPaneIconPickerProps>;

Parámetros

targetProperty: string

Propiedad de destino a la que está asociado el selector de iconos.

properties: IPropertyPaneIconPickerProps

Propiedades iconpicker fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneIconPickerProps>

PropertyPaneLabel(targetProperty, properties)

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>

PropertyPaneLink(targetProperty, properties)

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>

PropertyPaneSlider(targetProperty, properties)

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>

PropertyPaneTextField(targetProperty, properties)

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>

PropertyPaneThumbnailPicker(targetProperty, properties)

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 ThumbnailPicker en el PropertyPane.

export declare function PropertyPaneThumbnailPicker(targetProperty: string, properties: IPropertyPaneThumbnailPickerProps): IPropertyPaneField<IPropertyPaneThumbnailPickerProps>;

Parámetros

targetProperty: string

Propiedad de destino a la que está asociado el selector de miniaturas.

properties: IPropertyPaneThumbnailPickerProps

Propiedades ThumbnailPicker fuertemente tipadas.

Devoluciones

IPropertyPaneField<IPropertyPaneThumbnailPickerProps>

PropertyPaneToggle(targetProperty, properties)

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>

Compartir a través de

@microsoft/sp-property-pane package

Interfaces

Alias de tipos

Enumeraciones

Funciones

Detalles de la función

PropertyPaneButton(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneCheckbox(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneChoiceGroup(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneCustomField(properties)

Parámetros

Devoluciones

Comentarios

PropertyPaneDropdown(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneDynamicField(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneDynamicFieldSet(properties)

Parámetros

Devoluciones

PropertyPaneDynamicTextField(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneHeading(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneHorizontalRule()

Devoluciones

PropertyPaneIconPicker(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneLabel(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneLink(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneSlider(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneTextField(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneThumbnailPicker(targetProperty, properties)

Parámetros

Devoluciones

PropertyPaneToggle(targetProperty, properties)

Parámetros

Devoluciones

Recursos adicionales