ViewComponentScopedCss

Provides per-component scoped scss for viewcomponent

By providing special prefixes as scss class names, you can describe closed styles for each component, so you don't have to worry about css design such as bem.

Installation

Add this line to your application's Gemfile:

gem 'view_component_scoped_css'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install view_component_scoped_css

Usage

directory hier

app/component/application_component.rb

class ApplicationComponent < ViewComponent::Base
  include ViewComponentScopedCss::Base
end

app/component/button/component.rb

class Button::Component < ApplicationComponent
end

app/component/button/component.scss

:module(component) {
    color: white;
    background: green;
}

app/component/button/component.erb

<%= component_tag :button do %>
    test
<% end %>

app/views/layouts/application.html.erb

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <%= csrf_meta_tags %>
    <%= csp_meta_tag %>
    <%= yield :scoped_css_tags %>
  </head>
  <body>
    <main><%= yield %></main>
    <% provide(:scoped_css_tags, ViewComponentScopedCss.tags) %>
  </body>
</html>

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/aileron-inc/view_component_in_css. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 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 ViewComponentStyled project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.