@ibm-wch-sdk/web-components

web-components

Collection of native web components to work with layouts in Watson Content Hub.

Details

Refer to the documentation.

Changes

CHANGELOG

Class documentation

Refer to the documentation.

Usage

Install the library as a dependency to your project, e.g. via:

npm install --save @ibm-wch-sdk/web-components

Bootstrap the registration of the web components as part of the bootstrap process of your application:

import { initSdkComponents } from '@ibm-wch-sdk/web-components';

initSdkComponents();

The components depend on the existence of an implementation of the @ibm-wch-sdk/api in the global namespace. You can use e.g. one of the following implementations:

For a standalone application, bootstrap the @ibm-wch-sdk/services implementation.
Use the custom components as part of an Angular application.

Build

If you plan to use custom elements natively in the browser, make sure to import the ES6 version of the library. Since the library is packaged following the APF, the ES6 code is available via the es2015 key in the package json. Note that the ES5 implementation will not work in Chrome.

Webpack

When using webpack make the following modification to the webpack.config.js to pull in the ES6 code:

module.exports = {
  resolve: {
    mainFields: ['es2015', 'browser', 'module', 'main']
  }
}

Note how es2015 gets prepended to the default lookup chain.

Layouts

This package of custom web components assist in rendering pages that can be managed by a business user using the WCH UI. The main building blocks are pages and layouts.

Pages

The page structure can be managed in WCH. Each page has a path and points to renderable content.
Use the wch-page component to do the URL resolution and to display the configured content item for a page.

Layouts

Each WCH content item can be rendered using a layout. The business user decides which layout to use for a particular piece of content, the developer implements the layouts as part of the application.
Use the wch-contentref component to render the layout for a particular content item.

Custom layouts

Custom layouts have to be implemented by your application. The layout template as mananaged in WCH matches the name of the custom element. The wch-contentref will figure out which layout is mapped to the addressed content and will instantiate the matching custom element accordingly.
Custom layouts should accept the following attributes:

layoutmode: name of the layout mode used to render the component. When not specified this should fallback to default.

Custom layouts should accept the following properties:

layoutMode: same as the layoutmode attribute, but accessible as a property. Also note the camel case name.
renderingContext: the RenderingContext that identifies the addressed content item. Implementations are advised to use the wch-contentref to render referenced content (or content from search).

Components

The library defines the following web components:

wch-contentref: used to render a content item from a reference
wch-page: used to do routing according to the WCH configuration

TODO

Changelog

Current

Added

Initial version

@ibm-wch-sdk/web-components

Index

External modules

"base/abstract.base.component"
"base/abstract.rendering.component"
"content/content.component"
"contentref/content.ref.component"
"contentref/index"
"decorators/layout.decorator"
"decorators/layout.directive"
"dom/document"
"dom/index"
"dom/node"
"dom/predicates"
"index"
"init/components"
"init/index"
"init/init"
"layout-not-found/layout.not.found.component"
"page/page.component"
"utils/component.utils"
"utils/index"
"utils/logging.utils"
"utils/logic"

@ibm-wch-sdk/web-components > "base/abstract.base.component"

External module: "base/abstract.base.component"

Index

Classes

AbstractBaseComponent

Variables

ATTRLAYOUTMODE

Variables

`<Const>` ATTRLAYOUTMODE

● ATTRLAYOUTMODE: string = KEYLAYOUTMODE.toLowerCase()
Defined in base/abstract.base.component.ts:16

@ibm-wch-sdk/web-components > "base/abstract.rendering.component"

External module: "base/abstract.rendering.component"

Index

Classes

AbstractRenderingComponent

@ibm-wch-sdk/web-components > "content/content.component"

External module: "content/content.component"

Index

Classes

ContentComponent

Variables

`<Const>` ATTRID

● ATTRID: string = KEYID.toLowerCase()
Defined in content/content.component.ts:26

<Const> ATTRLAYOUTMODE
● ATTRLAYOUTMODE: string = KEYLAYOUTMODE.toLowerCase()
Defined in content/content.component.ts:28

<Const> ATTRLEVELS
● ATTRLEVELS: string = KEYLEVELS.toLowerCase()
Defined in content/content.component.ts:27

<Const> KEYID
● KEYID: "id" = "id"
Defined in content/content.component.ts:22

<Const> LOGGER
● LOGGER: "wch-content" = WCHCONTENT
Defined in content/content.component.ts:24

