Class default

constructor

• new default(conf: ConfigPartial): default

  Parameters

  • conf: ConfigPartial

  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 extends keyof EventPayloadMap>(
      name: K,
      handler: EventHandler<EventPayloadMap[K]>,
  ): void

  Remove an event listener

  Type Parameters

  • K extends keyof EventPayloadMap

  Parameters

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

  Returns void

on

• on<K extends keyof EventPayloadMap>(
      name: K,
      handler: EventHandler<EventPayloadMap[K]>,
  ): 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: boolean): void

  Set dark mode

  Parameters

  • darkMode: boolean

  Returns void

trigger

• trigger<K extends keyof EventPayloadMap>(
      name: K,
      payload?: EventPayloadMap[K],
  ): void

  Trigger an event

  Type Parameters

  • K extends keyof EventPayloadMap

  Parameters

  • name: K
  • Optionalpayload: EventPayloadMap[K]

  Returns void

update

• update(conf: ConfigPartial): void

  Update config of Artalk

  Parameters

  • conf: ConfigPartial

  Returns void

Staticinit

• init(conf: ConfigPartial): default

  Init Artalk

  Parameters

  • conf: ConfigPartial

  Returns default

StaticloadCountWidget

• loadCountWidget(c: ConfigPartial): void

  Load count widget

  Parameters

  • c: ConfigPartial

  Returns void

Staticuse

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

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

  Type Parameters

  • T = any

  Parameters

  • plugin: ArtalkPlugin<T>
  • Optionaloptions: T

  Returns void