1.0.56 • Published 6 years ago

lib-wch-ng-bootstrap v1.0.56

Weekly downloads
3
License
Apache-2.0
Repository
github
Last release
6 years ago

lib-wch-ng-bootstrap

Implementation of the Creative design for WCH.

Changes

CHANGELOG

Usage

This library is meant to be used in an Angular based application.

Add the library to your Application

  • add lib-wch-ng-bootstrap to the dependencies of your project
npm install --save lib-wch-ng-bootstrap
npm install --save-dev @types/scrollreveal
  • import WchNgBootstrapComponentsModule into your main application, e.g. like this:

src/app/app.module.ts

import { LAYOUTS } from './layouts';
import { WchNgModule } from 'ibm-wch-sdk-ng';
import { environment } from '../environments/environment';
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppRoutingModule } from './app-routing.module';

import { AppComponent } from './app.component';

// modification start
import { WchNgEditModule } from 'ibm-wch-sdk-ng-edit';
import { NgsRevealModule } from 'ng-scrollreveal';
import { WchNgBootstrapComponentsModule } from 'lib-wch-ng-bootstrap';
// modification end

@NgModule({
  declarations: [
    AppComponent,
    ...LAYOUTS],
  imports: [
    BrowserModule,
    AppRoutingModule,

    // modification start
    WchNgBootstrapComponentsModule,
    NgsRevealModule.forRoot(),
    WchNgEditModule.forRoot(),
    // modification end

    WchNgModule.forRoot(environment)],
  providers: [],
  entryComponents: [...LAYOUTS],
bootstrap: [AppComponent]
})
export class AppModule { }

This process provides all layouts to the single page application.

Note We are working on making it simpler to add the module to the application, stay tuned.

Deploy the application and WCH artifacts

The library bundles the WCH content types, layouts and layout mappings. Deploy these artifacts to WCH, e.g. by using the following command of the CLI:

ibm-wch-sdk-cli application push --data ./data/ --override --aggregated

The --aggregated flag makes sure to not only deploy the application data but also the bundled dependencies.

Note: In order to successfully execute the command make sure to meet me prerequisites mentioned in the documentation of the CLI.

Class documentation

Refer to the documentation.

Changelog

Current

Fixed

  • Adding missing images to types
  • Removing built test application from package

Added

  • Initial Version

lib-wch-ng-bootstrap

Index

External modules


lib-wch-ng-bootstrap > "app-routing.module"

External module: "app-routing.module"

Index

Classes

Variables


Variables

«Const» routes

● routes: Routes = { path: '', redirectTo: '/home/', pathMatch: 'full' }, { path: '**', component: PageComponent }

Defined in app-routing.module.ts:5


lib-wch-ng-bootstrap > "components/creative-advantage/abstractCreativeAdvantageComponent"

External module: "components/creative-advantage/abstractCreativeAdvantageComponent"

Index

Classes

Functions


Functions

assertCreativeAdvantageRenderingContext

assertCreativeAdvantageRenderingContext(aContext: RenderingContext): CreativeAdvantageRenderingContext

Defined in components/creative-advantage/abstractCreativeAdvantageComponent.ts:40

Provides a type assertion that can be used to validate and convert a generic {@link RenderingContext} info a example: this.onRenderingContext.map(assertCreativeAdvantageRenderingContext);

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the rendering context to check

Returns: CreativeAdvantageRenderingContext the {@link CreativeAdvantageRenderingContext } version of the {@link RenderingContext} or an exception


isCreativeAdvantageRenderingContext

isCreativeAdvantageRenderingContext(aContext: RenderingContext): boolean

Defined in components/creative-advantage/abstractCreativeAdvantageComponent.ts:22

Validates that the context is indeed of the desired type

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the {@link RenderingContext} to check

Returns: boolean true if the context is a {@link CreativeAdvantageRenderingContext } else false


lib-wch-ng-bootstrap > "components/creative-advantage/creativeAdvantageRenderingContext"

