Ibm-wch-sdk-theme NPM

ibm-wch-sdk-theme

Module that implements utility functions to deal with theme like UI configuration in WCH for single page applications.

Details

Refer to the documentation.

Changes

CHANGELOG

Class documentation

Refer to the documentation.

Usage

Install the module via

npm install --save ibm-wch-sdk-theme

Theme Module

This module provides utility classes to compute UI customization based on content items.

Usecase

Allow a business user to customize the color scheme of a single page application by making modifications to a content item using the WCH admin UI. Without having to touch the source code of the deployed application.

Usage

The colors sub module exposes functions to compute color variations based on a (configured) base color. This can be used to automatically build a color palette.
The theme sub module computes CSS styles and CSS variables based on a RenderingContext.

Changelog

Current

Added

Initial version

ibm-wch-sdk-theme

Index

Colors

A theme color palette typically consists of a set of base colors (such as primary or secondary) and derivations of these colors. Business users only want to customize the base colors, the variations can be computed.

Functions

the colorVariations method computes color variations for a base color by computing a set of darker and lighter colors. The result is provided as a mapping from CSS variable to color value.

Naming Scheme

The CSS variables are named using the following pattern: --${basename}-${method}-${level} where:

basename: logical name of the color in the scheme
method: variation, e.g. darken or lighten
level: percent value of the application of the method. A value darken-5 e.g. means that the base color has been darkened by 5%.

Theme Utilities

The utilities compute a full set of styles based on a RenderingContext.

Usage

Exposed functions:

`stylesFromRenderingContext': accepts a rendering context and returns a set of derived styles. ibm-wch-sdk-theme > "colors/colors"

External module: "colors/colors"

Index

Type aliases

ColorParser

Ƭ ColorParser: UnaryFunction<string, RGBA>

Defined in colors/colors.ts:20

Variables

`<Const>` colorToHSLA

● colorToHSLA: UnaryFunction<RGBA, HSLA> = rgbaToHsla

Defined in colors/colors.ts:136

`<Const>` colorToRGBA

● colorToRGBA: UnaryFunction<RGBA, RGBA> = identity

Defined in colors/colors.ts:135

Functions

`<Const>` colorParser

▸ colorParser(aDoc: Document): function

Defined in colors/colors.ts:72

Constructs a function that parses a color value using the DOM APIs

Parameters:

Param	Type	Description
aDoc	`Document`	the document

Returns: function the parser function

`<Const>` colorValue

▸ colorValue(aKey: string, aColor: RGBA): Styles

Defined in colors/colors.ts:60

Parameters:

Param	Type
aKey	`string`
aColor	RGBA

Returns: Styles

`<Const>` colorVariations

▸ colorVariations(aKey: string, aColor: RGBA): Styles

Defined in colors/colors.ts:129

Parameters:

Param	Type
aKey	`string`
aColor	RGBA

Returns: Styles

`<Const>` decomposeColor

▸ decomposeColor(aKey: string, aColor: RGBA): Styles

Defined in colors/colors.ts:111

Decompose the color string into color components

Parameters:

Param	Type	Description
aKey	`string`	the name of the color
aColor	RGBA	the actual color value

Returns: Styles the styles

`<Const>` noParser

▸ noParser(color: string): RGBA

Defined in colors/colors.ts:64

Parameters:

Param	Type
color	`string`

Returns: RGBA

rgbaToHsla

▸ rgbaToHsla(rgb: RGBA): HSLA

Defined in colors/colors.ts:33

Converts an RGB color value to HSL. Conversion formula adapted from http://en.wikipedia.org/wiki/HSL_color_space. Assumes r, g, and b are contained in the set [0, 255] and returns h, s, and l in the set [0, 1].

Parameters:

Param	Type
rgb	RGBA

Returns: HSLA Array The HSL representation

rgbaToString

▸ rgbaToString(rgb: RGBA): string

Defined in colors/colors.ts:55

Parameters:

Param	Type
rgb	RGBA

Returns: string