@microsoft/sp-webpart-base package

SharePoint Framework поддержка создания веб-частей.

Классы

BaseClientSideWebPart	Этот абстрактный класс реализует базовые функции для клиентской веб-части. Каждая клиентская веб-часть должна наследоваться от этого класса.
BaseWebPart	Этот абстрактный класс реализует не зависящие от пользовательского интерфейса базовые функции для клиентской веб-части. Цель заключается в том, чтобы разрешить общее ядро между двумя и mr webParts.
BaseWebPartContext	Объект контекста веб-части. Этот объект содержит контекстные службы, доступные веб-части. Например, контекстный экземпляр для http-клиента. Эта база должна быть расширена базой WebPart для пользовательского интерфейса.
WebPartContext	Объект контекста веб-части. Этот объект содержит контекстные службы, доступные веб-части. Например, контекстный экземпляр для http-клиента.

Интерфейсы

IClientSideWebPartStatusRenderer	Интерфейс, реализуемый компонентом, который должен отображать индикатор загрузки и сообщения об ошибках для веб-части.
IDynamicDataSharedPropertyConfiguration	Конфигурация, связанная с общим свойством.
IDynamicDataSharedPropertyFilters	Динамические фильтры свойств данных области свойств.
IDynamicDataSharedSourceConfiguration	Конфигурация, связанная с общим источником.
IDynamicDataSharedSourceFilters	Динамические фильтры источников данных области свойств.
IMicrosoftTeams	Предоставляет доступ к пакету SDK для Teams и контексту Teams. Предоставляется только при загрузке веб-части в Teams.
IPropertyPaneAccessor	Интерфейс метода доступа к области свойств контекста веб-части. Предоставляет некоторые наиболее часто используемые операции для доступа к области свойств и панели содержимого.
IPropertyPaneButtonProps	Свойства кнопки PropertyPane.
IPropertyPaneCheckboxProps	Свойства компонента CheckBox в PropertyPane.
IPropertyPaneChoiceGroupOption	Свойства параметра ChoiceGroup в PropertyPane.
IPropertyPaneChoiceGroupOptionIconProps	Значок PropertyPane ChoiceGroup реквизиты.
IPropertyPaneChoiceGroupProps	Реквизиты ChoiceGroup PropertyPane.
IPropertyPaneConditionalGroup	Условная группа области свойств.
IPropertyPaneConfiguration	Параметры конфигурации веб-части
IPropertyPaneCustomFieldProps	Свойства объекта CustomPropertyField в PropertyPane.
IPropertyPaneDropdownCalloutProps	Свойства выноски раскрывающегося списка PropertyPane.
IPropertyPaneDropdownOption	Пункты раскрывающегося меню PropertyPane.
IPropertyPaneDropdownProps	Свойства компонента раскрывающегося меню PropertyPane.
IPropertyPaneDynamicFieldFilters	Динамические фильтры полей области свойств, которые являются пересечением исходных фильтров и фильтров свойств.
IPropertyPaneDynamicFieldProps	Реквизиты PropertyPaneDynamicField.
IPropertyPaneDynamicFieldSetProps	Реквизиты PropertyPane DynamicFieldSet.
IPropertyPaneDynamicTextFieldProps	PropertyPaneDynamicData реквизит компонента.
IPropertyPaneField	Поле PropertyPane.
IPropertyPaneGroup	Группа PropertyPane. Группа является частью PropertyPanePage.
IPropertyPaneLabelProps	Свойства компонента PropertyPaneLabel.
IPropertyPaneLinkProps	Свойства компонента PropertyPaneLink.
IPropertyPanePage	Интерфейс PropertyPanePage.
IPropertyPanePageHeader	Заголовок PropertyPane. Этот заголовок остается неизменным для всех страниц.
IPropertyPaneSliderProps	Свойства компонента PropertyPaneSliderProps.
IPropertyPaneTextFieldProps	Свойства компонента PropertyPaneTextField.
IPropertyPaneToggleProps	Свойства компонента PropertyPaneToggle.
ISDKs	Условный набор пакетов SDK, предоставляемых SPFx в зависимости от среды.
ISerializedWebPartData	Эта структура представляет собой часть сериализованного состояния веб-части, которое управляется веб-частью. Ее дополняет интерфейс IWebPartData, который содержит данные, добавляемые платформой к сериализованным данным.
IWebPartContext	Интерфейс базового контекста для клиентских веб-частей.
IWebPartData	Эта структура представляет собой сериализованное состояние веб-части.
IWebPartPropertiesMetadata	Эта структура используется для определения метаданных свойств веб-части в виде сопоставления строк с IWebPartPropertyMetadata
IWebPartPropertyMetadata	Это структура, используемая для значений карты в IWebPartPropertiesMetadata

