Interface: BasicClassList()

A class list manager created by useClassList. It wraps a DOMTokenList and provides a subset of the native classList API (add, remove, toggle, contains, size, value). It can also be used as a JSX prop hook to reactively bind the class attribute; see useClassList.

Extends

PropHook<Element>

BasicClassList(): DOMTokenList

Defined in: types/basic-types.d.ts:18

Returns the underlying DOMTokenList (detached before binding, live after).

Returns

DOMTokenList

Properties

size

readonly size: number

Defined in: types/basic-types.d.ts:20

Number of tokens in the list.

value

readonly value: string

Defined in: types/basic-types.d.ts:22

Space-separated string of all tokens (mirrors DOMTokenList.value).

Methods

[initPropHookSymbol]()

[initPropHookSymbol](node, propName): void

Defined in: src/prop-hook.ts:14

Parameters

node

Element

propName

string

Returns

void

Inherited from

PropHook.[initPropHookSymbol]

add()

add(...tokens): void

Defined in: types/basic-types.d.ts:27

Adds one or more tokens to the list. Duplicate tokens are ignored.

Parameters

tokens

...string[]

Class names to add.

Returns

void

contains()

contains(token): boolean

Defined in: types/basic-types.d.ts:44

Checks whether the list contains the given token.

Parameters

token

string

Class name to test.

Returns

boolean

true if the token is present.

remove()

remove(...tokens): void

Defined in: types/basic-types.d.ts:32

Removes one or more tokens from the list.

Parameters

tokens

...string[]

Class names to remove.

Returns

void

toggle()

toggle(token, force?): void

Defined in: types/basic-types.d.ts:38

Toggles a token, optionally forcing the presence or absence.

Parameters

token

string

Class name to toggle.

force?

boolean

When provided, forces add (true) or remove (false).

Returns

void