surface v0.1.0-alpha.2 API Reference

Modules

Surface is component based library for Phoenix LiveView.

Defines a stateless component.

Defines a form that lets the user submit information.

An input field that let the user specify a color, either with a text field or a color picker interface.

An input field that let the user enter a date, either with a text field or a date picker interface.

An input field that let the user enter both date and time, using a text field and a date picker interface.

An input field that let the user enter one or multiple e-mails.

Defines a form field.

A hidden input field.

An input field that let the user to enter a number.

An input field that let the user securely specify a password.

Defines a radio button.

An input field that let the user specify a numeric value in a given range, usually using a slider.

Defines a reset button.

An input field that let the user enter search queries.

Defines a submit button to send the form.

An input field that let the user enter a telephone number.

An input field that let the user enter a multi-line text.

An input field that let the user enter a single-line text.

An input field that let the user enter a time (hours, minutes and optionally seconds).

An input field that let the user enter a URL.

Defines a hyperlink.

Defines a link that will patch the current LiveView.

Defines a link that will redirect to a new LiveView.

A simple macro component that converts markdown into HTML at compile-time.

A macro component that does not translate any of its contents.

A live (stateless or stateful) component. A wrapper around Phoenix.LiveComponent.

A wrapper component around Phoenix.LiveView.

A low-level component which is responsible for translating its own content at compile time.

Defines a behaviour that must be implemented by all HTML/Surface node translators.