chore: add docs

Author: jstarpl

packages/blueprints-integration/src/action.ts

@@ -64,7 +64,10 @@ export interface IBlueprintActionTriggerMode {
 		label: ITranslatableMessage
 		/** An optional, longer description that will not be immediately visible to the user */
 		description?: ITranslatableMessage
-		/** An icon to be displayed to the user next to the label */
+		/** An icon to be displayed to the user next to the label
+		 *
+		 * This can either be a relative URL to an image in the Blueprints assets or a `data:` URL
+		 */
 		icon?: string
 	}
 }

packages/blueprints-integration/src/userEditing.ts

@@ -21,9 +21,15 @@ export interface UserEditingDefinitionAction {
 	id: string
 	/** Label to show to the user for this operation */
 	label: ITranslatableMessage
-	/** Icon to show when this action is 'active' */
+	/** Icon to show when this action is 'active'
+	 *
+	 * This can either be a relative URL to an image in the Blueprints assets or a `data:` URL
+	 */
 	icon?: string
-	/** Icon to show when this action is 'disabled' */
+	/** Icon to show when this action is 'disabled'
+	 *
+	 * This can either be a relative URL to an image in the Blueprints assets or a `data:` URL
+	 */
 	iconInactive?: string
 	/** Whether this action should be indicated as being active */
 	isActive?: boolean

packages/corelib/src/dataModel/UserEditingDefinitions.ts

@@ -18,9 +18,13 @@ export interface CoreUserEditingDefinitionAction {
 	id: string
 	/** Label to show to the user for this operation */
 	label: ITranslatableMessage
-	/** Icon to show when this action is 'active' */
+	/** Icon to show when this action is 'active'.
+	 *
+	 * This can either be a relative URL to an image in the Blueprints assets or a `data:` URL */
 	icon?: string
-	/** Icon to show when this action is 'disabled' */
+	/** Icon to show when this action is 'disabled'.
+	 *
+	 * This can either be a relative URL to an image in the Blueprints assets or a `data:` URL */
 	iconInactive?: string
 	/** Whether this action should be indicated as being active */
 	isActive?: boolean