RsProperties

constructor(colWidth: Length? = null, colCount: ColCount? = null, colGap: Length.Absolute? = null, pageGutter: Length.Absolute? = null, flowSpacing: Length? = null, paraSpacing: Length? = null, paraIndent: Length? = null, maxLineLength: Length.Rem? = null, maxMediaWidth: Length? = null, maxMediaHeight: Length? = null, boxSizingMedia: BoxSizing? = null, boxSizingTable: BoxSizing? = null, textColor: Color? = null, backgroundColor: Color? = null, selectionTextColor: Color? = null, selectionBackgroundColor: Color? = null, linkColor: Color? = null, visitedColor: Color? = null, primaryColor: Color? = null, secondaryColor: Color? = null, typeScale: Double? = null, baseFontFamily: List<String>? = null, baseLineHeight: Either<Length, Double>? = null, oldStyleTf: List<String>? = null, modernTf: List<String>? = null, sansTf: List<String>? = null, humanistTf: List<String>? = null, monospaceTf: List<String>? = null, serifJa: List<String>? = null, sansSerifJa: List<String>? = null, serifJaV: List<String>? = null, sansSerifJaV: List<String>? = null, compFontFamily: List<String>? = null, codeFontFamily: List<String>? = null, overrides: Map<String, String?> = emptyMap())

Parameters

colWidth

The optimal column’s width. It serves as a floor in our design.

colCount

The optimal number of columns (depending on the columns’ width).

colGap

The gap between columns. You must account for this gap when scrolling.

pageGutter

The horizontal page margins.

flowSpacing

The default vertical margins for HTML5 flow content e.g. pre, figure, blockquote, etc.

paraSpacing

The default vertical margins for paragraphs.

paraIndent

The default text-indent for paragraphs.

maxLineLength

The optimal line-length. It must be set in rem in order to take :root’s font-size as a reference, whichever the body’s font-size might be.

maxMediaWidth

The max-width for media elements i.e. img, svg, audio and video.

maxMediaHeight

The max-height for media elements i.e. img, svg, audio and video.

boxSizingMedia

The box model (box-sizing) you want to use for media elements.

boxSizingTable

The box model (box-sizing) you want to use for tables.

textColor

The default color for body copy’s text.

backgroundColor

The default background-color for pages.

selectionTextColor

The color for selected text.

selectionBackgroundColor

The background-color for selected text.

linkColor

The default color for hyperlinks.

visitedColor

The default color for visited hyperlinks.

primaryColor

An optional primary accentuation color you could use for headings or any other element of your choice.

secondaryColor

An optional secondary accentuation color you could use for any element of your choice.

typeScale

The scale to be used for computing all elements’ font-size. Since those font sizes are computed dynamically, you can set a smaller type scale when the user sets one of the largest font sizes.

baseFontFamily

The default typeface for body copy in case the ebook doesn’t have one declared. Please note some languages have a specific font-stack (japanese, hindi, etc.)

baseLineHeight

The default line-height for body copy in case the ebook doesn’t have one declared.

oldStyleTf

An old style serif font-stack relying on pre-installed fonts.

modernTf

A modern serif font-stack relying on pre-installed fonts.

sansTf

A neutral sans-serif font-stack relying on pre-installed fonts.

humanistTf

A humanist sans-serif font-stack relying on pre-installed fonts.

monospaceTf

A monospace font-stack relying on pre-installed fonts.

serifJa

A Mincho font-stack whose fonts with proportional latin characters are prioritized for horizontal writing.

sansSerifJa

A Gothic font-stack whose fonts with proportional latin characters are prioritized for horizontal writing.

serifJaV

A Mincho font-stack whose fonts with fixed-width latin characters are prioritized for vertical writing.

sansSerifJaV

A Gothic font-stack whose fonts with fixed-width latin characters are prioritized for vertical writing.

compFontFamily

The typeface for headings. The value can be another variable e.g. var(-RS__humanistTf).

codeFontFamily

The typeface for code snippets. The value can be another variable e.g. var(-RS__monospaceTf).