Contents

[![Gem Version](https://badge.fury.io/rb/simple_form-theme.svg)](https://badge.fury.io/rb/simple_form-theme)

# SimpleForm::Theme
Short description and motivation.

### Supported CSS Frameworks
* [Tailwind CSS](https://tailwindcss.com/docs/installation)
* [Bulma](https://bulma.io/documentation/start/installation)

## Installation
Add this line to your application's Gemfile:

```ruby
gem 'simple_form-theme'
```

And then execute:
```bash
bundle
```

As an alternative instead of adding an additional dependency to your project,
you can copy the initializer file to your project from the GitHub repository.

Example:
```bash
cp lib/generators/simple_form/theme/templates/config/initializers/simple_form_tailwindcss.rb yourapp/config/initializers/simple_form_tailwindcss.rb
```

However, if you install the gem, you will get the latest updates and improvements.

## Requirements

* Make sure you have installed [simple_form](https://github.com/heartcombo/simple_form) gem.
* Make sure you have installed the decired css framework.

## Usage

### Install Tailwind CSS files

```bash
bin/rails generate simple_form:theme:tailwind install
```

After running this generator, you will see the `config/initializers/simple_form_tailwindcss.rb` file.
This file adds the Tailwind CSS styles to your application.
Additionally, the `config/locales/simple_form_tailwind.en.yml` file will add the "required" mark to the required fields.
However, you need to communicate Tailwind to "watch" those files by adding the following configuration:

```js
# tailwind.config.js

module.exports = {
  ...
  content: [
    './config/initializers/simple_form_tailwindcss.rb',
    './config/locales/simple_form*.yml',
    ...
  ],
}
```

### Install Bulma CSS files

```bash
bin/rails generate simple_form:theme:bulma install
```

## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/JuanVqz/simple_form-theme

## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
simple_form-theme-0.1.4	README.md
simple_form-theme-0.1.3	README.md