External module: "components/creative-advantage/creativeAdvantageRenderingContext"

Index

Interfaces

Variables


Variables

«Const» KEY_DESCRIPTION

● KEY_DESCRIPTION: "description" = "description"

Defined in components/creative-advantage/creativeAdvantageRenderingContext.ts:11


«Const» KEY_FA_ICON

● KEY_FA_ICON: "faIcon" = "faIcon"

Defined in components/creative-advantage/creativeAdvantageRenderingContext.ts:9


«Const» KEY_TITLE

● KEY_TITLE: "title" = "title"

Defined in components/creative-advantage/creativeAdvantageRenderingContext.ts:10


lib-wch-ng-bootstrap > "components/creative-advantage/typeCreativeAdvantageComponent"

External module: "components/creative-advantage/typeCreativeAdvantageComponent"

Index

Classes


lib-wch-ng-bootstrap > "components/creative-advantages-section/abstractCreativeAdvantagesSectionComponent"

External module: "components/creative-advantages-section/abstractCreativeAdvantagesSectionComponent"

Index

Classes

Functions


Functions

assertCreativeAdvantagesSectionRenderingContext

assertCreativeAdvantagesSectionRenderingContext(aContext: RenderingContext): CreativeAdvantagesSectionRenderingContext

Defined in components/creative-advantages-section/abstractCreativeAdvantagesSectionComponent.ts:41

Provides a type assertion that can be used to validate and convert a generic {@link RenderingContext} info a example: this.onRenderingContext.map(assertCreativeAdvantagesSectionRenderingContext);

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the rendering context to check

Returns: CreativeAdvantagesSectionRenderingContext the {@link CreativeAdvantagesSectionRenderingContext } version of the {@link RenderingContext} or an exception


isCreativeAdvantagesSectionRenderingContext

isCreativeAdvantagesSectionRenderingContext(aContext: RenderingContext): boolean

Defined in components/creative-advantages-section/abstractCreativeAdvantagesSectionComponent.ts:23

Validates that the context is indeed of the desired type

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the {@link RenderingContext} to check

Returns: boolean true if the context is a {@link CreativeAdvantagesSectionRenderingContext } else false


lib-wch-ng-bootstrap > "components/creative-advantages-section/creativeAdvantagesSectionRenderingContext"

External module: "components/creative-advantages-section/creativeAdvantagesSectionRenderingContext"

Index

Interfaces

Variables


Variables

«Const» KEY_ADVANTAGES

● KEY_ADVANTAGES: "advantages" = "advantages"

Defined in components/creative-advantages-section/creativeAdvantagesSectionRenderingContext.ts:12


«Const» KEY_SECTION_NAME

● KEY_SECTION_NAME: "sectionName" = "sectionName"

Defined in components/creative-advantages-section/creativeAdvantagesSectionRenderingContext.ts:10


«Const» KEY_TITLE

● KEY_TITLE: "title" = "title"

Defined in components/creative-advantages-section/creativeAdvantagesSectionRenderingContext.ts:11


lib-wch-ng-bootstrap > "components/creative-advantages-section/typeCreativeAdvantagesSectionComponent"

External module: "components/creative-advantages-section/typeCreativeAdvantagesSectionComponent"

Index

Classes


lib-wch-ng-bootstrap > "components/creative-bootstrap-micro-site-type/abstractCreativeBootstrapMicroSiteTypeComponent"

External module: "components/creative-bootstrap-micro-site-type/abstractCreativeBootstrapMicroSiteTypeComponent"

Index

Classes

Functions


Functions

assertCreativeBootstrapMicroSiteTypeRenderingContext

assertCreativeBootstrapMicroSiteTypeRenderingContext(aContext: RenderingContext): CreativeBootstrapMicroSiteTypeRenderingContext

Defined in components/creative-bootstrap-micro-site-type/abstractCreativeBootstrapMicroSiteTypeComponent.ts:39

Provides a type assertion that can be used to validate and convert a generic {@link RenderingContext} info a example: this.onRenderingContext.map(assertCreativeBootstrapMicroSiteTypeRenderingContext);

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the rendering context to check

