FlowbitePhoenix.Components.Forms (FlowbitePhoenix v0.1.2)
View SourceForm components for FlowbitePhoenix using Flowbite CSS framework.
This module provides form-related components including inputs, buttons, toggles, and form containers with consistent Flowbite styling.
Summary
Functions
Renders a button with Flowbite styling and multiple variants.
Generates a generic error message with Flowbite styling.
Renders an input with label and error messages using Flowbite styling.
Renders a label with Flowbite styling.
Renders a simple form with Flowbite styling.
Renders a toggle switch component using Flowbite styling.
Functions
Renders a button with Flowbite styling and multiple variants.
Examples
<.button>Send!</.button>
<.button phx-click="go" color="alternative">Cancel</.button>
<.button loading={true} color="blue">Loading...</.button>
<.button variant="outline" color="red">Delete</.button>
Attributes
type
(:string
) - Defaults tonil
.class
(:string
) - Defaults tonil
.loading
(:boolean
) - Defaults tofalse
.variant
(:string
) - Defaults to"default"
. Must be one of"default"
, or"outline"
.color
(:string
) - Defaults to"blue"
. Must be one of"blue"
,"alternative"
,"dark"
,"light"
,"green"
,"red"
,"yellow"
, or"purple"
.size
(:string
) - Defaults to"default"
. Must be one of"xs"
,"sm"
,"default"
,"lg"
, or"xl"
.- Global attributes are accepted. Supports all globals plus:
["disabled", "form", "name", "value"]
.
Slots
inner_block
(required)
Generates a generic error message with Flowbite styling.
Slots
inner_block
(required)
Renders an input with label and error messages using Flowbite styling.
A Phoenix.HTML.FormField
may be passed as argument,
which is used to retrieve the input name, id, and values.
Otherwise all attributes may be passed explicitly.
Types
This function accepts all HTML input types, considering that:
You may also set
type="select"
to render a<select>
tagtype="checkbox"
is used exclusively to render boolean valuesFor live file uploads, see
Phoenix.Component.live_file_input/1
See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input for more information. Unsupported types, such as hidden and radio, are best written directly in your templates.
Examples
<.input field={@form[:email]} type="email" />
<.input name="my-input" errors={["oh no!"]} />
Attributes
id
(:any
) - Defaults tonil
.name
(:any
)label
(:string
) - Defaults tonil
.value
(:any
)type
(:string
) - Defaults to"text"
. Must be one of"checkbox"
,"color"
,"date"
,"datetime-local"
,"email"
,"file"
,"hidden"
,"month"
,"number"
,"password"
,"range"
,"search"
,"select"
,"tel"
,"text"
,"textarea"
,"time"
,"url"
, or"week"
.field
(Phoenix.HTML.FormField
) - a form field struct retrieved from the form, for example: @form[:email].errors
(:list
) - Defaults to[]
.checked
(:boolean
) - the checked flag for checkbox inputs.prompt
(:string
) - the prompt for select inputs. Defaults tonil
.options
(:list
) - the options to pass to Phoenix.HTML.Form.options_for_select/2.multiple
(:boolean
) - the multiple flag for select inputs. Defaults tofalse
.- Global attributes are accepted. Supports all globals plus:
["accept", "autocomplete", "capture", "cols", "disabled", "form", "list", "max", "maxlength", "min", "minlength", "multiple", "pattern", "placeholder", "readonly", "required", "rows", "size", "step"]
.
Renders a label with Flowbite styling.
Attributes
for
(:string
) - Defaults tonil
.
Slots
inner_block
(required)
Renders a simple form with Flowbite styling.
Examples
<.simple_form for={@form} phx-change="validate" phx-submit="save">
<.input field={@form[:email]} label="Email"/>
<.input field={@form[:username]} label="Username" />
<:actions>
<.button>Save</.button>
</:actions>
</.simple_form>
Attributes
for
(:any
) (required) - the data structure for the form.as
(:any
) - the server side parameter to collect all input under. Defaults tonil
.- Global attributes are accepted. the arbitrary HTML attributes to apply to the form tag. Supports all globals plus:
["autocomplete", "name", "rel", "action", "enctype", "method", "novalidate", "target", "multipart"]
.
Slots
inner_block
(required)actions
- the slot for form actions, such as a submit button.
Renders a toggle switch component using Flowbite styling.
Examples
<.toggle name="notifications" label="Enable notifications" />
<.toggle name="dark_mode" label="Dark mode" checked={true} />
Attributes
id
(:string
) - Defaults tonil
.name
(:string
) (required)label
(:string
) - Defaults tonil
.checked
(:boolean
) - Defaults tofalse
.class
(:string
) - Defaults to""
.- Global attributes are accepted.