Skip to content

Latest commit

 

History

History
57 lines (45 loc) · 1.93 KB

dynamic.component.md

File metadata and controls

57 lines (45 loc) · 1.93 KB
Raw
Title Added Status Last reviewed
Dynamic Component
v3.0.0
Experimental
2018-12-17

Dynamic Component

Displays dynamically-loaded extension components.

Class members

Properties

Name Type Default value Description
data any Data for the dynamically-loaded component instance.
id string Unique ID string for the component to show.

Details

Use the Dynamic component to create extensible apps (ie, apps that provide a generalized UI structure where the specific content can be "plugged in" by other developers). The id property refers to a component that has previously been registered using the setComponents method of the Extension service:

// Registering the extension components.
extensionService.setComponents({
    'plugInName.components.docList': DocumentListComponent.
    'plugInName.components.login': LoginComponent,
    ... 
});
<!-- Using the component pre-registered with the key 'plugInName.components.login' -->
<adf-dynamic-component
    id="'plugInName.components.login'"
    data="{ ... }"
>
</adf-dynamic-component>

Use this to provide the extension developer with a standard layout that contains placeholders defined by instances of the Dynamic component. The developer can then register any desired components to correspond to the defined component IDs. For example, the extensible app might be shipped with the standard Document List component registered against plugInName.components.docList. The extension developer can replace this with a custom class simply by registering that class with setComponents before use.

See also