Class: KssModifier

kss. KssModifier

new KssModifier(data)

An instance of this class is returned on calling KssSection.modifier. Exposes convenience methods for interpreting data.

Parameters:
Name Type Description
data Object

A part of the data object passed on by KssSection.

Source:

Methods

className() → {string}

Returns the class name of the modifier.

Source:
Returns:

The class name of the modifier.

Type
string

description() → {string}

Returns the description of the modifier.

Source:
Returns:

The description of the modifier.

Type
string

markup() → {string}

Returns the HTML markup used to render this modifier.

Source:
Returns:

The markup of the modifier.

Type
string

name() → {string}

Returns the name of the modifier, e.g. :hover, .primary, etc.

Source:
Returns:

The name of the modifier.

Type
string

section() → {KssSection}

Returns the KssSection object this modifier is associated with.

Source:
Returns:

The style guide section the modifier belongs to.

Type
KssSection