agnosticui-astro v0.0.1

agnosticui-astro 🎉

This Astro integration enables AgnosticUI's agnostic-astro package in your Astro project.

AgnosticUI's agnostic-astro package is the Astro port of AgnosticUI that leverages XElement and Astro components. These UI components take advantage of the Astro's unique HTML-only templating with no client-side runtime capabilities helping you to create applications with blazingly fast performance and fully passing Lighthouse scores 🔥 💪

Installation

There are two ways to add integrations to your project. Let's try the most convenient option first!

(experimental) astro add command

Astro includes a CLI tool for adding first party integrations: astro add. This command will: 1. (Optionally) Install all necessary dependencies and peer dependencies 2. (Also optionally) Update your astro.config.* file to apply this integration

To install agnosticui-astro, run the following from your project directory and follow the prompts:

# Using NPM
npx astro add agnosticui-astro 
# Using Yarn
yarn astro add agnosticui-astro 
# Using PNPM
pnpx astro add agnosticui-astro

If you run into any hiccups, feel free to log an issue on our GitHub and try the manual installation steps below.

Install dependencies manually

First, install the agnosticui-astro integration like so:

npm install agnosticui-astro

Then, apply this integration to your astro.config.* file using the integrations property:

astro.config.mjs

import { defineConfig } from 'astro/config';
import agnosticAstro from 'agnosticui-astro';;

export default defineConfig({
	integrations: [agnosticAstro()]
});

Getting started

Visit AgnosticUI's agnostic-astro package documentation for configuration options and more usage guidance. Also see the Astro Integration Documentation for more on how to use integrations.

Testing Integration Locally

In one tab and in this same directory, build the integration and use pack to generate a tarball:

npm run build && npm pack

In another tab go to /test and install the tarball and run the app:

# of course the tarball name will likely be different
npm i ../agnosticui-astro-0.0.1.tgz && npm run dev

npm run build && npm pack