docs: update ui api documentation

ArtalkJS · Dec 26, 2023 · b00a257 · b00a257
1 parent 3698c0c
commit b00a257
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/docs/docs/develop/fe-api.md b/docs/docs/develop/fe-api.md
@@ -157,3 +157,23 @@ artalk.setDarkMode(true)
 ## 浏览量组件 `loadCountWidget`
 
 详情见：[浏览量统计](../guide/frontend/pv.md)
+
+## 获取配置 `getConf`
+
+获取当前 Artalk 配置。
+
+```js
+const artalk = Artalk.init({ ... })
+
+const conf = artalk.getConf()
+```
+
+## 获取挂载元素 `getEl`
+
+获取当前 Artalk 挂载的 DOM 元素。
+
+```js
+const artalk = Artalk.init({ ... })
+
+const el = artalk.getEl()
+```
diff --git a/ui/artalk/src/context.ts b/ui/artalk/src/context.ts
@@ -142,6 +142,10 @@ class Context implements ContextApi {
     return this.conf
   }
 
+  public getEl(): HTMLElement {
+    return this.$root
+  }
+
   public getMarked() {
     return marked.getInstance()
   }

diff --git a/ui/artalk/types/context.ts b/ui/artalk/types/context.ts
@@ -82,6 +82,9 @@ export interface ContextApi extends EventManagerFuncs<EventPayloadMap> {
   /** 获取配置 */
   getConf(): ArtalkConfig
 
+  /** 获取挂载元素 */
+  getEl(): HTMLElement
+
   /** 更新配置 */
   updateConf(conf: Partial<ArtalkConfig>): void
 }