https://github.com/bancedev/alpine-pages
Alpine.js plugin for cleanly making multiple client side pages with expanded reactivity.
https://github.com/bancedev/alpine-pages
Last synced: 4 months ago
JSON representation
Alpine.js plugin for cleanly making multiple client side pages with expanded reactivity.
- Host: GitHub
- URL: https://github.com/bancedev/alpine-pages
- Owner: BanceDev
- License: mit
- Created: 2024-08-14T11:56:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-24T14:24:53.000Z (almost 2 years ago)
- Last Synced: 2025-09-30T14:14:54.160Z (9 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/alpinejs-pages
- Size: 45.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Alpine Pages
Alpine Pages is a plugin desinged to make it simpler to make multiple "pages" for your Alpine SPA. This is achieved by allowing you to make fully reactive html and css inside your Alpine.data, enabling you to use alpine in more freeform ways and preventing clutter in your html documents.
## Install
### With a CDN
```html
```
### With a Package Manager
```shell
yarn add -D alpinejs-pages
npm install -D alpinejs-pages
```
```js
import Alpine from "alpinejs";
import pages from "alpinejs-pages";
Alpine.plugin(pages);
Alpine.start();
```
## Example
To create a page, just add a page function to an Alpine.data. This function needs to return a string of html that will make up your page. You may also make a styles function that will create scoped css for your page. The plugin automatically handles reactivity for embedding format strings. That way if any member of your data updates the page or styles will update with it.
```js
document.addEventListener("alpine:init", () => {
Alpine.data("home", () => ({
message: "hello",
color: "red",
styles() {
return `
h2 {
color: ${this.color};
}
`;
},
page() {
return `
${this.message}
`;
},
}));
});
```
In the HTML you first need to add your data to the scope. Then to render the page just attach the x-page property to an html tag and it will fill in the inner html with your page. Since the page functions as a sort of template you can also make multiple instances of the page if you want by attaching the x-page attribute to multiple html tags within your data scope.
```html
goodbye
```