Surface.Components.Form (surface v0.4.0) View Source
Defines a form that lets the user submit information.
Provides a wrapper for Phoenix.HTML.Form.form_for/3
. Additionally,
adds the form instance that is returned by form_for/3
into the context,
making it available to any child input.
All options passed via opts
will be sent to form_for/3
, for
and action
can be set directly and will override anything in opts
.
Properties
- for :any, required: true - Atom or changeset to inform the form data.
- action :string, default: "#" - URL to where the form is submitted.
- as :atom - The server side parameter in which all parameters will be gathered..
- method :string - Method to be used when submitting the form..
- multipart :boolean, default: false - When true, sets enctype to "multipart/form-data". Required when uploading files..
- csrf_token :any - For "post" requests, the form tag will automatically include an input tag with name _csrf_token. When set to false, this is disabled. .
- errors :keyword - Keyword list of errors for the form..
- opts :keyword, default: [] - Keyword list with options to be passed down to
Phoenix.HTML.Tag.tag/2
. - class :css_class - Class or classes to apply to the form.
Slots
- default, props: [:form] - The content of the
<form>
.
Events
- change - Triggered when the form is changed.
- submit - Triggered when the form is submitted.
- auto_recover - Triggered when the form is being recovered. Use this event to enable specialized recovery when extra recovery handling on the server is required. .
Link to this section Summary
Functions
Callback implementation for Phoenix.LiveComponent.mount/1
.
Callback implementation for Phoenix.LiveComponent.render/1
.
Callback implementation for Phoenix.LiveComponent.update/2
.
Link to this section Functions
Callback implementation for Phoenix.LiveComponent.mount/1
.
Callback implementation for Phoenix.LiveComponent.render/1
.
Callback implementation for Phoenix.LiveComponent.update/2
.