OctantisWeb.Components.PolarisWC.Types (octantis v0.2.0)

Enumerations of types commonly found in Polaris

TODOs:

BorderShorthand
MaybeAllValuesShorthandProperty<BoxBorderRadii
MaybeResponsive<MaybeAllValuesShorthandProperty<PaddingKeyword>>
MaybeResponsive<"" | MaybeTwoValuesShorthandProperty<PaddingKeyword>>
MaybeResponsive<"" | PaddingKeyword>
MaybeResponsive<"" | MaybeTwoValuesShorthandProperty<PaddingKeyword>>

Summary

Functions

accessibility_role()

accessibility_visibility()

attribute_name(name)

Get the name of the attribute to be given to the WebComponent.

background_color()

colours()

commands()

direction()

get_base_type(arg1)

icons()

overflow()

padding()

put_options(type, opts)

sigil_o(arg1, arg2)

A sigil for defining responsive values

targets()

tones()

variants()

Functions

accessibility_role()

accessibility_visibility()

attribute_name(name)

Get the name of the attribute to be given to the WebComponent.

We override some of these to match LiveView names. For example :click -> "data-phx-click"

Examples

iex> attribute_name(:color) "color"

iex> attribute_name(:accessibility_label) "accessibilityLabel"

background_color()

colours()

commands()

direction()

get_base_type(arg1)

icons()

overflow()

padding()

put_options(type, opts)

sigil_o(arg1, arg2)

(macro)

A sigil for defining responsive values

Examples

iex> ~o["inline" <= "200px" < "block"]r {:responsive, {:<=, "200px", "inline", "block"}}

iex> ~o["inline" < {200, :px} < "block"]r {:responsive, {:<, {200, :px}, "inline", "block"}}

iex> ~o["inline" < "200px" < "block" <= "400px" < "outline"]r {:responsive, {:<, "200px", "inline", {:<=, "400px", "block", "outline"}}}

iex> ~o["inline" < {200, :px} < "block" < {400, :px} < "outline"]r {:responsive, {:<, {200, :px}, "inline", {:<, {400, :px}, "block", "outline"}}}

iex> ~o["inline" < {200, :px} < "block" < {400, :px} < "outline" < {600, :px} < "extremity"]r {:responsive, {:<, {200, :px}, "inline", {:<, {400, :px}, "block", {:<, {600, :px}, "outline", "extremity"}}}}