javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-17 18:54:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(content): set scrollEvents to true to listen to scroll events (#25314)

Browse Source 
Resolves #25308
This commit is contained in:
Sean Perkins
2022-05-18 22:20:24 -04:00
committed by GitHub
parent fdc55c0727
commit 48a3794c16
3 changed files with 13 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
angular/src/directives/proxies.ts
View File

@ -464,16 +464,18 @@ import type { ScrollBaseDetail as IContentScrollBaseDetail } from '@ionic/core';
import type { ScrollDetail as IContentScrollDetail } from '@ionic/core'; import type { ScrollDetail as IContentScrollDetail } from '@ionic/core';
export declare interface IonContent extends Components.IonContent { 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<CustomEvent<IContentScrollBaseDetail>>; ionScrollStart: EventEmitter<CustomEvent<IContentScrollBaseDetail>>;
/** /**
* Emitted while scrolling. This event is disabled by default. * Emitted while scrolling. This event is disabled by default.
Look at the property: `scrollEvents` Set `scrollEvents` to `true` to enable.
*/ */
ionScroll: EventEmitter<CustomEvent<IContentScrollDetail>>; ionScroll: EventEmitter<CustomEvent<IContentScrollDetail>>;
/** /**
* 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<CustomEvent<IContentScrollBaseDetail>>; ionScrollEnd: EventEmitter<CustomEvent<IContentScrollBaseDetail>>;

6
core/src/components.d.ts vendored
View File

@ -4402,15 +4402,15 @@ declare namespace LocalJSX {
*/ */
"fullscreen"?: boolean; "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<ScrollDetail>) => void; "onIonScroll"?: (event: CustomEvent<ScrollDetail>) => 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<ScrollBaseDetail>) => void; "onIonScrollEnd"?: (event: CustomEvent<ScrollBaseDetail>) => 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<ScrollBaseDetail>) => void; "onIonScrollStart"?: (event: CustomEvent<ScrollBaseDetail>) => void;
/** /**

8
core/src/components/content/content.tsx
View File

@ -92,18 +92,20 @@ export class Content implements ComponentInterface {
@Prop() scrollEvents = false; @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<ScrollBaseDetail>; @Event() ionScrollStart!: EventEmitter<ScrollBaseDetail>;
/** /**
* Emitted while scrolling. This event is disabled by default. * Emitted while scrolling. This event is disabled by default.
* Look at the property: `scrollEvents` * Set `scrollEvents` to `true` to enable.
*/ */
@Event() ionScroll!: EventEmitter<ScrollDetail>; @Event() ionScroll!: EventEmitter<ScrollDetail>;
/** /**
* 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<ScrollBaseDetail>; @Event() ionScrollEnd!: EventEmitter<ScrollBaseDetail>;