OptionalapiVersion?: stringBackend API version (system data, not allowed for user modification)
OptionalavatarURLBuilder?: (comment: CommentData) => stringAvatar URL generator function
OptionalbeforeSubmit?: (editor: Editor, next: () => void) => voidCallback before submitting a comment
OptionalcountEl?: stringSelector for the element binding to the comment count
OptionaldarkMode?: boolean | "auto"Dark mode settings
OptionaldateFormatter?: (date: Date) => stringCustom date formatter
OptionaleditorTravel?: booleanMovable comment box (display below the comment to be replied)
Optionalel?: string | HTMLElementElement selector or Element to mount the Artalk
Optionalemoticons?: string | false | object | any[]Emoticons settings
OptionalfetchCommentsOnInit?: booleanImmediately fetch comments when Artalk instance is initialized
OptionalflatMode?: boolean | "auto"Flat mode for comment display
Optionalgravatar?: { mirror?: string; params?: string }Gravatar avatar settings
Optionalmirror?: stringAPI endpoint
Optionalparams?: stringAPI parameters
OptionalheightLimit?: { children?: number; content?: number; scrollable?: boolean }Height limit configuration
Optionalchildren?: numberMaximum height for child comments
Optionalcontent?: numberMaximum height for comment content
Optionalscrollable?: booleanWhether the content is scrollable
OptionalimgLazyLoad?: false | "native" | "data-src"Image lazy load mode
OptionalimgUpload?: booleanEnable image upload feature
OptionalimgUploader?: (file: File) => Promise<string>Image uploader function
OptionallistFetchParamsModifier?: (params: any) => voidModifier for list fetch request parameters
OptionallistSort?: booleanShow sorting dropdown for comment list
OptionallistUnreadHighlight?: booleanList unread highlight (enable by default in artalk-sidebar)
Optionallocale?: Localization settings
OptionalmarkedOptions?: {Options for the marked (Markdown parser)
Optionalasync?: booleanTrue will tell marked to await any walkTokens functions before parsing the tokens and returning an HTML string.
Optionalbreaks?: booleanEnable GFM line breaks. This option requires the gfm option to be true.
Optionalextensions?: Custom extensions
Optionalgfm?: booleanEnable GitHub flavored markdown.
Optionalhooks?: Hooks are methods that hook into some part of marked.
Optionalpedantic?: booleanConform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
Optionalrenderer?: Type: object Default: new Renderer()
An object containing functions to render tokens to HTML.
Optionalsilent?: booleanShows an HTML error message when rendering fails.
Optionaltokenizer?: The tokenizer defines how to turn markdown text into tokens.
OptionalwalkTokens?: ((token: Token) => void | Promise<void> | (void | Promise<void>)[]) | nullwalkTokens function returns array of values for Promise.all
OptionalmarkedReplacers?: ((raw: string) => string)[]Replacers for the marked (Markdown parser)
OptionalnestMax?: numberMaximum number of levels for nested comments
OptionalnestSort?: "DATE_ASC" | "DATE_DESC"Sorting order for nested comments
OptionalnoComment?: stringText to display when there are no comments
OptionalpageKey?: stringUnique page identifier
OptionalpageTitle?: stringTitle of the page
OptionalpageVote?: Page Vote Widget
Optionalpagination?: { autoLoad?: boolean; pageSize?: number; readMore?: boolean }Pagination settings
OptionalautoLoad?: booleanAutomatically load more comments when scrolled to the bottom
OptionalpageSize?: numberNumber of comments to fetch per request
OptionalreadMore?: boolean"Read more" mode
Optionalplaceholder?: stringPlaceholder text for the comment input box
OptionalpluginURLs?: string[]URLs for plugin scripts
OptionalpreferRemoteConf?: booleanPrefer to use the local configuration if available
Optionalpreview?: booleanPreview feature for comments
OptionalpvAdd?: booleanPage view increment when comment list is loaded
OptionalpvEl?: stringSelector for the element binding to the page views (PV) count
OptionalreqTimeout?: numberRequest timeout (in seconds)
OptionalscrollRelativeTo?: () => HTMLElementThe relative element for scrolling (useful if artalk is in a scrollable container)
OptionalsendBtn?: stringText for the send button
Optionalserver?: stringServer address
Optionalsite?: stringSite name
OptionalstatPageKeyAttr?: stringAttribute name for the PageKey in statistics components
OptionaluaBadge?: booleanDisplay UA badge (user agent badge)
OptionaluseBackendConf?: booleanUse remote configuration (from the backend server)
OptionalversionCheck?: booleanEnable version check
Optionalvote?: booleanVoting feature for comments
OptionalvoteDown?: booleanDownvote button for comments
Destroy instance of Artalk
Get the config of Artalk
Get the root element of Artalk
Remove an event listener
Add an event listener
Reload comment list of Artalk
Set dark mode
Trigger an event
Optionalpayload: EventPayloadMap[K]Update config of Artalk
OptionalapiVersion?: stringBackend API version (system data, not allowed for user modification)
OptionalavatarURLBuilder?: (comment: CommentData) => stringAvatar URL generator function
OptionalbeforeSubmit?: (editor: Editor, next: () => void) => voidCallback before submitting a comment
OptionalcountEl?: stringSelector for the element binding to the comment count
OptionaldarkMode?: boolean | "auto"Dark mode settings
OptionaldateFormatter?: (date: Date) => stringCustom date formatter
OptionaleditorTravel?: booleanMovable comment box (display below the comment to be replied)
Optionalel?: string | HTMLElementElement selector or Element to mount the Artalk
Optionalemoticons?: string | false | object | any[]Emoticons settings
OptionalfetchCommentsOnInit?: booleanImmediately fetch comments when Artalk instance is initialized
OptionalflatMode?: boolean | "auto"Flat mode for comment display
Optionalgravatar?: { mirror?: string; params?: string }Gravatar avatar settings
Optionalmirror?: stringAPI endpoint
Optionalparams?: stringAPI parameters
OptionalheightLimit?: { children?: number; content?: number; scrollable?: boolean }Height limit configuration
Optionalchildren?: numberMaximum height for child comments
Optionalcontent?: numberMaximum height for comment content
Optionalscrollable?: booleanWhether the content is scrollable
OptionalimgLazyLoad?: false | "native" | "data-src"Image lazy load mode
OptionalimgUpload?: booleanEnable image upload feature
OptionalimgUploader?: (file: File) => Promise<string>Image uploader function
OptionallistFetchParamsModifier?: (params: any) => voidModifier for list fetch request parameters
OptionallistSort?: booleanShow sorting dropdown for comment list
OptionallistUnreadHighlight?: booleanList unread highlight (enable by default in artalk-sidebar)
Optionallocale?: Localization settings
OptionalmarkedOptions?: {Options for the marked (Markdown parser)
Optionalasync?: booleanTrue will tell marked to await any walkTokens functions before parsing the tokens and returning an HTML string.
Optionalbreaks?: booleanEnable GFM line breaks. This option requires the gfm option to be true.
Optionalextensions?: Custom extensions
Optionalgfm?: booleanEnable GitHub flavored markdown.
Optionalhooks?: Hooks are methods that hook into some part of marked.
Optionalpedantic?: booleanConform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
Optionalrenderer?: Type: object Default: new Renderer()
An object containing functions to render tokens to HTML.
Optionalsilent?: booleanShows an HTML error message when rendering fails.
Optionaltokenizer?: The tokenizer defines how to turn markdown text into tokens.
OptionalwalkTokens?: ((token: Token) => void | Promise<void> | (void | Promise<void>)[]) | nullwalkTokens function returns array of values for Promise.all
OptionalmarkedReplacers?: ((raw: string) => string)[]Replacers for the marked (Markdown parser)
OptionalnestMax?: numberMaximum number of levels for nested comments
OptionalnestSort?: "DATE_ASC" | "DATE_DESC"Sorting order for nested comments
OptionalnoComment?: stringText to display when there are no comments
OptionalpageKey?: stringUnique page identifier
OptionalpageTitle?: stringTitle of the page
OptionalpageVote?: Page Vote Widget
Optionalpagination?: { autoLoad?: boolean; pageSize?: number; readMore?: boolean }Pagination settings
OptionalautoLoad?: booleanAutomatically load more comments when scrolled to the bottom
OptionalpageSize?: numberNumber of comments to fetch per request
OptionalreadMore?: boolean"Read more" mode
Optionalplaceholder?: stringPlaceholder text for the comment input box
OptionalpluginURLs?: string[]URLs for plugin scripts
OptionalpreferRemoteConf?: booleanPrefer to use the local configuration if available
Optionalpreview?: booleanPreview feature for comments
OptionalpvAdd?: booleanPage view increment when comment list is loaded
OptionalpvEl?: stringSelector for the element binding to the page views (PV) count
OptionalreqTimeout?: numberRequest timeout (in seconds)
OptionalscrollRelativeTo?: () => HTMLElementThe relative element for scrolling (useful if artalk is in a scrollable container)
OptionalsendBtn?: stringText for the send button
Optionalserver?: stringServer address
Optionalsite?: stringSite name
OptionalstatPageKeyAttr?: stringAttribute name for the PageKey in statistics components
OptionaluaBadge?: booleanDisplay UA badge (user agent badge)
OptionaluseBackendConf?: booleanUse remote configuration (from the backend server)
OptionalversionCheck?: booleanEnable version check
Optionalvote?: booleanVoting feature for comments
OptionalvoteDown?: booleanDownvote button for comments
StaticinitInit Artalk
OptionalapiVersion?: stringBackend API version (system data, not allowed for user modification)
OptionalavatarURLBuilder?: (comment: CommentData) => stringAvatar URL generator function
OptionalbeforeSubmit?: (editor: Editor, next: () => void) => voidCallback before submitting a comment
OptionalcountEl?: stringSelector for the element binding to the comment count
OptionaldarkMode?: boolean | "auto"Dark mode settings
OptionaldateFormatter?: (date: Date) => stringCustom date formatter
OptionaleditorTravel?: booleanMovable comment box (display below the comment to be replied)
Optionalel?: string | HTMLElementElement selector or Element to mount the Artalk
Optionalemoticons?: string | false | object | any[]Emoticons settings
OptionalfetchCommentsOnInit?: booleanImmediately fetch comments when Artalk instance is initialized
OptionalflatMode?: boolean | "auto"Flat mode for comment display
Optionalgravatar?: { mirror?: string; params?: string }Gravatar avatar settings
Optionalmirror?: stringAPI endpoint
Optionalparams?: stringAPI parameters
OptionalheightLimit?: { children?: number; content?: number; scrollable?: boolean }Height limit configuration
Optionalchildren?: numberMaximum height for child comments
Optionalcontent?: numberMaximum height for comment content
Optionalscrollable?: booleanWhether the content is scrollable
OptionalimgLazyLoad?: false | "native" | "data-src"Image lazy load mode
OptionalimgUpload?: booleanEnable image upload feature
OptionalimgUploader?: (file: File) => Promise<string>Image uploader function
OptionallistFetchParamsModifier?: (params: any) => voidModifier for list fetch request parameters
OptionallistSort?: booleanShow sorting dropdown for comment list
OptionallistUnreadHighlight?: booleanList unread highlight (enable by default in artalk-sidebar)
Optionallocale?: Localization settings
OptionalmarkedOptions?: {Options for the marked (Markdown parser)
Optionalasync?: booleanTrue will tell marked to await any walkTokens functions before parsing the tokens and returning an HTML string.
Optionalbreaks?: booleanEnable GFM line breaks. This option requires the gfm option to be true.
Optionalextensions?: Custom extensions
Optionalgfm?: booleanEnable GitHub flavored markdown.
Optionalhooks?: Hooks are methods that hook into some part of marked.
Optionalpedantic?: booleanConform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
Optionalrenderer?: Type: object Default: new Renderer()
An object containing functions to render tokens to HTML.
Optionalsilent?: booleanShows an HTML error message when rendering fails.
Optionaltokenizer?: The tokenizer defines how to turn markdown text into tokens.
OptionalwalkTokens?: ((token: Token) => void | Promise<void> | (void | Promise<void>)[]) | nullwalkTokens function returns array of values for Promise.all
OptionalmarkedReplacers?: ((raw: string) => string)[]Replacers for the marked (Markdown parser)
OptionalnestMax?: numberMaximum number of levels for nested comments
OptionalnestSort?: "DATE_ASC" | "DATE_DESC"Sorting order for nested comments
OptionalnoComment?: stringText to display when there are no comments
OptionalpageKey?: stringUnique page identifier
OptionalpageTitle?: stringTitle of the page
OptionalpageVote?: Page Vote Widget
Optionalpagination?: { autoLoad?: boolean; pageSize?: number; readMore?: boolean }Pagination settings
OptionalautoLoad?: booleanAutomatically load more comments when scrolled to the bottom
OptionalpageSize?: numberNumber of comments to fetch per request
OptionalreadMore?: boolean"Read more" mode
Optionalplaceholder?: stringPlaceholder text for the comment input box
OptionalpluginURLs?: string[]URLs for plugin scripts
OptionalpreferRemoteConf?: booleanPrefer to use the local configuration if available
Optionalpreview?: booleanPreview feature for comments
OptionalpvAdd?: booleanPage view increment when comment list is loaded
OptionalpvEl?: stringSelector for the element binding to the page views (PV) count
OptionalreqTimeout?: numberRequest timeout (in seconds)
OptionalscrollRelativeTo?: () => HTMLElementThe relative element for scrolling (useful if artalk is in a scrollable container)
OptionalsendBtn?: stringText for the send button
Optionalserver?: stringServer address
Optionalsite?: stringSite name
OptionalstatPageKeyAttr?: stringAttribute name for the PageKey in statistics components
OptionaluaBadge?: booleanDisplay UA badge (user agent badge)
OptionaluseBackendConf?: booleanUse remote configuration (from the backend server)
OptionalversionCheck?: booleanEnable version check
Optionalvote?: booleanVoting feature for comments
OptionalvoteDown?: booleanDownvote button for comments
StaticloadLoad count widget
OptionalapiVersion?: stringBackend API version (system data, not allowed for user modification)
OptionalavatarURLBuilder?: (comment: CommentData) => stringAvatar URL generator function
OptionalbeforeSubmit?: (editor: Editor, next: () => void) => voidCallback before submitting a comment
OptionalcountEl?: stringSelector for the element binding to the comment count
OptionaldarkMode?: boolean | "auto"Dark mode settings
OptionaldateFormatter?: (date: Date) => stringCustom date formatter
OptionaleditorTravel?: booleanMovable comment box (display below the comment to be replied)
Optionalel?: string | HTMLElementElement selector or Element to mount the Artalk
Optionalemoticons?: string | false | object | any[]Emoticons settings
OptionalfetchCommentsOnInit?: booleanImmediately fetch comments when Artalk instance is initialized
OptionalflatMode?: boolean | "auto"Flat mode for comment display
Optionalgravatar?: { mirror?: string; params?: string }Gravatar avatar settings
Optionalmirror?: stringAPI endpoint
Optionalparams?: stringAPI parameters
OptionalheightLimit?: { children?: number; content?: number; scrollable?: boolean }Height limit configuration
Optionalchildren?: numberMaximum height for child comments
Optionalcontent?: numberMaximum height for comment content
Optionalscrollable?: booleanWhether the content is scrollable
OptionalimgLazyLoad?: false | "native" | "data-src"Image lazy load mode
OptionalimgUpload?: booleanEnable image upload feature
OptionalimgUploader?: (file: File) => Promise<string>Image uploader function
OptionallistFetchParamsModifier?: (params: any) => voidModifier for list fetch request parameters
OptionallistSort?: booleanShow sorting dropdown for comment list
OptionallistUnreadHighlight?: booleanList unread highlight (enable by default in artalk-sidebar)
Optionallocale?: Localization settings
OptionalmarkedOptions?: {Options for the marked (Markdown parser)
Optionalasync?: booleanTrue will tell marked to await any walkTokens functions before parsing the tokens and returning an HTML string.
Optionalbreaks?: booleanEnable GFM line breaks. This option requires the gfm option to be true.
Optionalextensions?: Custom extensions
Optionalgfm?: booleanEnable GitHub flavored markdown.
Optionalhooks?: Hooks are methods that hook into some part of marked.
Optionalpedantic?: booleanConform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
Optionalrenderer?: Type: object Default: new Renderer()
An object containing functions to render tokens to HTML.
Optionalsilent?: booleanShows an HTML error message when rendering fails.
Optionaltokenizer?: The tokenizer defines how to turn markdown text into tokens.
OptionalwalkTokens?: ((token: Token) => void | Promise<void> | (void | Promise<void>)[]) | nullwalkTokens function returns array of values for Promise.all
OptionalmarkedReplacers?: ((raw: string) => string)[]Replacers for the marked (Markdown parser)
OptionalnestMax?: numberMaximum number of levels for nested comments
OptionalnestSort?: "DATE_ASC" | "DATE_DESC"Sorting order for nested comments
OptionalnoComment?: stringText to display when there are no comments
OptionalpageKey?: stringUnique page identifier
OptionalpageTitle?: stringTitle of the page
OptionalpageVote?: Page Vote Widget
Optionalpagination?: { autoLoad?: boolean; pageSize?: number; readMore?: boolean }Pagination settings
OptionalautoLoad?: booleanAutomatically load more comments when scrolled to the bottom
OptionalpageSize?: numberNumber of comments to fetch per request
OptionalreadMore?: boolean"Read more" mode
Optionalplaceholder?: stringPlaceholder text for the comment input box
OptionalpluginURLs?: string[]URLs for plugin scripts
OptionalpreferRemoteConf?: booleanPrefer to use the local configuration if available
Optionalpreview?: booleanPreview feature for comments
OptionalpvAdd?: booleanPage view increment when comment list is loaded
OptionalpvEl?: stringSelector for the element binding to the page views (PV) count
OptionalreqTimeout?: numberRequest timeout (in seconds)
OptionalscrollRelativeTo?: () => HTMLElementThe relative element for scrolling (useful if artalk is in a scrollable container)
OptionalsendBtn?: stringText for the send button
Optionalserver?: stringServer address
Optionalsite?: stringSite name
OptionalstatPageKeyAttr?: stringAttribute name for the PageKey in statistics components
OptionaluaBadge?: booleanDisplay UA badge (user agent badge)
OptionaluseBackendConf?: booleanUse remote configuration (from the backend server)
OptionalversionCheck?: booleanEnable version check
Optionalvote?: booleanVoting feature for comments
OptionalvoteDown?: booleanDownvote button for comments
StaticuseUse plugin, the plugin will be used when Artalk.init
Optionaloptions: T
Artalk
See
https://artalk.js.org