> **IMPORTANT**: [`svelte-preprocess`](https://github.com/sveltejs/svelte-preprocess) is required to use this library, as it is built in Typescript with no packaging build step. That will be fixed when [SvelteKit](https://kit.svelte.dev)'s [package command](https://kit.svelte.dev/docs#packaging) supports type generation.
> **WARNING**: This library is a work-in-progress, use at your own discretion!
## Features
- **Svelte-first**: All Components are API designed to work well with Svelte as a first-class citizen.
- **Progressive Enhancements**: Where possible, most logic is codified via CSS / HTML directly. With Javascript-enabled UX enhancements enabled for compatible clients.
- **Composable**: While 30+ prebuilt Components are available, Kahi UI also provides primitives to design your Application's UI without touching CSS.
- **Dark Mode**: Components in Kahi UI change colors when a compatible Browser views w/ Dark Mode.
- **Framework Independent**: Even though Svelte-first, there is no hard toolchain dependencies required. You can just take the built CSS files and use with React or in a traditional SSR environment.
- **Typescript Native**: Kahi UI tries to be fully typed by using TypeScript as its base language, so you get a complete IDE experience.
## Documentation
> Looking for documentation source? Visit [github.com/kahi-framework/kahi-ui.nbn.dev](https://github.com/kahi-framework/kahi-ui.nbn.dev).
Visit the documentation at [kahi-ui.nbn.dev](https://kahi-ui.nbn.dev).
## F.A.Q.
Visit the F.A.Q (frequently asked questions) at [kahi-ui.nbn.dev/docs/framework/faq](https://kahi-ui.nbn.dev/docs/framework/faq).
## Browser Support
- Chrome 87+ — November 2020
- Edge 87+ — November 2020
- Firefox 67+ — May 2019
- Safari 14.1+ — April 2021
- Edge _(Pre Chromium)_ — **UNSUPPORTED**
- Internet Explorer — **UNSUPPORTED**
## Installation
Open your terminal and install via `npm`:
```bash
npm install @kahi-ui/framework
```
## Usage
First if your toolchain supports it, import the required CSS files from `@kahi-ui/framework/dist`:
```javascript
import "@kahi-ui/framework/dist/kahi-ui.framework.css";
```
Otherwise download the required CSS files from [Releases](https://github.com/novacbn/kahi-ui/releases/latest) and use ``:
```html
```
Next, import Components by their variable name from `@kahi-ui/framework`:
```html
{clicks}
```
Some Components are multi-part patterns, so you'll need to import their namespaces:
```html
Lorem Ipsum
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin et consectetur orci.
Curabitur a egestas turpis, vitae convallis sapien. Sed pellentesque rutrum tellus, in
iaculis dolor tincidunt non. Orci varius natoque penatibus et magnis dis parturient
montes, nascetur ridiculus mus.
```
## License
Kahi UI is licensed under the [MIT license](./LICENSE).
