Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@astrojs/alpinejs
Advanced tools
@astrojs/alpinejs - npm Package Compare versions
Comparing version 0.3.1 to 0.3.2
| { | ||
| "name": "@astrojs/alpinejs", | ||
| "description": "Use Alpine within Astro", | ||
| "version": "0.3.1", | ||
| "version": "0.3.2", | ||
| "type": "module", | ||
@@ -35,3 +35,3 @@ "types": "./dist/index.d.ts", | ||
| "devDependencies": { | ||
| "astro": "3.2.3", | ||
| "astro": "4.0.8", | ||
| "astro-scripts": "0.0.14" | ||
@@ -38,0 +38,0 @@ }, |
114
README.md
@@ -5,107 +5,35 @@ # @astrojs/alpinejs | ||
| - <strong>[Installation](#installation)</strong> | ||
| - <strong>[Usage](#usage)</strong> | ||
| - <strong>[Configuration](#configuration)</strong> | ||
| - <strong>[Examples](#examples)</strong> | ||
| - <strong>[Troubleshooting](#troubleshooting)</strong> | ||
| - <strong>[Contributing](#contributing)</strong> | ||
| - <strong>[Changelog](#changelog)</strong> | ||
| ## Documentation | ||
| ## Installation | ||
| Read the [`@astrojs/alpinejs` docs][docs] | ||
| ### Quick Install | ||
| ## Support | ||
| The `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one. | ||
| - Get help in the [Astro Discord][discord]. Post questions in our `#support` forum, or visit our dedicated `#dev` channel to discuss current development and more! | ||
| ```sh | ||
| # Using NPM | ||
| npx astro add alpinejs | ||
| # Using Yarn | ||
| yarn astro add alpinejs | ||
| # Using PNPM | ||
| pnpm astro add alpinejs | ||
| ``` | ||
| - Check our [Astro Integration Documentation][astro-integration] for more on integrations. | ||
| If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. | ||
| - Submit bug reports and feature requests as [GitHub issues][issues]. | ||
| ### Manual Install | ||
| ## Contributing | ||
| First, install the `@astrojs/alpinejs` package using your package manager. If you're using npm or aren't sure, run this in the terminal: | ||
| This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! These links will help you get started: | ||
| ```sh | ||
| npm install @astrojs/alpinejs | ||
| ``` | ||
| - [Contributor Manual][contributing] | ||
| - [Code of Conduct][coc] | ||
| - [Community Guide][community] | ||
| Most package managers will install associated peer dependencies as well. However, if you see a "Cannot find package 'alpinejs'" (or similar) warning when you start up Astro, you'll need to manually install Alpine.js yourself: | ||
| ## License | ||
| ```sh | ||
| npm install alpinejs @types/alpinejs | ||
| ``` | ||
| MIT | ||
| Then, apply this integration to your `astro.config.*` file using the `integrations` property: | ||
| Copyright (c) 2023–present [Astro][astro] | ||
| ```diff lang="js" "alpine()" | ||
| // astro.config.mjs | ||
| import { defineConfig } from 'astro/config'; | ||
| + import alpine from '@astrojs/alpinejs'; | ||
| export default defineConfig({ | ||
| // ... | ||
| integrations: [alpine()], | ||
| // ^^^^^^^^ | ||
| }); | ||
| ``` | ||
| ## Usage | ||
| Once the integration is installed, you can use [Alpine.js](https://alpinejs.dev/) directives and syntax inside any Astro component. The Alpine.js script is automatically added and enabled on every page of your website. | ||
| Check our [Astro Integration Documentation][astro-integration] for more on integrations. | ||
| ## Limitations | ||
| The Alpine.js integration does not give you control over how the script is loaded or initialized. If you require this control, consider [installing and using Alpine.js manually](https://alpinejs.dev/essentials/installation). Astro supports all officially documented Alpine.js manual setup instructions, using `<script>` tags inside of an Astro component. | ||
| **It is not currently possible to [extend Alpine.js](https://alpinejs.dev/advanced/extending) when using this component.** If you need this feature, consider following [the manual Alpine.js setup](https://alpinejs.dev/essentials/installation) instead using an Astro script tag: | ||
| ```astro | ||
| --- | ||
| // src/pages/index.astro | ||
| --- | ||
| <!-- Example: Load AlpineJS on a single page. --> | ||
| <script> | ||
| import Alpine from 'alpinejs'; | ||
| // Optional: Extend Alpine.js | ||
| // Alpine.directive('foo', ...) | ||
| window.Alpine = Alpine; | ||
| Alpine.start(); | ||
| </script> | ||
| ``` | ||
| ## Configuration | ||
| The Alpine.js integration does not support any custom configuration at this time. | ||
| ## Examples | ||
| - The [Astro Alpine.js example](https://github.com/withastro/astro/tree/latest/examples/framework-alpine) shows how to use Alpine.js in an Astro project. | ||
| ## Troubleshooting | ||
| For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help! | ||
| You can also check our [Astro Integration Documentation][astro-integration] for more on integrations. | ||
| ## Contributing | ||
| This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! | ||
| ## Changelog | ||
| See [CHANGELOG.md](CHANGELOG.md) for a history of changes to this integration. | ||
| [astro]: https://astro.build/ | ||
| [docs]: https://docs.astro.build/en/guides/integrations-guide/alpinejs/ | ||
| [contributing]: https://github.com/withastro/astro/blob/main/CONTRIBUTING.md | ||
| [coc]: https://github.com/withastro/.github/blob/main/CODE_OF_CONDUCT.md | ||
| [community]: https://github.com/withastro/.github/blob/main/COMMUNITY_GUIDE.md | ||
| [discord]: https://astro.build/chat/ | ||
| [issues]: https://github.com/withastro/astro/issues | ||
| [astro-integration]: https://docs.astro.build/en/guides/integrations-guide/ | ||
| [astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-29.32%
6545
- Number of lines in readme file
- decreased by-64.86%
39
No dependency changes