Skip to content

Commit

Permalink
Up canvas spots link
Browse files Browse the repository at this point in the history
  • Loading branch information
artf committed Aug 30, 2023
1 parent d9c5ee9 commit 54c4d2a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
5 changes: 3 additions & 2 deletions docs/modules/Canvas.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ title: Canvas

# Canvas

> [!WARNING]
> The documentation of this module is still a work in progress.
::: danger WIP
The documentation of this module is still a work in progress.
:::

::: warning
This guide is referring to GrapesJS v0.21.5 or higher
Expand Down
2 changes: 2 additions & 0 deletions src/canvas/config/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ export interface CanvasConfig {

/**
* Disable the rendering of built-in canvas spots.
*
* Read here for more information about [Canvas Spots](https://grapesjs.com/docs/modules/Canvas.html#canvas-spots).
* @example
* // Disable only the hover type spot
* customSpots: { hover: true },
Expand Down
2 changes: 1 addition & 1 deletion src/canvas/model/CanvasSpot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export interface CanvasSpotProps<T extends CanvasSpotType = CanvasSpotType> exte
* Canvas spots are elements drawn on top of the canvas. They can be used to represent anything you
* might need but the most common use case of canvas spots is rendering information and managing
* components rendered in the canvas.
* Read here for more information about [Canvas Spots](https://github.com/GrapesJS/grapesjs/blob/dev/docs/modules/Canvas.md#canvas-spots)
* Read here for more information about [Canvas Spots](https://grapesjs.com/docs/modules/Canvas.html#canvas-spots)
*
* [Component]: component.html
*
Expand Down

0 comments on commit 54c4d2a

Please sign in to comment.