Skip to content

Commit

Permalink
Change name!
Browse files Browse the repository at this point in the history
  • Loading branch information
croxton committed Dec 3, 2023
1 parent 4841260 commit cf90d56
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# htmx components
# Booster pack

## Overview

A minimalistic component framework that works seamlessly with [htmx](https://github.com/bigskysoftware/htmx) and [hx-boost](https://htmx.org/attributes/hx-boost/). No bundler required, all you need is `<script>`.

You can try it out online with StackBlitz:
https://stackblitz.com/github/croxton/htmx-components
https://stackblitz.com/github/croxton/htmx-booster-pack

### Add `data-component` attributes to your HTML:
```html
Expand Down Expand Up @@ -43,7 +43,7 @@ You want to run scripts when using `hx-boost` or `hx-get` swaps, and not have to
1. Include `components.min.js` in the `<head>` of your page, right after `htmx`:
```html
<script defer src="https://cdn.jsdelivr.net/gh/bigskysoftware/htmx@1.9.9/src/htmx.min.js"></script>
<script defer src="https://cdn.jsdelivr.net/gh/croxton/htmx-components@1.0.2/dist/components.min.js"></script>
<script defer src="https://cdn.jsdelivr.net/gh/croxton/htmx-booster-pack@1.0.3/dist/components.min.js"></script>
```

2. Create a folder in the webroot of your project to store components, e.g. `/scripts/components/.` Add a `<meta>` tag and set the `basePath` of your folder:
Expand Down Expand Up @@ -109,7 +109,7 @@ Every component must have a unique id. If you reuse a component multiple times i
The name of your component. No spaces or hyphens, but camelCase is fine. This must match the filename of your component script.

### data-load
The loading strategy to use for the component. See [Loading strategies](https://github.com/croxton/htmx-components#loading-strategies) below.
The loading strategy to use for the component. See [Loading strategies](https://github.com/croxton/htmx-booster-pack#loading-strategies) below.

### data-options
A JSON formatted string of options to pass to your component.
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "htmx-components",
"version": "1.0.2",
"name": "htmx-booster-pack",
"version": "1.0.3",
"description": "Minimal component framework for htmx",
"type": "module",
"exports": {
Expand All @@ -18,7 +18,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/croxton/htmx-components.git"
"url": "git+https://github.com/croxton/htmx-booster-pack.git"
},
"keywords": [
"htmx",
Expand Down

0 comments on commit cf90d56

Please sign in to comment.