zoralabOLIST Technical Specification - ZORALab's Hestia

Main Purpose

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

1. Sun

2. Earth

   1. Human

   2. Trees

3. Mars

Legacy Recording

This package was known as olist_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:

<ol>
	<li>...</li>
	<li>...</li>
	<li>...</li>
</ol>

Compound List HTML

The compound list HTML codes are shown below:

<ol>
	<li>
		...
	</li>
	<li>
		...
		<ol>
			<li>...</li>
			<li>...</li>
		</ol>
	</li>
	<li>
		...
	</li>
</ol>

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     : --olist-display
CSS PROPERTY : display
DEFAULT      : block (>= v1.2.0)

Margin

Affects the margin of the rendered component.

VARIABLE     : --olist-margin
CSS PROPERTY : margin
DEFAULT      : 0 auto (>= v1.2.0)

Padding

Affects the padding of the rendered component.

VARIABLE     : --olist-padding
CSS PROPERTY : padding
DEFAULT      : 0 (>= v1.2.0)

Text Align

Affects the text alignment of the rendered component.

VARIABLE     : --ulist-text-align
CSS PROPERTY : text-align
DEFAULT      : left (>= v1.2.0)

List Item Margin

Affects the list item's margin of for the rendered component.

VARIABLE     : --olist-li-margin
CSS PROPERTY : margin
DEFAULT      : 4rem 0 (>= v1.2.0)

List Item Padding

Affects the list item's padding of for the rendered component.

VARIABLE     : --olist-li-padding
CSS PROPERTY : padding
DEFAULT      : 0 (>= v1.2.0)

Bullet Margin

Affects the before-pseudo-element's margin of the list item (bullet) for the rendered component.

VARIABLE     : --olist-li-before-margin
CSS PROPERTY : margin
DEFAULT      : 0 (>= v1.2.0)

Bullet Padding

Affects the before-pseudo-element's padding of the list item (bullet) for the rendered component.

VARIABLE     : --olist-li-before-padding
CSS PROPERTY : padding
DEFAULT      : 0 (>= v1.2.0)

Bullet Font Size

Affects the before-pseudo-element's font size of the list item (bullet) for the rendered component.

VARIABLE     : --olist-li-before-font-size
CSS PROPERTY : font-size
DEFAULT      : 2.6rem (>= v1.2.0)

Bullet Font Weight

Affects the before-pseudo-element's font weight of the list item (bullet) for the rendered component.

VARIABLE     : --olist-li-before-font-weight
CSS PROPERTY : font-weight
DEFAULT      : 800 (>= v1.2.0)

Bullet Text Align

Affects the before-pseudo-element's text alignment of the list item (bullet) for the rendered component.

VARIABLE     : --olist-li-before-text-align
CSS PROPERTY : text-align
DEFAULT      : left (>= 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/zoralabOLIST/ToCSS" . -}}
<pre>{{- printf "%#v\n" $ret -}}</pre>