zoralabBLOCKQUOTE 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 blockquote values. In web UI, it is shown as follows:
The scientists of today think deeply instead of clearly. One must be sane to think clearly, but one can think deeply and be quite insane. Nikolai Tesla
The scientists of today think deeply instead of clearly. One must be sane to think clearly, but one can think deeply and be quite insane. Nikolai Tesla
Legacy Recording
This package was known as blockquote_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:
<blockquote> ... <cite>...</cite> </blockquote>
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 : --blockquote-display CSS PROPERTY : display DEFAULT : block (>= v1.2.0)
Before Content
Affects the before-pseudo-element's content of the blockquote of the rendered component.
VARIABLE : --blockquote-before-content CSS PROPERTY : content DEFAULT : "❝" (>= v1.2.0)
Margin
Affects the margin of the rendered component.
VARIABLE : --blockquote-margin CSS PROPERTY : margin DEFAULT : 0 0 3rem (>= v1.2.0)
Padding
Affects the padding of the rendered component.
VARIABLE : --blockquote-padding CSS PROPERTY : padding DEFAULT : 4rem 3rem 3rem 10rem (>= v1.2.0)
Border
Affects the border of the rendered component.
VARIABLE : --blockquote-border CSS PROPERTY : border DEFAULT : none (>= v1.2.0)
Border Radius
Affects the border radius of the rendered component.
VARIABLE : --blockquote-border-radius CSS PROPERTY : border-radius DEFAULT : 1rem (>= v1.2.0)
Min-Width
Affects the minimum width of the rendered component.
VARIABLE : --blockquote-min-width CSS PROPERTY : min-width DEFAULT : initial (>= v1.2.0)
Width
Affects the width of the rendered component.
VARIABLE : --blockquote-width CSS PROPERTY : width DEFAULT : initial (<= v1.2.0)
Max-Width
Affects the maximum width of the rendered component.
VARIABLE : --blockquote-max-width CSS PROPERTY : max-width DEFAULT : initial (<= v1.2.0)
Min-Height
Affects the minimum height of the rendered component.
VARIABLE : --blockquote-min-height CSS PROPERTY : min-height DEFAULT : initial (>= v1.2.0)
Height
Affects the height of the rendered component.
VARIABLE : --blockquote-height CSS PROPERTY : height DEFAULT : initial (>= v1.2.0)
Max-Height
Affects the maximum height of the rendered component.
VARIABLE : --blockquote-max-height CSS PROPERTY : max-height DEFAULT : initial (>= v1.2.0)
Text Align
Affects the text alignment of the rendered component.
VARIABLE : --blockquote-text-align CSS PROPERTY : text-align DEFAULT : justify (>= v1.2.0)
Color
Affects the color of the rendered component.
VARIABLE : --blockquote-color CSS PROPERTY : color DEFAULT : var(--color-typography-900) (>= v1.2.0)
Color (Print Mode)
Affects the color of the rendered component when in print mode.
VARIABLE : --blockquote-color-print CSS PROPERTY : color DEFAULT : var(--body-color-print) (>= v1.2.0)
Background
Affects the background of the rendered component.
VARIABLE : --blockquote-background CSS PROPERTY : background DEFAULT : var(--color-primary-100) (>= v1.2.0)
Background (Print Mode)
Affects the background of the rendered component when in print mode.
VARIABLE : --blockquote-background-print CSS PROPERTY : background DEFAULT : var(--body-background-print) (>= v1.2.0)
Transition
Affects the animation timing of the rendered component.
VARIABLE : --blockquote-timing CSS PROPERTY : transition DEFAULT : var(--timing-rapid) (>= v1.2.0)
Margin (Cite)
Affects the margin of the rendered component's cite syntax.
VARIABLE : --blockquote-cite-margin CSS PROPERTY : margin DEFAULT : 2rem 0 0 (>= v1.2.0)
Border-Top (Cite)
Affects the top border of the rendered component's cite syntax.
VARIABLE : --blockquote-cite-border-top CSS PROPERTY : border-top DEFAULT : 2px solid var(--blockquote-color) (>= 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/zoralabBLOCKQUOTE/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