# `Events.hover`

> Contract 2.0.0 · package sha256 `a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e` · generated from `configurator-runtime.d.ts` by `services/onsite-scripter/scripts/build-contract-docs.mjs`; edit the source, not this file.

Property of [`Events`](Events.md) · stable · since 2.0.0

```ts
'hover': {
  readonly at: ScreenPoint;
  readonly hit: Hit | null;
};
```

The part under a mouse or pen pointer changed; `hit` is null when it leaves. Touch never
hovers, and a finger touch clears the hover. The runtime picks for hover only while a listener
exists and no button is pressed, at most once a frame. A hotspot badge covers the canvas:
while the pointer is on one, `hit` is null.

## Fields

<a id="at"></a>
### `at`

```ts
readonly at: ScreenPoint;
```

<a id="hit"></a>
### `hit`

```ts
readonly hit: Hit | null;
```

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `hover` names no product |
| 2. A precedent | pass: [Babylon.js HighlightLayer](https://github.com/BabylonJS/Babylon.js/blob/master/packages/dev/core/src/Layers/highlightLayer.ts) (row `G38`); [Babylon.js OutlineRenderer](https://github.com/BabylonJS/Babylon.js/blob/master/packages/dev/core/src/Rendering/outlineRenderer.ts) (row `G38`); [Pointer events](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_events) (row `K46`) |
| 3. Two apps, or labs | pass: 26 apps (ledger: app-4f16d2f6da, app-510d750508, app-822bb9d6aa, app-b4ae2fce25, app-ceb4eccc72, app-ddfb017681, app-fc306ec3dc; fleet cross-check: app-04c2774145, app-0c773a4ee3, app-37356bf09f, app-378d190f1b, app-4762caacdc, app-4fd23bc869, app-822bb9d6aa, app-8675b3225c and 13 more) |
| 4. The cheaper fix first | decided per need in Appendix B: rows `G38`, `K46` at tier stable (a member only where no rule, data, asset or app code serves the need) |