JSDoc: o-typography

new Typography(typographyEl, opts)

Class constructor.

Methods

• getOptions(typographyEl) - (static) Get the data attributes from the typographyEl. If typography is being set up declaratively, this method is used to extract the data attributes from the DOM.
• checkOptions(opts) - (static) Check the options passed in are valid, otherwise set defaults
• init(rootElement, options) - (static) Initialise o-typography.

Links

• "Typography" class on Github

Typography.getOptions(typographyEl)

Static Method

Get the data attributes from the typographyEl. If typography is being set up declaratively, this method is used to extract the data attributes from the DOM.

Returns

• Object.<string, any> - An option dictionary

Links

• "getOptions" function on Github

Typography.checkOptions(opts)

Static Method

Check the options passed in are valid, otherwise set defaults

Returns

• object - opts

Links

• "checkOptions" function on Github

Typography.init(rootElement, options)

Static Method

Initialise o-typography.

Returns

• Typography - The Typography instance

Links

• "init" function on Github