Skrypt dla każdego rozszerzenia jest pobierany i uruchamiany zanim widżet komentarzy zacznie pobierać pierwszy zestaw komentarzy i renderować UI.

Na początkowym ładowaniu następujące dane zostaną przypisane do obiektu rozszerzenia:

• config - Odwołanie do obiektu config.
• translations - Odwołanie do obiektu translations.
• commentsById - Odwołanie do wszystkich komentarzy według id.
• root - Odwołanie do głównego węzła DOM.

Rozszerzenia powinny nadpisać pożądane funkcje, które widżet komentarzy wywoła w odpowiednich momentach.

Najmniejsze możliwe rozszerzenie wyglądałoby następująco:

Proste rozszerzenie

Copy Run

1

2(function () {

3 const extension = FastCommentsUI.extensions.find((extension) => {

4 return extension.id === 'my-extension';

5 });

6})();

7

Na potrzeby tego przykładu zapisz to jako my-extension.js i udostępnij pod adresem https://example.com/my-extension.min.js.

To rozszerzenie nic nie robi, poza tym przy wczytaniu pobiera obiekt rozszerzenia utworzony przez główną bibliotekę komentarzy.

This Extension object is a singleton and is not shared with any other extensions.

Aby załadować nasze rozszerzenie, musimy poinformować o tym widżet komentarzy. Na przykład:

Using a Custom Extension

Copy 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

Przykłady funkcjonalne znajdują się w następnej sekcji.

Obiekt rozszerzenia składa się z następującej definicji:

JSDoc obiektu rozszerzenia

Copy 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 - Główny węzeł DOM widżetu.

10 * @property {string} [css]

11 * @property {Object} config - Obiekt konfiguracyjny FastComments.

12 * @property {Object} commentsById - Odwołanie do obiektu ze wszystkimi komentarzami według id, które jest na bieżąco aktualizowane.

13 * @property {Object} translations - Odwołanie do wszystkich tłumaczeń.

14 * @property {Function} reRenderComment - Odwołanie do funkcji, którą można wywołać, aby ponownie wyrenderować komentarz.

15 * @property {Function} removeCommentAndReRender - Odwołanie do funkcji, którą można wywołać, aby usunąć komentarz z pamięci i ponownie wyrenderować odpowiednią część DOM.

16 * @property {Function} newBroadcastId - Odwołanie do funkcji, którą można wywołać, aby utworzyć nowe id broadcast i dodać je do lokalnej listy id broadcast do zignorowania.

17 * @property {FastCommentsUIExtensionSetupEventHandlers} [setupEventHandlers]

18 * @property {FastCommentsUIExtensionPrepareCommentForSavingCallback} [prepareCommentForSaving]

19 * @property {FastCommentsUIExtensionNewCommentCallback} [newComment]

20 * @property {FastCommentsUIExtensionReplyAreaFilter} [replyAreaFilter] - Filtr HTML dla obszaru odpowiedzi.

21 * @property {FastCommentsUIExtensionWidgetFilter} [widgetFilter] - Filtr HTML dla całego widżetu podczas renderowania.

22 * @property {FastCommentsUIExtensionCommentTopFilter} [commentFilter] - Filtr HTML dla każdego komentarza przed renderowaniem.

23 * @property {FastCommentsUIExtensionReplyAreaFilter} [commentMenuFilter] - Filtr HTML dla każdego menu komentarza przed renderowaniem.

24 * @property {FastCommentsUIExtensionMenuFilter} [menuFilter] - Filtr HTML dla całego widżetu podczas renderowania.

25 * @property {FastCommentsUIExtensionReplyAreaTop} [replyAreaTop] - (PRZESTARZAŁE) Zwraca HTML do dodania na górze obszaru odpowiedzi.

26 * @property {FastCommentsUIExtensionWidgetTopCallback} [widgetTop] - (PRZESTARZAŁE) Zwraca HTML do dodania na górze widżetu.

27 * @property {FastCommentsUIExtensionCommentTopCallback} [commentTop] - (PRZESTARZAŁE) Zwraca HTML do dodania na górze elementu komentarza.

28 * @property {FastCommentsUIExtensionCommentBottomCallback} [commentBottom] - (PRZESTARZAŁE) Zwraca HTML do dodania na dole elementu komentarza.

29 * @property {FastCommentsUIExtensionMenuBottomCallback} [menuBottom] - (PRZESTARZAŁE) Zwraca HTML do dodania na dole elementu menu dla każdego komentarza.

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 - Element root.

39 * @param {Object.<string, Function>} clickListeners - Obsługiwacze zdarzeń kliknięć, według nazwy klasy, które można modyfikować przez referencję.

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

Interakcja z Extension jest prosta — wystarczy zdefiniować odniesienia do funkcji, które chcemy wywołać.

Bazując na wcześniejszym przykładzie, załóżmy, że chcemy dodać HTML na początku każdego komentarza:

Proste rozszerzenie - ciąg dalszy

Copy 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

Kiedykolwiek zwrócisz HTML w ten sposób, zostanie on scalony z interfejsem użytkownika za pomocą algorytmu porównywania DOM (dom-diffing).

Ręczne wywoływanie ponownego renderowania komentarza

Możemy poczekać na początkowe załadowanie strony i ręcznie ponownie wyrenderować komentarz, wywołując reRenderComment:

Ponowne renderowanie komentarza

Copy 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 nie jest wymagany, to tylko przykład.

20 }

21})();

22