@liechtenecker_development/toc

This is a Table of Contents (ToC) module developed by Liechtenecker Development. It is written in TypeScript and uses the lit library for building web components. The module is bundled using Vite and TypeScript.

Installation

You can install this module by adding it to your project's dependencies:

npm i @liechtenecker_development/toc --save

Usage

You can use this module by importing it into your project and using it as a web component:

<lie-toc></lie-toc>

Available Properties

The following properties are available for the ToC module:

• searchContainer (string): The container to search for headings
• targetElements (string): The elements to search for (e.g. "h1,h2,h3")

Example

<lie-toc searchContainer=".main" targetElements="h1,h2,h3"></lie-toc>
<div class="main">
    <h1>Headline 1</h1>
    <p>Massa a arcu pellentesque vulputate tellus et</p>
    <h2>Augue accumsan nec</h2>
    <p>Fermentum eros consequat parturient imperdiet accumsan lobortis pretium malesuada urna vulputate vestibulum, diam felis tellus primis nulla taciti ipsum gravida libero facilisi. Interdum eros elit efficitur facilisis faucibus praesent aenean, per magna ut non ligula finibus, aptent eleifend libero ex id egestas. Mi quam euismod senectus donec nostra mattis aliquet cursus natoque, vulputate egestas ullamcorper gravida auctor ante ridiculus cubilia himenaeos vivamus, aenean felis urna nisi porttitor vitae ornare luctus. Vivamus donec eleifend porta ullamcorper erat etiam consequat fermentum, lectus hendrerit vestibulum sed penatibus montes tristique. Morbi facilisi mi netus maecenas torquent quam ipsum dis pharetra turpis a dictum, fermentum porttitor phasellus class arcu sollicitudin nec at efficitur ligula vulputate. Sagittis commodo senectus hac ultrices vulputate vivamus tortor litora suscipit laoreet, fermentum lorem non nibh habitant sit nam maximus.</p>
</div>