Boxicon (Surface Boxicons v0.5.0) View Source

Boxicon is surface component library that wraps the amazing boxicons library.

Usage:

  defmodule MyComponent do
    use Surface.Component

    @impl true
    def render(assigns) do
      ~F"""
        <Boxicon
          name="calendar"
          type="regular"
          size="64"
          class="icon green"
        />
      """
    end
  end

To get a full list of all the available icons, go to https://boxicons.com/

Properties

  • type :string, values!: ["solid", "regular", "logos"], default: Application.get_env(:surface_boxicon, :default_type, "regular") - Type of the icon.
  • name :string, required: true - Name of the icon.
  • size :integer, default: Application.get_env(:surface_boxicon, :default_size, 24) - Width & height of the icon.
  • class :string, default: Application.get_env(:surface_boxicon, :default_class, "icon") - CSS classes for the wrapping svg element.

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.