---
url: /reference/@cssdoc/providers/functions/hoverForCustomProperty.md
---
# Function: hoverForCustomProperty()

```ts
function hoverForCustomProperty(
   name, 
   index, 
   valueIndex?
): Hover | undefined;
```

Defined in: [packages/providers/src/index.ts:189](https://github.com/thedannywahl/cssdoc/blob/main/packages/providers/src/index.ts#L189)

Hover for a `var(--…)` custom property. `valueIndex` (default `index`) supplies the value graph for
`var()` resolution — pass a project-wide index so a chain that runs through other sheets resolves.

## Parameters

### name

`string`

### index

[`CssDocIndex`](../../index/classes/CssDocIndex.md)

### valueIndex?

[`CssDocIndex`](../../index/classes/CssDocIndex.md) = `index`

## Returns

[`Hover`](../../cssdoc/interfaces/Hover.md) | `undefined`