View Source Surface.Components.Link (surface v0.11.4)

This module is deprecated. Use liveview's built-in `<.link>` instead.

Soft deprecation warning

This component has been deprecated in favor of liveview's built-in <.link> and will be removed in v0.13. See https://hexdocs.pm/phoenix_live_view/live-navigation.html for more info usage.

Generates a link to the given URL.

Provides similar capabilities to Phoenix's built-in link/2 function.

Options label and class can be set directly and will override anything in opts. All other options are forwarded to the underlying <a> tag.

Examples

<Link
  label="user"
  to="/users/1"
  class="is-danger"
  method={:delete}
  opts={data: [confirm: "Really?"]}
/>

<Link
  to="/users/1"
  class="is-link"
>
  <span>user</span>
</Link>

Properties

  • values :keyword, default: [] - List values that will be sent as part of the payload triggered by an event

  • to :any, required: true - The page to link to

  • method :atom, default: :get - The method to use with the link

  • id :string - Id to apply to the link

  • class :css_class - Class or classes to apply to the link

  • label :string - The label for the generated <a> element, if no content (default slot) is provided.

  • opts :keyword, default: [] - Additional attributes to add onto the generated element

Slots

  • default - The content of the generated <a> element. If no content is provided, the value of property label is used instead.

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

Summary

Functions

Callback implementation for Surface.Component.render/1.