unpoly-rails 3.10.2 → 3.11.0.rc12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37db81cf31bc9480ba80407d23344ca9e4bfad195071a655852da126d4f56097
-  data.tar.gz: d4c8ee2ec83656a6e419002eca43f52f9eaa0656b02fa64087826e18cefcb299
+  metadata.gz: 551821fd3e2d1c7b3616920feefcf9b45bb9e0e2d6f01cd3217d6fdf6d9517e9
+  data.tar.gz: e195f3dc8af4ac112c332e46d6272a7ec163cae8f6c37b0d635b33e2c7d7a0e6
 SHA512:
-  metadata.gz: b959922764b4dafdf7b1756effcd3673bc834f652383da79ee4cb90e34d987b27a15c79ca156e5ef0d0a59e664ef96639c8abbb3c6deb5951b7736eb4d484866
-  data.tar.gz: 7209ed9ae1f2253689db9ce1aa4db9ee520c7f7794d1b4bce9e4305c945ba367f72e1d1800f4379a0dbeb78aeb7aba304cd739e73f0bf8b6d669c81509c62e1f
+  metadata.gz: 424952d386cf1db728343b020fab00f6b4c8da5d33c4f52586704c124a5c2e40b5b337a9d150c29e1830506d5d1f409a60bfe9b3400d8772e182323e36fd3af5
+  data.tar.gz: 0c875af0ac3c0d18784b1a3a99472338063992e3e54ee2ef244f66e36cb946e8caa7ecc36c222b071dcd014258681bf93a7fbdd23a9be65dbc40260166ce5d40

data/README.md

@@ -25,9 +25,9 @@ Now run `bundle install` and restart your development server.
 Installing frontend assets
 --------------------------
 
-### With esbuild or Webpacker
+### With npm
 
-If you're using [esbuild](https://esbuild.github.io/) or [Webpacker](https://edgeguides.rubyonrails.org/webpacker.html), install the [`unpoly` npm package](https://unpoly.com/install/npm) to get Unpoly's frontend files.
+If you're using a build tool like [esbuild](https://esbuild.github.io/) or [Webpacker](https://edgeguides.rubyonrails.org/webpacker.html), install the [`unpoly` npm package](https://unpoly.com/install/npm) to get Unpoly's frontend files.
 
 Now `import` Unpoly from your `application.js` pack:
 
