@microsoft/sp-webpart-base package

Estrutura do SharePoint suporte para a criação de peças Web.

Classes

BaseClientSideWebPart	Esta classe abstrata implementa a funcionalidade base de uma peça Web do lado do cliente. Todas as peças Web do lado do cliente têm de herdar desta classe.
BaseWebPart	Esta classe abstrata implementa a funcionalidade de base agnóstica da IU para uma peça Web do lado do cliente. O objetivo é permitir um núcleo comum entre Peças Web 2D e MR.
BaseWebPartContext	Objeto de contexto de peça Web. Este objeto contém os serviços contextuais disponíveis para uma peça Web. Por exemplo, uma instância contextual para o cliente http. Esta base deve ser expandida pela base da Peça Web específica da IU.
WebPartContext	Objeto de contexto de peça Web. Este objeto contém os serviços contextuais disponíveis para uma peça Web. Por exemplo, uma instância contextual para o cliente http.

Interfaces

IClientSideWebPartStatusRenderer	Interface a implementar por um componente que deve apresentar o indicador de carregamento e as mensagens de erro de uma peça Web.
IDynamicDataSharedPropertyConfiguration	Configuração relacionada com uma propriedade partilhada.
IDynamicDataSharedPropertyFilters	Filtros de propriedades de dados dinâmicos do painel de propriedades.
IDynamicDataSharedSourceConfiguration	Configuração relacionada com uma origem partilhada.
IDynamicDataSharedSourceFilters	Filtros de origem de dados dinâmicos do painel de propriedades.
IMicrosoftTeams	Fornece acesso ao SDK do Teams e ao contexto do Teams. Apenas fornecido quando a peça Web é carregada no Teams.
IPropertyPaneAccessor	Interface de acessório do painel de propriedades do contexto da peça Web. Fornece algumas operações mais utilizadas para aceder ao painel de propriedades e ao painel de conteúdo.
IPropertyPaneButtonProps	Propriedades do botão PropertyPane.
IPropertyPaneCheckboxProps	Propriedades do componente PropertyPane CheckBox.
IPropertyPaneChoiceGroupOption	Propriedades da opção PropertyPane ChoiceGroup.
IPropertyPaneChoiceGroupOptionIconProps	PropertyPane ChoiceGroup ícone props.
IPropertyPaneChoiceGroupProps	Propriedades PropertyPane ChoiceGroup.
IPropertyPaneConditionalGroup	Grupo condicional do painel de propriedades.
IPropertyPaneConfiguration	Definições das configurações da Web Part
IPropertyPaneCustomFieldProps	Propriedades PropertyPane CustomPropertyField.
IPropertyPaneDropdownCalloutProps	PropertyPane propriedades de nota de aviso pendente.
IPropertyPaneDropdownOption	Opções do menu suspenso do PropertyPane.
IPropertyPaneDropdownProps	Propriedades de componente da lista suspensa de PropertyPane.
IPropertyPaneDynamicFieldFilters	Filtros de campo dinâmico do painel de propriedades, que é uma interseção entre os filtros de origem e de propriedade.
IPropertyPaneDynamicFieldProps	PropertyPaneDynamicField props.
IPropertyPaneDynamicFieldSetProps	PropertyPane DynamicFieldSet props.
IPropertyPaneDynamicTextFieldProps	PropertyPaneDynamicData adereços de componentes.
IPropertyPaneField	Campo PropertyPane.
IPropertyPaneGroup	Campo do PropertyPane. O grupo faz parte do PropertyPanePage.
IPropertyPaneLabelProps	Propriedades do componente PropertyPaneLabel.
IPropertyPaneLinkProps	Propriedades do componente PropertyPaneLink
IPropertyPanePage	Interface de PropertyPanePage
IPropertyPanePageHeader	Cabeçalho de PropertyPane. Esse cabeçalho permanece o mesmo para todas as páginas.
IPropertyPaneSliderProps	Propriedades do componente PropertyPaneSliderProps
IPropertyPaneTextFieldProps	Propriedades do componente PropertyPaneTextField.
IPropertyPaneToggleProps	Propriedades do componente PropertyPaneToggle
ISDKs	Conjunto condicional de SDKs fornecidos pelo SPFx dependentes do ambiente.
ISerializedWebPartData	Essa estrutura representa a parte do estado serializado de uma Web Part que é controlada pela Web Part. Ele é estendido por IWebPartData que contém outros dados adicionados pela estrutura para os dados serializados.
IWebPartContext	A interface de contexto básica por Web Parts do lado do cliente.
IWebPartData	Essa estrutura representa o estado serializado de uma Web Part.
IWebPartPropertiesMetadata	Esta estrutura é utilizada para definir metadados para propriedades de peças Web como um mapa de cadeia para IWebPartPropertyMetadata
IWebPartPropertyMetadata	Esta é a estrutura utilizada para valores de mapa em IWebPartPropertiesMetadata

