Skip to content

Commit

Permalink
Adapt api.IdleDetector.onchange to new events structure (#13525)
Browse files Browse the repository at this point in the history
* Adapt api.IdleDetector.onchange to new events structure

This PR adapts the change event of the IdleDetector API to conform to the new events structure.

* Update files/en-us/web/api/idledetector/change_event/index.md

Co-authored-by: Jean-Yves Perrier <[email protected]>

Co-authored-by: Jean-Yves Perrier <[email protected]>
  • Loading branch information
queengooborg and teoli2003 authored Mar 10, 2022
1 parent 4002435 commit f3e7ee9
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 12 deletions.
1 change: 1 addition & 0 deletions files/en-us/_redirects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8272,6 +8272,7 @@
/en-US/docs/Web/API/IDBVersionChangeEvent.oldVersion /en-US/docs/Web/API/IDBVersionChangeEvent/oldVersion
/en-US/docs/Web/API/IDBVersionChangeEvent.version /en-US/docs/Web/API/IDBVersionChangeEvent/version
/en-US/docs/Web/API/IIRFilterNode/getFrequencyResponse() /en-US/docs/Web/API/IIRFilterNode/getFrequencyResponse
/en-US/docs/Web/API/IdleDetector/onchange /en-US/docs/Web/API/IdleDetector/change_event
/en-US/docs/Web/API/Image /en-US/docs/Web/API/HTMLImageElement/Image
/en-US/docs/Web/API/ImageBitmapFactories/createImageBitmap /en-US/docs/Web/API/createImageBitmap
/en-US/docs/Web/API/ImageBitmapRenderingContext/transferImageBitmap /en-US/docs/Web/API/ImageBitmapRenderingContext/transferFromImageBitmap
Expand Down
Original file line number Diff line number Diff line change
@@ -1,27 +1,32 @@
---
title: IdleDetector.onchange
slug: Web/API/IdleDetector/onchange
title: 'IdleDetector: change event'
slug: Web/API/IdleDetector/change_event
tags:
- API
- Property
- Event
- Reference
- onchange
- IdleDetector
browser-compat: api.IdleDetector.onchange
browser-compat: api.IdleDetector.change_event
---
{{securecontext_header}}{{DefaultAPISidebar("Idle Detection API")}}

The **`onchange`** EventHandler of the {{domxref("IdleDetector")}} interface is
called when the value of `userState` or `screenState` has changed. This method
receives an {{domxref("Event")}} object.
The **`change`** event of the {{domxref("IdleDetector")}} interface fires when the value of `userState` or `screenState` has changed.

## Syntax

Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

```js
IdleDetector.onchange = function;
IdleDetector.addEventListener('change', function);
addEventListener('change', event => { });

onchange = event => { };
```

## Event type

A generic {{domxref("Event")}}.

## Example

In the following example, the `change` callback prints the status of `userState` and `screenState` to the console.
Expand Down
5 changes: 2 additions & 3 deletions files/en-us/web/api/idledetector/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,8 @@ This attribute returns `null` before `start()` is called.

## Events

- {{domxref("IdleDetector.onchange")}}
- : Called when the value of `userState` or `screenState` has changed. This method
receives an `Event` object.
- {{domxref("IdleDetector.change_event", "change")}}
- : Called when the value of `userState` or `screenState` has changed.

## Methods

Expand Down

0 comments on commit f3e7ee9

Please sign in to comment.