@@ -41,7 +41,7 @@ You may need to import [additional files](https://unpoly.com/install), e.g. when
 
 ### With the Asset Pipeline
 
-If you're using the [Asset Pipeline](https://guides.rubyonrails.org/asset_pipeline.html), this `unpoly-rails` gem also contains Unpoly's frontend files. The files are automatically added to the Asset Pipeline's <a href="https://guides.rubyonrails.org/asset_pipeline.html#search-paths">search path</a>.
+If you're using the [Asset Pipeline](https://guides.rubyonrails.org/asset_pipeline.html), this `unpoly-rails` gem also contains Unpoly's frontend files.  The files are automatically added to the Asset Pipeline's <a href="https://guides.rubyonrails.org/asset_pipeline.html#search-paths">search path</a>.
 
 Add the following line to your `application.js` manifest:
 
@@ -270,51 +270,6 @@ For this to work you must also include the `<meta name="csp-nonce">` tag in the
 > Prefixing nonces only works for `[up-on...]` attributes. You cannot use it for native HTML attributes like `[onclick]`.
 
 
-### Working with context
-
-Calling `up.context` will return the [context](https://unpoly.com/up.context) object of the targeted layer.
-
-The context is a JSON object shared between the frontend and the server.
-It persists for a series of Unpoly navigation, but is cleared when the user makes a full page load.
-Different Unpoly [layers](https://unpoly.com/up.layer) will usually have separate context objects,
-although layers may choose to share their context scope. 
-
-You may read and change the context object. Changes will be sent to the frontend with your response.
-
-```ruby
-class GamesController < ApplicationController
-
-  def restart
-    up.context[:lives] = 3
-    render 'stage1'
-  end
-
-end
-```
-
-Keys can be accessed as either strings or symbols:
-
-```ruby
-puts "You have " + up.layer.context[:lives] + " lives left"
-puts "You have " + up.layer.context['lives'] + " lives left"
-````
-
-You may delete a key from the frontend by calling `up.context.delete`:
-
-```ruby
-up.context.delete(:foo)
-````
-
-You may replace the entire context by calling `up.context.replace`: 
-
-```ruby
-context_from_file = JSON.parse(File.read('context.json))
-up.context.replace(context_from_file)
-```
-
-`up.context` is an alias for `up.layer.context`.
-
-
 ### Accessing the targeted layer
 
 Use the methods below to interact with the [layer](/up.layer) of the fragment being targeted.
@@ -376,49 +331,61 @@ Returns whether the layer targeted for a failed response is an overlay.
 
 Returns the [context](https://unpoly.com/up.context) object of the layer targeted for a failed response.
 
+#### `up.origin_layer.mode`
 
-### Expiring the client-side cache
+Returns the [mode](https://unpoly.com/up.layer.mode) of the layer that caused the request.
 
-The Unpoly frontend [caches server responses](https://unpoly.com/caching) for a few minutes, making requests to these URLs return instantly.
-Only `GET` requests are cached. The entire cache is expired after every non-`GET` request (like `POST` or `PUT`).
+#### `up.origin_layer.root?`
 
-The server may override these defaults. For instance, the server can expire Unpoly's client-side response cache, even for `GET` requests:
+Returns whether the layer that caused the request is the root layer.
+
+#### `up.origin_layer.overlay?`
+
+Returns whether the layer that caused the request is an overlay.
+
+
+### Opening a new overlay
+
+You can request the frontend to [render your response in a new overlay](https://unpoly.com/X-Up-Open-Layer):
 
 ```ruby
-up.cache.expire
+up.layer.open
 ```
 
-You may also expire a single URL or [URL pattern](https://unpoly.com/url-patterns):
+This will discard the [initial request target](#detecting-a-fragment-update)
+and render your response into [`:main`](https://unpoly.com/main). You can pass an explicit
+target as a `:target` option:
 
 ```ruby
-up.cache.expire('/notes/*')
+up.layer.open(target: '#overlay')
 ```
 
-You may also prevent cache expiration for an unsafe request:
+Any [visual layer options](https://unpoly.com/customizing-overlays) can be also be passed as keyword arguments:
+
 
 ```ruby
-up.cache.expire(false)
+up.layer.open(mode: 'drawer', position: 'right')
 ```
 
-Here is an longer example where the server uses careful cache management to avoid expiring too much of the client-side cache:
+
+### Expiring the client-side cache
+
+The Unpoly frontend [caches server responses](https://unpoly.com/caching) for a few minutes, making requests to these URLs return instantly.
+Only `GET` requests are cached. The entire cache is expired after every non-`GET` request (like `POST` or `PUT`).
+
+The server may override these defaults. For instance, the server can expire Unpoly's client-side response cache, even for `GET` requests:
 
 ```ruby
-def NotesController < ApplicationController
+up.cache.expire
+```
 
-  def create
-    @note = Note.create!(params[:note].permit(...))
-    if @note.save
-      up.cache.expire('/notes/*') # Only expire affected entries
-      redirect_to(@note)
-    else
-      up.cache.expire(false) # Keep the cache fresh because we haven't saved
-      render 'new'
-    end
-  end
-  ...
-end
+You may also expire a single URL or [URL pattern](https://unpoly.com/url-patterns):
+
+```ruby
+up.cache.expire('/notes/*')
 ```
 
+
 ### Evicting pages from the client-side cache
 
 Instead of *expiring* pages from the cache you may also *evict*. The difference is that expired pages can still be rendered instantly and are then [revalidated](/caching#revalidation) with the server. Evicted pages are erased from the cache.
@@ -498,6 +465,52 @@ If the initial page was loaded with a non-`GET` HTTP method, Unpoly will fall ba
 The reason for this is that some browsers remember the method of the initial page load and don't let the application change it, even with `pushState`. Thus, when the user reloads the page much later, an affected browser might request a `POST`, `PUT`, etc. instead of the correct method.
 
 
+### Working with context
+
+Calling `up.context` will return the [context](https://unpoly.com/up.context) object of the targeted layer.
+
+The context is a JSON object shared between the frontend and the server.
+It persists for a series of Unpoly navigation, but is cleared when the user makes a full page load.
+Different Unpoly [layers](https://unpoly.com/up.layer) will usually have separate context objects,
+although layers may choose to share their context scope.
+
+You may read and change the context object. Changes will be sent to the frontend with your response.
+
+```ruby
+class GamesController < ApplicationController
+
+  def restart
+    up.context[:lives] = 3
+    render 'stage1'
+  end
+
+end
+```
+
+Keys can be accessed as either strings or symbols:
+
+```ruby
+puts "You have " + up.layer.context[:lives] + " lives left"
+puts "You have " + up.layer.context['lives'] + " lives left"
+````
+
+You may delete a key from the frontend by calling `up.context.delete`:
+
+```ruby
+up.context.delete(:foo)
+````
+
+You may replace the entire context by calling `up.context.replace`:
+
+```ruby
+context_from_file = JSON.parse(File.read('context.json))
+up.context.replace(context_from_file)
+```
+
+`up.context` is an alias for `up.layer.context`.
+
+
+
 What you still need to do manually
 ----------------------------------
 

data/assets/unpoly/unpoly-bootstrap3.js

@@ -50,7 +50,7 @@ __webpack_require__.r(__webpack_exports__);
 /******/ 	
 /************************************************************************/
 var __webpack_exports__ = {};
-// This entry need to be wrapped in an IIFE because it need to be isolated against other modules in the chunk.
+// This entry needs to be wrapped in an IIFE because it needs to be isolated against other modules in the chunk.
 (() => {
 up.status.config.currentClasses.push('active');
 up.status.config.activeClasses.push('active');

data/assets/unpoly/unpoly-bootstrap3.min.js

@@ -1 +1 @@
-(()=>{var o={303:(o,p,u)=>{"use strict";u.r(p)}},p={};function u(e){var a=p[e];if(void 0!==a)return a.exports;var t=p[e]={exports:{}};return o[e](t,t.exports,u),t.exports}u.r=o=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(o,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(o,"o",{value:!0})},up.status.config.currentClasses.push("active"),up.status.config.activeClasses.push("active"),up.status.config.navSelectors.push(".nav",".navbar"),up.form.config.groupSelectors.unshift(".form-group"),up.viewport.config.fixedTopSelectors.push(".navbar-fixed-top"),up.viewport.config.fixedBottomSelectors.push(".navbar-fixed-bottom"),up.viewport.config.anchoredRightSelectors.push(".navbar-fixed-top",".navbar-fixed-bottom"),up.fragment.config.badTargetClasses.push("row",/^col(-xs|-sm|-md|-lg)?(-\d+)?$/),up.layer.config.foreignOverlaySelectors.push(".modal:not(up-modal)",".popover:not(up-popup)",".dropdown-menu:not(up-popup)"),u(303)})();
+(()=>{var o={215:(o,p,u)=>{"use strict";u.r(p)}},p={};function u(e){var a=p[e];if(void 0!==a)return a.exports;var t=p[e]={exports:{}};return o[e](t,t.exports,u),t.exports}u.r=o=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(o,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(o,"o",{value:!0})},up.status.config.currentClasses.push("active"),up.status.config.activeClasses.push("active"),up.status.config.navSelectors.push(".nav",".navbar"),up.form.config.groupSelectors.unshift(".form-group"),up.viewport.config.fixedTopSelectors.push(".navbar-fixed-top"),up.viewport.config.fixedBottomSelectors.push(".navbar-fixed-bottom"),up.viewport.config.anchoredRightSelectors.push(".navbar-fixed-top",".navbar-fixed-bottom"),up.fragment.config.badTargetClasses.push("row",/^col(-xs|-sm|-md|-lg)?(-\d+)?$/),up.layer.config.foreignOverlaySelectors.push(".modal:not(up-modal)",".popover:not(up-popup)",".dropdown-menu:not(up-popup)"),u(215)})();

data/assets/unpoly/unpoly-bootstrap4.js

@@ -50,7 +50,7 @@ __webpack_require__.r(__webpack_exports__);
 /******/ 	
 /************************************************************************/
 var __webpack_exports__ = {};
-// This entry need to be wrapped in an IIFE because it need to be isolated against other modules in the chunk.
+// This entry needs to be wrapped in an IIFE because it needs to be isolated against other modules in the chunk.
 (() => {
 up.status.config.currentClasses.push('active');
 up.status.config.activeClasses.push('active');

data/assets/unpoly/unpoly-bootstrap4.min.js

@@ -1 +1 @@
-(()=>{var o={79:(o,p,u)=>{"use strict";u.r(p)}},p={};function u(e){var t=p[e];if(void 0!==t)return t.exports;var a=p[e]={exports:{}};return o[e](a,a.exports,u),a.exports}u.r=o=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(o,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(o,"o",{value:!0})},up.status.config.currentClasses.push("active"),up.status.config.activeClasses.push("active"),up.status.config.navSelectors.push(".nav",".navbar"),up.form.config.groupSelectors.unshift(".form-group"),up.viewport.config.fixedTopSelectors.push(".navbar.fixed-top"),up.viewport.config.fixedBottomSelectors.push(".navbar.fixed-bottom"),up.viewport.config.anchoredRightSelectors.push(".navbar.fixed-top",".navbar.fixed-bottom"),up.fragment.config.badTargetClasses.push("row",/^col(-xs|-sm|-md|-lg|-xl)?(-\d+)?$/,/^[mp][tblrxy]?-\d+$/),up.layer.config.foreignOverlaySelectors.push(".modal:not(up-modal)",".popover:not(up-popup)",".dropdown-menu:not(up-popup)"),u(79)})();
+(()=>{var o={566:(o,p,u)=>{"use strict";u.r(p)}},p={};function u(e){var t=p[e];if(void 0!==t)return t.exports;var a=p[e]={exports:{}};return o[e](a,a.exports,u),a.exports}u.r=o=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(o,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(o,"o",{value:!0})},up.status.config.currentClasses.push("active"),up.status.config.activeClasses.push("active"),up.status.config.navSelectors.push(".nav",".navbar"),up.form.config.groupSelectors.unshift(".form-group"),up.viewport.config.fixedTopSelectors.push(".navbar.fixed-top"),up.viewport.config.fixedBottomSelectors.push(".navbar.fixed-bottom"),up.viewport.config.anchoredRightSelectors.push(".navbar.fixed-top",".navbar.fixed-bottom"),up.fragment.config.badTargetClasses.push("row",/^col(-xs|-sm|-md|-lg|-xl)?(-\d+)?$/,/^[mp][tblrxy]?-\d+$/),up.layer.config.foreignOverlaySelectors.push(".modal:not(up-modal)",".popover:not(up-popup)",".dropdown-menu:not(up-popup)"),u(566)})();

data/assets/unpoly/unpoly-bootstrap5.js

@@ -50,7 +50,7 @@ __webpack_require__.r(__webpack_exports__);
 /******/ 	
 /************************************************************************/
 var __webpack_exports__ = {};
-// This entry need to be wrapped in an IIFE because it need to be isolated against other modules in the chunk.
+// This entry needs to be wrapped in an IIFE because it needs to be isolated against other modules in the chunk.
 (() => {
 up.status.config.currentClasses.push('active');
 up.status.config.activeClasses.push('active');

data/assets/unpoly/unpoly-bootstrap5.min.js

@@ -1 +1 @@
-(()=>{var o={313:(o,p,e)=>{"use strict";e.r(p)}},p={};function e(u){var t=p[u];if(void 0!==t)return t.exports;var a=p[u]={exports:{}};return o[u](a,a.exports,e),a.exports}e.r=o=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(o,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(o,"o",{value:!0})},up.status.config.currentClasses.push("active"),up.status.config.activeClasses.push("active"),up.status.config.navSelectors.push(".nav",".navbar"),up.viewport.config.fixedTopSelectors.push(".navbar.fixed-top"),up.viewport.config.fixedBottomSelectors.push(".navbar.fixed-bottom"),up.viewport.config.anchoredRightSelectors.push(".navbar.fixed-top",".navbar.fixed-bottom"),up.fragment.config.badTargetClasses.push("row",/^col(-xs|-sm|-md|-lg|-xl|-xxl)?(-\d+)?$/,/^[mp][tbsexy]?-\d+$/),up.layer.config.foreignOverlaySelectors.push(".modal:not(up-modal)",".popover:not(up-popup)",".dropdown-menu:not(up-popup)"),e(313)})();
+(()=>{var o={633:(o,p,e)=>{"use strict";e.r(p)}},p={};function e(u){var t=p[u];if(void 0!==t)return t.exports;var a=p[u]={exports:{}};return o[u](a,a.exports,e),a.exports}e.r=o=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(o,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(o,"o",{value:!0})},up.status.config.currentClasses.push("active"),up.status.config.activeClasses.push("active"),up.status.config.navSelectors.push(".nav",".navbar"),up.viewport.config.fixedTopSelectors.push(".navbar.fixed-top"),up.viewport.config.fixedBottomSelectors.push(".navbar.fixed-bottom"),up.viewport.config.anchoredRightSelectors.push(".navbar.fixed-top",".navbar.fixed-bottom"),up.fragment.config.badTargetClasses.push("row",/^col(-xs|-sm|-md|-lg|-xl|-xxl)?(-\d+)?$/,/^[mp][tbsexy]?-\d+$/),up.layer.config.foreignOverlaySelectors.push(".modal:not(up-modal)",".popover:not(up-popup)",".dropdown-menu:not(up-popup)"),e(633)})();