Returns: CreativeBootstrapMicroSiteTypeRenderingContext the {@link CreativeBootstrapMicroSiteTypeRenderingContext } version of the {@link RenderingContext} or an exception


isCreativeBootstrapMicroSiteTypeRenderingContext

isCreativeBootstrapMicroSiteTypeRenderingContext(aContext: RenderingContext): boolean

Defined in components/creative-bootstrap-micro-site-type/abstractCreativeBootstrapMicroSiteTypeComponent.ts:22

Validates that the context is indeed of the desired type

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the {@link RenderingContext} to check

Returns: boolean true if the context is a {@link CreativeBootstrapMicroSiteTypeRenderingContext } else false


lib-wch-ng-bootstrap > "components/creative-bootstrap-micro-site-type/creativeBootstrapMicroSiteTypeRenderingContext"

External module: "components/creative-bootstrap-micro-site-type/creativeBootstrapMicroSiteTypeRenderingContext"

Index

Interfaces

Variables


Variables

«Const» KEY_SECTIONS

● KEY_SECTIONS: "sections" = "sections"

Defined in components/creative-bootstrap-micro-site-type/creativeBootstrapMicroSiteTypeRenderingContext.ts:10


«Const» KEY_THEME

● KEY_THEME: "theme" = "theme"

Defined in components/creative-bootstrap-micro-site-type/creativeBootstrapMicroSiteTypeRenderingContext.ts:11


lib-wch-ng-bootstrap > "components/creative-bootstrap-micro-site-type/typeCreativeBootstrapMicroSiteTypeComponent"

External module: "components/creative-bootstrap-micro-site-type/typeCreativeBootstrapMicroSiteTypeComponent"

Index

Classes

Functions


Functions

_createStyle

_createStyle(aStyles: object): string

Defined in components/creative-bootstrap-micro-site-type/typeCreativeBootstrapMicroSiteTypeComponent.ts:20

Parameters:

ParamTypeDescription
aStylesobject-

Returns: string


lib-wch-ng-bootstrap > "components/creative-contact-info/abstractCreativeContactInfoComponent"

External module: "components/creative-contact-info/abstractCreativeContactInfoComponent"

Index

Classes

Functions


Functions

assertCreativeContactInfoRenderingContext

assertCreativeContactInfoRenderingContext(aContext: RenderingContext): CreativeContactInfoRenderingContext

Defined in components/creative-contact-info/abstractCreativeContactInfoComponent.ts:39

Provides a type assertion that can be used to validate and convert a generic {@link RenderingContext} info a example: this.onRenderingContext.map(assertCreativeContactInfoRenderingContext);

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the rendering context to check

Returns: CreativeContactInfoRenderingContext the {@link CreativeContactInfoRenderingContext } version of the {@link RenderingContext} or an exception


isCreativeContactInfoRenderingContext

isCreativeContactInfoRenderingContext(aContext: RenderingContext): boolean

Defined in components/creative-contact-info/abstractCreativeContactInfoComponent.ts:22

Validates that the context is indeed of the desired type

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the {@link RenderingContext} to check

Returns: boolean true if the context is a {@link CreativeContactInfoRenderingContext } else false


lib-wch-ng-bootstrap > "components/creative-contact-info/creativeContactInfoRenderingContext"

External module: "components/creative-contact-info/creativeContactInfoRenderingContext"

Index

Interfaces

Variables


Variables

«Const» KEY_CONTACT

● KEY_CONTACT: "contact" = "contact"

Defined in components/creative-contact-info/creativeContactInfoRenderingContext.ts:10


«Const» KEY_FA_ICON

● KEY_FA_ICON: "faIcon" = "faIcon"

Defined in components/creative-contact-info/creativeContactInfoRenderingContext.ts:9


lib-wch-ng-bootstrap > "components/creative-contact-info/typeCreativeContactInfoComponent"

External module: "components/creative-contact-info/typeCreativeContactInfoComponent"

