Folio.Styles (Folio v0.3.0)

Copy Markdown View Source

Style rules for customizing document appearance.

Folio.to_pdf("# Hello", styles: [
  Folio.Styles.page_size(width: 595, height: 842),
  Folio.Styles.page_margin(top: 40, bottom: 40, left: 50, right: 50),
  Folio.Styles.font_size(11),
  Folio.Styles.font_family(["Helvetica", "Arial"]),
  Folio.Styles.text_color("#333333"),
])

Summary

Types

rule()

Functions

enum_body_indent(body_indent)
enum_indent(indent)
enum_item_spacing(spacing)
font_family(families)
font_size(size)
font_weight(weight)
heading_bookmarked(bookmarked)
heading_numbering(pattern)
heading_outlined(outlined)
heading_supplement(content)
hyphenate(hyphenate)
lang(lang)
leading(leading)
list_body_indent(body_indent)
list_indent(indent)
list_item_spacing(spacing)
page_footer(content)
page_header(content)
page_margin(opts)
page_numbering(pattern)
page_size(opts)
par_indent(indent, opts \\ [])
par_justify(justify)
par_spacing(spacing)
text_color(color)

Types

rule()

@type rule() ::
  Folio.Styles.PageSize.t()
  | Folio.Styles.PageMargin.t()
  | Folio.Styles.FontSize.t()
  | Folio.Styles.FontFamily.t()
  | Folio.Styles.FontWeight.t()
  | Folio.Styles.TextColor.t()
  | Folio.Styles.ParJustify.t()
  | Folio.Styles.ParIndent.t()
  | Folio.Styles.PageNumbering.t()
  | Folio.Styles.PageHeader.t()
  | Folio.Styles.PageFooter.t()
  | Folio.Styles.HeadingNumbering.t()
  | Folio.Styles.HeadingSupplement.t()
  | Folio.Styles.HeadingOutlined.t()
  | Folio.Styles.HeadingBookmarked.t()
  | Folio.Styles.Lang.t()
  | Folio.Styles.Hyphenate.t()
  | Folio.Styles.Leading.t()
  | Folio.Styles.ParSpacing.t()
  | Folio.Styles.EnumIndent.t()
  | Folio.Styles.EnumBodyIndent.t()
  | Folio.Styles.EnumItemSpacing.t()
  | Folio.Styles.ListIndent.t()
  | Folio.Styles.ListBodyIndent.t()
  | Folio.Styles.ListItemSpacing.t()

Functions

enum_body_indent(body_indent)

@spec enum_body_indent(number()) :: Folio.Styles.EnumBodyIndent.t()

enum_indent(indent)

@spec enum_indent(number()) :: Folio.Styles.EnumIndent.t()

enum_item_spacing(spacing)

@spec enum_item_spacing(number()) :: Folio.Styles.EnumItemSpacing.t()

font_family(families)

@spec font_family([String.t()]) :: Folio.Styles.FontFamily.t()

font_size(size)

@spec font_size(number()) :: Folio.Styles.FontSize.t()

font_weight(weight)

@spec font_weight(100..900) :: Folio.Styles.FontWeight.t()

heading_bookmarked(bookmarked)

@spec heading_bookmarked(boolean()) :: Folio.Styles.HeadingBookmarked.t()

heading_numbering(pattern)

@spec heading_numbering(String.t()) :: Folio.Styles.HeadingNumbering.t()

heading_outlined(outlined)

@spec heading_outlined(boolean()) :: Folio.Styles.HeadingOutlined.t()

heading_supplement(content)

@spec heading_supplement(Folio.Content.t() | [Folio.Content.t()] | String.t()) ::
  Folio.Styles.HeadingSupplement.t()

hyphenate(hyphenate)

@spec hyphenate(boolean()) :: Folio.Styles.Hyphenate.t()

lang(lang)

@spec lang(String.t()) :: Folio.Styles.Lang.t()

leading(leading)

@spec leading(number()) :: Folio.Styles.Leading.t()

list_body_indent(body_indent)

@spec list_body_indent(number()) :: Folio.Styles.ListBodyIndent.t()

list_indent(indent)

@spec list_indent(number()) :: Folio.Styles.ListIndent.t()

list_item_spacing(spacing)

@spec list_item_spacing(number()) :: Folio.Styles.ListItemSpacing.t()

page_footer(content)

@spec page_footer(Folio.Content.t() | [Folio.Content.t()] | String.t()) ::
  Folio.Styles.PageFooter.t()

page_header(content)

@spec page_header(Folio.Content.t() | [Folio.Content.t()] | String.t()) ::
  Folio.Styles.PageHeader.t()

page_margin(opts)

@spec page_margin(keyword()) :: Folio.Styles.PageMargin.t()

page_numbering(pattern)

@spec page_numbering(String.t()) :: Folio.Styles.PageNumbering.t()

page_size(opts)

@spec page_size(keyword()) :: Folio.Styles.PageSize.t()

par_indent(indent, opts \\ [])

@spec par_indent(
  number(),
  keyword()
) :: Folio.Styles.ParIndent.t()

par_justify(justify)

@spec par_justify(boolean()) :: Folio.Styles.ParJustify.t()

par_spacing(spacing)

@spec par_spacing(number()) :: Folio.Styles.ParSpacing.t()

text_color(color)

@spec text_color(String.t()) :: Folio.Styles.TextColor.t()