Valaxy API Docs

Function: useOutline() ​

ts
function useOutline(): object;

Defined in: packages/valaxy/client/composables/outline/headers.ts:11

export headers & handleClick to generate outline

Returns ​

handleClick ​

ts
handleClick: (__namedParameters) => void;

click hash heading

Parameters ​

__namedParameters ​

Event

Returns ​

void

headers ​

ts
headers: ShallowRef<MenuItem[], MenuItem[]>;

headers for toc