Skip to content
Materialize Wrappers for SimpleForm
Ruby HTML CoffeeScript Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
bin
lib
test
.codeclimate.json
.gitignore
.mdlrc
.rubocop.yml
.yardopts
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Gemfile
LICENSE.txt
README.md
Rakefile
_config.yml
simple_form_materialize.gemspec

README.md

Simple Form Materialize

CircleCI Maintainability Test Coverage Gem Version Discord

Simple Form Materialize is here to help generate your configuration needed to using simple form with materialized styles. This gem is not intended to live forever in your gemfile. It must be in your gemfile to load the resources needed from the generator. Below in the installation section will detail out which gems to install for all to work.

Installation

Add these lines to your application's Gemfile:

# Required gems so you don't have to add files manually
gem "materialize-sass"
gem "material_icons"
gem "simple_form"

gem "simple_form_materialize", "~>1.2.0"

Usage

simple_form, materialize-sass and material_icons are required in your gemfile to enable the views to generate without error and in the proper style.

< rails g simple_form_materialize:install

This will generate your two config files and javascript file of initializers


your_project_name/
├─ app/
|   └─ assets/
|       └─ javascript/
|           └─ init_form_materialize.coffee
└─ config/
    └─ initializers/
        ├─ simple_form_components.rb
        └─ simple_form_materialize.rb

Change Log

Check out the Change Log for new features/bug fixes per release of a new version.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake build. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/chiefpansancolt/simple_form_materialize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

  • Fork Repo and create new branch
  • Once all is changed and committed create a pull request.

Ensure all merge conflicts are fixed and CI is passing.

License

The gem is available as open source under the terms of the MIT License.

You can’t perform that action at this time.