Index

Classes


lib-wch-ng-bootstrap > "components/creative-contact-section/abstractCreativeContactSectionComponent"

External module: "components/creative-contact-section/abstractCreativeContactSectionComponent"

Index

Classes

Functions


Functions

assertCreativeContactSectionRenderingContext

assertCreativeContactSectionRenderingContext(aContext: RenderingContext): CreativeContactSectionRenderingContext

Defined in components/creative-contact-section/abstractCreativeContactSectionComponent.ts:42

Provides a type assertion that can be used to validate and convert a generic {@link RenderingContext} info a example: this.onRenderingContext.map(assertCreativeContactSectionRenderingContext);

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the rendering context to check

Returns: CreativeContactSectionRenderingContext the {@link CreativeContactSectionRenderingContext } version of the {@link RenderingContext} or an exception


isCreativeContactSectionRenderingContext

isCreativeContactSectionRenderingContext(aContext: RenderingContext): boolean

Defined in components/creative-contact-section/abstractCreativeContactSectionComponent.ts:23

Validates that the context is indeed of the desired type

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the {@link RenderingContext} to check

Returns: boolean true if the context is a {@link CreativeContactSectionRenderingContext } else false


lib-wch-ng-bootstrap > "components/creative-contact-section/creativeContactSectionRenderingContext"

External module: "components/creative-contact-section/creativeContactSectionRenderingContext"

Index

Interfaces

Variables


Variables

«Const» KEY_CONTACT

● KEY_CONTACT: "contact" = "contact"

Defined in components/creative-contact-section/creativeContactSectionRenderingContext.ts:13


«Const» KEY_PARAGRAPH

● KEY_PARAGRAPH: "paragraph" = "paragraph"

Defined in components/creative-contact-section/creativeContactSectionRenderingContext.ts:12


«Const» KEY_SECTION_NAME

● KEY_SECTION_NAME: "sectionName" = "sectionName"

Defined in components/creative-contact-section/creativeContactSectionRenderingContext.ts:10


«Const» KEY_TITLE

● KEY_TITLE: "title" = "title"

Defined in components/creative-contact-section/creativeContactSectionRenderingContext.ts:11


lib-wch-ng-bootstrap > "components/creative-contact-section/typeCreativeContactSectionComponent"

External module: "components/creative-contact-section/typeCreativeContactSectionComponent"

Index

Classes


lib-wch-ng-bootstrap > "components/creative-external-reference-button/abstractCreativeExternalReferenceButtonComponent"

External module: "components/creative-external-reference-button/abstractCreativeExternalReferenceButtonComponent"

Index

Classes

Functions


Functions

assertCreativeExternalReferenceButtonRenderingContext

assertCreativeExternalReferenceButtonRenderingContext(aContext: RenderingContext): CreativeExternalReferenceButtonRenderingContext

Defined in components/creative-external-reference-button/abstractCreativeExternalReferenceButtonComponent.ts:39

Provides a type assertion that can be used to validate and convert a generic {@link RenderingContext} info a example: this.onRenderingContext.map(assertCreativeExternalReferenceButtonRenderingContext);

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the rendering context to check

Returns: CreativeExternalReferenceButtonRenderingContext the {@link CreativeExternalReferenceButtonRenderingContext } version of the {@link RenderingContext} or an exception


isCreativeExternalReferenceButtonRenderingContext

isCreativeExternalReferenceButtonRenderingContext(aContext: RenderingContext): boolean

Defined in components/creative-external-reference-button/abstractCreativeExternalReferenceButtonComponent.ts:23

Validates that the context is indeed of the desired type

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the {@link RenderingContext} to check

Returns: boolean true if the context is a {@link CreativeExternalReferenceButtonRenderingContext } else false


lib-wch-ng-bootstrap > "components/creative-external-reference-button/creativeExternalReferenceButtonRenderingContext"

External module: "components/creative-external-reference-button/creativeExternalReferenceButtonRenderingContext"

Index

Interfaces

