Class Themes

Themes to apply to displayed content

Param: rendition

Index

Constructors

Properties

_current _injected _overrides _themes rendition

Methods

add default destroy font fontSize inject override overrides register registerCss registerRules registerThemes registerUrl removeOverride select update

Constructors

constructor

new Themes(rendition: Rendition): Themes
Parameters
- rendition: Rendition
Returns Themes
- Defined in themes.ts:18

Properties

_current

_current: string | undefined

_injected

_injected: string[] | undefined

_overrides

_overrides: Record<string, { priority: boolean; value: string }> | undefined

_themes

_themes: Record<string, ThemeEntry> | undefined

rendition

rendition: Rendition | undefined

Methods

add

add(name: string, contents: Contents): void
Add Theme to contents
Parameters
- name: string
- contents: Contents
Returns void
- Defined in themes.ts:189

default

default(theme: string | Record<string, Record<string, string>>): void
Add a default theme to be used by a rendition
Parameters
- theme: string | Record<string, Record<string, string>>
Returns void
Example
```
themes.register("http://example.com/default.css")
```
Example
```
themes.register({ "body": { "color": "purple"}})
```
- Defined in themes.ts:65

destroy

destroy(): void
Returns void
- Defined in themes.ts:266

font

font(f: string): void
Adjust the font-family of a rendition
Parameters
- f: string
Returns void
- Defined in themes.ts:262

fontSize

fontSize(size: string): void
Adjust the font size of a rendition
Parameters
- size: string
Returns void
- Defined in themes.ts:254

inject

inject(contents: Contents): void
Inject all themes into contents
Parameters
- contents: Contents
Returns void
- Defined in themes.ts:164

override

override(name: string, value: string, priority?: boolean): void
Add override
Parameters
- name: string
- value: string
- Optionalpriority: boolean
Returns void
- Defined in themes.ts:213

overrides

overrides(contents: Contents): void
Add all overrides
Parameters
- contents: Contents
  contents to apply overrides to
Returns void
- Defined in themes.ts:240

register

register(
    ...args: (
        | string
        | Record<string, string | Record<string, Record<string, string>>>
    )[],
): void
Add themes to be used by a rendition
Parameters
- ...args: (string | Record<string, string | Record<string, Record<string, string>>>)[]
Returns void
Example
```
themes.register("light", "http://example.com/light.css")
```
Example
```
themes.register("light", { "body": { "color": "purple"}})
```
Example
```
themes.register({ "light" : {...}, "dark" : {...}})
```
- Defined in themes.ts:41

registerCss

registerCss(name: string, css: string): void
Register a theme by passing its css as string
Parameters
- name: string
- css: string
Returns void
- Defined in themes.ts:99

registerRules

registerRules(name: string, rules: Record<string, Record<string, string>>): void
Register rule
Parameters
- name: string
- rules: Record<string, Record<string, string>>
Returns void
- Defined in themes.ts:124

registerThemes

registerThemes(
themes: Record<string, string | Record<string, Record<string, string>>>,
): void
Register themes object
Parameters
- themes: Record<string, string | Record<string, Record<string, string>>>
Returns void
- Defined in themes.ts:81

registerUrl

registerUrl(name: string, input: string): void
Register a url
Parameters
- name: string
- input: string
Returns void
- Defined in themes.ts:111

removeOverride

removeOverride(name: string): void
Parameters
- name: string
Returns void
- Defined in themes.ts:226

select

select(name: string): void
Select a theme
Parameters
- name: string
Returns void
- Defined in themes.ts:136

update

update(name: string): void
Update a theme
Parameters
- name: string
Returns void
- Defined in themes.ts:153