Enumerações

DynamicDataSharedDepth	Enumerar os possíveis valores de profundidade partilhada da referência de dados dinâmicos.
PropertyPaneButtonType	Enumeração para todos os tipos de botão com suporte.
PropertyPaneDropdownOptionType	Especifica o tipo de opção num menu pendente composto por PropertyPaneDropdown().
PropertyPaneFieldType	Enumeração para todos os tipos de campo PropertyPane suportados. Os nomes devem ser consistentes com os do office-ui-fabric-react, tenha cuidado para corrigir as maiúsculas/minúsculas.
WebPartFormFactor	Fator de forma da peça Web.

Funções

PropertyPaneButton(targetProperty, properties)	Método auxiliar para criar um Botão no PropertyPane.
PropertyPaneCheckbox(targetProperty, properties)	Método auxiliar para criar uma Caixa de seleção no PropertyPane.
PropertyPaneChoiceGroup(targetProperty, properties)	Método auxiliar para criar um Grupo de seleção no PropertyPane.
PropertyPaneCustomField(properties)	Método auxiliar para criar um campo personalizado no PropertyPane.
PropertyPaneDropdown(targetProperty, properties)	Método auxiliar para criar uma Lista suspensa no PropertyPane.
PropertyPaneDynamicField(targetProperty, properties)	Método auxiliar para criar um widget Dados Dinâmicos no PropertyPane para um campo dinâmico.
PropertyPaneDynamicFieldSet(properties)	Método auxiliar para criar um widget Dados Dinâmicos no Painel de Propriedades para um conjunto de campos dinâmicos com uma origem de dados comum. Estes campos podem possivelmente partilhar a mesma propriedade com base nos filtros associados.
PropertyPaneDynamicTextField(targetProperty, properties)	Método auxiliar para criar um Campo de Texto Dinâmico no PropertyPane.
PropertyPaneHorizontalRule()	Método auxiliar para criar uma Regra Horizontal no PropertyPane.
PropertyPaneLabel(targetProperty, properties)	Método auxiliar para criar um Rótulo no PropertyPane.
PropertyPaneLink(targetProperty, properties)	Método auxiliar para criar um Link no PropertyPane.
PropertyPaneSlider(targetProperty, properties)	Método auxiliar para criar um Controle Deslizante no PropertyPane.
PropertyPaneTextField(targetProperty, properties)	Método auxiliar para criar um Campo de Texto no PropertyPane.
PropertyPaneToggle(targetProperty, properties)	Método auxiliar para criar um Botão de Alternância no PropertyPane.

Detalhes da função

PropertyPaneButton(targetProperty, properties)

Aviso

Essa API foi preterida.

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

Método auxiliar para criar um Botão no PropertyPane.

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

Parâmetros

targetProperty

string

Propriedade de destino à qual o Botão está associado.

properties

IPropertyPaneButtonProps

Propriedades do Botão fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneButtonProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneCheckbox(targetProperty, properties)

Aviso

Essa API foi preterida.

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

Método auxiliar para criar uma Caixa de seleção no PropertyPane.

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

Parâmetros

targetProperty

string

Propriedade de destino à qual a caixa de seleção está associada.

properties

IPropertyPaneCheckboxProps

Propriedades da Caixa de seleção fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneCheckboxProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneChoiceGroup(targetProperty, properties)

Aviso

Essa API foi preterida.

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

Método auxiliar para criar um Grupo de seleção no PropertyPane.

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

Parâmetros

targetProperty

string

Propriedade de destino à qual o grupo de escolha está associado.

properties

IPropertyPaneChoiceGroupProps

Propriedades do Grupo de Escolha fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneChoiceGroupProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneCustomField(properties)

Aviso

