petal_components
petal_components
v1.0.8

View Source PetalComponents.Form (petal_components v1.0.8)

Everything related to forms: inputs, labels etc

Link to this section Summary

Functions

checkbox(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
checkbox_group(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "".
  • options (:list) - options for the select. Defaults to [].
  • layout (:atom) - layout for the checkboxes. Defaults to :col.
  • checked (:list) - a list of checked values. Global attributes are accepted.
color_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
date_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
date_select(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
datetime_local_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
datetime_select(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
email_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
file_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
form_field(assigns)

Use this when you want to include the label and some margin.

form_field_error(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "".
form_help_text(assigns)

Attributes

  • class (:string) - extra classes for the help text. Defaults to "".
  • help_text (:string) - context/help for your field. Defaults to nil. Global attributes are accepted.

Slots

  • inner_block
form_label(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • has_error (:boolean) - . Defaults to false.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - CSS classes to add to your label. Global attributes are accepted.

Slots

  • inner_block
hidden_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil. Global attributes are accepted.
number_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
password_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
radio(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "".
  • value (:any) - the radio value. Defaults to nil. Global attributes are accepted.
radio_group(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "".
  • options (:list) - options for the select. Defaults to [].
  • layout (:atom) - layout for the radio options. Defaults to :col. Global attributes are accepted.
range_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
search_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
select(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "".
  • options (:list) - options for the select. Defaults to []. Global attributes are accepted.
switch(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
telephone_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
text_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
textarea(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
time_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
time_select(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
url_input(assigns)

Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.

Link to this section Functions

Link to this function

checkbox(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

checkbox_group(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "".
  • options (:list) - options for the select. Defaults to [].
  • layout (:atom) - layout for the checkboxes. Defaults to :col.
  • checked (:list) - a list of checked values. Global attributes are accepted.
Link to this function

color_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

date_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

date_select(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

datetime_local_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

datetime_select(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

email_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

file_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

form_field(assigns)

View Source

Use this when you want to include the label and some margin.

attributes

 Attributes

  • form (:any) (required) - the form object.
  • field (:atom) (required) - field in changeset / form.
  • label (:string) - labels your field.
  • label_class (:string) - extra CSS for your label. Defaults to nil.
  • help_text (:string) - context/help for your field. Defaults to nil.
  • type (:string) - The type of input. Defaults to "text_input".
  • wrapper_classes (:string) - CSS class for wrapper. Defaults to "pc-form-field-wrapper". Global attributes are accepted.
Link to this function

form_field_error(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "".
Link to this function

form_help_text(assigns)

View Source

attributes

 Attributes

  • class (:string) - extra classes for the help text. Defaults to "".
  • help_text (:string) - context/help for your field. Defaults to nil. Global attributes are accepted.

slots

 Slots

  • inner_block
Link to this function

form_label(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • has_error (:boolean) - . Defaults to false.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - CSS classes to add to your label. Global attributes are accepted.

slots

 Slots

  • inner_block
Link to this function

hidden_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil. Global attributes are accepted.
Link to this function

number_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

password_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

radio(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "".
  • value (:any) - the radio value. Defaults to nil. Global attributes are accepted.
Link to this function

radio_group(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "".
  • options (:list) - options for the select. Defaults to [].
  • layout (:atom) - layout for the radio options. Defaults to :col. Global attributes are accepted.
Link to this function

range_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

search_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

select(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "".
  • options (:list) - options for the select. Defaults to []. Global attributes are accepted.
Link to this function

switch(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

telephone_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

text_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

textarea(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

time_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

time_select(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.
Link to this function

url_input(assigns)

View Source

attributes

 Attributes

  • form (:any) - . Defaults to nil.
  • field (:atom) - . Defaults to nil.
  • label (:string) - labels your field. Defaults to nil.
  • class (:string) - extra classes for the text input. Defaults to "". Global attributes are accepted.