Class Appearence

The Appearence class manages the theme of anything that can have an appearence.

The theme will persist to a storage of your choice, by default it will be stored in memory.
The default theme is system, which means that the theme will be dark or light depending on the system theme.

Aracna Reference

Hierarchy (View Summary)

EventEmitter<AppearenceEvents>
- Appearence

Index

Constructors

constructor

new Appearence(init?: AppearenceInit): Appearence
Parameters
- Optionalinit: AppearenceInit
Returns Appearence
Overrides EventEmitter.constructor
- Defined in src/classes/appearence.ts:32

Properties

`Protected`listeners

listeners: EventEmitterListener<AppearenceEvents, keyof AppearenceEvents>[]

`Protected`maxListeners

maxListeners: number

storage

storage: Storage

The storage that will be used to store the theme.

storageKey

storageKey: string

The key that will be used to store the theme.

theme

theme: Theme

The theme, can be dark, light or system.

Accessors

isThemeDark

get isThemeDark(): boolean
Checks if the theme is dark.

Returns boolean
- Defined in src/classes/appearence.ts:141

isThemeLight

get isThemeLight(): boolean
Checks if the theme is light.

Returns boolean
- Defined in src/classes/appearence.ts:155

isThemeSystem

get isThemeSystem(): boolean
Checks if the theme is system.

Returns boolean
- Defined in src/classes/appearence.ts:169

themeByPrefersColorScheme

get themeByPrefersColorScheme(): Theme
Returns the theme depending on the system theme.

Returns Theme
- Defined in src/classes/appearence.ts:124

Methods

countListeners

countListeners<K extends keyof AppearenceEvents>(
    name?: K,
    callback?: AppearenceEvents[K],
    options?: EventEmitterListenerOptions,
): number
Counts the listeners that match the name, callback and options. If no arguments are passed, all listeners will be counted.
Type Parameters
- K extends keyof AppearenceEvents
Parameters
- Optionalname: K
- Optionalcallback: AppearenceEvents[K]
- Optionaloptions: EventEmitterListenerOptions
Returns number
Inherited from EventEmitter.countListeners
- Defined in src/classes/event-emitter.ts:27

emit

emit<K extends keyof AppearenceEvents>(
name: K,
...args: Parameters<AppearenceEvents[K]>,
): boolean
Emits an event.
Type Parameters
- K extends keyof AppearenceEvents
Parameters
- name: K
- ...args: Parameters<AppearenceEvents[K]>
Returns boolean
Inherited from EventEmitter.emit
- Defined in src/classes/event-emitter.ts:34

getEventNames

getEventNames(): (keyof AppearenceEvents)[]
Returns the names of the events that have listeners.

Returns (keyof AppearenceEvents)[]
Inherited from EventEmitter.getEventNames
- Defined in src/classes/event-emitter.ts:56

getListeners

getListeners<K extends keyof AppearenceEvents>(
    name?: K,
    callback?: AppearenceEvents[K],
    options?: EventEmitterListenerOptions,
): EventEmitterListener<AppearenceEvents, keyof AppearenceEvents>[]
Returns the listeners that match the name, callback and options. If no arguments are passed, all listeners will be returned.
Type Parameters
- K extends keyof AppearenceEvents
Parameters
- Optionalname: K
- Optionalcallback: AppearenceEvents[K]
- Optionaloptions: EventEmitterListenerOptions
Returns EventEmitterListener<AppearenceEvents, keyof AppearenceEvents>[]
Inherited from EventEmitter.getListeners
- Defined in src/classes/event-emitter.ts:64

getMaxListeners

getMaxListeners(): number
Returns the maximum number of listeners that can be registered for a single event.

Returns number
Inherited from EventEmitter.getMaxListeners
- Defined in src/classes/event-emitter.ts:78

hasListeners

hasListeners<K extends keyof AppearenceEvents>(
    name?: K,
    callback?: AppearenceEvents[K],
    options?: EventEmitterListenerOptions,
): boolean
Checks if the event has listeners that match the name, callback and options.
Type Parameters
- K extends keyof AppearenceEvents
Parameters
- Optionalname: K
- Optionalcallback: AppearenceEvents[K]
- Optionaloptions: EventEmitterListenerOptions
Returns boolean
Inherited from EventEmitter.hasListeners
- Defined in src/classes/event-emitter.ts:85

initialize

initialize(): Promise<boolean>
Retrieves the theme from the storage and sets it.

Returns Promise<boolean>
- Defined in src/classes/appearence.ts:45

off

