Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/eliot-akira/innerface

Generic UI atoms and components
https://github.com/eliot-akira/innerface

Last synced: about 1 month ago
JSON representation

Generic UI atoms and components

Awesome Lists containing this project

README

        

# Innerface

Innerface is a library of generic UI atoms and components.

It consists of modular SASS styles and vanilla TypeScript, designed to be minimal, themable, and embeddable.

## Install

```sh
yarn add innerface
```

## Use

Styles

```scss

// Define variables

$prefix: "i-"; // Leave empty for global
$base-font-size: 14px;

@import "innerface/base";

// Import components

@import "innerface/components/slider";
```

Scripts

```ts
import innerface from 'innerface'
import slider from 'innerface/slider'

innerface.use(slider)
```

## Develop this library

Install dependencies

```sh
yarn
```

Develop: Watch files; Recompile, type check and test on changes

```sh
yarn dev
```

Build

```sh
yarn build
```

Publish to NPM

```sh
npm run release
```