開發擴充功能
背景
FastComments 提供透過我們稱為擴充功能的腳本來擴充我們的核心功能的能力。
An Extension 可以向留言元件新增額外的標記、事件監聽器，並執行任意程式碼。
在這裡你會找到我們在生產環境中使用的擴充功能範例，以及如何撰寫擴充功能的文件。
擴充套件生命週期 
每個擴充功能的腳本會在評論元件開始抓取第一批評論並渲染 UI 之前被抓取並執行。
在初始載入時，下列資料會被標記到擴充功能物件上：
config- 一個指向config物件的參考。translations- 一個指向translations物件的參考。commentsById- 一個以 id 為索引的所有評論的參考。root- 一個指向根 DOM 節點的參考。
擴充功能應覆寫所需的函式，評論元件會在適當的時機呼叫它們。
定義擴充套件
最小的擴充功能範例為：
一個簡單的擴充功能
Copy 
Run 
Run 1
2(function () {
3 const extension = FastCommentsUI.extensions.find((extension) => {
4 return extension.id === 'my-extension';
5 });
6})();
7
為了本範例，將此儲存為 my-extension.js，並讓它可透過 https://example.com/my-extension.min.js 存取。
這個擴充功能本身不會執行任何動作，只有在載入時會取回由核心留言函式庫所建立的擴充物件。
此 Extension 物件為單例，且不會與其他擴充功能共用。
接下來，要載入我們的擴充功能，必須告知留言小工具。例如：
Using a Custom Extension
Copy Run
Run 1
2<script async src="https://cdn.fastcomments.com/js/embed-v2-async.min.js"></script>
3<div id="fastcomments-widget"></div>
4<script>
5window.fcConfigs = [{
6 "tenantId": "demo",
7 "extensions": [
8 {
9 "id": "my-extension",
10 "path": "https://example.com/my-extension.min.js"
11 }
12 ]
13}];
14</script>
15
關於功能範例，請參閱下一節。
範例擴充套件
在 FastComments，我們使用相同的 API 自行撰寫擴充功能。您可以在下列端點查看這些擴充功能的未壓縮程式碼：
Dark Mode
當偵測到頁面為「深色」時，深色模式擴充功能會被有條件地載入。此擴充功能僅向評論元件加入一些 CSS。如此一來，當不需要時我們就不用載入深色模式的 CSS。
https://fastcomments.com/js/comment-ui/extensions/comment-ui.dark.extension.js
Moderation
當目前使用者為版主時，我們會使用審核擴充功能。
這是一個很好的範例，示範如何新增基於點擊的事件監聽器、發出 API 請求，以及新增項目到評論選單和評論區域。
https://fastcomments.com/js/comment-ui/extensions/comment-ui.moderation.extension.js
Live Chat
即時聊天擴充功能（搭配其他設定與樣式）會將評論元件轉變成即時聊天組件。
https://fastcomments.com/js/comment-ui/extensions/live-chat.extension.js
擴充套件物件
擴充套件物件由下列定義組成：
擴充套件物件 JSDoc
Copy Run
Run 1
2/**
3 * The FastCommentsUI extension object. Used for lazy-loading certain components. For example, the review system is not
4 * used by all customers, so we only load that extension when we want it.
5 *
6 * @typedef {Object} FastCommentsUIExtension
7 * @property {string} id
8 * @property {Element} scriptNode
9 * @property {Element} root - widget 的根 DOM 節點。
10 * @property {string} [css]
11 * @property {Object} config - FastComments 的設定物件。
12 * @property {Object} commentsById - 參考一個以 id 為鍵、包含所有評論的物件，並會持續保持更新。
13 * @property {Object} translations - 參考所有翻譯資料。
14 * @property {Function} reRenderComment - 參考一個可用來重新渲染評論的函式。
15 * @property {Function} removeCommentAndReRender - 參考一個可用來從記憶體中移除評論並重新渲染對應 DOM 區段的函式。
16 * @property {Function} newBroadcastId - 參考一個可用來建立新的廣播 id 並將其加入本地要忽略的廣播 id 清單的函式。
17 * @property {FastCommentsUIExtensionSetupEventHandlers} [setupEventHandlers]
18 * @property {FastCommentsUIExtensionPrepareCommentForSavingCallback} [prepareCommentForSaving]
19 * @property {FastCommentsUIExtensionNewCommentCallback} [newComment]
20 * @property {FastCommentsUIExtensionReplyAreaFilter} [replyAreaFilter] - 為評論區過濾 HTML。
21 * @property {FastCommentsUIExtensionWidgetFilter} [widgetFilter] - 在渲染時為整個 widget 過濾 HTML。
22 * @property {FastCommentsUIExtensionCommentTopFilter} [commentFilter] - 在渲染前為每個評論過濾 HTML。
23 * @property {FastCommentsUIExtensionReplyAreaFilter} [commentMenuFilter] - 在渲染前為每則評論的選單過濾 HTML。
24 * @property {FastCommentsUIExtensionMenuFilter} [menuFilter] - 在渲染時為整個 widget 過濾 HTML。
25 * @property {FastCommentsUIExtensionReplyAreaTop} [replyAreaTop] - （遺留）回傳要新增至回覆區頂端的 HTML。
26 * @property {FastCommentsUIExtensionWidgetTopCallback} [widgetTop] - （遺留）回傳要新增至 widget 頂端的 HTML。
27 * @property {FastCommentsUIExtensionCommentTopCallback} [commentTop] - （遺留）回傳要新增至評論元素頂端的 HTML。
28 * @property {FastCommentsUIExtensionCommentBottomCallback} [commentBottom] - （遺留）回傳要新增至評論元素底部的 HTML。
29 * @property {FastCommentsUIExtensionMenuBottomCallback} [menuBottom] - （遺留）回傳要新增至每則評論的選單元素底部的 HTML。
30 * @property {FastCommentsUIExtensionRenderCallback} [onRender]
31 * @property {FastCommentsUIExtensionConnectionStatusCallback} [onLiveConnectionStatusUpdate]
32 * @property {FastCommentsUIExtensionInitialRenderCallback} [onInitialRenderComplete]
33 * @property {FastCommentsUIExtensionPresenceUpdateCallback} [onPresenceUpdate]
34 */
35
36/**
37 * @callback FastCommentsUIExtensionSetupEventHandlers
38 * @param {Element} element - 根元素。
39 * @param {Object.<string, Function>} clickListeners - 以 class 名稱為鍵的點擊事件處理器，可透過參考來修改。
40 * @returns void
41 */
42
43/**
44 * @callback FastCommentsUIExtensionWidgetTopCallback
45 * @param {Object} moduleData
46 * @returns {string}
47 */
48
49/**
50 * @callback FastCommentsUIExtensionWidgetFilter
51 * @param {Object} moduleData
52 * @param {Object} html
53 * @returns {string}
54 */
55
56/**
57 * @callback FastCommentsUIExtensionCommentTopCallback
58 * @param {Object} comment
59 * @returns {string}
60 */
61
62/**
63 * @callback FastCommentsUIExtensionCommentTopFilter
64 * @param {Object} comment
65 * @param {string} html
66 * @returns {string}
67 */
68
69/**
70 * @callback FastCommentsUIExtensionCommentBottomCallback
71 * @param {Object} comment
72 * @returns {string}
73 */
74
75/**
76 * @callback FastCommentsUIExtensionMenuBottomCallback
77 * @param {Object} comment
78 * @returns {string}
79 */
80
81/**
82 * @callback FastCommentsUIExtensionMenuFilter
83 * @param {Object} comment
84 * @param {string} html
85 * @returns {string}
86 */
87
88/**
89 * @callback FastCommentsUIExtensionRenderCallback
90 * @returns {string}
91 */
92
93/**
94 * @callback FastCommentsUIExtensionConnectionStatusCallback
95 * @param {boolean} isConnected
96 * @returns {void}
97 */
98
99/**
100 * @callback FastCommentsUIExtensionInitialRenderCallback
101 * @returns {void}
102 */
103
104/**
105 * @callback FastCommentsUIExtensionReplyAreaTop
106 * @param {Object|null} currentUser
107 * @param {boolean} isSaving
108 * @param {boolean} isReplyOpen
109 * @param {string|null} parentId
110 * @returns {string}
111 */
112
113/**
114 * @callback FastCommentsUIExtensionReplyAreaFilter
115 * @param {Object|null} currentUser
116 * @param {boolean} isSaving
117 * @param {boolean} isReplyOpen
118 * @param {string|null} parentId
119 * @param {string|null} html
120 * @returns {string}
121 */
122
123/**
124 * @callback FastCommentsUIExtensionPrepareCommentForSavingCallback
125 * @param {Object} comment
126 * @param {string} parentId
127 */
128
129/**
130 * @callback FastCommentsUIExtensionNewCommentCallback
131 * @param {Object} comment
132 */
133
134/**
135 * @callback FastCommentsUIExtensionPresenceUpdateCallback
136 * @param {Object} update
137 */
138
擴充套件 API
與 Extension 的互動很簡單，只要定義我們想呼叫的函式參考。
延續先前的範例，假設我們想在每個評論的頂部加入 HTML：
簡單的擴充功能 - 繼續
Copy Run
Run 1
2(function () {
3 const extension = FastCommentsUI.extensions.find((extension) => {
4 return extension.id === 'my-extension';
5 });
6
7 extension.commentFilter = function(comment, html) {
8 return `<h3>The user's name is ${comment.commenterName}!</h3>` + html;
9 }
10})();
11
每當你返回這類 HTML 時，它會透過 DOM 差異比對演算法合併到 UI 中。
手動觸發評論的重新渲染
我們可以等到初始頁面載入完成，並透過呼叫 reRenderComment 手動重新渲染評論：
重新渲染評論
Copy Run
Run 1
2(function () {
3 const extension = FastCommentsUI.extensions.find((extension) => {
4 return extension.id === 'my-extension';
5 });
6
7 let renderCount = 0;
8
9 extension.commentFilter = function(comment, html) {
10 renderCount++;
11 return `<h3>The render count is ${renderCount}!</h3>` + html;
12 }
13
14 extension.onInitialRenderComplete = function() {
15 setInterval(function() {
16 extension.reRenderComment(extension.commentsById[Object.keys(extension.commentsById)[0]], function renderDone() {
17 console.log('Comment re-render done.');
18 });
19 }, 2000); // timeout not required, just an example.
20 }
21})();
22