bs5_expandable_list_group 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3cf656df05f0efc37c63c574dc62e39dfc143911398bc3346f5641a1ac14400
-  data.tar.gz: 1122074157406c6c4a52aa579d59c64fe8162e3c320c5bb03d6dc56b8e5f9b12
+  metadata.gz: a25801cb5cccc05129ddee20be6d7613b6861725540fc35762abeb9533da688e
+  data.tar.gz: 8404505ce4e166979bacd59621d8354e40db54c7a9e582c0187a31d5e9101625
 SHA512:
-  metadata.gz: 2e225cb6367f28f3e31123bf1a9af9d6735bf441ef64e5d2276f04ebbfbf6d6b7545f7e00fc64741ca81b293b6273a9363cb802832f39fbc426a7a22998b819e
-  data.tar.gz: 3294f3b18925ebf3f7317bf07f67816e03e4fe54c700a8156de928675c88ec7183a1175de4aeebf738e0ecab9cda4bb0d5f8d971f0651e733121c67135671c3a
+  metadata.gz: 92876de97894c46e95299f40bc5ea069d1a0c8151da69c399c350e59573f71986e5a0534fe36308d651e0fb00f9b744b6b26a101a6f8f0e66b59a781e2144223
+  data.tar.gz: 807dbe554e7fb82bf8f29e6b69212f8afb2952110b23828703a5f0ce1b8dcf66a48a0dacd499bec41f2e5dcae97dafd9cd8b5342d8313af9623e2467cc492499

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/bazzel/Bs5ExpandableListGroup.svg?branch=main)](https://travis-ci.org/bazzel/Bs5ExpandableListGroup)
 
-**Bootstrap 5 expandable list group** gives you a simple API for creating expandable and stretchable list groups. A bit like [Bootstrap 5](https://getbootstrap.com/)'s [Accordion](https://getbootstrap.com/docs/5.0/components/accordion/), [Collapse](https://getbootstrap.com/docs/5.0/components/collapse/) and [List group](https://getbootstrap.com/docs/5.0/components/list-group/) components combined.
+**Bootstrap 5 expandable list group** is a Ruby on Rails engine and gives you a simple API for creating expandable and stretchable list groups. A bit like [Bootstrap 5](https://getbootstrap.com/)'s [Accordion](https://getbootstrap.com/docs/5.0/components/accordion/), [Collapse](https://getbootstrap.com/docs/5.0/components/collapse/) and [List group](https://getbootstrap.com/docs/5.0/components/list-group/) components combined.
 
 https://user-images.githubusercontent.com/7672/120296188-27170580-c2c8-11eb-936a-a93c16326acb.mp4
 
@@ -55,7 +55,7 @@ $ bin/rails generate bs5_expandable_list_group:install
 
 This copies the required assets to your application directory:
 
-Stylesheets are copied to `app/javascript/stylesheets`. If needed, you can the following line to your `application.scss` to import them:
+Stylesheets are copied to `app/javascript/stylesheets`. If needed, you can add the following line to your `application.scss` to import them:
 
 ```scss
 @import "bootstrap";
@@ -63,13 +63,11 @@ Stylesheets are copied to `app/javascript/stylesheets`. If needed, you can the f
 @import "stylesheets/stretchable-items";
 ```
 
-When you use Webpacker for your CSS, you should move these added stylesheets to the proper location (propably somewhere in `app/javascript` and import them in `application.scss` (or alike) located there.
-
 ## Usage
 
 To render a **Bootstrap 5 expandable list group** you use `render(Bs5::ExpandableListGroupComponent.new)` and pass it a block for rendering every list item.
 
-Let's say, in the `index` action of your `PostsController`, you have assigned `@posts` that contains a list of `Post` instances. To render these `@posts` in a **Bootstrap 5 expandable list group**, you put the following code in your `index.html.erb` template:
+Given that you have assigned a list of `Post` instances to `@posts`, to render these `@posts` in a **Bootstrap 5 expandable list group**, you put the following code in your template:
 
 ```erb
 <%= render(Bs5::ExpandableListGroupComponent.new) do |c| %>
@@ -131,7 +129,7 @@ To show one set:
     <% end %>
     <% i.actions do %>
       <%= link_to 'Delete', post, method: :delete, class: 'btn btn-sm btn-outline-danger' %>
-	   <%= link_to 'Edit', edit_post_path(post), class: 'btn btn-sm btn-outline-secondary' %>
+      <%= link_to 'Edit', edit_post_path(post), class: 'btn btn-sm btn-outline-secondary' %>
     <% end %>
     <%= i.body { ... } %>
   <% end %>
@@ -161,6 +159,28 @@ To show a different set on hovering:
   <% end %>
 ```
 
+### Omitting the `item` methods
+
+Instead of using the `item`'s methods `title`, `body` and/or `actions` you can just use (HTML-) text as a block.  
+This will render just a [list group item](https://getbootstrap.com/docs/5.0/components/list-group/#basic-example), but will come in handy when you, i.e. show the first 25 items of a longer list and want to present a "Load more" link as last item of the list (for simplicity sake the sample uses a non-working `link_to_next_page` although this is [part of Kaminari](https://github.com/kaminari/kaminari#the-link_to_next_page-and-link_to_previous_page-aliased-to-link_to_prev_page-helper-methods)):
+
+```erb
+<%= render(Bs5::ExpandableListGroupComponent.new) do |c| %>
+  <% @posts.each do |post| %>
+    <% c.item do |i| %>
+      <%= i.title { post.title } %>
+      <%= i.body  { post.text } %>
+    <% end %>
+  <% end %>
+  <% if @companies.next_page %>
+    <% c.item %>
+      <%= link_to_next_page @posts "Load more" %>
+    <% end %>
+  <% end %>
+<% end %>
+```
+
+
 ### Passing options
 
 The following options can be passed to `Bs5::ExpandableListGroupComponent.new`:

data/app/components/bs5/expandable_list_item_component.html.erb

@@ -1,9 +1,15 @@
-<%= tag.div(class: "list-group-item expandable-item", data: component_data_options) do %>
-  <div class="expandable-item-header">
-    <%= title %>
-    <%= actions %>
-  </div>
-  <%= tag.div(id: target_id, class: "expandable-item-body collapse", data: body_data_options) do %>
-    <%= body %>
+
+<% if simple_content? %>
+  <%= tag.div(content, class: "list-group-item") %>
+<% else %>
+  <%= tag.div(class: "list-group-item expandable-item", data: component_data_options) do %>
+    <div class="expandable-item-header">
+      <%= title %>
+      <%= actions %>
+    </div>
+    <%= tag.div(id: target_id, class: "expandable-item-body collapse", data: body_data_options) do %>
+      <%= body %>
+    <% end %>
   <% end %>
 <% end %>
+

data/app/components/bs5/expandable_list_item_component.rb

@@ -18,6 +18,10 @@ module Bs5
 
     private
 
+    def simple_content?
+      title.nil? && body.nil? && actions.nil?
+    end
+
     def target_id
       "expandable-list-item-#{object_id}"
     end

data/lib/bs5_expandable_list_group/version.rb

@@ -1,3 +1,3 @@
 module Bs5ExpandableListGroup
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bs5_expandable_list_group
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Patrick Baselier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -129,7 +129,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/bazzel/Bs5ExpandableListGroup
   source_code_uri: https://github.com/bazzel/Bs5ExpandableListGroup
-  changelog_uri: https://github.com/bazzel/Bs5ExpandableListGroup/CHANGELOG.md
+  changelog_uri: https://github.com/bazzel/Bs5ExpandableListGroup/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: