updated docs

README.md

@@ -79,11 +79,6 @@ _(see [Quick Start](https://ddnexus.github.io/pagy/how-to#quick-start) for more
 
 Use the official extras, or write your own in just a few lines. Extras add special options and manage different components, behaviors, Frontend or Backend environments... usually by just requiring them:
 
-### Component Extras
-
-- [compact](http://ddnexus.github.io/pagy/extras/compact): An alternative UI that combines the pagination feature with the navigation info in one compact element: ![pagy-compact](docs/assets/images/pagy-compact-w.png)
-- [responsive](http://ddnexus.github.io/pagy/extras/responsive): On resize, the number of page links adapts in real-time to the available window or container width: ![pagy-responsive](docs/assets/images/pagy-responsive-w.png)
-
 ### Backend Extras
 
 - [array](http://ddnexus.github.io/pagy/extras/array): Paginate arrays efficiently, avoiding expensive array-wrapping and without overriding
@@ -103,6 +98,13 @@ Use the official extras, or write your own in just a few lines. Extras add speci
 - [out_of_range](http://ddnexus.github.io/pagy/extras/out_of_range): Allow for easy handling of out of range pages
 - [trim](http://ddnexus.github.io/pagy/extras/trim): Remove the `page=1` param from the first page link
 
+### Alternative components
+
+Besides the classic pagination `nav`, Pagy offers a few ready to use alternatives like:
+
+- [compact nav](http://ddnexus.github.io/pagy/extras/navs#compact-navs): An alternative UI that combines the pagination feature with the navigation info in one compact element: ![pagy-compact](docs/assets/images/pagy-compact-w.png)
+- [responsive nav](http://ddnexus.github.io/pagy/extras/navs#responsive-navs): On resize, the number of page links adapts in real-time to the available window or container width: ![pagy-responsive](docs/assets/images/pagy-responsive-w.png)
+
 ## Chat Support and Feedback
 
 [Chat on Gitter](https://gitter.im/ruby-pagy/Lobby)

docs/_layouts/default.html

@@ -36,13 +36,12 @@ <h1 id="site-title">{{ site.title | default: site.github.repository_name }} <a c
       <a href="{{ site.baseurl }}/extras/array"><p class="indent1" {% if page.title == 'Array' %}id="active"{% endif %} >Array</p></a>
       <a href="{{ site.baseurl }}/extras/bootstrap"><p class="indent1" {% if page.title == 'Bootstrap' %}id="active"{% endif %} >Bootstrap</p></a>
       <a href="{{ site.baseurl }}/extras/bulma"><p class="indent1" {% if page.title == 'Bulma' %}id="active"{% endif %} >Bulma</p></a>
-      <a href="{{ site.baseurl }}/extras/compact"><p class="indent1" {% if page.title == 'Compact' %}id="active"{% endif %} >Compact</p></a>
       <a href="{{ site.baseurl }}/extras/foundation"><p class="indent1" {% if page.title == 'Foundation' %}id="active"{% endif %} >Foundation</p></a>
       <a href="{{ site.baseurl }}/extras/i18n"><p class="indent1" {% if page.title == 'I18n' %}id="active"{% endif %} >I18n</p></a>
       <a href="{{ site.baseurl }}/extras/items"><p class="indent1" {% if page.title == 'Items' %}id="active"{% endif %} >Items</p></a>
       <a href="{{ site.baseurl }}/extras/out_of_range"><p class="indent1" {% if page.title == 'Out Of Range' %}id="active"{% endif %} >Out Of Range</p></a>
       <a href="{{ site.baseurl }}/extras/materialize"><p class="indent1" {% if page.title == 'Materialize' %}id="active"{% endif %} >Materialize</p></a>
-      <a href="{{ site.baseurl }}/extras/responsive"><p class="indent1" {% if page.title == 'Responsive' %}id="active"{% endif %} >Responsive</p></a>
+      <a href="{{ site.baseurl }}/extras/navs"><p class="indent1" {% if page.title == 'Navs' %}id="active"{% endif %} >Navs</p></a>
       <a href="{{ site.baseurl }}/extras/searchkick"><p class="indent1" {% if page.title == 'Searchkick' %}id="active"{% endif %} >Searchkick</p></a>
       <a href="{{ site.baseurl }}/extras/trim"><p class="indent1" {% if page.title == 'Trim' %}id="active"{% endif %} >Trim</p></a>
       <a href="{{ site.baseurl }}/migration-tips"><p {% if page.title == 'Migration Tips' %}id="active"{% endif %} >Migration Tips</p></a>

docs/api.md

@@ -8,7 +8,7 @@ title: API
 The whole core structure of Pagy is very simple: it is organized around 3 small modules of just ~100 lines of code in total:
 
 | Module           | Description                                                                                                     | Links                                                                                                        |
-| --------------- | -------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
+| ---------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
 | `Pagy`           | The small class that keeps track of the variables involved in the pagination                                    | [source](https://github.com/ddnexus/pagy/blob/master/lib/pagy.rb), [documentation](api/pagy.md)              |
 | `Pagy::Backend`  | The optional module that you can include in your controllers in order to automatically create the Pagy instance | [source](https://github.com/ddnexus/pagy/blob/master/lib/pagy/backend.rb), [documentation](api/backend.md)   |
 | `Pagy::Frontend` | The module to include in your views in order to get a few helpers for the HTML output                           | [source](https://github.com/ddnexus/pagy/blob/master/lib/pagy/frontend.rb), [documentation](api/frontend.md) |

docs/api/frontend.md

@@ -118,7 +118,7 @@ If you need to add some HTML attribute to the page links, you can pass some extr
 
 1. For all pagy objects: set the global variable `:link_extra`:
     ```ruby
-    # in the Pagy initializer file
+    # in the pagy.rb initializer file
     Pagy::VARS[:link_extra] = 'data-remote="true"'
     # in any view
     link = pagy_link_proc(pagy)

docs/api/pagy.md

@@ -8,7 +8,7 @@ The scope of the `Pagy` class is keeping track of the all integers and variables
 ## Synopsys
 
 ```ruby
-# set global defaults and extra variables typically in the Pagy initializer
+# set global defaults and extra variables typically in the pagy.rb initializer
 # they will get merged with every new Pagy instance
 Pagy::VARS[:items]    = 25
 Pagy::VARS[:some_var] = 'default value'
@@ -38,7 +38,7 @@ pagy.series
 
 The `Pagy::VARS` is a globally available hash used to set defaults variables. It gets merged with (and overridden by) the variables passed with the `new` method every times a `Pagy` instance gets created.
 
-You will typically use it in an initializer file to pass defaults values. For example:
+You will typically use it in a `pagy.rb` initializer file to pass defaults values. For example:
 
 ```ruby
 Pagy::VARS[:items]     = 25

docs/extras.md

@@ -5,24 +5,23 @@ title: Extras
 
 Pagy comes with a few optional extensions/extras:
 
-| Extra          | Description                                                                                            | Links                                                                                                                                   |
-| :------------- | :----------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
-| `array`        | Paginate arrays efficiently avoiding expensive array-wrapping and without overriding                   | [array.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/array.rb), [documentation](extras/array.md)                      |
-| `bootstrap`    | Nav helper and templates for Bootstrap pagination                                                      | [bootstrap.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/bootstrap.rb), [documentation](extras/bootstrap.md)          |
-| `bulma`        | Nav helper and templates for [Bulma](https://bulma.io) pagination component                            | [bulma.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/bulma.rb), [documentation](extras/bulma.md)                      |
-| `compact`      | An alternative UI that combines the pagination  with the nav info in a single compact element          | [compact.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/compact.rb), [documentation](extras/compact.md)                |
-| `foundation`   | Nav helper and templates for Foundation pagination                                                     | [foundation.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/foundation.rb), [documentation](extras/foundation.md)       |
-| `i18n`         | Use the `I18n` gem instead of the pagy implementation                                                  | [i18n.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/i81n.rb), [documentation](extras/i18n.md)                         |
-| `items`        | Allow the client to request a custom number of items per page with a ready to use selector UI          | [items.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/items.rb), [documentation](extras/items.md)                      |
-| `materialize`  | Nav helper for Materialize CSS [pagination component](https://materializecss.com/pagination.html)      | [materialize.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/materialize.rb), [documentation](extras/materialize.md)    |
-| `out_of_range` | Allow for easy handling of out of range pages                                                          | [out_of_range.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/out_of_range.rb), [documentation](extras/out_of_range.md) |
-| `responsive`   | On resize, the number of page links will adapt in real-time to the available window or container width | [responsive.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/responsive.rb), [documentation](extras/responsive.md)       |
-| `searchkick`   | Paginate arrays efficiently avoiding expensive array-wrapping and without overriding                   | [searchkick.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/searchkick.rb), [documentation](extras/searchkick.md)       |
-| `trim`         | Remove the `page=1` param from links                                                                   | [trim.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/trim.rb), [documentation](extras/trim.md)                         |
+| Extra          | Description                                                                                                                | Links                                                                                                                                   |
+| :------------- | :------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
+| `array`        | Paginate arrays efficiently avoiding expensive array-wrapping and without overriding                                       | [array.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/array.rb), [documentation](extras/array.md)                      |
+| `bootstrap`    | Nav, responsive and compact helpers and templates for Bootstrap pagination                                                 | [bootstrap.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/bootstrap.rb), [documentation](extras/bootstrap.md)          |
+| `bulma`        | Nav, responsive and compact helpers and templates for [Bulma](https://bulma.io) pagination component                       | [bulma.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/bulma.rb), [documentation](extras/bulma.md)                      |
+| `foundation`   | Nav, responsive and compact helpers and templates for Foundation pagination                                                | [foundation.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/foundation.rb), [documentation](extras/foundation.md)       |
+| `i18n`         | Use the `I18n` gem instead of the pagy implementation                                                                      | [i18n.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/i81n.rb), [documentation](extras/i18n.md)                         |
+| `items`        | Allow the client to request a custom number of items per page with a ready to use selector UI                              | [items.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/items.rb), [documentation](extras/items.md)                      |
+| `materialize`  | Nav, responsive and compact helpers for Materialize CSS [pagination component](https://materializecss.com/pagination.html) | [materialize.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/materialize.rb), [documentation](extras/materialize.md)    |
+| `navs`         | Add responsive and compact generic/unstyled nav helpers                                                                    | [navs.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/navs.rb), [documentation](extras/navs.md)                         |
+| `out_of_range` | Allow for easy handling of out of range pages                                                                              | [out_of_range.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/out_of_range.rb), [documentation](extras/out_of_range.md) |
+| `searchkick`   | Paginate arrays efficiently avoiding expensive array-wrapping and without overriding                                       | [searchkick.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/searchkick.rb), [documentation](extras/searchkick.md)       |
+| `trim`         | Remove the `page=1` param from links                                                                                       | [trim.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/trim.rb), [documentation](extras/trim.md)                         |
 
 ## Synopsys
 
-Extras are not loaded by default, so you should require them explicitly in your initializer _(see [Configuration](how-to.md#global-configuration))_:
+Extras are not loaded by default, so you should require them explicitly in your `pagy.rb` initializer _(see [Configuration](how-to.md#global-configuration))_:
 
 ```ruby
 require 'pagy/extras/bootstrap'
@@ -39,14 +38,14 @@ All the added methods are documented in the respective extras.
 
 ## Javascript
 
-The `compact`, `items` and `responsive` extras use javascript, so if you use any of them you should load the [pagy.js](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/javascripts/pagy.js) file, and run `Pagy.init()` on window load.
+The `compact`, `items` and `responsive` extras use javascript, so if you use any of them you should load the [pagy.js](https://github.com/ddnexus/pagy/blob/master/lib/javascripts/pagy.js) file, and run `Pagy.init()` on window load.
 
 ### In rails apps
 
 Add the assets-path in the `pagy.rb` initializer:
 
 ```ruby
-Rails.application.config.assets.paths << Pagy.root.join('pagy', 'extras', 'javascripts')
+Rails.application.config.assets.paths << Pagy.root.join('javascripts')
 ```
 
 Add the pagy javascript to the `application.js`:

docs/extras/bootstrap.md

@@ -3,17 +3,25 @@ title: Bootstrap
 ---
 # Bootstrap Extra
 
-This extra adds nav helper and templates for Bootstrap pagination.
+This extra adds nav helpers and templates for Bootstrap pagination.
 
 ## Synopsys
 
 See [extras](../extras.md) for general usage info.
 
+In the `pagy.rb` initializer:
+
+```ruby
+require 'pagy/extras/bootstrap'
+```
+
 Render the navigation links in some view...
 with a fast helper:
 
 ```erb
 <%== pagy_nav_bootstrap(@pagy) %>
+<%== pagy_nav_responsive_bootstrap(@pagy) %>
+<%== pagy_nav_compact_bootstrap(@pagy) %>
 ```
 
 or with a template:
@@ -22,25 +30,43 @@ or with a template:
 <%== render 'pagy/nav_bootstrap', locals: {pagy: @pagy} %>
 ```
 
+Configure [javascript](../extras.md#javascript) if you use `pagy_nav_responsive_bootstrap` or `pagy_nav_compact_bootstrap`.
+
 ## Files
 
 This extra is composed of 4 files:
 
 - [bootstrap.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/bootstrap.rb)
-- [nav_bootstrap.html.erb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/templates/nav_bootstrap.html.erb) (optional template)
-- [nav_bootstrap.html.haml](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/templates/nav_bootstrap.html.haml) (optional template)
-- [nav_bootstrap.html.slim](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/templates/nav_bootstrap.html.slim)  (optional template)
+- [nav_bootstrap.html.erb](https://github.com/ddnexus/pagy/blob/master/lib/templates/nav_bootstrap.html.erb) (optional template)
+- [nav_bootstrap.html.haml](https://github.com/ddnexus/pagy/blob/master/lib/templates/nav_bootstrap.html.haml) (optional template)
+- [nav_bootstrap.html.slim](https://github.com/ddnexus/pagy/blob/master/lib/templates/nav_bootstrap.html.slim)  (optional template)
 
 ## Methods
 
-This extra adds one nav helpers to the `Pagy::Frontend` module. You can customize it by overriding it directly in your own view helper.
+This extra adds 3 nav helpers to the `Pagy::Frontend` module. You can customize them by overriding it directly in your own view helper.
 
 ### pagy_nav_bootstrap(pagy)
 
 This method is the same as the `pagy_nav`, but customized for Bootstrap.
 
 The `nav_bootstrap.*` templates produce the same output, and can be used as an easier (but slower) starting point to override it.
 
+### pagy_nav_compact_bootstrap(pagy, ...)
+
+This method is the same as the `pagy_nav_compact`, but customized for the Bootstrap framework.
+
+Here is an example:
+
+![pagy-compact](../assets/images/pagy-compact-g.png)
+
+See more details in the [compact navs](navs.md#compact-navs) documentation.
+
+### pagy_nav_responsive_bootstrap(pagy, ...)
+
+This method is the same as the `pagy_nav_responsive`, but customized for the Bootstrap framework.
+
+See more details in the [responsive navs](navs.md#responsive-navs) documentation.
+
 ### Optional Template Files
 
 See [Using Templates](../how-to.md#using-templates).