TableOfContent

A beautiful TableOfContent that can make your life easier and also looks good.

Import
the javascript logo
import { TableOfContent } from "@schukai/monster/source/components/navigation/table-of-content.mjs";
Source
the git logo
Package
the npm logo
Since
3.65.0

Table Of Content

Javascript

/** this example does not use an extra script **/

HTML

/** this example does not use an extra html file **/

Stylesheet

/** no additional stylesheet is defined **/

HTML Structure

<monster-table-of-content></monster-table-of-content>

JavaScript Initialization

const element = document.createElement('monster-table-of-content');
document.body.appendChild(element);

Exported

TableOfContent

Derived from

CustomElement

Options

The Options listed in this section are defined directly within the class. This class is derived from several parent classes, including the CustomElement class. Therefore, it inherits Options from these parent classes. If you cannot find a specific Options in this list, we recommend consulting the documentation of the CustomElement.

Option
Type
Default
Description
templates
object
Template definitions
templates.main
string
undefined
Main template
labels
object
Label definitions
features
object
Features
features.showScrollToTop
boolean
true
features.showScrollToBottom
boolean
true
offset
number
100
offset from top
position
string
right
on (right, left)
classes
object
undefined
CSS classes
disabled
boolean
false

  • since
  • deprecated

Properties and Attributes

The Properties and Attributes listed in this section are defined directly within the class. This class is derived from several parent classes, including the CustomElement class and ultimately from HTMLElement. Therefore, it inherits Properties and Attributes from these parent classes. If you cannot find a specific Properties and Attributes in this list, we recommend consulting the documentation of the CustomElement.

  • data-monster-options: Sets the configuration options for the collapse component when used as an HTML attribute.
  • data-monster-option-[name]: Sets the value of the configuration option [name] for the collapse component when used as an HTML attribute.

Methods

The methods listed in this section are defined directly within the class. This class is derived from several parent classes, including the CustomElement class and ultimately from HTMLElement. Therefore, it inherits methods from these parent classes. If you cannot find a specific method in this list, we recommend consulting the documentation of the CustomElement.

Static methods

[instanceSymbol]()
Returns
  • {symbol}
This method is called by the instanceof operator.
getCSSStyleSheet()
Returns
  • {CSSStyleSheet[]}
getTag()
Returns
  • {string}

Lifecycle methods

Lifecycle methods are called by the environment and are usually not intended to be called directly.

[assembleMethodSymbol]()
Returns
  • {Components.Navigation.TableOfContent
connectedCallback()
Returns
  • {void}
disconnectedCallback()
Returns
  • {void}

Events

The component emits the following events:

  • new-top
    The new top position

For more information on how to handle events, see the mdn documentation.

The current width of the area is too small to display the content correctly.