To install Altea (soon available) use the following command:
npm i altea
yarn install altea
Get started with Altea by importing the stylesheet.
import "altea/globals.css";
Define the theme in the app.html file (or any other place)
<html class="light-theme"> <!--style="color-scheme: light;" is optional-->
...
Now you can start using components!
<script>
import { Button } from "altea";
</script>
<Button variant="shadow">Hello World</Button>
Once you've created a project and installed dependencies with npm install
(or pnpm install
or yarn
), start a development server:
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
Everything inside src/lib
is part of your library, everything inside src/routes
can be used as a showcase or preview app.
To build your library:
npm run package
To create a production version of your showcase app:
npm run build
You can preview the production build with npm run preview
.
To deploy your app, you may need to install an adapter for your target environment.
Go into the package.json
and give your package the desired name through the "name"
option. Also consider adding a "license"
field and point it to a LICENSE
file which you can create from a template (one popular option is the MIT license).
To publish your library to npm:
npm publish
Read more about creating a library in the docs.