@ibm-wch-sdk/web-components > "contentref/content.ref.component"

External module: "contentref/content.ref.component"

Index

Variables

`<Const>` LOGGER

● LOGGER: "wch-contentref" = WCHCONTENTREF
Defined in contentref/content.ref.component.ts:92

<Const> DEFAULTLAYOUT
● DEFAULTLAYOUT: "wch-default-layout" = "wch-default-layout"
Defined in contentref/content.ref.component.ts:29

<Const> PAGENOTFOUNDLAYOUT
● PAGENOTFOUNDLAYOUT: "wch-404" = "wch-404"
Defined in contentref/content.ref.component.ts:31
Functions
getType
▸ getType(aLayoutMode: string \| undefined, aRenderingContext: RenderingContext, aRegistry: CustomElementRegistry): Observable<string>
Defined in contentref/content.ref.component.ts:67
Parameters:
| Name | Type | | ------ | ------ | | aLayoutMode | string \| undefined | | aRenderingContext | RenderingContext | | aRegistry | CustomElementRegistry |
Returns: Observable<string>

resolveLayout
▸ resolveLayout(aLayout: Layout, aRegistry: CustomElementRegistry): Observable<string>
Defined in contentref/content.ref.component.ts:42
Parameters:
| Name | Type | | ------ | ------ | | aLayout | Layout | | aRegistry | CustomElementRegistry |
Returns: Observable<string>
Object literals
<Const> LAYOUTNOTFOUNDLAYOUT
LAYOUTNOTFOUNDLAYOUT: object
Defined in contentref/content.ref.component.ts:37
template
● template: string = DEFAULTLAYOUT
Defined in contentref/content.ref.component.ts:39

templateType
● templateType: string = LAYOUTTYPEANGULAR
Defined in contentref/content.ref.component.ts:38

<Const> PAGENOTFOUNDLAYOUT
PAGENOTFOUNDLAYOUT: object
Defined in contentref/content.ref.component.ts:33
template
● template: string = PAGENOTFOUNDLAYOUT
Defined in contentref/content.ref.component.ts:35

templateType
● templateType: string = LAYOUTTYPEANGULAR
Defined in contentref/content.ref.component.ts:34

@ibm-wch-sdk/web-components > "contentref/index"

External module: "contentref/index"

Index

---
@ibm-wch-sdk/web-components > "decorators/layout.decorator"

External module: "decorators/layout.decorator"

Index

Variables

LAYOUTSYMBOL

Functions

LayoutComponent
getSelectors
registerLayoutComponents

Variables

`<Const>` LAYOUTSYMBOL

● LAYOUTSYMBOL: unique symbol = Symbol()
Defined in decorators/layout.decorator.ts:5
Functions
LayoutComponent
▸ LayoutComponent(aDirective?: LayoutComponentDirective): function
Defined in decorators/layout.decorator.ts:12
Parameters:
| Name | Type | | ------ | ------ | | Optional aDirective | LayoutComponentDirective |
Returns: function

getSelectors
▸ getSelectors(aComponent: any): string
Defined in decorators/layout.decorator.ts:32
Returns the selectors for a component
Parameters:
| Name | Type | Description | | ------ | ------ | ------ | | aComponent | any | the component |
Returns: string the selectors, can be the empty strign

registerLayoutComponents
▸ registerLayoutComponents(aComponents: any): void
Defined in decorators/layout.decorator.ts:49
Registers the given set of layout components
Parameters:
| Name | Type | Description | | ------ | ------ | ------ | | aComponents | any | the components |
Returns: void

@ibm-wch-sdk/web-components > "decorators/layout.directive"

External module: "decorators/layout.directive"

Index

Interfaces

LayoutComponentDirective

@ibm-wch-sdk/web-components > "dom/document"

External module: "dom/document"

Index

Variables

