Welcome to Neptune JS!

Install

NMP

Copy the following Code to install the npm package.

npm i neptunecss-js

CDN

<script src="https://cdn.jsdelivr.net/npm/neptunecss-js@latest/neptune.min.js"></script>

Import

There are two ways to import Neptune JS. The first way is a namespaced import. Copy the following line into your file.

import * as NeptuneJS from "path/to/package/neptune.min.js"

Now you have to write NeptuneJS. before every class of Neptune JS like:

const myBadge = new NeptuneJS.Badge({
    text: "default badge",
    size: "m",
    style: "primary"
});

The second way to import Neptune JS is to import only the components you need.

import { Badge, Spinner, Toast } from "path/to/package/neptune.min.js"

Example

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">

        <!-- Import neptune ui -->
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/neptunecss@latest/neptune.min.css">
        
        <title>Neptune example</title>
    </head>
    <body>
        <!-- Your Content -->
        
        <!-- Import Neptune JS -->
        <script src="https://cdn.jsdelivr.net/npm/neptunecss-js@latest/neptune.min.js"></script>
    </body>
</html>

Documentation

You can read the docs here.

Snippets Extension

Download it in VS Code Marketplace or checkout on GitHub.

License

MIT LICENSE

Author

Colin Grahm

fef