Essa API foi preterida.

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

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Método auxiliar para criar um campo personalizado no PropertyPane.

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

Parâmetros

properties

IPropertyPaneCustomFieldProps

Propriedades de campo personalizadas fortemente digitadas.

Retornos

IPropertyPaneField<IPropertyPaneCustomFieldProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneDropdown(targetProperty, properties)

Aviso

Essa API foi preterida.

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

Método auxiliar para criar uma Lista suspensa no PropertyPane.

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

Parâmetros

targetProperty

string

Propriedade de destino à qual a lista suspensa está associada.

properties

IPropertyPaneDropdownProps

Propriedades da Lista Suspensa fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneDropdownProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneDynamicField(targetProperty, properties)

Aviso

Essa API foi preterida.

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

Método auxiliar para criar um widget Dados Dinâmicos no PropertyPane para um campo dinâmico.

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

Parâmetros

targetProperty

string

Propriedade de destino à qual o widget Dados Dinâmicos está associado.

properties

IPropertyPaneDynamicFieldProps

Retornos

IPropertyPaneField<IPropertyPaneDynamicFieldProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneDynamicFieldSet(properties)

Aviso

Essa API foi preterida.

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

Método auxiliar para criar um widget Dados Dinâmicos no Painel de Propriedades para um conjunto de campos dinâmicos com uma origem de dados comum.

Estes campos podem possivelmente partilhar a mesma propriedade com base nos filtros associados.

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

Parâmetros

properties

IPropertyPaneDynamicFieldSetProps

Contém entradas e opções, descritas abaixo: entradas – um conjunto de entradas a configurar pelo widget. Cada entrada inclui a propriedade de destino e, opcionalmente, a etiqueta a mostrar. options - Opções que permitem valores personalizados para chamada de retorno, filtros, etc., para o conjunto especificado de campos dinâmicos.

Retornos

IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneDynamicTextField(targetProperty, properties)

Aviso

Essa API foi preterida.

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

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Método auxiliar para criar um Campo de Texto Dinâmico no PropertyPane.

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

Parâmetros

targetProperty

string

Propriedade de destino à qual o campo de texto dinâmico está associado.

properties

IPropertyPaneDynamicTextFieldProps

Propriedades do PropertyPaneDynamicTextField.

Retornos

IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneHorizontalRule()

Aviso

Essa API foi preterida.

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

Método auxiliar para criar uma Regra Horizontal no PropertyPane.

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

Retornos

IPropertyPaneField<void>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneLabel(targetProperty, properties)

Aviso

Essa API foi preterida.

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

Método auxiliar para criar um Rótulo no PropertyPane.

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

Parâmetros

targetProperty

string

Propriedade de destino à qual o rótulo está associado.

properties

IPropertyPaneLabelProps

Propriedades do Rótulo fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneLabelProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneLink(targetProperty, properties)

Aviso

Essa API foi preterida.

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

Método auxiliar para criar um Link no PropertyPane.

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

Parâmetros

targetProperty

string

Propriedade de destino à qual o Link está associado.

properties

IPropertyPaneLinkProps

Propriedades do Link fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneLinkProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneSlider(targetProperty, properties)

Aviso

Essa API foi preterida.

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

Método auxiliar para criar um Controle Deslizante no PropertyPane.

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

Parâmetros

targetProperty

string

Propriedade de destino à qual o controle deslizante está associado.

properties

IPropertyPaneSliderProps

Propriedades do Controle Deslizante fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneSliderProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneTextField(targetProperty, properties)

Aviso

Essa API foi preterida.

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

Método auxiliar para criar um Campo de Texto no PropertyPane.

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

Parâmetros

targetProperty

string

Propriedade de destino à qual o campo de texto está associado.

properties

IPropertyPaneTextFieldProps

Propriedades do Campo de Texto fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneTextFieldProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.

PropertyPaneToggle(targetProperty, properties)

Aviso

Essa API foi preterida.

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

Método auxiliar para criar um Botão de Alternância no PropertyPane.

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

Parâmetros

targetProperty

string

Propriedade de destino à qual o botão de alternância está associado.

properties

IPropertyPaneToggleProps

Propriedades do Botão de Alternância fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneToggleProps>

Comentários

Deixámos aqui a implementação original para evitar quebrar o contrato de API pública.