zoralabCODE Technical Specification - ZORALab's Hestia

Main Purpose

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

This paragraph has code which looks like this and ends with a clean paragraph.

Legacy Recording

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

...<code>...</code>...

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.

Margin

Affects the margin of the rendered component.

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

Padding

Affects the padding of the rendered component.

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

Border

Affects the border of the rendered component.

VARIABLE     : --code-border
CSS PROPERTY : border
DEFAULT      : initial (>= v1.2.0)

Border Radius

Affects the border radius of the rendered component.

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

Font Weight

Affects the font weight of the rendered component.

VARIABLE     : --code-font-weight
CSS PROPERTY : font-weight
DEFAULT      : 700 (>= v1.2.0)

Letter Spacing

Affects the letter spacing of the rendered component.

VARIABLE     : --code-letter-spacing
CSS PROPERTY : letter-spacing
DEFAULT      : 0 (>= v1.2.0)

Color

Affects the color of the rendered component.

VARIABLE     : --code-color
CSS PROPERTY : color
DEFAULT      : var(--color-primary-300) (>= v1.2.0)

Color (Inverted)

Affects the color of the rendered component in inverted mode.

VARIABLE     : --code-color-inverted
CSS PROPERTY : color
DEFAULT      : var(--color-primary-200) (>= v1.2.0)

Color (Print Mode)

Affects the color of the rendered component during print mode.

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

Overflow Wrap

Affects the overflow wrapping behavior of the rendered component.

VARIABLE     : --code-overflow-wrap
CSS PROPERTY : overflow-wrap
DEFAULT      : break-word (>= 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/zoralabCODE/ToCSS" . -}}
<pre>{{- printf "%#v\n" $ret -}}</pre>