> For the complete documentation index, see [llms.txt](https://neptune-css.gitbook.io/neptune-css-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://neptune-css.gitbook.io/neptune-css-docs/neptune-js.md).

# Neptune JS

## Getting Started

### NPM

Copy the following Code to install the [npm package](https://www.npmjs.com/package/neptunecss-js).

```
npm i neptunecss-js
```

### CDN

```html
<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.

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

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

```javascript
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.

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

#### Example Project

```html
<!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>
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://neptune-css.gitbook.io/neptune-css-docs/neptune-js.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
