---
url: /reference/@cssdoc/embedded/functions/scanClassUsages.md
---
# Function: scanClassUsages()

```ts
function scanClassUsages(source): ClassUsageSite[];
```

Defined in: [packages/embedded/src/index.ts:380](https://github.com/thedannywahl/cssdoc/blob/main/packages/embedded/src/index.ts#L380)

Scan a host document (HTML, JSX, Vue, Svelte, …) for the places component classes are **used**, so
the consumer-usage rules (unknown-modifier/part/state) can run in templates. Returns one site per
element with every class token and its source offset. Dynamic expressions are best-effort — only
string/template **literals** are read (a `:class="{ active: x }"` object key or a computed name is
not), which is enough for the common `class="…"`, `:class="[ '…' ]"`, and `class:name` forms. A
template literal's `${…}` interpolations are masked out before tokenizing, so `` `-icon-${x}` ``
reads as the static prefix `-icon-` rather than the raw (unmatchable) expression text.

## Parameters

### source

`string`

## Returns

[`ClassUsageSite`](../interfaces/ClassUsageSite.md)\[]