createHTMLAbbrElement
createHTMLAddressElement
createHTMLAnchorElement
createHTMLAppletElement
createHTMLAreaElement
createHTMLArticleElement
createHTMLAsideElement
createHTMLAudioElement
createHTMLBElement
createHTMLBaseElement
createHTMLBasefontElement
createHTMLBdoElement
createHTMLBlockquoteElement
createHTMLBodyElement
createHTMLBrElement
createHTMLButtonElement
createHTMLCanvasElement
createHTMLCaptionElement
createHTMLCiteElement
createHTMLCodeElement
createHTMLColElement
createHTMLColgroupElement
createHTMLDataElement
createHTMLDatalistElement
createHTMLDdElement
createHTMLDelElement
createHTMLDfnElement
createHTMLDirElement
createHTMLDivElement
createHTMLDlElement
createHTMLDtElement
createHTMLEmElement
createHTMLEmbedElement
createHTMLFieldsetElement
createHTMLFigcaptionElement
createHTMLFigureElement
createHTMLFontElement
createHTMLFooterElement
createHTMLFormElement
createHTMLFrameElement
createHTMLFramesetElement
createHTMLH1Element
createHTMLH2Element
createHTMLH3Element
createHTMLH4Element
createHTMLH5Element
createHTMLH6Element
createHTMLHeadElement
createHTMLHeaderElement
createHTMLHgroupElement
createHTMLHrElement
createHTMLHtmlElement
createHTMLIElement
createHTMLIframeElement
createHTMLImgElement
createHTMLInputElement
createHTMLInsElement
createHTMLKbdElement
createHTMLLabelElement
createHTMLLegendElement
createHTMLLiElement
createHTMLLinkElement
createHTMLMapElement
createHTMLMarkElement
createHTMLMarkeeElement
createHTMLMenuElement
createHTMLMetaElement
createHTMLMeterElement
createHTMLNavElement
createHTMLNoScriptElement
createHTMLObjectElement
createHTMLOlElement
createHTMLOptgroupElement
createHTMLOptionElement
createHTMLOutputElement
createHTMLPElement
createHTMLParamElement
createHTMLPictureElement
createHTMLPreElement
createHTMLProgressElement
createHTMLQElement
createHTMLRtElement
createHTMLRubyElement
createHTMLSElement
createHTMLSampElement
createHTMLScriptElement
createHTMLSectionElement
createHTMLSelectElement
createHTMLSmallElement
createHTMLSourceElement
createHTMLSpanElement
createHTMLStrongElement
createHTMLStyleElement
createHTMLSubElement
createHTMLSupElement
createHTMLTableElement
createHTMLTbodyElement
createHTMLTdElement
createHTMLTemplateElement
createHTMLTextareaElement
createHTMLTfootElement
createHTMLThElement
createHTMLTheadElement
createHTMLTimeElement
createHTMLTitleElement
createHTMLTrElement
createHTMLTrackElement
createHTMLUElement
createHTMLUlElement
createHTMLVarElement
createHTMLVideoElement
createHTMLWbrElement
docCreateElement

Functions

createElement
createWchContentRefElement

Variables

`<Const>` createHTMLAbbrElement

● createHTMLAbbrElement: function = createElement('abbr')
Defined in dom/document.ts:32
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLAddressElement
● createHTMLAddressElement: function = createElement('address')
Defined in dom/document.ts:34
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLAnchorElement

● createHTMLAnchorElement: function = createElement('a')
Defined in dom/document.ts:31
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLAppletElement
● createHTMLAppletElement: function = createElement('applet')
Defined in dom/document.ts:35
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLAreaElement

● createHTMLAreaElement: function = createElement('area')
Defined in dom/document.ts:36
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLArticleElement
● createHTMLArticleElement: function = createElement('article')
Defined in dom/document.ts:37
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLAsideElement

● createHTMLAsideElement: function = createElement('aside')
Defined in dom/document.ts:38
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLAudioElement
● createHTMLAudioElement: function = createElement('audio')
Defined in dom/document.ts:39
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLBElement

● createHTMLBElement: function = createElement('b')
Defined in dom/document.ts:40
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLBaseElement
● createHTMLBaseElement: function = createElement('base')
Defined in dom/document.ts:41
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLBasefontElement

● createHTMLBasefontElement: function = createElement('basefont')
Defined in dom/document.ts:42
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLBdoElement
● createHTMLBdoElement: function = createElement('bdo')
Defined in dom/document.ts:44
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLBlockquoteElement

● createHTMLBlockquoteElement: function = createElement('blockquote')
Defined in dom/document.ts:46
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLBodyElement
● createHTMLBodyElement: function = createElement('body')
Defined in dom/document.ts:47
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLBrElement

● createHTMLBrElement: function = createElement('br')
Defined in dom/document.ts:48
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLButtonElement
● createHTMLButtonElement: function = createElement('button')
Defined in dom/document.ts:49
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLCanvasElement

