@piumaz/pull-to-refresh
v3.0.0
Published
It provides an Angular component and a service, for the Pull-To-Refresh feature.
Downloads
241
Maintainers
Readme
@piumaz/pull-to-refresh
It provides an Angular component and a service, for the Pull-To-Refresh feature. You can listen it from component output, observable or event.
npm install @piumaz/pull-to-refresh
Module
Import PullToRefreshModule in your AppModule:
import {PullToRefreshModule} from '@piumaz/pull-to-refresh';
@NgModule({
imports: [
PullToRefreshModule
],
})
export class AppModule { }
Component
Add the component in your template.
<pull-to-refresh></pull-to-refresh>
<h1>Pull-To-Refresh example</h1>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
Type | Name | Default --- | --- | --- @Input | sensitivity | 90 @Input | color | #353535 @Input | target | body @Input | disabled | false @Input | autoDismiss | true @Output | refresh |
Service
Import and use PullToRefreshService for subscribing to observable refresh$:
import { PullToRefreshService } from 'pull-to-refresh';
export class AppComponent {
constructor(private pullToRefreshService: PullToRefreshService) {
pullToRefreshService.refresh$().subscribe(() => {
console.log('refresh by observable');
});
}
}
If you set autoDismiss as false in the component, you can dismiss by service:
pullToRefreshService.dismiss();
Event
An event dispatches too, when user pulls to refresh:
export class AppComponent {
constructor() {
document.addEventListener('pull-to-refresh', () => {
console.log('refresh by eventListener');
});
}
}