Variables


Variables

«Const» KEY_LINK

● KEY_LINK: "link" = "link"

Defined in components/creative-external-reference-button/creativeExternalReferenceButtonRenderingContext.ts:9


lib-wch-ng-bootstrap > "components/creative-external-reference-button/typeCreativeExternalReferenceButtonComponent"

External module: "components/creative-external-reference-button/typeCreativeExternalReferenceButtonComponent"

Index

Classes


lib-wch-ng-bootstrap > "components/creative-headline-section/abstractCreativeHeadlineSectionComponent"

External module: "components/creative-headline-section/abstractCreativeHeadlineSectionComponent"

Index

Classes

Functions


Functions

assertCreativeHeadlineSectionRenderingContext

assertCreativeHeadlineSectionRenderingContext(aContext: RenderingContext): CreativeHeadlineSectionRenderingContext

Defined in components/creative-headline-section/abstractCreativeHeadlineSectionComponent.ts:45

Provides a type assertion that can be used to validate and convert a generic {@link RenderingContext} info a example: this.onRenderingContext.map(assertCreativeHeadlineSectionRenderingContext);

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the rendering context to check

Returns: CreativeHeadlineSectionRenderingContext the {@link CreativeHeadlineSectionRenderingContext } version of the {@link RenderingContext} or an exception


isCreativeHeadlineSectionRenderingContext

isCreativeHeadlineSectionRenderingContext(aContext: RenderingContext): boolean

Defined in components/creative-headline-section/abstractCreativeHeadlineSectionComponent.ts:25

Validates that the context is indeed of the desired type

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the {@link RenderingContext} to check

Returns: boolean true if the context is a {@link CreativeHeadlineSectionRenderingContext } else false


lib-wch-ng-bootstrap > "components/creative-headline-section/creativeHeadlineSectionRenderingContext"

External module: "components/creative-headline-section/creativeHeadlineSectionRenderingContext"

Index

Interfaces

Variables


Variables

«Const» KEY_ACTION_BTN

● KEY_ACTION_BTN: "actionBtn" = "actionBtn"

Defined in components/creative-headline-section/creativeHeadlineSectionRenderingContext.ts:14


«Const» KEY_BG_IMAGE

● KEY_BG_IMAGE: "bgImage" = "bgImage"

Defined in components/creative-headline-section/creativeHeadlineSectionRenderingContext.ts:15


«Const» KEY_HEADLINE

● KEY_HEADLINE: "headline" = "headline"

Defined in components/creative-headline-section/creativeHeadlineSectionRenderingContext.ts:12


«Const» KEY_PARAGRAPH

● KEY_PARAGRAPH: "paragraph" = "paragraph"

Defined in components/creative-headline-section/creativeHeadlineSectionRenderingContext.ts:13


«Const» KEY_SECTION_NAME

● KEY_SECTION_NAME: "sectionName" = "sectionName"

Defined in components/creative-headline-section/creativeHeadlineSectionRenderingContext.ts:11


lib-wch-ng-bootstrap > "components/creative-headline-section/typeCreativeHeadlineSectionComponent"

External module: "components/creative-headline-section/typeCreativeHeadlineSectionComponent"

Index

Classes


lib-wch-ng-bootstrap > "components/creative-image-linkout/abstractCreativeImageLinkoutComponent"

External module: "components/creative-image-linkout/abstractCreativeImageLinkoutComponent"

Index

Classes

Functions


Functions

assertCreativeImageLinkoutRenderingContext

assertCreativeImageLinkoutRenderingContext(aContext: RenderingContext): CreativeImageLinkoutRenderingContext

Defined in components/creative-image-linkout/abstractCreativeImageLinkoutComponent.ts:46

Provides a type assertion that can be used to validate and convert a generic {@link RenderingContext} info a example: this.onRenderingContext.map(assertCreativeImageLinkoutRenderingContext);

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the rendering context to check

Returns: CreativeImageLinkoutRenderingContext the {@link CreativeImageLinkoutRenderingContext } version of the {@link RenderingContext} or an exception


