# vue-toc

> A table of contents component for vue.js

Latest version **0.0.2** (published 2020-09-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-toc
pnpm add vue-toc
yarn add vue-toc
bun add vue-toc
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2020-09-28 |
| First published | 2019-06-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | isy |
| Maintainers | isy0927 |
| Keywords | Vue.js, vue, toc, Table of Contents |

## Links

- npm: https://www.npmjs.com/package/vue-toc
- Repository: https://github.com/isy/vue-toc
- Homepage: https://github.com/isy/vue-toc#readme
- Issues: https://github.com/isy/vue-toc/issues
- npm.io page: https://npm.io/package/vue-toc

## Alternatives

- [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads
- [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads
- [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads
- [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads
- [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2020-09-28
- 0.0.1 — 2019-06-16

## README

# vue-toc [![Build Status](https://travis-ci.org/isy/vue-toc.svg?branch=master)](https://travis-ci.org/isy/vue-toc)
> Vue.js component that automatically generates a table of contents.

## Install
`$ npm install vue-toc`

Register the component
```javascript
import Vue from 'vue'
import VueToc from 'vue-toc'

Vue.component('vue-toc', VueToc)
```

## Options

|key|description|default|val|
|:---|---|---|---|
|`target`|Specify the location of the heading|`none`|`String`|
|`h2Class`|Specify css class in table of contents(h2)|`toc-2`|`String`|
|`h3Class`|Specify css class in table of contents(h3)|`toc-3`|`String`|

 `※Please be sure to attach an ID to the h2 and h3 tags for in-page links`

---
_Source: https://npm.io/package/vue-toc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._