Kozenet UI
Beautiful, minimal, Apple-inspired UI components for Rails.
Installation
Add to your Gemfile:
gem "kozenet_ui", github: "kozenetpro/kozenet_ui"Then run:
bundle installIf you want to use a released version from RubyGems.org (after release):
bundle add kozenet_uiOr:
gem install kozenet_uiUsage in your Rails app
-
Add the theme variables tag to your layout
<head>:<%= kozenet_ui_theme_variables_tag %>
-
Import Kozenet UI styles in your main application.css:
@import "kozenet_ui/tokens.css"; @import "kozenet_ui/base.css"; @import "kozenet_ui/components.css";
-
(Optional) Override icons: Place your own SVGs in
app/assets/images/icons/to override the gem's icons. -
Customize colors in
config/initializers/kozenet_ui.rb. -
Use components in your views:
<%= render KozenetUi::HeaderComponent.new do |header| %> ... <% end %>
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/kozenetpro/kozenet_ui. 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 KozenetUi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.