isCreativeImageLinkoutRenderingContext

isCreativeImageLinkoutRenderingContext(aContext: RenderingContext): boolean

Defined in components/creative-image-linkout/abstractCreativeImageLinkoutComponent.ts:27

Validates that the context is indeed of the desired type

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the {@link RenderingContext} to check

Returns: boolean true if the context is a {@link CreativeImageLinkoutRenderingContext } else false


lib-wch-ng-bootstrap > "components/creative-image-linkout/creativeImageLinkoutRenderingContext"

External module: "components/creative-image-linkout/creativeImageLinkoutRenderingContext"

Index

Interfaces

Variables


Variables

«Const» KEY_BG_IMAGE

● KEY_BG_IMAGE: "bgImage" = "bgImage"

Defined in components/creative-image-linkout/creativeImageLinkoutRenderingContext.ts:12


«Const» KEY_CATEGORY

● KEY_CATEGORY: "category" = "category"

Defined in components/creative-image-linkout/creativeImageLinkoutRenderingContext.ts:14


«Const» KEY_LINK

● KEY_LINK: "link" = "link"

Defined in components/creative-image-linkout/creativeImageLinkoutRenderingContext.ts:15


«Const» KEY_TITLE

● KEY_TITLE: "title" = "title"

Defined in components/creative-image-linkout/creativeImageLinkoutRenderingContext.ts:13


lib-wch-ng-bootstrap > "components/creative-image-linkout/typeCreativeImageLinkoutComponent"

External module: "components/creative-image-linkout/typeCreativeImageLinkoutComponent"

Index

Classes


lib-wch-ng-bootstrap > "components/creative-linkout-section/abstractCreativeLinkoutSectionComponent"

External module: "components/creative-linkout-section/abstractCreativeLinkoutSectionComponent"

Index

Classes

Functions


Functions

assertCreativeLinkoutSectionRenderingContext

assertCreativeLinkoutSectionRenderingContext(aContext: RenderingContext): CreativeLinkoutSectionRenderingContext

Defined in components/creative-linkout-section/abstractCreativeLinkoutSectionComponent.ts:42

Provides a type assertion that can be used to validate and convert a generic {@link RenderingContext} info a example: this.onRenderingContext.map(assertCreativeLinkoutSectionRenderingContext);

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the rendering context to check

Returns: CreativeLinkoutSectionRenderingContext the {@link CreativeLinkoutSectionRenderingContext } version of the {@link RenderingContext} or an exception


isCreativeLinkoutSectionRenderingContext

isCreativeLinkoutSectionRenderingContext(aContext: RenderingContext): boolean

Defined in components/creative-linkout-section/abstractCreativeLinkoutSectionComponent.ts:23

Validates that the context is indeed of the desired type

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the {@link RenderingContext} to check

Returns: boolean true if the context is a {@link CreativeLinkoutSectionRenderingContext } else false


lib-wch-ng-bootstrap > "components/creative-linkout-section/creativeLinkoutSectionRenderingContext"

External module: "components/creative-linkout-section/creativeLinkoutSectionRenderingContext"

Index

Interfaces

Variables


Variables

«Const» KEY_ACTION_BTN

● KEY_ACTION_BTN: "actionBtn" = "actionBtn"

Defined in components/creative-linkout-section/creativeLinkoutSectionRenderingContext.ts:13


«Const» KEY_LINKOUTS

● KEY_LINKOUTS: "linkouts" = "linkouts"

Defined in components/creative-linkout-section/creativeLinkoutSectionRenderingContext.ts:14


«Const» KEY_SECTION_NAME

● KEY_SECTION_NAME: "sectionName" = "sectionName"

Defined in components/creative-linkout-section/creativeLinkoutSectionRenderingContext.ts:11


«Const» KEY_TITLE

● KEY_TITLE: "title" = "title"

Defined in components/creative-linkout-section/creativeLinkoutSectionRenderingContext.ts:12


