@ramstack/alpinegear-main 1.0.0-preview.1 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,36 @@
|
|
|
2
2
|
|
|
3
3
|
`@ramstack/alpinegear-main` is a combined plugin for [Alpine.js](https://alpinejs.dev/) that includes several useful directives. This plugin aggregates multiple individual plugins, providing a convenient all-in-one package.
|
|
4
4
|
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
### Using CDN
|
|
8
|
+
To include the CDN version of this plugin, add the following `<script>` tag before the core `alpine.js` file:
|
|
9
|
+
|
|
10
|
+
```html
|
|
11
|
+
<!-- alpine.js plugin -->
|
|
12
|
+
<script src="https://cdn.jsdelivr.net/npm/@ramstack/alpinegear-main@1/dist/alpinegear-main.min.js" defer></script>
|
|
13
|
+
|
|
14
|
+
<!-- alpine.js -->
|
|
15
|
+
<script src="https://cdn.jsdelivr.net/npm/alpinejs@3.x.x/dist/cdn.min.js" defer></script>
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### Using NPM
|
|
19
|
+
Alternatively, you can install the plugin via `npm`:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install --save @ramstack/alpinegear-main
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Then initialize it in your bundle:
|
|
26
|
+
|
|
27
|
+
```js
|
|
28
|
+
import Alpine from "alpinejs";
|
|
29
|
+
import main from "@ramstack/alpinegear-main";
|
|
30
|
+
|
|
31
|
+
Alpine.plugin(main);
|
|
32
|
+
Alpine.start();
|
|
33
|
+
```
|
|
34
|
+
|
|
5
35
|
## Included Plugins
|
|
6
36
|
|
|
7
37
|
**[@ramstack/alpinegear-bound](https://github.com/rameel/ramstack.alpinegear.js/tree/main/src/plugins/bound)** ([README](https://github.com/rameel/ramstack.alpinegear.js/tree/main/src/plugins/bound))<br>
|
|
@@ -102,36 +132,6 @@ Provides the `x-when` directive, which allows for conditional rendering of eleme
|
|
|
102
132
|
</template>
|
|
103
133
|
```
|
|
104
134
|
|
|
105
|
-
## Installation
|
|
106
|
-
|
|
107
|
-
### Using CDN
|
|
108
|
-
To include the CDN version of this plugin, add the following `<script>` tag before the core `alpine.js` file:
|
|
109
|
-
|
|
110
|
-
```html
|
|
111
|
-
<!-- alpine.js plugin -->
|
|
112
|
-
<script src="https://cdn.jsdelivr.net/npm/@ramstack/alpinegear-main@1/dist/alpinegear-main.min.js" defer></script>
|
|
113
|
-
|
|
114
|
-
<!-- alpine.js -->
|
|
115
|
-
<script src="https://cdn.jsdelivr.net/npm/alpinejs@3.x.x/dist/cdn.min.js" defer></script>
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
### Using NPM
|
|
119
|
-
Alternatively, you can install the plugin via `npm`:
|
|
120
|
-
|
|
121
|
-
```bash
|
|
122
|
-
npm install --save @ramstack/alpinegear-main
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
Then initialize it in your bundle:
|
|
126
|
-
|
|
127
|
-
```js
|
|
128
|
-
import Alpine from "alpinejs";
|
|
129
|
-
import main from "@ramstack/alpinegear-main";
|
|
130
|
-
|
|
131
|
-
Alpine.plugin(main);
|
|
132
|
-
Alpine.start();
|
|
133
|
-
```
|
|
134
|
-
|
|
135
135
|
## Source Code
|
|
136
136
|
You can find the source code for this plugin on GitHub:
|
|
137
137
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ramstack/alpinegear-main",
|
|
3
|
-
"version": "1.0.0
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "@ramstack/alpinegear-main is a combined plugin that includes several Alpine.js directives, providing a convenient all-in-one package.",
|
|
5
5
|
"author": "Rameel Burhan",
|
|
6
6
|
"license": "MIT",
|