rails_accordion 0.2.0.pre.beta → 0.2.2.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e9e757eaa0cead4dab2b564df0a1ca006e5638d11c1d0fa6261595ea3faf367
-  data.tar.gz: 89a3fd28498cf34c6ac666abd5be076aba75a8c0125b3903a9eaa36b68d2d822
+  metadata.gz: bf3f97b048a95a190cabdb3132a8d1dff2fefd0816c677c4201fe5f8b6b776bf
+  data.tar.gz: df20bf60d4c6ec24c3b7cab4d76ff4c6bd0596d14974060d97636996b8b8bdc5
 SHA512:
-  metadata.gz: a1c850657c4d42d3a00db7f82aee4862e7e8f8c26843c2092ed435913349ee5870961b79fd88ed6cb84a9400e5ceb37cb02caeb75d43344ec90d5b34a5928f38
-  data.tar.gz: 2a319415261a298555ad85e36f735f4775cb2c42c7f2ec53420bc366c608e9d8ba60db35e59d2fb51ae21bb1f83ad59fe00afc68d214a78b80bb7a9af0eb65e2
+  metadata.gz: 51d8736179dd89ff72eb84f244475d7f73fe39388ad9fd9680c10ec1444b7295c91c3fd37aeccfdb0cbeaf662ad76d46f31dd8b6027aa8d93f04cbed28ef6cf8
+  data.tar.gz: 7278d6e7e8b925b7f1b999b235219296405276793ea0555b9d1f6143ecce82497ac741840fc8c57b9a11558d1a981fe18f4897e55f24049bdaa8bede82bef3d9

data/README.md

@@ -5,7 +5,7 @@ rails_accordion is a Ruby gem that provides an easy-to-use accordion component f
 ## Installation
 
 ```rb
-gem 'rails_accordion', '~> 0.1.12.pre.beta'
+gem 'rails_accordion', '~> 0.2.0.pre.beta'
 ```
 
 ```shell
@@ -16,26 +16,69 @@ bundle install
 rails generate rails_accordion:install
 ```
 
-In config/importmap.rb, add:
+Then follow the instructions for your JavaScript setup:
 
-```rb
+- [Importmap](#importmap) (Rails 7 default)
+- [esbuild, rollup.js, or Webpack](#esbuild-rollupjs-or-webpack)
+- [Webpacker](#webpacker) (Rails 6 default)
+- [Sprockets](#sprockets)
+
+### Importmap
+
+In `config/importmap.rb`, add:
+
+```ruby
 pin "rails_accordion", to: "rails_accordion.js"
 ```
 
-And in app/javascript/application.js, add:
+And in `app/javascript/application.js`, add:
+
+```js
+import "rails_accordion"
+```
+
+### esbuild, rollup.js, or Webpack
+
+Run:
+
+```sh
+yarn add rails_accordion rails_accordion.js
+```
+
+And in `app/javascript/application.js`, add:
+
+```js
+import "rails_accordion/rails_accordion.js"
+```
+
+Note: For rollup.js, this requires `format: "iife"` in `rollup.config.js`.
+
+### Webpacker
+
+Run:
+
+```sh
+yarn add rails_accordion rails_accordion.js
+```
+
+And in `app/javascript/packs/application.js`, add:
+
 ```js
-import 'rails_accordion'
+import "rails_accordion/rails_accordion.js"
 ```
 
-in application.scss, add:
-```scss
-@import 'rails_accordion'
+### Sprockets
+
+In `app/assets/javascripts/application.js`, add:
+
+```js
+//= require rails_accordion
 ```
 
 ## Usage
 
 ```erb
-<%= accordion class: "bg-white rounded-xl overflow-auto", data: {controller: "tooltip"} do %>
+<%= accordion class: "bg-white rounded-xl overflow-auto" do %>
     <%= accordion_item do |item| %>
         <% item.header do  %>
             Hello world
@@ -47,6 +90,13 @@ in application.scss, add:
 <% end %>
 ```
 
+### Options
+
+multiple_open: [true, false]
+default_state: 1. all_closed: All items are closed on page load. 2. all_opened: All items are opened. 3. first_opened: First item is opened by default
+
+<%= accordion class: "bg-white rounded-xl overflow-auto", default_state: :all_opened do %>
+
 ## 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.
@@ -55,7 +105,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_accordion. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rails_accordion/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_accordion. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Tajbrains/rails_accordion/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/rails_accordion/configuration.rb

@@ -3,7 +3,7 @@ module RailsAccordion
     attr_accessor :default_state, :animation_duration, :multiple_open
 
     def initialize
-      @default_state = :closed
+      @default_state = :all_closed
       @animation_duration = 300
       @multiple_open = false
     end

data/rails_accordion.gemspec

@@ -4,12 +4,12 @@ require_relative "lib/rails_accordion/version"
 
 Gem::Specification.new do |spec|
   spec.name = "rails_accordion"
-  spec.version = RailsAccordion::VERSION
+  spec.version = ENV['GEM_VERSION'] || RailsAccordion::VERSION
   spec.authors = ["Ahmadshoh Nasrullozoda"]
   spec.email = ["tajbrains@gmail.com"]
 
-  spec.summary = "rails_accordion is in development."
-  spec.description = "rails_accordion is in development."
+  spec.summary = "rails_accordion is a Ruby gem that provides an easy-to-use accordion component for use in Rails web applications."
+  spec.description = "rails_accordion is a Ruby gem that provides an easy-to-use accordion component for use in Rails web applications. With this gem, developers can create collapsible sections of content that can be expanded or collapsed with a single click. The accordion is a great way to improve the user experience of your web application, by providing a clean and intuitive way to display complex information."
   spec.homepage = "https://tajbrains.com"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_accordion
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.beta
+  version: 0.2.2.pre.beta
 platform: ruby
 authors:
 - Ahmadshoh Nasrullozoda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-21 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stimulus-rails
@@ -52,7 +52,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-description: rails_accordion is in development.
+description: rails_accordion is a Ruby gem that provides an easy-to-use accordion
+  component for use in Rails web applications. With this gem, developers can create
+  collapsible sections of content that can be expanded or collapsed with a single
+  click. The accordion is a great way to improve the user experience of your web application,
+  by providing a clean and intuitive way to display complex information.
 email:
 - tajbrains@gmail.com
 executables: []
@@ -109,5 +113,6 @@ requirements: []
 rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: rails_accordion is in development.
+summary: rails_accordion is a Ruby gem that provides an easy-to-use accordion component
+  for use in Rails web applications.
 test_files: []