From fc0c2fc844d6df202e0939207f46661d051aacd5 Mon Sep 17 00:00:00 2001 From: Sergey Moiseev Date: Tue, 6 Feb 2024 17:29:01 +0200 Subject: [PATCH 1/2] Lookbook rework (#2) --- Gemfile.lock | 2 +- README.md | 14 ++++++++------ {test/dummy => lib}/lookbook/checkbox_preview.rb | 0 .../dummy => lib}/lookbook/chips_input_preview.rb | 0 .../dummy => lib}/lookbook/chips_select_preview.rb | 0 {test/dummy => lib}/lookbook/input_preview.rb | 0 .../dummy => lib}/lookbook/menu_button_preview.rb | 0 {test/dummy => lib}/lookbook/modal_preview.rb | 0 {test/dummy => lib}/lookbook/radio_preview.rb | 0 {test/dummy => lib}/lookbook/select_preview.rb | 0 {test/dummy => lib}/lookbook/switch_preview.rb | 0 {test/dummy => lib}/lookbook/textarea_preview.rb | 0 test/dummy/app/views/layouts/application.html.erb | 5 +++-- test/dummy/config/application.rb | 2 +- 14 files changed, 13 insertions(+), 10 deletions(-) rename {test/dummy => lib}/lookbook/checkbox_preview.rb (100%) rename {test/dummy => lib}/lookbook/chips_input_preview.rb (100%) rename {test/dummy => lib}/lookbook/chips_select_preview.rb (100%) rename {test/dummy => lib}/lookbook/input_preview.rb (100%) rename {test/dummy => lib}/lookbook/menu_button_preview.rb (100%) rename {test/dummy => lib}/lookbook/modal_preview.rb (100%) rename {test/dummy => lib}/lookbook/radio_preview.rb (100%) rename {test/dummy => lib}/lookbook/select_preview.rb (100%) rename {test/dummy => lib}/lookbook/switch_preview.rb (100%) rename {test/dummy => lib}/lookbook/textarea_preview.rb (100%) diff --git a/Gemfile.lock b/Gemfile.lock index 5050880..9f6a637 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - turbo_material (0.1.4) + turbo_material (0.1.5) importmap-rails (~> 2.0.1) rails (~> 7.1, >= 7.1.2) stimulus-rails (~> 1.3) diff --git a/README.md b/README.md index ee9afd9..e700f1a 100644 --- a/README.md +++ b/README.md @@ -211,6 +211,10 @@ aside.mdc-drawer.main-drawer { } ``` +## Tailwind Forms customizations leakage + +This gem uses Tailwind for additional customizations, I am noticed that `@tailwindcss/forms` leaking to Material inputs adding partial white backgrounds. For now I would recommend to disable forms plugin while using this gem. + ## Installation Add this line to your application's Gemfile: @@ -230,15 +234,13 @@ $ gem install turbo_material ## Lookbook documentation for components -Gem implements [Lookbook](https://lookbook.build) documentation for all components. I am considering implementing a way to pass it's previews to lookbook in hosting application, but for now, to use it, please checkout gem source code and use it like this: +Gem implements [Lookbook](https://lookbook.build) documentation for all components. To use it in the application, add `gem 'lookbook'` to your Gemfile and run `bundle install`. Then add following to your `config/application.rb`: -```bash -bundle install -cd test/dummy -foreman start -f Procfile.dev +```ruby +config.lookbook.preview_paths = [TurboMaterial::Engine.root.join('lib/lookbook')] ``` -and then open [http://localhost:3000/lookbook](http://localhost:3000/lookbook) in your browser. +Or extend your existing config for `lookbook.preview_paths` with same value. ## Contributing This gem is open for new contributions. Use [Material Components for Web documentation](https://github.com/material-components/material-components-web/tree/master/packages) as a references for missing functionality. diff --git a/test/dummy/lookbook/checkbox_preview.rb b/lib/lookbook/checkbox_preview.rb similarity index 100% rename from test/dummy/lookbook/checkbox_preview.rb rename to lib/lookbook/checkbox_preview.rb diff --git a/test/dummy/lookbook/chips_input_preview.rb b/lib/lookbook/chips_input_preview.rb similarity index 100% rename from test/dummy/lookbook/chips_input_preview.rb rename to lib/lookbook/chips_input_preview.rb diff --git a/test/dummy/lookbook/chips_select_preview.rb b/lib/lookbook/chips_select_preview.rb similarity index 100% rename from test/dummy/lookbook/chips_select_preview.rb rename to lib/lookbook/chips_select_preview.rb diff --git a/test/dummy/lookbook/input_preview.rb b/lib/lookbook/input_preview.rb similarity index 100% rename from test/dummy/lookbook/input_preview.rb rename to lib/lookbook/input_preview.rb diff --git a/test/dummy/lookbook/menu_button_preview.rb b/lib/lookbook/menu_button_preview.rb similarity index 100% rename from test/dummy/lookbook/menu_button_preview.rb rename to lib/lookbook/menu_button_preview.rb diff --git a/test/dummy/lookbook/modal_preview.rb b/lib/lookbook/modal_preview.rb similarity index 100% rename from test/dummy/lookbook/modal_preview.rb rename to lib/lookbook/modal_preview.rb diff --git a/test/dummy/lookbook/radio_preview.rb b/lib/lookbook/radio_preview.rb similarity index 100% rename from test/dummy/lookbook/radio_preview.rb rename to lib/lookbook/radio_preview.rb diff --git a/test/dummy/lookbook/select_preview.rb b/lib/lookbook/select_preview.rb similarity index 100% rename from test/dummy/lookbook/select_preview.rb rename to lib/lookbook/select_preview.rb diff --git a/test/dummy/lookbook/switch_preview.rb b/lib/lookbook/switch_preview.rb similarity index 100% rename from test/dummy/lookbook/switch_preview.rb rename to lib/lookbook/switch_preview.rb diff --git a/test/dummy/lookbook/textarea_preview.rb b/lib/lookbook/textarea_preview.rb similarity index 100% rename from test/dummy/lookbook/textarea_preview.rb rename to lib/lookbook/textarea_preview.rb diff --git a/test/dummy/app/views/layouts/application.html.erb b/test/dummy/app/views/layouts/application.html.erb index 56b6f0f..b7f2318 100644 --- a/test/dummy/app/views/layouts/application.html.erb +++ b/test/dummy/app/views/layouts/application.html.erb @@ -6,14 +6,15 @@ <%= csrf_meta_tags %> <%= csp_meta_tag %> - - <%= javascript_importmap_tags %> + <%= stylesheet_link_tag "turbo_material/tailwind.css" %> <%= stylesheet_link_tag "tailwind", "inter-font", "data-turbo-track": "reload" %> <%= stylesheet_link_tag "application" %> + + <%= javascript_importmap_tags %> diff --git a/test/dummy/config/application.rb b/test/dummy/config/application.rb index 91b9ce0..5bf7753 100644 --- a/test/dummy/config/application.rb +++ b/test/dummy/config/application.rb @@ -25,6 +25,6 @@ class Application < Rails::Application # # config.time_zone = "Central Time (US & Canada)" # config.eager_load_paths << Rails.root.join("extras") - config.lookbook.preview_paths = ["lookbook"] + config.lookbook.preview_paths = [TurboMaterial::Engine.root.join('lib/lookbook')] end end From b2d8160b5c8ca49f33f019c60888329020f201cc Mon Sep 17 00:00:00 2001 From: Sergey Moiseev Date: Tue, 6 Feb 2024 17:32:49 +0200 Subject: [PATCH 2/2] Bump version to v0.1.6 --- lib/turbo_material/version.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/turbo_material/version.rb b/lib/turbo_material/version.rb index 3bd37fe..32bc6d6 100644 --- a/lib/turbo_material/version.rb +++ b/lib/turbo_material/version.rb @@ -1,3 +1,3 @@ module TurboMaterial - VERSION = "0.1.5" + VERSION = "0.1.6" end