OctantisWeb.Components.Polaris.Labelled (octantis v0.1.12)

View Source

Skeleton display text is used to provide a low fidelity representation of content before it appears on the page, and improves load times perceived by merchants. Can be used for content in or outside of a card.

Examples

  </.labelled>

See

Summary

Functions

Attributes

  • id (:string) - A unique identifier for the label.
  • hidden (:boolean) - Visually hide the label. Defaults to false.
  • required_indicator (:boolean) - Visual required indicator for the label. Defaults to false.

Slots

  • inner_block (required) - Label content.

Skeleton display text is used to provide a low fidelity representation of content before it appears on the page, and improves load times perceived by merchants. Can be used for content in or outside of a card.

Functions

build_style(attrs)

class(attrs)

label(assigns)

Attributes

  • id (:string) - A unique identifier for the label.
  • hidden (:boolean) - Visually hide the label. Defaults to false.
  • required_indicator (:boolean) - Visual required indicator for the label. Defaults to false.

Slots

  • inner_block (required) - Label content.

label_class(attrs)

label_text_class(attrs)

labelled(assigns)

Skeleton display text is used to provide a low fidelity representation of content before it appears on the page, and improves load times perceived by merchants. Can be used for content in or outside of a card.

Examples

  </.labelled>

See

Attributes

  • id (:string) - A unique identifier for the label.
  • label (:string) (required) - Text for the label.
  • error (:string) - Error to display beneath the label. Defaults to nil.
  • action (:any) - An action. Defaults to false.
  • help_text (:string) - Additional hint text to display. Defaults to nil.
  • label_hidden (:boolean) - Visually hide the label. Defaults to false.
  • required_indicator (:boolean) - Visual required indicator for the label. Defaults to false.
  • disabled (:boolean) - Labels signify a disabled control. Defaults to false.
  • read_only (:boolean) - Labels signify a readOnly control. Defaults to false.
  • Global attributes are accepted.

Slots

  • inner_block (required) - Content to display inside the connected.

style(arg)