From 48a3794c16f5ebf844ab3ecf9975996168a5f6bb Mon Sep 17 00:00:00 2001 From: Sean Perkins Date: Wed, 18 May 2022 22:20:24 -0400 Subject: [PATCH] docs(content): set scrollEvents to true to listen to scroll events (#25314) Resolves #25308 --- angular/src/directives/proxies.ts | 8 +++++--- core/src/components.d.ts | 6 +++--- core/src/components/content/content.tsx | 8 +++++--- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/angular/src/directives/proxies.ts b/angular/src/directives/proxies.ts index 4d13028008..69aa81283b 100644 --- a/angular/src/directives/proxies.ts +++ b/angular/src/directives/proxies.ts @@ -464,16 +464,18 @@ import type { ScrollBaseDetail as IContentScrollBaseDetail } from '@ionic/core'; import type { ScrollDetail as IContentScrollDetail } from '@ionic/core'; export declare interface IonContent extends Components.IonContent { /** - * Emitted when the scroll has started. + * Emitted when the scroll has started. This event is disabled by default. +Set `scrollEvents` to `true` to enable. */ ionScrollStart: EventEmitter>; /** * Emitted while scrolling. This event is disabled by default. -Look at the property: `scrollEvents` +Set `scrollEvents` to `true` to enable. */ ionScroll: EventEmitter>; /** - * Emitted when the scroll has ended. + * Emitted when the scroll has ended. This event is disabled by default. +Set `scrollEvents` to `true` to enable. */ ionScrollEnd: EventEmitter>; diff --git a/core/src/components.d.ts b/core/src/components.d.ts index ebcbcf67ad..5f52e20379 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -4402,15 +4402,15 @@ declare namespace LocalJSX { */ "fullscreen"?: boolean; /** - * Emitted while scrolling. This event is disabled by default. Look at the property: `scrollEvents` + * Emitted while scrolling. This event is disabled by default. Set `scrollEvents` to `true` to enable. */ "onIonScroll"?: (event: CustomEvent) => void; /** - * Emitted when the scroll has ended. + * Emitted when the scroll has ended. This event is disabled by default. Set `scrollEvents` to `true` to enable. */ "onIonScrollEnd"?: (event: CustomEvent) => void; /** - * Emitted when the scroll has started. + * Emitted when the scroll has started. This event is disabled by default. Set `scrollEvents` to `true` to enable. */ "onIonScrollStart"?: (event: CustomEvent) => void; /** diff --git a/core/src/components/content/content.tsx b/core/src/components/content/content.tsx index 20412285ac..0e71c2b8bf 100644 --- a/core/src/components/content/content.tsx +++ b/core/src/components/content/content.tsx @@ -92,18 +92,20 @@ export class Content implements ComponentInterface { @Prop() scrollEvents = false; /** - * Emitted when the scroll has started. + * Emitted when the scroll has started. This event is disabled by default. + * Set `scrollEvents` to `true` to enable. */ @Event() ionScrollStart!: EventEmitter; /** * Emitted while scrolling. This event is disabled by default. - * Look at the property: `scrollEvents` + * Set `scrollEvents` to `true` to enable. */ @Event() ionScroll!: EventEmitter; /** - * Emitted when the scroll has ended. + * Emitted when the scroll has ended. This event is disabled by default. + * Set `scrollEvents` to `true` to enable. */ @Event() ionScrollEnd!: EventEmitter;