JSPM

@aotearoan/neon

0.18.9
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 499
  • Score
    100M100P100Q100974F
  • License MIT

Neon is a design library of components for use with VueJS. It supports light and dark modes and can be extended to support multiple themes

Package Exports

  • @aotearoan/neon

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aotearoan/neon) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

neon

Documentation & Demo

Full documentation is available on the demo site.

Installation

Install the package with one of the following commands:

npm install @aotearoan/neon
yarn add @aotearoan/neon

Usage

Javascript/Typescript

Import components and supporting classes like so:

import { Component, Vue } from 'vue-property-decorator';
import { NeonLogo } from '@aotearoan/neon';

@Component({
  components: {
    NeonLogo,
  },
})
export default class App extends Vue {}

SASS

First select a theme:

  • default

There are two imports necessary to use a theme, the variables and the theme itself. These are split into two files to allow developers to override the variables for customization. Here is how to import the default theme:

@import '~@aotearoan/neon/default-variables';
@import 'src/sass/overrides';
@import '~@aotearoan/neon/default-theme';

Finally, the theme and mode (light/dark) need to be set on the document, e.g. to set the default theme and dark mode:

<html class="app neon neon-theme--default neon-mode--dark">