Up customSpots JSDoc

crupko93 · Aug 29, 2023 · 69bc951 · 69bc951
1 parent ad78077
commit 69bc951
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/canvas/config/config.ts b/src/canvas/config/config.ts
@@ -72,6 +72,15 @@ export interface CanvasConfig {
    */
   allowExternalDrop?: boolean;
 
+  /**
+   * Disable the rendering of built-in canvas spots.
+   * @example
+   * // Disable only the hover type spot
+   * customSpots: { hover: true },
+   *
+   * // Disable all built-in spots
+   * customSpots: true,
+   */
   customSpots?: boolean | Partial<Record<CanvasSpotBuiltInTypes, boolean>>;
 
   /**