Compartir a través de

IClientSideComponentManifest interface

  • Referencia
Paquete:
@microsoft/sp-module-interfaces

Todos los componentes del lado cliente basados en el marco de SharePoint necesitan un manifiesto de componente válido. Esta interfaz representa las propiedades necesarias para todos los tipos de componentes del lado cliente, como aplicaciones y elementos web. Los manifiestos específicos del componente ampliarán esta interfaz para agregar las propiedades necesarias para ese tipo de componente.

Extends
IClientSideManifestBase

Comentarios

Microsoft posee y versiona el esquema de este manifiesto. Se deben seguir las siguientes reglas al cambiar este esquema. Este conjunto de reglas también se puede denominar "reglas de actualización de manifiesto".

  • Para los cambios menores, se pueden agregar nuevas propiedades a este esquema de una manera compatible con versiones anteriores. Es decir, el código que procesa el manifiesto debe ser capaz de controlar la ausencia de esas nuevas propiedades.

  • Intente modelar los cambios como incrementos menores de SemVer. Los cambios de versión principales deben evitarse porque imponen un costo de migración a los desarrolladores.

  • 'manifestVersion' Se debe realizar un resquete para todos los cambios pequeños o grandes.

Propiedades

alias

Nombre corto que suele dar el desarrollador. No es necesario localizarlo y se espera que permanezca igual durante la duración del componente. Si una aplicación invalida la ClientSideApplication.alias propiedad , ClientSideApplication.alias tiene prioridad sobre el valor proporcionado en el manifiesto.
componentType

Tipo de componente del lado cliente. Los componentes con el tipo "Application" se definen mediante la interfaz "IClientSideApplicationManifest". Los componentes con el tipo "WebPart" se definen mediante la interfaz "IClientSideWebPartManifest". Los componentes con el tipo "Library" se definen mediante la interfaz "IClientSideLibraryManifest". Los componentes con el tipo "AdaptiveCardExtension" se definen mediante la interfaz "IAdaptiveCardExtensionManifest".
loaderConfig

En esta parte de la configuración se describe cómo un cliente debe cargar e inicializar el componente. Contiene una enumeración de scripts que el componente requiere junto con un único script de punto de entrada.
loadLegacyFabricCss

Esta propiedad se usa para mantener los componentes anteriores que no usan CSS de tejido explícitamente. En su mayor parte, los elementos web que se compilan después de usar spfx 1.1 no lo necesitan.
requiresCustomScript

Si es true, el componente se comporta de la siguiente manera en sitios donde no se permite ejecutar scripts personalizados: - cuando el componente es un elemento web, no está disponible en el selector de elementos web - todas las instancias del componente que se agregaron a la página mientras se permitía la ejecución de scripts personalizados ya no aparecerán en esas páginas. El autor todavía puede quitar esos componentes al editar la página.
safeWithCustomScriptDisabled

Esta propiedad se proporciona para la compatibilidad con versiones anteriores. Ya no tiene ningún efecto.
version

Versión del componente del lado cliente. Se espera que el desarrollador del componente del lado cliente controle el valor de este campo.

Detalles de las propiedades

alias

Nombre corto que suele dar el desarrollador. No es necesario localizarlo y se espera que permanezca igual durante la duración del componente. Si una aplicación invalida la ClientSideApplication.alias propiedad , ClientSideApplication.alias tiene prioridad sobre el valor proporcionado en el manifiesto.

alias: string;

Valor de propiedad

string

Comentarios

Uso: nombre corto para identificar un componente del lado cliente por parte del desarrollador.

Valores admitidos: los caracteres permitidos son a-z, A-Z y '-'. No más de 40 caracteres.

Ejemplo: "NewFeed"

componentType

Tipo de componente del lado cliente. Los componentes con el tipo "Application" se definen mediante la interfaz "IClientSideApplicationManifest". Los componentes con el tipo "WebPart" se definen mediante la interfaz "IClientSideWebPartManifest". Los componentes con el tipo "Library" se definen mediante la interfaz "IClientSideLibraryManifest". Los componentes con el tipo "AdaptiveCardExtension" se definen mediante la interfaz "IAdaptiveCardExtensionManifest".

componentType: ComponentType;

Valor de propiedad

ComponentType

Comentarios

Uso: para ayudar a agrupar, cargar, enumerar e inicializar componentes en función de su contenido.

Valores admitidos: "Application","WebPart" , "Library", , "Extension""AdaptiveCardExtension"

loaderConfig

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.

En esta parte de la configuración se describe cómo un cliente debe cargar e inicializar el componente. Contiene una enumeración de scripts que el componente requiere junto con un único script de punto de entrada.

loaderConfig: IClientSideComponentLoaderConfiguration;

Valor de propiedad

IClientSideComponentLoaderConfiguration

Comentarios

Uso: carga de un componente.

Consulte IClientSideComponentLoaderConfiguration para obtener más información y ejemplos.

loadLegacyFabricCss

Esta propiedad se usa para mantener los componentes anteriores que no usan CSS de tejido explícitamente. En su mayor parte, los elementos web que se compilan después de usar spfx 1.1 no lo necesitan.

loadLegacyFabricCss?: boolean;

Valor de propiedad

boolean

requiresCustomScript

Si es true, el componente se comporta de la siguiente manera en sitios donde no se permite ejecutar scripts personalizados: - cuando el componente es un elemento web, no está disponible en el selector de elementos web - todas las instancias del componente que se agregaron a la página mientras se permitía la ejecución de scripts personalizados ya no aparecerán en esas páginas. El autor todavía puede quitar esos componentes al editar la página.

requiresCustomScript?: boolean;

Valor de propiedad

boolean

Comentarios

Valores predeterminados de falso. Vea https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f para obtener más información.

Uso: requiere que se permita el script personalizado para que este componente se instale y ejecute.

safeWithCustomScriptDisabled

Advertencia

Esta API ya está en desuso.

Use requiresCustomScript instead of safeWithCustomScriptDisabled.

Esta propiedad se proporciona para la compatibilidad con versiones anteriores. Ya no tiene ningún efecto.

safeWithCustomScriptDisabled?: boolean;

Valor de propiedad

boolean

version

Versión del componente del lado cliente. Se espera que el desarrollador del componente del lado cliente controle el valor de este campo.

version: string;

Valor de propiedad

string

Comentarios

El propósito de este campo es ayudar a los desarrolladores de componentes del lado cliente a actualizar sus componentes del lado cliente de forma administrada. Esto ayuda a los consumidores del componente del lado cliente a tomar decisiones sobre cuándo y cómo actualizar el componente del lado cliente. A medida que el desarrollador evoluciona el código de su componente del lado cliente, puede decidir mejorar la versión PRINCIPAL, SECUNDARIA o PATCH del componente.

Todos los cambios de API incompatibles deben dar lugar a un problema de versión principal. Los cambios en la funcionalidad compatibles con versiones anteriores deben dar lugar a un problema de versión SECUNDARIA y las correcciones de errores compatibles con versiones anteriores deben dar lugar a un problema de versión patch. http://semver.org Consulte para obtener más información sobre cómo administrar la versión de los componentes.

Uso: control de versiones y evolución de un componente del lado cliente de forma segura de forma controlada.

Valores admitidos: cadena que representa una versión semántica , es decir, MAJOR. MENOR. PARCHE

Ejemplo: "1.0.0"