off<K extends keyof AppearenceEvents>(
    name?: K,
    callback?: AppearenceEvents[K],
    options?: EventEmitterListenerOptions,
): this
Removes the listeners that match the name, callback and options. If no arguments are passed, all listeners will be removed.
Type Parameters
- K extends keyof AppearenceEvents
Parameters
- Optionalname: K
- Optionalcallback: AppearenceEvents[K]
- Optionaloptions: EventEmitterListenerOptions
Returns this
Inherited from EventEmitter.off
- Defined in src/classes/event-emitter.ts:93

on

on<K extends keyof AppearenceEvents>(
    name: K,
    callback: AppearenceEvents[K],
    options?: EventEmitterListenerOptions,
): this
Adds a listener, which will be called when the event is emitted.

Optionally the listener can be removed after the first call with the once option. Optionally the listener can be prepended to the listeners array with the prepend option.
Type Parameters
- K extends keyof AppearenceEvents
Parameters
- name: K
- callback: AppearenceEvents[K]
- Optionaloptions: EventEmitterListenerOptions
Returns this
Inherited from EventEmitter.on
- Defined in src/classes/event-emitter.ts:113

once

once<K extends keyof AppearenceEvents>(
    name: K,
    callback: AppearenceEvents[K],
    options?: EventEmitterListenerOptions,
): this
Adds a listener, which will be called only once when the event is emitted.
Type Parameters
- K extends keyof AppearenceEvents
Parameters
- name: K
- callback: AppearenceEvents[K]
- Optionaloptions: EventEmitterListenerOptions
Returns this
Inherited from EventEmitter.once
- Defined in src/classes/event-emitter.ts:140

prepend

prepend<K extends keyof AppearenceEvents>(
    name: K,
    callback: AppearenceEvents[K],
    options?: EventEmitterListenerOptions,
): this
Adds a listener, which will be called first when the event is emitted.
Type Parameters
- K extends keyof AppearenceEvents
Parameters
- name: K
- callback: AppearenceEvents[K]
- Optionaloptions: EventEmitterListenerOptions
Returns this
Inherited from EventEmitter.prepend
- Defined in src/classes/event-emitter.ts:147

`Protected`registerThemeEventListener

registerThemeEventListener(): void
Registers the theme event listener in environments that support it.

Returns void
- Defined in src/classes/appearence.ts:102

setListeners

setListeners(
    listeners: EventEmitterListener<
        AppearenceEvents,
        keyof AppearenceEvents,
    >[],
): this
Sets the listeners.
Parameters
- listeners: EventEmitterListener<AppearenceEvents, keyof AppearenceEvents>[]
Returns this
Inherited from EventEmitter.setListeners
- Defined in src/classes/event-emitter.ts:154

setMaxListeners

setMaxListeners(n: number): this
Sets the maximum number of listeners that can be registered for a single event.
Parameters
- n: number
Returns this
Inherited from EventEmitter.setMaxListeners
- Defined in src/classes/event-emitter.ts:164

setTheme

setTheme(theme: Theme): this
Sets the theme. The "change-theme" event will be emitted.
Parameters
- theme: Theme
Returns this
- Defined in src/classes/appearence.ts:75

store

store(): Promise<boolean>
Stores the theme in the storage.

Returns Promise<boolean>
- Defined in src/classes/appearence.ts:95

toggleTheme

toggleTheme(): this
Toggles the theme between dark and light. If the theme is set to system, it will be set to dark or light depending on the system theme.

Returns this
- Defined in src/classes/appearence.ts:60

Class Appearence

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Appearence

Properties

Protectedlisteners

ProtectedmaxListeners

storage

storageKey

theme

Accessors

isThemeDark

Returns boolean

isThemeLight

Returns boolean

isThemeSystem

Returns boolean

themeByPrefersColorScheme

Returns Theme

Methods

countListeners

Type Parameters

Parameters

Returns number

emit

Type Parameters

Parameters

Returns boolean

getEventNames

Returns (keyof AppearenceEvents)[]

getListeners

Type Parameters

Parameters

Returns EventEmitterListener<AppearenceEvents, keyof AppearenceEvents>[]

getMaxListeners

Returns number

hasListeners

Type Parameters

Parameters

Returns boolean

initialize

Returns Promise<boolean>

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

prepend

Type Parameters

Parameters

Returns this

ProtectedregisterThemeEventListener

Returns void

setListeners

Parameters

Returns this

setMaxListeners

Parameters

Returns this

setTheme

Parameters

Returns this

store

Returns Promise<boolean>

toggleTheme

Returns this

`Protected`listeners

`Protected`maxListeners

`Protected`registerThemeEventListener