lib-wch-ng-bootstrap > "components/creative-linkout-section/typeCreativeLinkoutSectionComponent"

External module: "components/creative-linkout-section/typeCreativeLinkoutSectionComponent"

Index

Classes


lib-wch-ng-bootstrap > "components/creative-section-reference-button/abstractCreativeSectionReferenceButtonComponent"

External module: "components/creative-section-reference-button/abstractCreativeSectionReferenceButtonComponent"

Index

Classes

Functions


Functions

assertCreativeSectionReferenceButtonRenderingContext

assertCreativeSectionReferenceButtonRenderingContext(aContext: RenderingContext): CreativeSectionReferenceButtonRenderingContext

Defined in components/creative-section-reference-button/abstractCreativeSectionReferenceButtonComponent.ts:41

Provides a type assertion that can be used to validate and convert a generic {@link RenderingContext} info a example: this.onRenderingContext.map(assertCreativeSectionReferenceButtonRenderingContext);

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the rendering context to check

Returns: CreativeSectionReferenceButtonRenderingContext the {@link CreativeSectionReferenceButtonRenderingContext } version of the {@link RenderingContext} or an exception


isCreativeSectionReferenceButtonRenderingContext

isCreativeSectionReferenceButtonRenderingContext(aContext: RenderingContext): boolean

Defined in components/creative-section-reference-button/abstractCreativeSectionReferenceButtonComponent.ts:23

Validates that the context is indeed of the desired type

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the {@link RenderingContext} to check

Returns: boolean true if the context is a {@link CreativeSectionReferenceButtonRenderingContext } else false


lib-wch-ng-bootstrap > "components/creative-section-reference-button/creativeSectionReferenceButtonRenderingContext"

External module: "components/creative-section-reference-button/creativeSectionReferenceButtonRenderingContext"

Index

Interfaces

Variables


Variables

«Const» KEY_ALT_TEXT

● KEY_ALT_TEXT: "altText" = "altText"

Defined in components/creative-section-reference-button/creativeSectionReferenceButtonRenderingContext.ts:11


«Const» KEY_SECTION

● KEY_SECTION: "section" = "section"

Defined in components/creative-section-reference-button/creativeSectionReferenceButtonRenderingContext.ts:12


«Const» KEY_TITILE

● KEY_TITILE: "titile" = "titile"

Defined in components/creative-section-reference-button/creativeSectionReferenceButtonRenderingContext.ts:10


lib-wch-ng-bootstrap > "components/creative-section-reference-button/typeCreativeSectionReferenceButtonComponent"

External module: "components/creative-section-reference-button/typeCreativeSectionReferenceButtonComponent"

Index

Classes


lib-wch-ng-bootstrap > "components/creative-theme/abstractCreativeThemeComponent"

External module: "components/creative-theme/abstractCreativeThemeComponent"

Index

Classes

Functions


Functions

assertCreativeThemeRenderingContext

assertCreativeThemeRenderingContext(aContext: RenderingContext): CreativeThemeRenderingContext

Defined in components/creative-theme/abstractCreativeThemeComponent.ts:40

Provides a type assertion that can be used to validate and convert a generic {@link RenderingContext} info a example: this.onRenderingContext.map(assertCreativeThemeRenderingContext);

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the rendering context to check

Returns: CreativeThemeRenderingContext the {@link CreativeThemeRenderingContext } version of the {@link RenderingContext} or an exception


isCreativeThemeRenderingContext

isCreativeThemeRenderingContext(aContext: RenderingContext): boolean

Defined in components/creative-theme/abstractCreativeThemeComponent.ts:22

Validates that the context is indeed of the desired type

Parameters:

ParamTypeDescription
aContextRenderingContextinstance of the {@link RenderingContext} to check

Returns: boolean true if the context is a {@link CreativeThemeRenderingContext } else false


lib-wch-ng-bootstrap > "components/creative-theme/creativeThemeRenderingContext"

External module: "components/creative-theme/creativeThemeRenderingContext"

Index

Interfaces

Variables