Skip to content

Switch to unpkg as default CDN provider #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 6, 2025
Merged

Switch to unpkg as default CDN provider #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b39ba32
1.1.0
justalever Oct 6, 2025
edbf78a
Switch to unpkg as default CDN provider
justalever Oct 6, 2025
468411a
Update demo to use unpkg for Stimulus CDN
justalever Oct 6, 2025
7891bad
Update demo to use unpkg importmap distribution
justalever Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions IMPORTMAP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ This guide helps Rails developers set up railsui-stimulus with importmaps.

```ruby
# Main package
pin "railsui-stimulus", to: "https://cdn.jsdelivr.net/npm/railsui-stimulus@1.0.11/dist/importmap/index.js"
pin "railsui-stimulus", to: "https://unpkg.com/railsui-stimulus@1.1.0/dist/importmap/index.js"

# Required dependencies
pin "@hotwired/stimulus", to: "https://ga.jspm.io/npm:@hotwired/[email protected]/dist/stimulus.js"
pin "tippy.js", to: "https://ga.jspm.io/npm:[email protected]/dist/tippy.esm.js"
pin "flatpickr", to: "https://ga.jspm.io/npm:[email protected]/dist/esm/index.js"
pin "hotkeys-js", to: "https://ga.jspm.io/npm:[email protected]/dist/hotkeys.esm.js"
pin "stimulus-use", to: "https://ga.jspm.io/npm:[email protected]/dist/index.js"
pin "@hotwired/stimulus", to: "https://unpkg.com/@hotwired/[email protected]/dist/stimulus.js"
pin "tippy.js", to: "https://unpkg.com/[email protected]/dist/tippy.esm.js"
pin "flatpickr", to: "https://unpkg.com/[email protected]/dist/esm/index.js"
pin "hotkeys-js", to: "https://unpkg.com/[email protected]/dist/hotkeys.esm.js"
pin "stimulus-use", to: "https://unpkg.com/[email protected]/dist/index.js"
```

### 2. Add CSS dependencies
Expand All @@ -27,14 +27,14 @@ Add to your `app/assets/stylesheets/application.css`:
@import "https://unpkg.com/[email protected]/dist/tippy.css";

/* Required for Date Range Picker component */
@import "https://cdn.jsdelivr.net/npm/[email protected]/dist/flatpickr.min.css";
@import "https://unpkg.com/[email protected]/dist/flatpickr.min.css";
```

Or add to your layout file (`app/views/layouts/application.html.erb`):

```erb
<%= stylesheet_link_tag "https://unpkg.com/[email protected]/dist/tippy.css", "data-turbo-track": "reload" %>
<%= stylesheet_link_tag "https://cdn.jsdelivr.net/npm/[email protected]/dist/flatpickr.min.css", "data-turbo-track": "reload" %>
<%= stylesheet_link_tag "https://unpkg.com/[email protected]/dist/flatpickr.min.css", "data-turbo-track": "reload" %>
```

### 3. Register components
Expand Down Expand Up @@ -106,11 +106,11 @@ pin "railsui-stimulus", to: "railsui-stimulus/index.js"
pin_all_from "vendor/javascript/railsui-stimulus", under: "railsui-stimulus"

# Dependencies (still need to be pinned)
pin "@hotwired/stimulus", to: "https://ga.jspm.io/npm:@hotwired/[email protected]/dist/stimulus.js"
pin "tippy.js", to: "https://ga.jspm.io/npm:[email protected]/dist/tippy.esm.js"
pin "flatpickr", to: "https://ga.jspm.io/npm:[email protected]/dist/esm/index.js"
pin "hotkeys-js", to: "https://ga.jspm.io/npm:[email protected]/dist/hotkeys.esm.js"
pin "stimulus-use", to: "https://ga.jspm.io/npm:[email protected]/dist/index.js"
pin "@hotwired/stimulus", to: "https://unpkg.com/@hotwired/[email protected]/dist/stimulus.js"
pin "tippy.js", to: "https://unpkg.com/[email protected]/dist/tippy.esm.js"
pin "flatpickr", to: "https://unpkg.com/[email protected]/dist/esm/index.js"
pin "hotkeys-js", to: "https://unpkg.com/[email protected]/dist/hotkeys.esm.js"
pin "stimulus-use", to: "https://unpkg.com/[email protected]/dist/index.js"
```

## Component-Specific CSS Notes
Expand Down Expand Up @@ -142,12 +142,12 @@ You can use different CDN providers if preferred:

**jsDelivr:**
```ruby
pin "railsui-stimulus", to: "https://cdn.jsdelivr.net/npm/railsui-stimulus@1.0.11/dist/importmap/index.js"
pin "railsui-stimulus", to: "https://cdn.jsdelivr.net/npm/railsui-stimulus@1.1.0/dist/importmap/index.js"
```

**unpkg:**
**JSPM:**
```ruby
pin "railsui-stimulus", to: "https://unpkg.com/railsui-stimulus@1.0.11/dist/importmap/index.js"
pin "railsui-stimulus", to: "https://ga.jspm.io/npm:railsui-stimulus@1.1.0/dist/importmap/index.js"
```

## Need Help?
Expand Down
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ Rails 7+ ships with importmap-rails by default. This method doesn't require npm