● createHTMLCanvasElement: function = createElement('canvas')
Defined in dom/document.ts:50
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLCaptionElement
● createHTMLCaptionElement: function = createElement('caption')
Defined in dom/document.ts:51
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLCiteElement

● createHTMLCiteElement: function = createElement('cite')
Defined in dom/document.ts:53
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLCodeElement
● createHTMLCodeElement: function = createElement('code')
Defined in dom/document.ts:54
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLColElement

● createHTMLColElement: function = createElement('col')
Defined in dom/document.ts:55
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLColgroupElement
● createHTMLColgroupElement: function = createElement('colgroup')
Defined in dom/document.ts:56
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLDataElement

● createHTMLDataElement: function = createElement('data')
Defined in dom/document.ts:58
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLDatalistElement
● createHTMLDatalistElement: function = createElement('datalist')
Defined in dom/document.ts:59
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLDdElement

● createHTMLDdElement: function = createElement('dd')
Defined in dom/document.ts:60
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLDelElement
● createHTMLDelElement: function = createElement('del')
Defined in dom/document.ts:61
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLDfnElement

● createHTMLDfnElement: function = createElement('dfn')
Defined in dom/document.ts:63
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLDirElement
● createHTMLDirElement: function = createElement('dir')
Defined in dom/document.ts:65
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLDivElement

● createHTMLDivElement: function = createElement('div')
Defined in dom/document.ts:66
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLDlElement
● createHTMLDlElement: function = createElement('dl')
Defined in dom/document.ts:67
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLDtElement

● createHTMLDtElement: function = createElement('dt')
Defined in dom/document.ts:68
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLEmElement
● createHTMLEmElement: function = createElement('em')
Defined in dom/document.ts:69
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLEmbedElement

● createHTMLEmbedElement: function = createElement('embed')
Defined in dom/document.ts:70
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLFieldsetElement
● createHTMLFieldsetElement: function = createElement('fieldset')
Defined in dom/document.ts:71
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLFigcaptionElement

● createHTMLFigcaptionElement: function = createElement('figcaption')
Defined in dom/document.ts:72
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLFigureElement
● createHTMLFigureElement: function = createElement('figure')
Defined in dom/document.ts:73
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLFontElement

● createHTMLFontElement: function = createElement('font')
Defined in dom/document.ts:74
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLFooterElement
● createHTMLFooterElement: function = createElement('footer')
Defined in dom/document.ts:75
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLFormElement

● createHTMLFormElement: function = createElement('form')
Defined in dom/document.ts:76
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLFrameElement
● createHTMLFrameElement: function = createElement('frame')
Defined in dom/document.ts:77
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLFramesetElement

● createHTMLFramesetElement: function = createElement('frameset')
Defined in dom/document.ts:78
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLH1Element
● createHTMLH1Element: function = createElement('h1')
Defined in dom/document.ts:79
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLH2Element

● createHTMLH2Element: function = createElement('h2')
Defined in dom/document.ts:80
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLH3Element
● createHTMLH3Element: function = createElement('h3')
Defined in dom/document.ts:81
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLH4Element

● createHTMLH4Element: function = createElement('h4')
Defined in dom/document.ts:82
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLH5Element
● createHTMLH5Element: function = createElement('h5')
Defined in dom/document.ts:83
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLH6Element

● createHTMLH6Element: function = createElement('h6')
Defined in dom/document.ts:84
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLHeadElement
● createHTMLHeadElement: function = createElement('head')
Defined in dom/document.ts:85
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLHeaderElement

● createHTMLHeaderElement: function = createElement('header')
Defined in dom/document.ts:86
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLHgroupElement
● createHTMLHgroupElement: function = createElement('hgroup')
Defined in dom/document.ts:87
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLHrElement

● createHTMLHrElement: function = createElement('hr')
Defined in dom/document.ts:88
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLHtmlElement
● createHTMLHtmlElement: function = createElement('html')
Defined in dom/document.ts:89
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLIElement

● createHTMLIElement: function = createElement('i')
Defined in dom/document.ts:90
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLIframeElement
● createHTMLIframeElement: function = createElement('iframe')
Defined in dom/document.ts:91
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLImgElement

