Documentation & Demo

Full documentation is available on the demo site.

Installation

Install with NPM:

or yarn:

Usage

Javascript/Typescript

Import components and supporting classes like so:

SASS

To import the theme:

Alternatively the theme can be imported with a list of used components to minimise the final package size:

HTML

Add the necessary app & Neon styles to the HTML element as well as the light/dark mode, e.g.to set dark mode by default:

For more information on dynamically changing the mode see Dark mode.

Building and using the library locally

1. build the project (npm build),
2. run npm pack to create a tarball of the project
3. install from the tarball with npm i -S /$PATH-TO-THIS-PROJECT/aotearoan-neon-21.2.8.tgz