Skip to content
Generate dynamic class strings easily
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.
bin V1.0.0 (#1) May 10, 2019
lib Update class_name.rb May 15, 2019
spec V1.0.0 (#1) May 10, 2019
.gitignore V1.0.0 (#1) May 10, 2019
.rspec Hello world! 👏 👏 👏 May 10, 2019
.rspec_status rspec result bump May 11, 2019
.travis.yml V1.0.0 (#1) May 10, 2019
CODE_OF_CONDUCT.md Hello world! 👏 👏 👏 May 10, 2019
Gemfile V1.0.0 (#1) May 10, 2019
Gemfile.lock Release May 11, 2019
LICENSE.txt V1.0.0 (#1) May 10, 2019
README.md Update README.md May 11, 2019
Rakefile V1.0.0 (#1) May 10, 2019
class_name.gemspec Fixed homepage url May 11, 2019

README.md

class_name

IHV Gem Version Build Status Build Status Build Status License Build Status Inline docs Security Maintainability Maintainability Technical Debt


A ruby implementation of Node's classnames package.

Installation

Add this line to your application's Gemfile:

gem 'class_name', github: 'invisiblehats/class_name'

And then execute:

$ bundle

Or install it yourself as:

$ gem install class_name

Usage

You can use this in any ruby environment. Test it out in your terminal:

require 'class_name'

include ClassName

class_name("ui card", { fluid: false, flexbox: true, float: false }, ["blue", "inverted"])
# "ui card flexbox blue inverted"

Rails

Add this line to ApplicationHelper:

module ApplicationHelper
  include ClassName
end

Then use it in your view templates:

<div class="<%= class_name('ui card', fluid: false, { blue: true }) %>"></div>

Would generate:

<div class="ui card blue"></div>

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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 install. 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/invisiblehats/class_name. 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.

License

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

Code of Conduct

Everyone interacting in the ClassName project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Development team

People

Partners

You can’t perform that action at this time.