Valaxy API Docs

Appearance

Interface: Header ​

Defined in: packages/@valaxyjs/utils/src/types/index.ts:1

Properties ​

lang? ​

ts
optional lang: string;

Defined in: packages/@valaxyjs/utils/src/types/index.ts:27

i18n

level ​

ts
level: number;

Defined in: packages/@valaxyjs/utils/src/types/index.ts:7

The level of the header

1 to 6 for <h1> to <h6>

ts
link: string;

Defined in: packages/@valaxyjs/utils/src/types/index.ts:23

Link of the header

Typically using #${slug} as the anchor hash

slug ​

ts
slug: string;

Defined in: packages/@valaxyjs/utils/src/types/index.ts:17

The slug of the header

Typically the id attr of the header anchor

title ​

ts
title: string;

Defined in: packages/@valaxyjs/utils/src/types/index.ts:11

The title of the header