zoralabDIVIDER_CUT 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-cut_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):
zoralabCORE zoralabDIVIDERHTML
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 class='cut' />
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 : --divider-cut-margin CSS PROPERTY : margin DEFAULT : 2rem 0 (>= v1.2.0)
Border Bottom
Affects the bottom border of the rendered component.
VARIABLE : --divider-cut-border-bottom CSS PROPERTY : border-bottom DEFAULT : 3px dashed var(--divider-cut-color) (>= v1.2.0)
Border Bottom (Inverted)
Affects the bottom border of the rendered component while in inverted mode.
VARIABLE : --divider-cut-border-bottom-inverted CSS PROPERTY : border-bottom DEFAULT : 3px dashed var(--divider-cut-color-inverted) (>= v1.2.0)
Divider Content
Affects the content of the rendered component.
VARIABLE : --divider-cut-content CSS PROPERTY : content DEFAULT : "✀" ((= v1.2.0)
Font Size
Affects the font size of the rendered component.
VARIABLE : --divider-cut-font-size CSS PROPERTY : font-size DEFAULT : 3.5rem (>= v1.2.0)
Color
Affects the color of the rendered component.
VARIABLE : --divider-cut-color CSS PROPERTY : color DEFAULT : var(--color-typography-300) (>= v1.2.0)
Color (Inverted Mode)
Affects the color of the rendered component while in inverted mode.
VARIABLE : --divider-cut-color-inverted CSS PROPERTY : color DEFAULT : var(--color-typography-200) (>= v1.2.0)
Background
Affects the background of the rendered component.
VARIABLE : --divider-cut-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-cut-background-inverted CSS PROPERTY : background DEFAULT : transparent (>= 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_CUT/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