zoralabDIVIDER Technical Specification - ZORALab's Hestia
The technical specifications to refer when using the package. Easy-going, offline supported (via web PWA installation), and detailed oriented. Courtesy from ZORALab's Hestia.
Objectives and Purposes
Main Purpose
This package's primary purpose is to provide user interface (UI) styling
specifically for divider values. In web UI, it is shown as follows:
Legacy Recording
This package was known as divider_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.
Product Designs
Designers
This component was designed by the following creators:
(Holloway) Chew, Kean HoDependencies
This component has the following dependencies (arranged in the order from left-top to right-bottom):
zoralabCOREHTML
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:
<hr/>
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 : --divider-display CSS PROPERTY : display DEFAULT : block (>= v1.2.0)
Margin
Affects the margin of the rendered component.
VARIABLE : --divider-margin CSS PROPERTY : margin DEFAULT : 0 auto (>= v1.2.0)
Padding
Affects the padding of the rendered component.
VARIABLE : --divide-padding CSS PROPERTY : padding DEFAULT : 0 (>= v1.2.0)
Border
Affects the border of the rendered component.
VARIABLE : --divider-border CSS PROPERTY : border DEFAULT : initial (>= v1.2.0)
Border Top
Affects the top border of the rendered component.
VARIABLE : --divider-border-top CSS PROPERTY : border-top DEFAULT : initial (>= v1.2.0)
Border Bottom
Affects the bottom border of the rendered component.
VARIABLE : --divider-border-bottom CSS PROPERTY : border-bottom DEFAULT : 1px solid var(--divider-color) (>= v1.2.0)
Min-Width
Affects the minimum width of the rendered component.
VARIABLE : --divider-min-width CSS PROPERTY : min-width DEFAULT : initial (>= v1.2.0)
Width
Affects the width of the rendered component.
VARIABLE : --divider-width CSS PROPERTY : width DEFAULT : 100% (>= v1.2.0)
Max-Width
Affects the maximum width of the rendered component.
VARIABLE : --divider-max-width CSS PROPERTY : max-width DEFAULT : 100% (>= v1.2.0)
Min-Height
Affects the minimum height of the rendered component.
VARIABLE : --divider-min-height CSS PROPERTY : min-height DEFAULT : initial (>= v1.2.0)
Height
Affects the height of the rendered component.
VARIABLE : --divider-height CSS PROPERTY : height DEFAULT : 1px (>= v1.2.0)
Max-Height
Affects the maximum height of the rendered component.
VARIABLE : --divider-max-height CSS PROPERTY : max-height DEFAULT : initial (>= v1.2.0)
Color
Affects the color of the rendered component.
VARIABLE : --divider-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 : --divider-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 : --divider-color-print CSS PROPERTY : color DEFAULT : var(--body-color-print) (>= v1.2.0)
Background
Affects the background of the rendered component.
VARIABLE : --divider-background CSS PROPERTY : background DEFAULT : transparent (>= v1.2.0)
Background (Inverted Mode)
Affects the background of the rendered component while in inverted mode.
VARIABLE : --divider-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 : --divider-background-print CSS PROPERTY : background DEFAULT : var(--body-background-print) (>= v1.2.0)
Border Color
Affects the border color of the rendered component.
VARIABLE : --divider-border-color CSS PROPERTY : border-color DEFAULT : var(--divider-color) (>= v1.2.0)
Border Color (Inverted Mode)
Affects the border color of the rendered component while in inverted mode.
VARIABLE : --divider-color-inverted CSS PROPERTY : border-color DEFAULT : var(--divider-color-inverted) (>= v1.2.0)
JavaScript
Fortunately, this component does not use any JavaScript. Relax.
Constants
This package does not offer any constant value.
Variables
This package does not offer any variable.
Offered Functions
ToCSS
Render the CSS output for this UI component.
Hugo
Usage example:
{{- $ret := partial "hestiaGUI/zoralabDIVIDER/ToCSS" . -}} <pre>{{- printf "%#v\n" $ret -}}</pre>
Data Types
This package does not offer any data type.
Epilogue
Looks like we have arrived to the last station. Intrigued to get in touch? Please feel free to start contacting us via the following public channels:
GitHub Discussion Portal