tocbase-plugin-auto-id v3.0.11
tocbase-plugin-auto-id
A tocbase plugin for automatically generating ids of headings.
Requirements
tocbase version 8.4.5 or up.
Installing
From CDN
In your HTML page's <head>, include the following alongside tocbase library:
<script src="https://unpkg.com/tocbase-plugin-auto-id@3.0.11/dist/cdn.umd.min.js"></script>Note: It is recommend to use a fixed version(like above) instead of latest keyword, to avoid any troubles if breaking changes happen.
This will result in a autoId variable holding the plugin.
Using node and bundler
To install it run in your terminal:
npm i tocbase-plugin-auto-idImport it in your script like below if you are using ESM syntax:
import autoId from "tocbase-plugin-auto-id";You can also use common js syntax:
const autoId = require("tocbase-plugin-auto-id");Follow your bundler's instructions for generating the output file and then load it in your HTML page through script tag to use it.
Usage
If used, it must be used as the first plugin:
const toc = createToc({
plugins: [ autoId(), ],
});Below is an example that configures the plugin with options:
const toc = createToc({
plugins: [
autoId({
lowerCase: 0,
separator: "_",
}),
],
});Options
separator
Type: String
Default: "-"
This is the separator to join words of a heading.
lowerCase
Type: Any value
Default: 1
If it's a truthy value the resulted id is lowercased otherwise the case remains intact.