An open API service indexing awesome lists of open source software.

https://github.com/imputnet/helium-prism

Shared UI components of Helium web interfaces for Svelte
https://github.com/imputnet/helium-prism

Last synced: 19 days ago
JSON representation

Shared UI components of Helium web interfaces for Svelte

Awesome Lists containing this project

README

          


Helium Prism

## Helium Prism

Shared UI components of [Helium](https://github.com/imputnet/helium) web interfaces for Svelte.

Prism UI library contains the shared building blocks used by web-based Helium applications and
websites, such as: typography, buttons, inputs, loading states, icons, and the brand gradient
shimmer effect.

This library isn't built for use outside of Helium web apps, so it may feel clunky for anything
else.

Demo: [prism.helium.computer](https://prism.helium.computer/)\
npm: [@imput/helium-prism](https://www.npmjs.com/package/@imput/helium-prism)

## Installation

deno:

```sh
deno add npm:@imput/helium-prism
```

pnpm:

```sh
pnpm add @imput/helium-prism
```

npm:

```sh
npm i @imput/helium-prism
```

## Basic usage

Import the stylesheet once near the root of your app:

```svelte

import "@imput/helium-prism/styles.css";

```

Then import components from the package root:

```svelte

import { Button } from "@imput/helium-prism";

Button
Button 2
```

You can also import all components at once if you're a madman or have an actual reason to do so
(such as for [demo](src/demo/App.svelte) purposes):

```svelte

import * as Prism from "@imput/helium-prism";

Button
Button 2
```

## API docs

Sample usage of components is documented in [docs/api.md](docs/api.md).

## License

Helium Prism is licensed under GPL-3.0, just like the rest of Helium. See [LICENSE](LICENSE).