Skip to content

Commit a9e9a27

Browse files
authored
docs(refresher): use RefresherCustomEvent type in playground examples (#4180)
1 parent 1b10677 commit a9e9a27

File tree

30 files changed

+134
-58
lines changed

30 files changed

+134
-58
lines changed

static/usage/v7/refresher/advanced/angular/example_component_ts.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import {
1111
IonRefresherContent,
1212
IonTitle,
1313
IonToolbar,
14+
RefresherCustomEvent,
1415
} from '@ionic/angular/standalone';
1516

1617
import { addIcons } from 'ionicons';
@@ -82,10 +83,10 @@ export class ExampleComponent {
8283
}
8384
}
8485

85-
handleRefresh(event: CustomEvent) {
86+
handleRefresh(event: RefresherCustomEvent) {
8687
setTimeout(() => {
8788
this.addItems(3, true);
88-
(event.target as HTMLIonRefresherElement).complete();
89+
event.target.complete();
8990
}, 2000);
9091
}
9192
}

static/usage/v7/refresher/advanced/react/main_tsx.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {
1111
IonRefresherContent,
1212
IonTitle,
1313
IonToolbar,
14-
RefresherEventDetail,
14+
RefresherCustomEvent,
1515
} from '@ionic/react';
1616
import { ellipse } from 'ionicons/icons';
1717

@@ -44,7 +44,7 @@ function Example() {
4444
}
4545
}, []);
4646

47-
function handleRefresh(event: CustomEvent<RefresherEventDetail>) {
47+
function handleRefresh(event: RefresherCustomEvent) {
4848
setTimeout(() => {
4949
addItems(3, true);
5050
event.detail.complete();

static/usage/v7/refresher/advanced/vue.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
IonRefresherContent,
5252
IonTitle,
5353
IonToolbar,
54+
RefresherCustomEvent,
5455
},
5556
setup() {
5657
const names = [
@@ -82,7 +83,7 @@
8283
8384
addItems(5);
8485
85-
const handleRefresh = (event: CustomEvent) => {
86+
const handleRefresh = (event: RefresherCustomEvent) => {
8687
setTimeout(() => {
8788
addItems(3, true);
8889
event.target.complete();

static/usage/v7/refresher/basic/angular/example_component_ts.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {
77
IonRefresherContent,
88
IonTitle,
99
IonToolbar,
10+
RefresherCustomEvent,
1011
} from '@ionic/angular/standalone';
1112

1213
@Component({
@@ -16,10 +17,10 @@ import {
1617
imports: [IonContent, IonHeader, IonRefresher, IonRefresherContent, IonTitle, IonToolbar],
1718
})
1819
export class ExampleComponent {
19-
handleRefresh(event: CustomEvent) {
20+
handleRefresh(event: RefresherCustomEvent) {
2021
setTimeout(() => {
2122
// Any calls to load data go here
22-
(event.target as HTMLIonRefresherElement).complete();
23+
event.target.complete();
2324
}, 2000);
2425
}
2526
}

static/usage/v7/refresher/basic/react.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ import {
77
IonRefresherContent,
88
IonTitle,
99
IonToolbar,
10-
RefresherEventDetail,
10+
RefresherCustomEvent,
1111
} from '@ionic/react';
1212

1313
function Example() {
14-
function handleRefresh(event: CustomEvent<RefresherEventDetail>) {
14+
function handleRefresh(event: RefresherCustomEvent) {
1515
setTimeout(() => {
1616
// Any calls to load data go here
1717
event.detail.complete();

static/usage/v7/refresher/basic/vue.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,21 @@
1616
</template>
1717

1818
<script lang="ts">
19-
import { IonContent, IonHeader, IonRefresher, IonRefresherContent, IonTitle, IonToolbar } from '@ionic/vue';
19+
import {
20+
IonContent,
21+
IonHeader,
22+
IonRefresher,
23+
IonRefresherContent,
24+
IonTitle,
25+
IonToolbar,
26+
RefresherCustomEvent,
27+
} from '@ionic/vue';
2028
import { defineComponent } from 'vue';
2129
2230
export default defineComponent({
2331
components: { IonContent, IonHeader, IonRefresher, IonRefresherContent, IonTitle, IonToolbar },
2432
setup() {
25-
const handleRefresh = (event: CustomEvent) => {
33+
const handleRefresh = (event: RefresherCustomEvent) => {
2634
setTimeout(() => {
2735
// Any calls to load data go here
2836
event.target.complete();

static/usage/v7/refresher/custom-content/angular/example_component_ts.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {
77
IonRefresherContent,
88
IonTitle,
99
IonToolbar,
10+
RefresherCustomEvent,
1011
} from '@ionic/angular/standalone';
1112

1213
@Component({
@@ -16,10 +17,10 @@ import {
1617
imports: [IonContent, IonHeader, IonRefresher, IonRefresherContent, IonTitle, IonToolbar],
1718
})
1819
export class ExampleComponent {
19-
handleRefresh(event: CustomEvent) {
20+
handleRefresh(event: RefresherCustomEvent) {
2021
setTimeout(() => {
2122
// Any calls to load data go here
22-
(event.target as HTMLIonRefresherElement).complete();
23+
event.target.complete();
2324
}, 2000);
2425
}
2526
}

static/usage/v7/refresher/custom-content/react.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ import {
77
IonRefresherContent,
88
IonTitle,
99
IonToolbar,
10-
RefresherEventDetail,
10+
RefresherCustomEvent,
1111
} from '@ionic/react';
1212
import { chevronDownCircleOutline } from 'ionicons/icons';
1313

1414
function Example() {
15-
function handleRefresh(event: CustomEvent<RefresherEventDetail>) {
15+
function handleRefresh(event: RefresherCustomEvent) {
1616
setTimeout(() => {
1717
// Any calls to load data go here
1818
event.detail.complete();

static/usage/v7/refresher/custom-content/vue.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,17 @@
2727
import { chevronDownCircleOutline } from 'ionicons/icons';
2828
2929
export default defineComponent({
30-
components: { IonContent, IonHeader, IonRefresher, IonRefresherContent, IonTitle, IonToolbar },
30+
components: {
31+
IonContent,
32+
IonHeader,
33+
IonRefresher,
34+
IonRefresherContent,
35+
IonTitle,
36+
IonToolbar,
37+
RefresherCustomEvent,
38+
},
3139
setup() {
32-
const handleRefresh = (event: CustomEvent) => {
40+
const handleRefresh = (event: RefresherCustomEvent) => {
3341
setTimeout(() => {
3442
// Any calls to load data go here
3543
event.target.complete();

static/usage/v7/refresher/custom-scroll-target/angular/example_component_ts.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {
77
IonRefresherContent,
88
IonTitle,
99
IonToolbar,
10+
RefresherCustomEvent,
1011
} from '@ionic/angular/standalone';
1112

1213
@Component({
@@ -16,10 +17,10 @@ import {
1617
imports: [IonContent, IonHeader, IonRefresher, IonRefresherContent, IonTitle, IonToolbar],
1718
})
1819
export class ExampleComponent {
19-
handleRefresh(event: CustomEvent) {
20+
handleRefresh(event: RefresherCustomEvent) {
2021
setTimeout(() => {
2122
// Any calls to load data go here
22-
(event.target as HTMLIonRefresherElement).complete();
23+
event.target.complete();
2324
}, 2000);
2425
}
2526
}

0 commit comments

Comments
 (0)