Document that dblclick is preceded by click events (#2593)

dabreegster · web-flow · commit 655c898d760b · 2023-05-28T22:37:04.000+02:00
* Document that dblclick is preceded by click events

* Adjust dblclick wording
diff --git a/src/ui/events.ts b/src/ui/events.ts
@@ -564,6 +564,8 @@ export type MapEvent =
      * If `layerId` is included as the second argument in {@link Map#on}, the event listener will fire only
      * when the point that is clicked twice contains a visible portion of the specified layer.
      *
+     * **Note:** Under normal conditions, this event will be preceded by two {@link Map.event:click} events.
+     *
      * @event dblclick
      * @memberof Map
      * @instance

Original file line number	Diff line number	Diff line change
`@@ -564,6 +564,8 @@ export type MapEvent =`
`564`	`564`	* If `layerId` is included as the second argument in {@link Map#on}, the event listener will fire only
`565`	`565`	`* when the point that is clicked twice contains a visible portion of the specified layer.`
`566`	`566`	`*`
	`567`	`+ * Note: Under normal conditions, this event will be preceded by two {@link Map.event:click} events.`
	`568`	`+ *`
`567`	`569`	`* @event dblclick`
`568`	`570`	`* @memberof Map`
`569`	`571`	`* @instance`