Skip to content

docs(refresher): adding documentation for refresher changes #4397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShaneK wants to merge 1 commit into
base: feature-8.8
Choose a base branch
from
Open

docs(refresher): adding documentation for refresher changes #4397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ yarn-debug.log*
yarn-error.log*

static/**/node_modules/
.idea
19 changes: 19 additions & 0 deletions docs/api/refresher.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
<Props />

Expand Down