BitstylesPhoenix

Basic helpers for bitstyles for elixir phoenix projects.

Requirements

Bitstyles must be installed separately into the asset generation. The helpers in this project just output classes for working with bitstyles.

Bitstyles versions from 4.3.0 down to 1.3.0 are supported.

Installation

The package can be installed by adding bitstyles_phoenix to your list of dependencies in mix.exs:

def deps do
  [
    {:bitstyles_phoenix, "~> 2.3"}
  ]
end

To make use of the various ui_* helpers in the project, just add a use statement to the phoenix application view_helpers:

  defp view_helpers do
    quote do
      # Use all HTML functionality (forms, tags, etc)
      use Phoenix.HTML
      use BitstylesPhoenix

      # Import basic rendering functionality (render, render_layout, etc)
      import Phoenix.View

      ...
    end
  end

Getting started

Check out the top level BitstylesPhoenix module for usage examples, for the ui_* helpers.

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/bitstyles_phoenix.

Configuration

Check out the top level BitstylesPhoenix module for configuration examples and documentation.

Developing bitstyles_phoenix

To live update the documentation when you change the lib folder you can do:

mix docs && fswatch -o lib | xargs -n1 -I {} mix docs

For running the demo app & integration tests check out the demo README.