Поделиться через

IClientSideComponentManifest interface

  • Ссылка
Пакет:
@microsoft/sp-module-interfaces

Все клиентские компоненты, созданные на платформе SharePoint, нуждаются в допустимом манифесте компонента. Этот интерфейс представляет свойства, необходимые для всех типов клиентских компонентов, таких как приложения и веб-части. Манифесты конкретного компонента расширяют этот интерфейс, добавляя свойства, необходимые для этого типа компонента.

Extends
IClientSideManifestBase

Комментарии

Схема этого манифеста принадлежит и используется корпорацией Майкрософт. При изменении этой схемы необходимо соблюдать следующие правила. Этот набор правил также можно назвать "правилами обновления манифеста".

  • При незначительных изменениях в эту схему можно добавить новые свойства с обратной совместимостью. т. е. код, обрабатывающий манифест, должен быть в состоянии обработать отсутствие этих новых свойств.

  • Попробуйте смоделировать изменения как незначительные приращения SemVer. Следует избегать серьезных изменений версий, так как они налагают на разработчиков затраты на миграцию.

  • При 'manifestVersion' любых небольших или больших изменениях необходимо нагромождать.

Свойства

alias

Краткое имя обычно присваивается разработчиком. Он не нуждается в локализации и, как ожидается, останется неизменным в течение всего времени существования компонента. Если приложение переопределяет ClientSideApplication.alias свойство, ClientSideApplication.alias ему присваивается приоритет над значением, указанным в манифесте.
componentType

Тип клиентского компонента. Компоненты с типом Application определяются интерфейсом IClientSideApplicationManifest. Компоненты с типом WebPart определяются интерфейсом IClientSideWebPartManifest. Компоненты с типом Library определяются интерфейсом IClientSideLibraryManifest. Компоненты с типом AdaptiveCardExtension определяются интерфейсом IAdaptiveCardExtensionManifest.
loaderConfig

В этой части конфигурации описывается загрузка и инициализация компонента клиентом. Он содержит перечисление скриптов, необходимых компоненту, а также скрипт одной точки входа.
loadLegacyFabricCss

Это свойство используется для хранения старых компонентов, которые явно не используют CSS структуры. По большей части веб-части, которые создаются после использования spfx 1.1, это не требуется.
requiresCustomScript

Если значение true, компонент ведет себя следующим образом на сайтах, на которых запрещено выполнять пользовательские скрипты. Если компонент является веб-частью, он недоступен в средстве выбора веб-частей. Каждый экземпляр компонента, добавленного на страницу, когда пользовательские скрипты были разрешены для выполнения, больше не будут отображаться на этих страницах. Автор по-прежнему может удалить эти компоненты при редактировании страницы
safeWithCustomScriptDisabled

Это свойство предоставляется для обратной совместимости. Это больше не имеет никакого эффекта.
version

Версия компонента на стороне клиента. Ожидается, что значение этого поля будет контролироваться разработчиком клиентского компонента.

Сведения о свойстве

alias

Краткое имя обычно присваивается разработчиком. Он не нуждается в локализации и, как ожидается, останется неизменным в течение всего времени существования компонента. Если приложение переопределяет ClientSideApplication.alias свойство, ClientSideApplication.alias ему присваивается приоритет над значением, указанным в манифесте.

alias: string;

Значение свойства

string

Комментарии

Использование: краткое имя для идентификации клиентского компонента разработчиком.

Поддерживаемые значения: допустимые символы: a-z, A–Z и -. Не более 40 символов.

Пример: "NewFeed"

componentType

Тип клиентского компонента. Компоненты с типом Application определяются интерфейсом IClientSideApplicationManifest. Компоненты с типом WebPart определяются интерфейсом IClientSideWebPartManifest. Компоненты с типом Library определяются интерфейсом IClientSideLibraryManifest. Компоненты с типом AdaptiveCardExtension определяются интерфейсом IAdaptiveCardExtensionManifest.

componentType: ComponentType;

Значение свойства

ComponentType

Комментарии

Использование. Для объединения, загрузки, перечисления и инициализации компонентов на основе их содержимого.

Поддерживаемые значения: "Application","WebPart" ,"Library" , , "Extension""AdaptiveCardExtension"

loaderConfig

Примечание

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

В этой части конфигурации описывается загрузка и инициализация компонента клиентом. Он содержит перечисление скриптов, необходимых компоненту, а также скрипт одной точки входа.

loaderConfig: IClientSideComponentLoaderConfiguration;

Значение свойства

IClientSideComponentLoaderConfiguration

Комментарии

Использование: загрузка компонента.

Дополнительные сведения и примеры см IClientSideComponentLoaderConfiguration . в этой статье.

loadLegacyFabricCss

Это свойство используется для хранения старых компонентов, которые явно не используют CSS структуры. По большей части веб-части, которые создаются после использования spfx 1.1, это не требуется.

loadLegacyFabricCss?: boolean;

Значение свойства

boolean

requiresCustomScript

Если значение true, компонент ведет себя следующим образом на сайтах, на которых запрещено выполнять пользовательские скрипты. Если компонент является веб-частью, он недоступен в средстве выбора веб-частей. Каждый экземпляр компонента, добавленного на страницу, когда пользовательские скрипты были разрешены для выполнения, больше не будут отображаться на этих страницах. Автор по-прежнему может удалить эти компоненты при редактировании страницы

requiresCustomScript?: boolean;

Значение свойства

boolean

Комментарии

Значение по умолчанию: false. Дополнительные сведения см. в статье https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f.

Использование. Для установки и запуска этого компонента требуется разрешить настраиваемый скрипт.

safeWithCustomScriptDisabled

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

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

Use requiresCustomScript instead of safeWithCustomScriptDisabled.

Это свойство предоставляется для обратной совместимости. Это больше не имеет никакого эффекта.

safeWithCustomScriptDisabled?: boolean;

Значение свойства

boolean

version

Версия компонента на стороне клиента. Ожидается, что значение этого поля будет контролироваться разработчиком клиентского компонента.

version: string;

Значение свойства

string

Комментарии

Цель этого поля — помочь разработчикам компонентов на стороне клиента обновить свои клиентские компоненты управляемым способом. Это помогает потребителям клиентского компонента принимать решения о том, когда и как обновлять компонент на стороне клиента. По мере развития кода для клиентского компонента разработчик может выбрать версию КОМПОНЕНТА MAJOR, MINOR или PATCH.

Все несовместимые изменения API должны привести к удару по версии MAJOR. Изменения обратной совместимости функций должны привести к удару версии MINOR, а исправления ошибок, совместимые с обратной совместимостью, должны привести к сбою версии PATCH. Дополнительные сведения об управлении версией компонентов см http://semver.org . в этой статье.

Использование: управление версиями и безопасное развитие клиентского компонента управляемым способом.

Поддерживаемые значения: строка, представляющая семантическую версию , т. е. MAJOR. НЕСОВЕРШЕННОЛЕТНИЙ. ЗАПЛАТА

Пример: "1.0.0"