petal_components
petal_components
v1.0.8

View Source PetalComponents.Typography (petal_components v1.0.8)

Everything related to text. Headings, paragraphs and links

Link to this section Summary

Functions

h1(assigns)

Attributes

  • class (:string) - CSS class. Defaults to "".
  • label (:string) - label your heading. Defaults to nil.
  • no_margin (:boolean) - removes margin from headings. Defaults to nil.
  • underline (:boolean) - underlines a heading. Defaults to false.
  • color_class (:string) - adds a color class. Defaults to nil. Global attributes are accepted.

Slots

  • inner_block
h2(assigns)

Attributes

  • class (:string) - CSS class. Defaults to "".
  • label (:string) - label your heading. Defaults to nil.
  • no_margin (:boolean) - removes margin from headings. Defaults to nil.
  • underline (:boolean) - underlines a heading. Defaults to false.
  • color_class (:string) - adds a color class. Defaults to nil. Global attributes are accepted.

Slots

  • inner_block
h3(assigns)

Attributes

  • class (:string) - CSS class. Defaults to "".
  • label (:string) - label your heading. Defaults to nil.
  • no_margin (:boolean) - removes margin from headings. Defaults to nil.
  • underline (:boolean) - underlines a heading. Defaults to false.
  • color_class (:string) - adds a color class. Defaults to nil. Global attributes are accepted.

Slots

  • inner_block
h4(assigns)

Attributes

  • class (:string) - CSS class. Defaults to "".
  • label (:string) - label your heading. Defaults to nil.
  • no_margin (:boolean) - removes margin from headings. Defaults to nil.
  • underline (:boolean) - underlines a heading. Defaults to false.
  • color_class (:string) - adds a color class. Defaults to nil. Global attributes are accepted.

Slots

  • inner_block
h5(assigns)

Attributes

  • class (:string) - CSS class. Defaults to "".
  • label (:string) - label your heading. Defaults to nil.
  • no_margin (:boolean) - removes margin from headings. Defaults to nil.
  • underline (:boolean) - underlines a heading. Defaults to false.
  • color_class (:string) - adds a color class. Defaults to nil. Global attributes are accepted.

Slots

  • inner_block
ol(assigns)

Usage

p(assigns)

Attributes

  • class (:string) - CSS class. Defaults to "". Global attributes are accepted.

Slots

  • inner_block
prose(assigns)

Attributes

  • class (:string) - CSS class. Defaults to "". Global attributes are accepted.

Slots

  • inner_block
ul(assigns)

Usage

Link to this section Functions

Link to this function

h1(assigns)

View Source

attributes

 Attributes

  • class (:string) - CSS class. Defaults to "".
  • label (:string) - label your heading. Defaults to nil.
  • no_margin (:boolean) - removes margin from headings. Defaults to nil.
  • underline (:boolean) - underlines a heading. Defaults to false.
  • color_class (:string) - adds a color class. Defaults to nil. Global attributes are accepted.

slots

 Slots

  • inner_block
Link to this function

h2(assigns)

View Source

attributes

 Attributes

  • class (:string) - CSS class. Defaults to "".
  • label (:string) - label your heading. Defaults to nil.
  • no_margin (:boolean) - removes margin from headings. Defaults to nil.
  • underline (:boolean) - underlines a heading. Defaults to false.
  • color_class (:string) - adds a color class. Defaults to nil. Global attributes are accepted.

slots

 Slots

  • inner_block
Link to this function

h3(assigns)

View Source

attributes

 Attributes

  • class (:string) - CSS class. Defaults to "".
  • label (:string) - label your heading. Defaults to nil.
  • no_margin (:boolean) - removes margin from headings. Defaults to nil.
  • underline (:boolean) - underlines a heading. Defaults to false.
  • color_class (:string) - adds a color class. Defaults to nil. Global attributes are accepted.

slots

 Slots

  • inner_block
Link to this function

h4(assigns)

View Source

attributes

 Attributes

  • class (:string) - CSS class. Defaults to "".
  • label (:string) - label your heading. Defaults to nil.
  • no_margin (:boolean) - removes margin from headings. Defaults to nil.
  • underline (:boolean) - underlines a heading. Defaults to false.
  • color_class (:string) - adds a color class. Defaults to nil. Global attributes are accepted.

slots

 Slots

  • inner_block
Link to this function

h5(assigns)

View Source

attributes

 Attributes

  • class (:string) - CSS class. Defaults to "".
  • label (:string) - label your heading. Defaults to nil.
  • no_margin (:boolean) - removes margin from headings. Defaults to nil.
  • underline (:boolean) - underlines a heading. Defaults to false.
  • color_class (:string) - adds a color class. Defaults to nil. Global attributes are accepted.

slots

 Slots

  • inner_block
Link to this function

ol(assigns)

View Source

Usage:

<.ol>
  <li>Item 1</li>
  <li>Item 2</li>
</.ol>

attributes

 Attributes

  • class (:string) - CSS class. Defaults to "". Global attributes are accepted.

slots

 Slots

  • inner_block
Link to this function

p(assigns)

View Source

attributes

 Attributes

  • class (:string) - CSS class. Defaults to "". Global attributes are accepted.

slots

 Slots

  • inner_block
Link to this function

prose(assigns)

View Source

attributes

 Attributes

  • class (:string) - CSS class. Defaults to "". Global attributes are accepted.

slots

 Slots

  • inner_block
Link to this function

ul(assigns)

View Source

Usage:

<.ul>
  <li>Item 1</li>
  <li>Item 2</li>
</.ul>

attributes

 Attributes

  • class (:string) - CSS class. Defaults to "". Global attributes are accepted.

slots

 Slots

  • inner_block