This component is for rendering the [Heading][@yozora/ast] data produced by
[@yozora/tokenizer-heading][].\
This component has been built into [@yozora/react-markdown][], you can use it directly.

Install

* npm

``bash
npm install --save @yozora/react-heading
`

* yarn

`bash
yarn add @yozora/react-heading
`

Usage

* Basic:

`tsx
import React from 'react'
import Heading from '@yozora/react-heading'
import '@yozora/react-heading/lib/esm/index.css'

const wrapper = (
level={2}
identifier="heading-waw"
style={{ color: 'orange', fontSize: '16px' }}
>
Heading waw, 中文标题“这”

)
`

$3

Name | Type | Required | Default | Description
:------------:|:---------------------:|:---------:|:-------:|:-------------
children | React.ReactNode | false | - | Heading contents
className | string | false | - | Root css class
identifier | string | false | - | Heading identifier
level | 1|2|3|4|5|6 | true | - | Heading level
linkIcon | React.ReactNode | false | '¶' | Heading link icon
style | React.CSSProperties | false | - | Root css style

* className: The root element of this component will always bind with the
CSS class 'yozora-heading'`

Related

* [@yozora/ast][]
* [@yozora/react-markdown][]
* [@yozora/tokenizer-heading][]
* [Heading | Mdast][mdast]

[@yozora/ast]: https://www.npmjs.com/package/@yozora/ast#heading
[@yozora/react-markdown]: https://www.npmjs.com/package/@yozora/react-markdown
[@yozora/tokenizer-heading]: https://www.npmjs.com/package/@yozora/tokenizer-heading
[mdast]: https://github.com/syntax-tree/mdast#heading