@microsoft/sp-webpart-base package
Suporte à Estrutura do SharePoint para a criação de Web Parts.
Classes
| BaseClientSideWebPart |
Essa classe abstrata implementa a funcionalidade básica de uma Web Part do lado do cliente. Cada Web Part do lado do cliente precisa herdar dessa classe. |
| BaseWebPart |
Essa classe abstrata implementa a funcionalidade base independente de interface do usuário para uma Web Part do lado do cliente. A finalidade é permitir um núcleo comum entre as Web Parts 2D e MR. |
| BaseWebPartContext |
objeto de contexto da Web part. Esse objeto contém os serviços contextuais disponíveis para uma Web Part. por exemplo, uma instância contextual para o cliente HTTP. Essa base deve ser estendida pela base da WebPart específica da interface do usuário. |
| WebPartContext |
objeto de contexto da Web part. Esse objeto contém os serviços contextuais disponíveis para uma Web Part. por exemplo, uma instância contextual para o cliente HTTP. |
Interfaces
| IAgentsSDK |
Fornece acesso a funcionalidades relacionadas a agentes. |
| IClientSideWebPartStatusRenderer |
Interface a ser implementada por um componente que deve exibir o indicador de carregamento e as mensagens de erro de uma web part. |
| IDynamicDataSharedPropertyConfiguration |
Configuração relacionada a uma propriedade compartilhada. |
| IDynamicDataSharedPropertyFilters |
Painel de propriedades, dados dinâmicos, filtros de propriedades. |
| IDynamicDataSharedSourceConfiguration |
Configuração relacionada a uma fonte compartilhada. |
| IDynamicDataSharedSourceFilters |
Painel de propriedades Filtros dinâmicos de fonte de dados. |
| IMicrosoftTeams |
Fornece acesso ao SDK do Teams e ao contexto do Teams. Fornecido apenas quando a Web Part é carregada no Teams. |
| IPropertyPaneAccessor |
Painel de propriedades de contexto da Web part interface acessadora. Fornece algumas das operações mais comumente usadas para acessar o painel de propriedades e o 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 |
Painel de propriedades, grupo condicional. |
| IPropertyPaneConfiguration |
Definições das configurações da Web Part |
| IPropertyPaneCustomFieldProps |
Propriedades PropertyPane CustomPropertyField. |
| IPropertyPaneDropdownCalloutProps |
Propriedades de balão suspenso do PropertyPane. |
| 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 dos filtros de origem e propriedade. |
| IPropertyPaneDynamicFieldProps |
PropertyPaneDynamicField props. |
| IPropertyPaneDynamicFieldSetProps |
PropertyPane DynamicFieldSet props. |
| IPropertyPaneDynamicTextFieldProps |
|
| IPropertyPaneField |
Campo PropertyPane. |
| IPropertyPaneGroup |
Campo do PropertyPane. O grupo faz parte do PropertyPanePage. |
| IPropertyPaneLabelProps |
Propriedades do componente PropertyPaneLabel. |
| IPropertyPaneLifeCycleEventCallback |
Retorno de chamada para o evento de ciclo de vida do painel de propriedades. |
| IPropertyPaneLifeCycleEventData |
Dados retornados pela web part para o host ao invocar o propertyPaneLifeCycleEventCallback. |
| 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 fornecido pelo SPFx dependendo 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 |
Essa estrutura é usada para definir metadados para propriedades da Web Part como um mapa de cadeia de caracteres para |
| IWebPartPropertyMetadata |
Esta é a estrutura usada para mapear valores em |
Aliases de tipo
| _ClearDomElementCallback |
Retorno de chamada para limpar o nó dom. |
Enumerações
| DynamicDataSharedDepth |
Enumeração para os possíveis valores de profundidade compartilhada 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 em um menu suspenso renderizado por PropertyPaneDropdown(). |
| PropertyPaneFieldType |
Enumeração para todos os tipos de campo PropertyPane com suporte. Os nomes devem ser consistentes com os de office-ui-fabric-react, tenha cuidado para corrigir o uso de maiúsculas e minúsculas das letras. |
| WebPartFormFactor |
Fator forma da Web Part. |
| WebPartIsolationLevel |
Enumeração descrevendo diferentes níveis de isolamento com suporte para uma web part. |
Funções
| Property |
Método auxiliar para criar um Botão no PropertyPane. |
| Property |
Método auxiliar para criar uma Caixa de seleção no PropertyPane. |
| Property |
Método auxiliar para criar um Grupo de seleção no PropertyPane. |
| Property |
Método auxiliar para criar um campo personalizado no PropertyPane. |
| Property |
Método auxiliar para criar uma Lista suspensa no PropertyPane. |
| Property |
Método auxiliar para criar um widget Dados Dinâmicos no PropertyPane para um campo dinâmico. |
| Property |
Método auxiliar para criar um widget Dados Dinâmicos no Painel de Propriedades para um conjunto de campos dinâmicos com uma fonte de dados comum. Esses campos possivelmente podem compartilhar a mesma propriedade com base nos filtros associados. |
| Property |
Método auxiliar para criar um TextField dinâmico no PropertyPane. |
| Property |
Método auxiliar para criar uma Regra Horizontal no PropertyPane. |
| Property |
Método auxiliar para criar um Rótulo no PropertyPane. |
| Property |
Método auxiliar para criar um Link no PropertyPane. |
| Property |
Método auxiliar para criar um Controle Deslizante no PropertyPane. |
| Property |
Método auxiliar para criar um Campo de Texto no PropertyPane. |
| Property |
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
Comentários
Deixamos a implementação original aqui para evitar a quebra do 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
Comentários
Deixamos a implementação original aqui para evitar a quebra do 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
Comentários
Deixamos a implementação original aqui para evitar a quebra do 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 tipadas.
Retornos
Comentários
Deixamos a implementação original aqui para evitar a quebra do 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
Comentários
Deixamos a implementação original aqui para evitar a quebra do 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
Comentários
Deixamos a implementação original aqui para evitar a quebra do 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 fonte de dados comum.
Esses campos possivelmente podem compartilhar 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 serem configuradas pelo widget. Cada entrada inclui a propriedade target e, opcionalmente, o rótulo a ser mostrado. options - Opções que habilitam valores personalizados para retorno de chamada, filtros, etc., para um determinado conjunto de campos dinâmicos.
Retornos
Comentários
Deixamos a implementação original aqui para evitar a quebra do 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 TextField 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
Comentários
Deixamos a implementação original aqui para evitar a quebra do 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
Deixamos a implementação original aqui para evitar a quebra do 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
Comentários
Deixamos a implementação original aqui para evitar a quebra do 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
Comentários
Deixamos a implementação original aqui para evitar a quebra do 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
Comentários
Deixamos a implementação original aqui para evitar a quebra do 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
Comentários
Deixamos a implementação original aqui para evitar a quebra do 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
Comentários
Deixamos a implementação original aqui para evitar a quebra do contrato de API pública.