-
Notifications
You must be signed in to change notification settings - Fork 21
Expand file tree
/
Copy pathimoduleconfiguration.yml
More file actions
62 lines (56 loc) · 2.21 KB
/
imoduleconfiguration.yml
File metadata and controls
62 lines (56 loc) · 2.21 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
### YamlMime:TSType
name: IModuleConfiguration
uid: '@microsoft/sp-module-interfaces!IModuleConfiguration:interface'
package: '@microsoft/sp-module-interfaces!'
fullName: IModuleConfiguration
summary: This is the base interface for a script module's definition.
remarks: ''
isPreview: true
isDeprecated: false
type: interface
properties:
- name: shouldNotPreload
uid: >-
@microsoft/sp-module-interfaces!IModuleConfiguration#shouldNotPreload:member
package: '@microsoft/sp-module-interfaces!'
fullName: shouldNotPreload
summary: >-
If set to `true`<!-- -->, this module should not be preloaded when loading
the component.
remarks: >-
The most common case for setting this property to "true" is when a module
is defined in a manifest, but is not required for the module referenced in
"entryModuleId" to load. Modules may be defined that are loaded
asynchronously, and these modules do not need to be preloaded. This field
implicitly defaults to `false`<!-- -->.
Usage: Instructs the module loader to not preload this module.
isPreview: true
isDeprecated: false
syntax:
content: 'shouldNotPreload?: boolean;'
return:
type: boolean
- name: type
uid: '@microsoft/sp-module-interfaces!IModuleConfiguration#type:member'
package: '@microsoft/sp-module-interfaces!'
fullName: type
summary: >-
The type of the script block. `"component"` modules come from a component,
`"path"` and `"localizedPath"` modules must be available on the paths
provided in the `"internalModuleBaseUrls"` field.
remarks: >-
Modules with the `"path"` type use the `IPathModuleConfiguration`
interface.
Modules with the `"component"` type use the
`IComponentModuleConfiguration` interface.
Modules with the `"localizedPath"` type use the
`ILocalizedPathModuleConfiguration` interface.
Supported values: `"component"`<!-- -->, `"path"`<!-- -->,
`"localizedPath"`
Example: `"localized"`
isPreview: true
isDeprecated: false
syntax:
content: 'type: ''component'' | ''path'' | ''localizedPath'';'
return:
type: '''component'' | ''path'' | ''localizedPath'''