Перечисления

DynamicDataSharedDepth	Перечисление возможных значений общей глубины динамической ссылки на данные.
PropertyPaneButtonType	Перечисление для всех поддерживаемых типов кнопки.
PropertyPaneDropdownOptionType	Указывает тип параметра в раскрывающемся меню, отображаемом свойством PropertyPaneDropdown().
PropertyPaneFieldType	Перечисление для всех поддерживаемых типов полей PropertyPane. Имена должны соответствовать именам в office-ui-fabric-react, проверьте регистр букв.
WebPartFormFactor	Форм-фактор веб-части.

Функции

PropertyPaneButton(targetProperty, properties)	Вспомогательный метод для создания кнопки в PropertyPane.
PropertyPaneCheckbox(targetProperty, properties)	Вспомогательный метод для создания флажка в PropertyPane.
PropertyPaneChoiceGroup(targetProperty, properties)	Вспомогательный метод для создания группы выбора в PropertyPane.
PropertyPaneCustomField(properties)	Вспомогательный метод для создания настраиваемого поля в PropertyPane.
PropertyPaneDropdown(targetProperty, properties)	Вспомогательный метод для создания раскрывающегося меню в PropertyPane.
PropertyPaneDynamicField(targetProperty, properties)	Вспомогательный метод для создания мини-приложения динамических данных в PropertyPane для динамического поля.
PropertyPaneDynamicFieldSet(properties)	Вспомогательный метод для создания мини-приложения динамических данных в области свойств для набора динамических полей с общим источником данных. Эти поля могут совместно использовать одно и то же свойство на основе связанных фильтров.
PropertyPaneDynamicTextField(targetProperty, properties)	Вспомогательный метод для создания динамического текстового поля в PropertyPane.
PropertyPaneHorizontalRule()	Вспомогательный метод для создания горизонтальной линейки в PropertyPane.
PropertyPaneLabel(targetProperty, properties)	Вспомогательный метод для создания подписи в PropertyPane.
PropertyPaneLink(targetProperty, properties)	Вспомогательный метод для создания ссылки в PropertyPane.
PropertyPaneSlider(targetProperty, properties)	Вспомогательный метод для создания ползунка в PropertyPane.
PropertyPaneTextField(targetProperty, properties)	Вспомогательный метод для создания текстового поля в PropertyPane.
PropertyPaneToggle(targetProperty, properties)	Вспомогательный метод для создания переключателя в PropertyPane.

Сведения о функции

