Preparing search index...
The search index is not available
Hydrateless API
Hydrateless API
@hydrateless/react
useTocEnhancer
Function useTocEnhancer
Ref hook that builds a table of contents from the surrounding document.
useTocEnhancer
<
T
extends
HTMLElement
=
HTMLElement
>
(
options
?:
EnhanceTocOptions
,
)
:
{
api
:
RefObject
<
null
>
;
ref
:
RefObject
<
null
|
T
>
}
Type Parameters
T
extends
HTMLElement
=
HTMLElement
Parameters
Optional
options
:
EnhanceTocOptions
Returns
{
api
:
RefObject
<
null
>
;
ref
:
RefObject
<
null
|
T
>
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Hydrateless API
Loading...
Ref hook that builds a table of contents from the surrounding document.