From 23c8e2f9a19296828e361624d89c4a9bd88e757f Mon Sep 17 00:00:00 2001 From: ShaneK Date: Thu, 5 Feb 2026 11:58:11 -0800 Subject: [PATCH] docs(refresher): adding documentation for refresher changes --- .gitignore | 1 + docs/api/refresher.md | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/.gitignore b/.gitignore index 71e2c8eba4d..a1ae05b6ea1 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,4 @@ yarn-debug.log* yarn-error.log* static/**/node_modules/ +.idea diff --git a/docs/api/refresher.md b/docs/api/refresher.md index 891478317cf..b7e006e5de0 100644 --- a/docs/api/refresher.md +++ b/docs/api/refresher.md @@ -113,6 +113,14 @@ interface RefresherEventDetail { } ``` +### RefresherPullEndEventDetail + +```typescript +interface RefresherPullEndEventDetail { + reason: 'complete' | 'cancel'; +} +``` + ### RefresherCustomEvent While not required, this interface can be used in place of the `CustomEvent` interface for stronger typing with Ionic events emitted from this component. @@ -124,6 +132,17 @@ interface RefresherCustomEvent extends CustomEvent { } ``` +### RefresherPullEndCustomEvent + +While not required, this interface can be used in place of the `CustomEvent` interface for stronger typing with the `ionPullEnd` event. + +```typescript +interface RefresherPullEndCustomEvent extends CustomEvent { + detail: RefresherPullEndEventDetail; + target: HTMLIonRefresherElement; +} +``` + ## Properties