Surface.Components.LiveFileInput (surface v0.4.0) View Source

Wrapper around Phoenix LiveView's built-in live_file_input/2 function.

The parent LiveView, or LiveComponent must allow_uploads during mount:

  def mount(socket) do
    socket = allow_upload(socket, :avatar, accept: ~w(.json), max_entries: 1)
    {:ok, socket}
  end

See Phoenix.LiveView Uploads documentation

Properties

  • upload :struct, required: true - Upload specified via allow_upload.
  • class :css_class - The CSS class for the generated <input> element.
  • opts :keyword, default: [] - Keyword list with options to be passed down to live_file_input/2.

Events

  • capture_click - Triggered when the component captures click.
  • click - Triggered when the component receives click.
  • window_focus - Triggered when the page receives focus.
  • window_blur - Triggered when the page loses focus.
  • focus - Triggered when the component receives focus.
  • blur - Triggered when the component loses focus.
  • window_keyup - Triggered when a key on the keyboard is released (window-level).
  • window_keydown - Triggered when a key on the keyboard is pressed (window-level).
  • keyup - Triggered when a key on the keyboard is released.
  • keydown - Triggered when a key on the keyboard is pressed.

Link to this section Summary

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.