importmap-rails 0.9.5 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1406d9923764802841f3205c1a9aec24a218449673b793d9b9eb8af29c1da607
-  data.tar.gz: 166e27d0f7ee63ce971cace7aad3b0bb7fce013bfda89c48c6f4ef6014cd27b2
+  metadata.gz: 53d756788e46fd583d5f4dc1b813f11b8479237e766a556fbcbabebf4285ffdd
+  data.tar.gz: 640b9d1cce345d5193e12f17400c772532ddbc4fd97488567e9988eb3ac81fd7
 SHA512:
-  metadata.gz: 2b71b0af3396dab6c431b6acf5171e8c2ec0e91dbcc62c99a255a845fa938af93501bd4e36678fead960d8989605a96c4c057f74cca779872615aeab8613894e
-  data.tar.gz: 7e35dc22a60a3dd3c35f871d07419345e6f5099f6d9d896cb3b1ccd875ab56730fb19d91778f7be8f8b9a1c34865bf1ee44e3ee1daa6024acae5f18d6339c342
+  metadata.gz: 77a669609b58956d33610ebf3053e0ebe73bdfc1d79d1580df70f1f4d60f96ff92fec0dd0484bac01fe9ed678aac48a07da45402d0209c8a1869a3aece8db85a
+  data.tar.gz: 35e0355d199c75f066f6ce2bea61ceceec0d25e15b6cf10b5d1a052b583580413ab99c104a8a11435d72841b1675815d7535d3c44c976e51a2f3bf6e7910677e

data/README.md

@@ -1,6 +1,6 @@
 # Importmap for Rails
 
-[Import maps](https://github.com/WICG/import-maps) let you import JavaScript modules using logical names that map to versioned/digested files – directly from the browser. So you can [build modern JavaScript applications using JavaScript libraries made for ESM without the need for transpiling or bundling](https://world.hey.com/dhh/modern-web-apps-without-javascript-bundling-or-transpiling-a20f2755).This frees you from needing Webpack, Yarn, npm, or any other part of the JavaScript toolchain. All you need is the asset pipeline that's already included in Rails.
+[Import maps](https://github.com/WICG/import-maps) let you import JavaScript modules using logical names that map to versioned/digested files – directly from the browser. So you can [build modern JavaScript applications using JavaScript libraries made for ES modules (ESM) without the need for transpiling or bundling](https://world.hey.com/dhh/modern-web-apps-without-javascript-bundling-or-transpiling-a20f2755). This frees you from needing Webpack, Yarn, npm, or any other part of the JavaScript toolchain. All you need is the asset pipeline that's already included in Rails.
 
 With this approach you'll ship many small JavaScript files instead of one big JavaScript file. Thanks to HTTP/2 that no longer carries a material performance penalty during the initial transport, and in fact offers substantial benefits over the long run due to better caching dynamics. Whereas before any change to any JavaScript file included in your big bundle would invalidate the cache for the the whole bundle, now only the cache for that single file is invalidated.
 
@@ -42,7 +42,7 @@ to 1 of the 3 viable ways of loading ES Module javascript packages.
 For example:
 
 ```rb
-# config/importmaps.rb
+# config/importmap.rb
 pin "react", to: "https://ga.jspm.io/npm:react@17.0.2/index.js"
 ```
 
@@ -224,6 +224,41 @@ pin_all_from File.expand_path("../app/assets/javascripts", __dir__)
 ```
 
 
+## Selectively importing modules
+
+You can selectively import your javascript modules on specific pages.
+
+Create your javascript in `app/javascript`:
+
+```js
+// /app/javascript/checkout.js
+// some checkout specific js
+```
+
+Pin your js file:
+
+```rb
+# config/importmap.rb
+# ... other pins...
+pin "checkout"
+```
+
+Import your module on the specific page. Note: you'll likely want to use a `content_for` block on the specifc page/partial, then yield it in your layout.
+
+```erb
+<% content_for :head do %>
+  <%= javascript_import_module_tag "checkout" %>
+<% end %>
+```
+
+**Important**: The `javacript_import_module_tag` should come after your `javascript_importmap_tags`
+
+```erb
+<%= javascript_importmap_tags %>
+<%= yield(:head) %>
+```
+
+
 ## Include a digest of the import map in your ETag
 
 If you're using [ETags](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) generated by Rails helpers like `stale?` or `fresh_when`, you need to include the digest of the import map into this calculation. Otherwise your application will return 302 cache responses even when your JavaScript assets have changed. You can avoid this with something like: