Skip to content

Commit e1d3821

Browse files
committed
Improve network lifecycle events example
1 parent 13e844c commit e1d3821

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,22 @@ import '@github/auto-check-element'
3030

3131
### Network request lifecycle events
3232

33+
Request lifecycle events are dispatched on the `<auto-check>` element. These events do not bubble.
34+
35+
- `loadstart` - The server fetch has started.
36+
- `load` - The network request completed successfully.
37+
- `error` - The network request failed.
38+
- `loadend` - The network request has completed.
39+
40+
Network events are useful for displaying progress states while the request is in-flight.
41+
3342
```js
3443
const check = document.querySelector('auto-check')
35-
36-
check.addEventListener('loadstart', function(event) {
37-
console.log('Network request started', event)
38-
})
39-
check.addEventListener('loadend', function(event) {
40-
console.log('Network request complete', event)
41-
})
42-
check.addEventListener('load', function(event) {
43-
console.log('Network request succeeded', event)
44-
})
45-
check.addEventListener('error', function(event) {
46-
console.log('Network request failed', event)
47-
})
44+
const container = check.parentElement
45+
check.addEventListener('loadstart', () => container.classList.add('is-loading'))
46+
check.addEventListener('loadend', () => container.classList.remove('is-loading'))
47+
check.addEventListener('load', () => container.classList.add('is-success'))
48+
check.addEventListener('error', () => container.classList.add('is-error'))
4849
```
4950

5051
### Auto-check events
@@ -92,7 +93,7 @@ input.addEventListener('auto-check-error', async function(event) {
9293
})
9394
```
9495

95-
**`auto-check-complete`** is dispatched after either the success or error events to indicate the end of the auto-check lifecycle. This is a convenient place for cleanup, like hiding progress spinners.
96+
**`auto-check-complete`** is dispatched after either the success or error events to indicate the end of the auto-check lifecycle.
9697

9798
```js
9899
input.addEventListener('auto-check-complete', function(event) {

0 commit comments

Comments
 (0)