● createHTMLImgElement: function = createElement('img')
Defined in dom/document.ts:92
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLInputElement
● createHTMLInputElement: function = createElement('input')
Defined in dom/document.ts:93
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLInsElement

● createHTMLInsElement: function = createElement('ins')
Defined in dom/document.ts:94
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLKbdElement
● createHTMLKbdElement: function = createElement('kbd')
Defined in dom/document.ts:96
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLLabelElement

● createHTMLLabelElement: function = createElement('label')
Defined in dom/document.ts:98
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLLegendElement
● createHTMLLegendElement: function = createElement('legend')
Defined in dom/document.ts:99
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLLiElement

● createHTMLLiElement: function = createElement('li')
Defined in dom/document.ts:100
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLLinkElement
● createHTMLLinkElement: function = createElement('link')
Defined in dom/document.ts:101
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLMapElement

● createHTMLMapElement: function = createElement('map')
Defined in dom/document.ts:103
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLMarkElement
● createHTMLMarkElement: function = createElement('mark')
Defined in dom/document.ts:104
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLMarkeeElement

● createHTMLMarkeeElement: function = createElement('marquee')
Defined in dom/document.ts:105
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLMenuElement
● createHTMLMenuElement: function = createElement('menu')
Defined in dom/document.ts:106
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLMetaElement

● createHTMLMetaElement: function = createElement('meta')
Defined in dom/document.ts:108
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLMeterElement
● createHTMLMeterElement: function = createElement('meter')
Defined in dom/document.ts:109
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLNavElement

● createHTMLNavElement: function = createElement('nav')
Defined in dom/document.ts:110
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLNoScriptElement
● createHTMLNoScriptElement: function = createElement('noscript')
Defined in dom/document.ts:112
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLObjectElement

● createHTMLObjectElement: function = createElement('object')
Defined in dom/document.ts:113
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLOlElement
● createHTMLOlElement: function = createElement('ol')
Defined in dom/document.ts:114
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLOptgroupElement

● createHTMLOptgroupElement: function = createElement('optgroup')
Defined in dom/document.ts:115
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLOptionElement
● createHTMLOptionElement: function = createElement('option')
Defined in dom/document.ts:116
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLOutputElement

● createHTMLOutputElement: function = createElement('output')
Defined in dom/document.ts:117
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLPElement
● createHTMLPElement: function = createElement('p')
Defined in dom/document.ts:118
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLParamElement

● createHTMLParamElement: function = createElement('param')
Defined in dom/document.ts:119
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLPictureElement
● createHTMLPictureElement: function = createElement('picture')
Defined in dom/document.ts:120
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLPreElement

● createHTMLPreElement: function = createElement('pre')
Defined in dom/document.ts:121
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLProgressElement
● createHTMLProgressElement: function = createElement('progress')
Defined in dom/document.ts:122
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLQElement

● createHTMLQElement: function = createElement('q')
Defined in dom/document.ts:123
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLRtElement
● createHTMLRtElement: function = createElement('rt')
Defined in dom/document.ts:125
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLRubyElement

● createHTMLRubyElement: function = createElement('ruby')
Defined in dom/document.ts:126
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLSElement
● createHTMLSElement: function = createElement('s')
Defined in dom/document.ts:127
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLSampElement

● createHTMLSampElement: function = createElement('samp')
Defined in dom/document.ts:128
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLScriptElement
● createHTMLScriptElement: function = createElement('script')
Defined in dom/document.ts:129
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLSectionElement

● createHTMLSectionElement: function = createElement('section')
Defined in dom/document.ts:130
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLSelectElement
● createHTMLSelectElement: function = createElement('select')
Defined in dom/document.ts:131
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLSmallElement

● createHTMLSmallElement: function = createElement('small')
Defined in dom/document.ts:132
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLSourceElement
● createHTMLSourceElement: function = createElement('source')
Defined in dom/document.ts:133
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLSpanElement

● createHTMLSpanElement: function = createElement('span')
Defined in dom/document.ts:134
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLStrongElement
● createHTMLStrongElement: function = createElement('strong')
Defined in dom/document.ts:136
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLStyleElement

● createHTMLStyleElement: function = createElement('style')
Defined in dom/document.ts:137
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLSubElement
● createHTMLSubElement: function = createElement('sub')
Defined in dom/document.ts:138
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLSupElement

