Added comments to AdaptiveCardDesigner.Helpers.ts

Author: fabiofranzini

src/controls/adaptiveCardDesignerHost/AdaptiveCardDesigner.Helpers.ts

@@ -1,10 +1,14 @@
+/* This file contains reusable functions useful for managing designer functionality */
+
 import { Guid } from '@microsoft/sp-core-library';
 import { CardDesigner, IChoicePickerItem, SnippetPaletteItem, ToolbarButton, ToolbarChoicePicker } from "adaptivecards-designer";
 
+// Given the instance of a "CardDesigner", it allows you to hide an element of the toolbar given its id.
 export const hideToolbarElement = (cardDesigner: CardDesigner, elementId: string) => {
     cardDesigner.toolbar.getElementById(elementId).isVisible = false;
 };
 
+// Given the instance of a "CardDesigner", it allows you to add an element in the toolbar.
 export const addToolbarButton = (cardDesigner: CardDesigner, caption: string, iconClass: string, positionElementId: string, isAfter: true, hideElementId?: string, onClick?: (sender: ToolbarButton) => void): string => {
     let id = `__${Guid.newGuid().toString()}_ToolbarButton`;
     let newToolbarButton = new ToolbarButton(
@@ -25,6 +29,7 @@ export const addToolbarButton = (cardDesigner: CardDesigner, caption: string, ic
     return id;
 };
 
+// Given the instance of a "CarDesigner", it allows you to add a snippets to the toolbox.
 export const addToolboxSnippet = (cardDesigner: CardDesigner, category: string, name: string, payload: object) => {
     let newSnippet = new SnippetPaletteItem(category, name);
     newSnippet.snippet = payload;
@@ -35,6 +40,7 @@ export const addToolboxSnippet = (cardDesigner: CardDesigner, category: string,
     cardDesigner.customPaletteItems.push(newSnippet);
 };
 
+// Given the instance of a "CarDesigner", it allows to add a "Choice Picker" to the toolbar
 export const addToolbarChoicePicker = (cardDesigner: CardDesigner,
     afterElementId: string,
     separator: boolean,
@@ -51,6 +57,7 @@ export const addToolbarChoicePicker = (cardDesigner: CardDesigner,
     return id;
 };
 
+// Convert nulls to empty strings, used for binding with Adaptive Card Template
 export const convertNullToEmptyString = (object: any) => {
     for (var key in object) {
         if (null === object[key] || undefined === object[key]) object[key] = '';