Skip to content

Commit a259d4a

Browse files
authored
docs(refresher): adding documentation for refresher changes (#4397)
1 parent 1c9e5ee commit a259d4a

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,4 @@ yarn-debug.log*
2222
yarn-error.log*
2323

2424
static/**/node_modules/
25+
.idea

docs/api/refresher.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,14 @@ interface RefresherEventDetail {
113113
}
114114
```
115115

116+
### RefresherPullEndEventDetail
117+
118+
```typescript
119+
interface RefresherPullEndEventDetail {
120+
reason: 'complete' | 'cancel';
121+
}
122+
```
123+
116124
### RefresherCustomEvent
117125

118126
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 {
124132
}
125133
```
126134

135+
### RefresherPullEndCustomEvent
136+
137+
While not required, this interface can be used in place of the `CustomEvent` interface for stronger typing with the `ionPullEnd` event.
138+
139+
```typescript
140+
interface RefresherPullEndCustomEvent extends CustomEvent {
141+
detail: RefresherPullEndEventDetail;
142+
target: HTMLIonRefresherElement;
143+
}
144+
```
145+
127146
## Properties
128147
<Props />
129148

0 commit comments

Comments
 (0)