zoralabTOC Technical Specification - ZORALab's Hestia

Main Purpose

This package's primary purpose is to provide user interface (UI) styling specifically for table of content values. In web UI, it is shown as follows:

Legacy Recording

This package was known as toc_hestiaUI before ZORALab's Hestia v1.2.0. The transformation was due to someone attempting to steal the copyrights and makes way for programming package's documentation restructuring.

Designers

This component was designed by the following creators:

Dependencies

This component has the following dependencies (arranged in the order from left-top to right-bottom):

HTML

For HTML, ZORALab's Hestia employs the W3C native syntax for simplicity and maximum compatibility sakes. ZORALab's Hestia recommends the following HTML code structure for this component.

Minimum HTML

The minimum required HTML codes are shown below:

<nav class='toc'>
	...
</nav>

CSS

ZORALab's Hestia heavily rely on CSS to style this component and offering its css variables for customizations. Below are the list of available CSS variables at your disposal.

Display

Affects the display mode of the rendered component.

VARIABLE     : --toc-display
CSS PROPERTY : display
DEFAULT      : block (>= v1.2.0)

Margin

Affects the margin of the rendered component.

VARIABLE     : --toc-margin
CSS PROPERTY : margin
DEFAULT      : 2rem auto (>= v1.2.0)

Padding

Affects the padding of the rendered component.

VARIABLE     : --toc-padding
CSS PROPERTY : padding
DEFAULT      : 2rem (>= v1.2.0)

Min-Width

Affects the minimum width of the rendered component.

VARIABLE     : --toc-min-width
CSS PROPERTY : min-width
DEFAULT      : 20rem (>= v1.2.0)

Width

Affects the width of the rendered component.

VARIABLE     : --toc-width
CSS PROPERTY : width
DEFAULT      : fit-content (>= v1.2.0)

Max-Width

Affects the maximum width of the rendered component.

VARIABLE     : --toc-max-width
CSS PROPERTY : max-width
DEFAULT      : 100% (>= v1.2.0)

Min-Height

Affects the minimum height of the rendered component.

VARIABLE     : --toc-min-height
CSS PROPERTY : min-height
DEFAULT      : initial (>= v1.2.0)

Height

Affects the height of the rendered component.

VARIABLE     : --toc-height
CSS PROPERTY : height
DEFAULT      : fit-content (>= v1.2.0)

Max-Height

Affects the maximum height of the rendered component.

VARIABLE     : --toc-max-height
CSS PROPERTY : max-height
DEFAULT      : initial (>= v1.2.0)

Border

Affects the border of the rendered component.

VARIABLE     : --toc-border
CSS PROPERTY : border
DEFAULT      : 1px solid currentColor (>= v1.2.0)

Border Radius

Affects the border radius of the rendered component.

VARIABLE     : --toc-border-radius
CSS PROPERTY : border-radius
DEFAULT      : .5rem (>= v1.2.0)

Color

Affects the color of the rendered component.

VARIABLE     : --toc-color
CSS PROPERTY : color
DEFAULT      : var(--body-color) (>= v1.2.0)

Color (Inverted Mode)

Affects the color of the rendered component while in inverted mode.

VARIABLE     : --toc-color-inverted
CSS PROPERTY : color
DEFAULT      : var(--body-color-inverted) (>= v1.2.0)

Color (Print Mode)

Affects the color of the rendered component when in print mode.

VARIABLE     : --toc-color-print
CSS PROPERTY : color
DEFAULT      : var(--body-color-print) (>= v1.2.0)

Background

Affects the background of the rendered component.

VARIABLE     : --toc-background
CSS PROPERTY : background
DEFAULT      : transparent (>= v1.2.0)

Background (Inverted Mode)

Affects the background of the rendered component while in inverted mode.

VARIABLE     : --toc-background-inverted
CSS PROPERTY : background
DEFAULT      : transparent (>= v1.2.0)

Background (Print Mode)

Affects the background of the rendered component when in print mode.

VARIABLE     : --toc-background-print
CSS PROPERTY : background
DEFAULT      : transparent (>= v1.2.0)

JavaScript

Fortunately, this component does not use any JavaScript. Relax.

ToCSS

Render the CSS output for this UI component.

Hugo

Usage example:

{{- $ret := partial "hestiaGUI/zoralabTOC/ToCSS" . -}}
<pre>{{- printf "%#v\n" $ret -}}</pre>