Compartir a través de

IClientSideComponentLoaderConfiguration interface

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

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 interfaz se describe cómo un componente del lado cliente se va a cargar e inicializar mediante un marco de cliente de SharePoint. Contiene todos los datos para cargar un script de punto de entrada y sus scripts de dependencia.

Propiedades

entryModuleId

Este es el identificador de una de las entradas del diccionario "scriptResources".
exportName

El módulo al que hace referencia el campo "entryModuleId" puede exportar un objeto con varios campos.
internalModuleBaseUrls

Se trata de una matriz de rutas de acceso completas que se anteponen a cada una de las rutas de acceso de recursos de script con el tipo "interno" o "localizado". Si no se puede cargar, el cargador intentará cargar desde el siguiente hasta que no quede ninguna ruta de acceso base.
scriptResources

Se trata de un diccionario de recursos de script con nombre. path y localizedPath los módulos pueden hacer referencia entre sí y manifest se espera que el entorno de ejecución del marco proporcione los módulos. El recurso denominado en entryModuleId debe contener el objeto exportado del componente.

Detalles de las propiedades

entryModuleId

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.

Este es el identificador de una de las entradas del diccionario "scriptResources".

entryModuleId: string;

Valor de propiedad

string

Comentarios

El cargador descargará y evaluará el recurso de script al que se hace referencia en este campo, resolverá todas las dependencias con las claves de "scriptResources" y devolverá el objeto exportado a la función de llamada del cargador. La entrada a la que se hace referencia en el diccionario "scriptResources" debe ser del tipo "interno" o "localizado".

Valores admitidos: entrada en el diccionario "scriptResources" que define el módulo exportado base del componente.

Ejemplo: "myApplication.bundle"

exportName

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.

El módulo al que hace referencia el campo "entryModuleId" puede exportar un objeto con varios campos.

exportName?: string;

Valor de propiedad

string

Comentarios

Opcionalmente, este valor hace referencia al nombre de un campo en el objeto exportado por el módulo al que hace referencia el entryModuleId campo. Cuando este campo tiene un valor, el valor del campo al que se hace referencia en el objeto exportado por el módulo al que hace referencia el entryModuleId campo se devuelve cuando se carga este manifiesto en lugar del objeto exportado base. Por ejemplo, si entryModuleId hace referencia a un módulo con una exportación de nivel superior de { foo: 'bar', baz: 123 } y:

  • si este campo no está establecido, el valor devuelto por el cargador de módulos es { foo: 'bar', baz: 123 }

  • si este campo está establecido en foo, el valor devuelto por el cargador de módulos es bar

  • Si este campo está establecido baren , el valor devuelto por el cargador de módulos no está definido (como bar no es una clave en la exportación de nivel superior).

Ejemplo: mySpWebpart

internalModuleBaseUrls

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.

Se trata de una matriz de rutas de acceso completas que se anteponen a cada una de las rutas de acceso de recursos de script con el tipo "interno" o "localizado". Si no se puede cargar, el cargador intentará cargar desde el siguiente hasta que no quede ninguna ruta de acceso base.

internalModuleBaseUrls: string[];

Valor de propiedad

string[]

Comentarios

Todos los recursos de script "internos" y "localizados" que no tengan direcciones URL completas como valores de campo "path" deben hospedarse en cada una de las rutas de acceso enumeradas en esta propiedad. Por ejemplo, si el valor del campo "path" de un módulo interno es "master_2015-04-20/my-application.bundle_1928f8a0.js" y el valor de este campo es [ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ], el cargador intentará cargar primero este recurso de script desde la dirección URL "https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js". Si se produce un error al cargar desde esa dirección URL, el cargador intentará cargar este recurso de script desde "https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js". Si esa dirección URL no se carga, el componente no se cargará y se devolverá un error. Es importante tener en cuenta que la compatibilidad con varias direcciones URL base es únicamente para la compatibilidad con la conmutación por error. Esto significa que todos los archivos deben estar presentes en todos los hosts enumerados en este campo.

Uso: direcciones URL base para recursos de script con el tipo "interno" o "localizado".

Valores admitidos: cualquier dirección URL que contenga todos los scripts internos a los que se hace referencia en el diccionario "scriptResources".

Ejemplo: [ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]

scriptResources

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.

Se trata de un diccionario de recursos de script con nombre. path y localizedPath los módulos pueden hacer referencia entre sí y manifest se espera que el entorno de ejecución del marco proporcione los módulos. El recurso denominado en entryModuleId debe contener el objeto exportado del componente.

scriptResources: {
        [name: string]: IModuleConfiguration;
    };

Valor de propiedad

{ [name: string]: IModuleConfiguration; }

Comentarios

Valores admitidos: diccionario de recursos de script con nombre.

Ejemplo:

 {
   "myApplication.bundle": {
     "type": "path",
     "path": "master_2015-04-20/my-application.bundle_1928f8a0.js"
   },
   "@microsoft/sp-client-base": {
     "type": "component",
     "id": "af59c2b3-2da7-41fd-8b72-3939817960af",
     "version": "latest"
   },
   "@microsoft/sp-client-preview": {
     "type": "component",
     "id": "4d5eb168-6729-49a8-aec7-0e397f486b6e",
     "version": "latest"
   },
   "jQuery": {
     "type": "component",
     "id": "00000000-0000-0000-0000-000000000000",
     "version": "2.2.4",
     "path": "https://code.jquery.com/jquery-2.2.4.min.js"
   },
   "myApplication_strings": {
     "type": "localizedPath",
     "defaultPath": "master_2015-04-20/my-application_strings_default_af378e0d.js",
     "paths": {
       "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js",
       "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js"
     }
   }
 }