# BitstylesPhoenix

Basic helpers for [bitstyles](https://github.com/bitcrowd/bitstyles) for elixir phoenix projects.
Currently made for version 1.0.2 of bitstyles. Future versions might still work, since 
the common interface is just CSS classes. Feel free to drop PRs if you notice any inconsistencies with new versions.

## Requirements 

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

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `bitstyles_phoenix` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:bitstyles_phoenix, "~> 0.1.0"}
  ]
end
```

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

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

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

      ...
    end
  end

```


Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/bitstyles_phoenix](https://hexdocs.pm/bitstyles_phoenix).