Dynamic module widget

Index

Functions

Functions

convertKindToModuleId(kind: any): string

(overrridable) Replace this to re-interpret the kind id as a module path. By default it does a lookup for any custom maps added through mapKind and then falls back to the path "durandal/widgets/{kind}/controller".

Parameters

  • kind: any

Returns

string

convertKindToViewId(kind: any): string

(overridable) Replace this to re-interpret the kind id as a view id. The default does a lookup for any custom maps added through mapKind and then falls back to the path "durandal/widgets/{kind}/view".

Parameters

  • kind: any

Returns

string

create(element: any, settings: any, bindingContext?: any): any

Use this function to create a widget through code. The element should reference a dom element that the widget will be created on. The settings can be either a string or an object. If it's a string, it should specify the widget kind. If it's an object, it represents settings that will be passed along to the widget. This object should have a kind property used to identify the widget kind to create. Optionally, you can specify a bindingContext of which you want the widget's binding context to be created as a child.

Parameters

  • element: any
  • settings: any
  • bindingContext?: any optional

Returns

any

getParts(elements: any): any

Developers implementing widgets may wish to use this function to acquire the resolved template parts for a widget. Pass a single dom element or an array of elements and get back an object keyed by part name whose values are the dom elements corresponding to each part in that scope.

Parameters

  • elements: any

Returns

any

mapKind(kind: string, viewId?: string, moduleId?: string): any

Use this to re-map a widget kind identifier to a new viewId or moduleId representing the 'skin' and 'behavior' respectively.

Parameters

  • kind: string
  • viewId?: string optional
  • moduleId?: string optional

Returns

any

registerKind(kind: string): any

By default, you can create widgets in html by using the widget binding extension. Calling registerKind allows you to easily create a custom binding handler for your widget kind. Without calling registerKind you might declare a widget binding for an expander control with

Parameters

  • kind: string

Returns

any