```ruby
# config/importmap.rb
pin "railsui-stimulus", to: "https://cdn.jsdelivr.net/npm/railsui-stimulus@1.0.11/dist/importmap/index.js"
pin "railsui-stimulus", to: "https://unpkg.com/railsui-stimulus@1.1.0/dist/importmap/index.js"

# Pin dependencies
pin "@hotwired/stimulus", to: "https://ga.jspm.io/npm:@hotwired/[email protected]/dist/stimulus.js"
pin "tippy.js", to: "https://ga.jspm.io/npm:[email protected]/dist/tippy.esm.js"
pin "flatpickr", to: "https://ga.jspm.io/npm:[email protected]/dist/esm/index.js"
pin "hotkeys-js", to: "https://ga.jspm.io/npm:[email protected]/dist/hotkeys.esm.js"
pin "stimulus-use", to: "https://ga.jspm.io/npm:[email protected]/dist/index.js"
pin "@hotwired/stimulus", to: "https://unpkg.com/@hotwired/[email protected]/dist/stimulus.js"
pin "tippy.js", to: "https://unpkg.com/[email protected]/dist/tippy.esm.js"
pin "flatpickr", to: "https://unpkg.com/[email protected]/dist/esm/index.js"
pin "hotkeys-js", to: "https://unpkg.com/[email protected]/dist/hotkeys.esm.js"
pin "stimulus-use", to: "https://unpkg.com/[email protected]/dist/index.js"
```

3. Add required CSS files to your `app/assets/stylesheets/application.css` or include via CDN:
Expand All @@ -47,14 +47,14 @@ pin "stimulus-use", to: "https://ga.jspm.io/npm:[email protected]/dist/index.j
@import "https://unpkg.com/[email protected]/dist/tippy.css";

/* For Date Range Picker component */
@import "https://cdn.jsdelivr.net/npm/[email protected]/dist/flatpickr.min.css";
@import "https://unpkg.com/[email protected]/dist/flatpickr.min.css";
```

Or in your layout file:

```erb
<%= stylesheet_link_tag "https://unpkg.com/[email protected]/dist/tippy.css" %>
<%= stylesheet_link_tag "https://cdn.jsdelivr.net/npm/[email protected]/dist/flatpickr.min.css" %>
<%= stylesheet_link_tag "https://unpkg.com/[email protected]/dist/flatpickr.min.css" %>
```

4. Import components in your JavaScript entrypoint (e.g., `app/javascript/controllers/index.js`):
Expand Down
12 changes: 6 additions & 6 deletions importmap.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"imports": {
"@hotwired/stimulus": "https://ga.jspm.io/npm:@hotwired/[email protected]/dist/stimulus.js",
"tippy.js": "https://ga.jspm.io/npm:[email protected]/dist/tippy.esm.js",
"flatpickr": "https://ga.jspm.io/npm:[email protected]/dist/esm/index.js",
"hotkeys-js": "https://ga.jspm.io/npm:[email protected]/dist/hotkeys.esm.js",
"stimulus-use": "https://ga.jspm.io/npm:[email protected]/dist/index.js"
"@hotwired/stimulus": "https://unpkg.com/@hotwired/[email protected]/dist/stimulus.js",
"tippy.js": "https://unpkg.com/[email protected]/dist/tippy.esm.js",
"flatpickr": "https://unpkg.com/[email protected]/dist/esm/index.js",
"hotkeys-js": "https://unpkg.com/[email protected]/dist/hotkeys.esm.js",
"stimulus-use": "https://unpkg.com/[email protected]/dist/index.js"
},
"scopes": {},
"description": "Importmap configuration for railsui-stimulus. These are the CDN URLs for required dependencies. You can also use different CDN providers like unpkg or skypack, or pin specific versions via importmap-rails."
"description": "Importmap configuration for railsui-stimulus. These are the CDN URLs for required dependencies using unpkg. You can also use different CDN providers like jsDelivr or JSPM, or pin specific versions via importmap-rails."
}
20 changes: 10 additions & 10 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,23 @@
<script>hljs.highlightAll();</script>

<!--
Importmap Configuration
Importmap Configuration (unpkg CDN)

This demo uses the UNBUNDLED importmap version of railsui-stimulus.
All dependencies are loaded separately via CDN.
This demo uses the importmap distribution from unpkg CDN.
This is the recommended setup for Rails 7+ applications.

For Rails apps, see IMPORTMAP.md for setup instructions.
For Rails importmap apps, see IMPORTMAP.md for setup instructions.
For npm/bundler apps, see BUILD.md for setup instructions.
-->
<script type="importmap">
{
"imports": {
"@hotwired/stimulus": "https://ga.jspm.io/npm:@hotwired/[email protected]/dist/stimulus.js",
"railsui-stimulus": "./dist/importmap/index.js",
"tippy.js": "https://ga.jspm.io/npm:[email protected]/dist/tippy.esm.js",
"flatpickr": "https://ga.jspm.io/npm:[email protected]/dist/esm/index.js",
"hotkeys-js": "https://ga.jspm.io/npm:[email protected]/dist/hotkeys.esm.js",
"stimulus-use": "https://ga.jspm.io/npm:[email protected]/dist/index.js"
"@hotwired/stimulus": "https://unpkg.com/@hotwired/[email protected]/dist/stimulus.js",
"railsui-stimulus": "https://unpkg.com/[email protected]/dist/importmap/index.js",
"tippy.js": "https://unpkg.com/[email protected]/dist/tippy.esm.js",
"flatpickr": "https://unpkg.com/[email protected]/dist/esm/index.js",
"hotkeys-js": "https://unpkg.com/[email protected]/dist/hotkeys.esm.js",
"stimulus-use": "https://unpkg.com/[email protected]/dist/index.js"
}
}
</script>
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "railsui-stimulus",
"version": "1.0.11",
"version": "1.1.0",
"description": "Rails UI Stimulus.js Components",
"main": "./dist/railsui-stimulus.cjs",
"module": "./dist/railsui-stimulus.module.js",
Expand Down