Class default

constructor

• new default(conf): default

• Parameters

  • conf: DeepPartial<Config>

  Returns default

ctx

$root

• get $root(): HTMLElement

• Returns HTMLElement

  Deprecated

  Please use getEl() instead

conf

• get conf(): Config

• Returns Config

  Description

  Please use getConf() instead

destroy

• destroy(): void

• Destroy instance of Artalk

  Returns void

getConf

• getConf(): Config

• Get the config of Artalk

  Returns Config

getEl

• getEl(): HTMLElement

• Get the root element of Artalk

  Returns HTMLElement

off

• off<K>(name, handler): void

• Remove an event listener

  Type Parameters

  • K extends keyof EventPayloadMap

  Parameters

  • name: K
  • handler: EventHandler<EventPayloadMap[K]>

  Returns void

on

• on<K>(name, handler): void

• Add an event listener

  Type Parameters

  • K extends keyof EventPayloadMap

  Parameters

  • name: K
  • handler: EventHandler<EventPayloadMap[K]>

  Returns void

reload

• reload(): void

• Reload comment list of Artalk

  Returns void

setDarkMode

• setDarkMode(darkMode): void

• Set dark mode

  Parameters

  • darkMode: boolean

  Returns void

trigger

• trigger<K>(name, payload?): void

• Trigger an event

  Type Parameters

  • K extends keyof EventPayloadMap

  Parameters

  • name: K
  • Optionalpayload: EventPayloadMap[K]

  Returns void

update

• update(conf): void

• Update config of Artalk

  Parameters

  • conf: DeepPartial<Config>

  Returns void

Staticinit

• init(conf): default

• Init Artalk

  Parameters

  • conf: DeepPartial<Config>

  Returns default

StaticloadCountWidget

• loadCountWidget(c): void

• Load count widget

  Parameters

  • c: DeepPartial<Config>

  Returns void

Staticuse

• use<T>(plugin, options?): void

• Use plugin, the plugin will be used when Artalk.init

  Type Parameters

  • T = any

  Parameters

  • plugin: ArtalkPlugin<T>
  • Optionaloptions: T

  Returns void