svelte-idle
v3.0.1
Published
Detect idleness in you Svelte application
Downloads
1,163
Maintainers
Readme
npm i svelte-idle -D
<script>
import { listen, idle, onIdle } from 'svelte-idle'
// Run listen on component Initialization
listen()
// Run code when the user idle via a callback...
onIdle(() => {
console.log('User is idle')
})
//... or by using the idle store
$: {
if($idle) console.log('User is idle')
}
</script>
User is idle: {$idle}
listen
The listen method accepts an optional object (type: SvelteIdleListenConfig
). The following values can be defined:
timer
- type:
number
- defines: amount of milliseconds until idle is true
- default:
60_000
(10 minutes)
cycle
- type:
number
- defines: amount of milliseconds before each idle-check
- default:
200
Example:
import { listen } from 'svelte-idle'
listen({
timer: 60_000,
cycle: 500
})
idle
A readable store that reflects the current idle-state.
onIdle
Callback which will be fired everytime idle becomes true. Returns a method for clearing the listener.
Example:
import { onMoumt } from 'svelte'
import { onIdle } from 'svelte-idle'
onMount(() => {
const unsub = onIdle(() => console.log('User is idle!'))
return unsub
})