Surface UI

A server-side rendering component library for Phoenix

Surface UI

A component library for Phoenix

  • Home
  • Blog
  • Getting started
  • Documentation
    • Template Syntax
    • Components Basics
    • Properties
    • Data
    • Events
    • Slots
    • State Management
    • Contexts
    • Testing
    • JS Interoperability
    • Scoped CSS
    • Layouts & dead views
  • Built-in Components
    • Navigation

    • Link
    • LivePatch
    • LiveRedirect
    • Other

    • Markdown
    • Raw
    • Component (dynamic)
    • LiveComponent (dynamic)
  • Sample UI Components
    • Button
    • Table
    • Tabs
  • Home
  • Blog
  • Getting started
  • Documentation
    • Template Syntax
    • Components Basics
    • Properties
    • Data
    • Events
    • Slots
    • State Management
    • Contexts
    • Testing
    • JS Interoperability
    • Scoped CSS
    • Layouts & dead views
  • Built-in Components
    • Navigation

    • Link
    • LivePatch
    • LiveRedirect
    • Other

    • Markdown
    • Raw
    • Component (dynamic)
    • LiveComponent (dynamic)
  • Sample UI Components
    • Button
    • Table
    • Tabs
  • Home
  • Built-in Components
  • Link

Link

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 and usage

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

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.


# Public API

  • Properties
  • Slots
  • Events
Name Description Type Values Default
id Id to apply to the link.

:string — —
to Required. The page to link to.

:any — —
method The method to use with the link.

:atom — :get
class Class or classes to apply to the link.

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

:string — —
opts Additional attributes to add onto the generated element.

:keyword — []
values List values that will be sent as part of the payload triggered by an event.

:keyword — []
Name Description Arguments
default The content of the generated <a> element. If no content is provided, the value of property label is used instead.

—
Name Description
click

Triggered when the component receives click.

click_away

Triggered when a click event happens outside of the element.

capture_click

Triggered when the component captures click.

blur

Triggered when the component loses focus.

focus

Triggered when the component receives focus.

window_blur

Triggered when the page loses focus.

window_focus

Triggered when the page receives focus.

keydown

Triggered when a key on the keyboard is pressed.

keyup

Triggered when a key on the keyboard is released.

window_keydown

Triggered when a key on the keyboard is pressed (window-level).

window_keyup

Triggered when a key on the keyboard is released (window-level).

Name Description

Surface v0.12.0 - github.com/surface-ui/surface.