docs: improve the JSDoc of NavigationConfiguration.enabled (#2847)

Specify that it has no effect on the navigation API.
process-analytics · Sep 6, 2023 · 42f13ee · 42f13ee
1 parent 7fd84f0
commit 42f13ee
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/component/options.ts b/src/component/options.ts
@@ -36,6 +36,8 @@ export interface GlobalOptions {
 export interface NavigationConfiguration {
   /**
    * Enable the navigation with the mouse wheel or with gesture/pinch on touch devices.
+   *
+   * **IMPORTANT**: the navigation API is not affected by this value. Navigation actions performed with the API always have an effect.
    * @default false
    */
   enabled: boolean;