PropertyPaneButton(targetProperty, properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Вспомогательный метод для создания кнопки в PropertyPane.

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

Параметры

targetProperty

string

Целевое свойство, с которым связана кнопка.

properties

IPropertyPaneButtonProps

Строго типизированные свойства кнопки.

Возвращаемое значение

IPropertyPaneField<IPropertyPaneButtonProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneCheckbox(targetProperty, properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Вспомогательный метод для создания флажка в PropertyPane.

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

Параметры

targetProperty

string

Целевое свойство, с которым связан флажок.

properties

IPropertyPaneCheckboxProps

Строго типизированные свойства флажка.

Возвращаемое значение

IPropertyPaneField<IPropertyPaneCheckboxProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneChoiceGroup(targetProperty, properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Вспомогательный метод для создания группы выбора в PropertyPane.

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

Параметры

targetProperty

string

Целевое свойство, с которым связана группа выбора.

properties

IPropertyPaneChoiceGroupProps

Строго типизированные свойства группы выбора.

Возвращаемое значение

IPropertyPaneField<IPropertyPaneChoiceGroupProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneCustomField(properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Вспомогательный метод для создания настраиваемого поля в PropertyPane.

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

Параметры

properties

IPropertyPaneCustomFieldProps

Строго типизированные свойства настраиваемого поля.

Возвращаемое значение

IPropertyPaneField<IPropertyPaneCustomFieldProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneDropdown(targetProperty, properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Вспомогательный метод для создания раскрывающегося меню в PropertyPane.

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

Параметры

targetProperty

string

Целевое свойство, с которым связано раскрывающееся меню.

properties

IPropertyPaneDropdownProps

Строго типизированные свойства раскрывающегося меню.

Возвращаемое значение

IPropertyPaneField<IPropertyPaneDropdownProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneDynamicField(targetProperty, properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Вспомогательный метод для создания мини-приложения динамических данных в PropertyPane для динамического поля.

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

Параметры

targetProperty

string

Целевое свойство, с чем связано мини-приложение динамических данных.

properties

IPropertyPaneDynamicFieldProps

Возвращаемое значение

IPropertyPaneField<IPropertyPaneDynamicFieldProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneDynamicFieldSet(properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Вспомогательный метод для создания мини-приложения динамических данных в области свойств для набора динамических полей с общим источником данных.

Эти поля могут совместно использовать одно и то же свойство на основе связанных фильтров.

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

Параметры

properties

IPropertyPaneDynamicFieldSetProps

Содержит записи и параметры, описанные ниже: entries — набор записей для настройки мини-приложения. Каждая запись включает целевое свойство и, при необходимости, метку для отображения. options — параметры, включающие настраиваемые значения для обратного вызова, фильтров и т. д. для заданного набора динамических полей.

Возвращаемое значение

IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneDynamicTextField(targetProperty, properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Вспомогательный метод для создания динамического текстового поля в PropertyPane.

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

Параметры

targetProperty

string

Целевое свойство, с которое связано динамическое текстовое поле.

properties

IPropertyPaneDynamicTextFieldProps

Свойства PropertyPaneDynamicTextField.

Возвращаемое значение

IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneHorizontalRule()

Предупреждение

Теперь этот API является нерекомендуемым.

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

Вспомогательный метод для создания горизонтальной линейки в PropertyPane.

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

Возвращаемое значение

IPropertyPaneField<void>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneLabel(targetProperty, properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Вспомогательный метод для создания подписи в PropertyPane.

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

Параметры

targetProperty

string

Целевое свойство, с которым связана подпись.

properties

IPropertyPaneLabelProps

Строго типизированные свойства подписи.

Возвращаемое значение

IPropertyPaneField<IPropertyPaneLabelProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneLink(targetProperty, properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Вспомогательный метод для создания ссылки в PropertyPane.

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

Параметры

targetProperty

string

Целевое свойство, с которым связана ссылка.

properties

IPropertyPaneLinkProps

Строго типизированные свойства ссылки.

Возвращаемое значение

IPropertyPaneField<IPropertyPaneLinkProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneSlider(targetProperty, properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Вспомогательный метод для создания ползунка в PropertyPane.

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

Параметры

targetProperty

string

Целевое свойство, с которым связан ползунок.

properties

IPropertyPaneSliderProps

Строго типизированные свойства ползунка.

Возвращаемое значение

IPropertyPaneField<IPropertyPaneSliderProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneTextField(targetProperty, properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Вспомогательный метод для создания текстового поля в PropertyPane.

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

Параметры

targetProperty

string

Целевое свойство, с которым связано текстовое поле.

properties

IPropertyPaneTextFieldProps

Строго типизированные свойства текстового поля.

Возвращаемое значение

IPropertyPaneField<IPropertyPaneTextFieldProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.

PropertyPaneToggle(targetProperty, properties)

Предупреждение

Теперь этот API является нерекомендуемым.

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

Вспомогательный метод для создания переключателя в PropertyPane.

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

Параметры

targetProperty

string

Целевое свойство, с которым связан переключатель.

properties

IPropertyPaneToggleProps

Строго типизированные свойства переключателя.

Возвращаемое значение

IPropertyPaneField<IPropertyPaneToggleProps>

Комментарии

Мы оставили исходную реализацию здесь, чтобы избежать разрыва контракта общедоступного API.