zoralabPRE Technical Specification - ZORALab's Hestia

Main Purpose

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

This is a pre-formatted paragraph.

This is a pre-formatted paragraph.

Legacy Recording

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

<pre>...</pre>

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

Box-Sizing

Affects the box-sizing behavior of the rendered component.

VARIABLE     : --pre-box-sizing
CSS PROPERTY : box-sizing
DEFAULT      : border-box (>= v1.2.0)

Margin

Affects the margin of the rendered component.

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

Padding

Affects the padding of the rendered component.

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

Overflow

Affects the overflow behavior of the rendered component.

VARIABLE     : --pre-overflow
CSS PROPERTY : overflow
DEFAULT      : auto auto (>= v1.2.0)

Border

Affects the border of the rendered component.

VARIABLE     : --pre-border
CSS PROPERTY : border
DEFAULT      : .3rem solid var(--pre-color) (>= v1.2.0)

Border Radius

Affects the border radius of the rendered component.

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

Min-Width

Affects the minimum width of the rendered component.

VARIABLE     : --pre-min-width
CSS PROPERTY : min-width
DEFAULT      : initial (>= v1.2.0)

Width

Affects the width of the rendered component.

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

Max-Width

Affects the maximum width of the rendered component.

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

Min-Height

Affects the minimum height of the rendered component.

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

Height

Affects the height of the rendered component.

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

Max-Height

Affects the maximum height of the rendered component.

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

Font Size

Affects the font size of the rendered component.

VARIABLE     : --pre-font-size
CSS PROPERTY : font-size
DEFAULT      : var(--body-font-size) (>= v1.2.0)

Font Family

Affects the font family of the rendered component.

VARIABLE     : --pre-font-family
CSS PROPERTY : font-family
DEFAULT      : monospace (>= v1.2.0)

Text Decoration

Affects the text decoration of the rendered component.

VARIABLE     : --pre-text-decoration
CSS PROPERTY : text-decoration
DEFAULT      : normal (>= v1.2.0)

Word Break

Affects the word breaking behavior of the rendered component.

VARIABLE     : --pre-word-break
CSS PROPERTY : word-break
DEFAULT      : keep-all (>= v1.2.0)

Letter Spacing

Affects the letter spacing of the rendered component.

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

Line Height

Affects the line height of the rendered component.

VARIABLE     : --pre-line-height
CSS PROPERTY : line-height
DEFAULT      : var(--body-line-height) (>= v1.2.0)

Text Align

Affects the text alignment of the rendered component.

VARIABLE     : --pre-text-align
CSS PROPERTY : text-align
DEFAULT      : justify (>= v1.2.0)

White-space

Affects the white-spacing behavior of the rendered component.

VARIABLE     : --pre-white-space
CSS PROPERTY : white-space
DEFAULT      : pre (>= v1.2.0)

Color

Affects the color of the rendered component.

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

Color (Inverted Mode)

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

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

Color (Print Mode)

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

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

Background

Affects the background of the rendered component.

VARIABLE     : --pre-background
CSS PROPERTY : background
DEFAULT      : var(--color-contrast-50) (>= v1.2.0)

Background (Inverted Mode)

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

VARIABLE     : --pre-background-inverted
CSS PROPERTY : background
DEFAULT      : var(--color-contrast-50) (>= v1.2.0)

Background (Print Mode)

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

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

Transition

Affects the animation timing of the rendered component.

VARIABLE     : --pre-transition
CSS PROPERTY : transition
DEFAULT      : var(--timing-rapid) (>= 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/zoralabPRE/ToCSS" . -}}
<pre>{{- printf "%#v\n" $ret -}}</pre>