● createHTMLSupElement: function = createElement('sup')
Defined in dom/document.ts:140
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLTableElement
● createHTMLTableElement: function = createElement('table')
Defined in dom/document.ts:141
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLTbodyElement

● createHTMLTbodyElement: function = createElement('tbody')
Defined in dom/document.ts:142
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

<Const> createHTMLTdElement
● createHTMLTdElement: function = createElement('td')
Defined in dom/document.ts:143
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Returns: HTMLElementTagNameMap[T]

`<Const>` createHTMLTemplateElement

● createHTMLTemplateElement: function = createElement('template')
Defined in dom/document.ts:144
Type declaration
▸(aDoc?: Document): HTMLElementTagNameMap[T]
Parameters:
| Name | Type | | ------ | ------ | | Optional aDoc | Document |
Return

@ibm-wch-sdk/web-components

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Readme

Details

Changes

Class documentation

Usage

Build

Webpack

Layouts

Pages

Layouts

Custom layouts

Components

Current

Added

Index

External modules

Index

Classes

Variables

Variables

<Const> ATTRLAYOUTMODE

Index

Classes

Index

Classes

Variables

Variables

<Const> ATTRID

<Const> ATTRLAYOUTMODE

<Const> ATTRLEVELS

<Const> KEYID

<Const> LOGGER

Index

Classes

Variables

Functions

Object literals

Variables

<Const> LOGGER

<Const> DEFAULTLAYOUT

<Const> PAGENOTFOUNDLAYOUT

Functions

getType

resolveLayout

Object literals

<Const> LAYOUTNOTFOUNDLAYOUT

template

templateType

<Const> PAGENOTFOUNDLAYOUT

template

templateType

Index

Index

Variables

Functions

Variables

<Const> LAYOUTSYMBOL

Functions

LayoutComponent

getSelectors

registerLayoutComponents

Index

Interfaces

Index

Variables

Functions

Variables

<Const> createHTMLAbbrElement

Type declaration

<Const> createHTMLAddressElement

Type declaration

<Const> createHTMLAnchorElement

Type declaration

<Const> createHTMLAppletElement

Type declaration

<Const> createHTMLAreaElement

Downloads in past

`<Const>` ATTRLAYOUTMODE

`<Const>` ATTRID

`<Const>` ATTRLAYOUTMODE

`<Const>` ATTRLEVELS

`<Const>` KEYID

`<Const>` LOGGER

`<Const>` LOGGER

`<Const>` DEFAULTLAYOUT

`<Const>` PAGENOTFOUNDLAYOUT

`<Const>` LAYOUTNOTFOUNDLAYOUT

`<Const>` PAGENOTFOUNDLAYOUT

`<Const>` LAYOUTSYMBOL

`<Const>` createHTMLAbbrElement

`<Const>` createHTMLAddressElement

`<Const>` createHTMLAnchorElement

`<Const>` createHTMLAppletElement

`<Const>` createHTMLAreaElement

`<Const>` createHTMLArticleElement

`<Const>` createHTMLAsideElement

`<Const>` createHTMLAudioElement

`<Const>` createHTMLBElement

`<Const>` createHTMLBaseElement

`<Const>` createHTMLBasefontElement

`<Const>` createHTMLBdoElement

`<Const>` createHTMLBlockquoteElement

`<Const>` createHTMLBodyElement

`<Const>` createHTMLBrElement

`<Const>` createHTMLButtonElement

`<Const>` createHTMLCanvasElement

`<Const>` createHTMLCaptionElement

`<Const>` createHTMLCiteElement

`<Const>` createHTMLCodeElement

`<Const>` createHTMLColElement

`<Const>` createHTMLColgroupElement

`<Const>` createHTMLDataElement

`<Const>` createHTMLDatalistElement

`<Const>` createHTMLDdElement

`<Const>` createHTMLDelElement

`<Const>` createHTMLDfnElement

`<Const>` createHTMLDirElement

`<Const>` createHTMLDivElement

`<Const>` createHTMLDlElement

`<Const>` createHTMLDtElement

`<Const>` createHTMLEmElement

`<Const>` createHTMLEmbedElement

`<Const>` createHTMLFieldsetElement

`<Const>` createHTMLFigcaptionElement

`<Const>` createHTMLFigureElement

`<Const>` createHTMLFontElement

`<Const>` createHTMLFooterElement

`<Const>` createHTMLFormElement

`<Const>` createHTMLFrameElement