Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mon4ik/frekui
UI Kit
https://github.com/mon4ik/frekui
css-framework scss uikit
Last synced: about 1 month ago
JSON representation
UI Kit
- Host: GitHub
- URL: https://github.com/mon4ik/frekui
- Owner: Mon4ik
- Created: 2023-04-10T05:04:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-26T10:04:30.000Z (over 1 year ago)
- Last Synced: 2024-10-31T03:42:28.750Z (3 months ago)
- Topics: css-framework, scss, uikit
- Language: SCSS
- Homepage:
- Size: 195 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FrekUI (β)
> **F**ancy **R**ounded n**E**w **K**it **UI**
Tailwind based UI Kit
## Installation
### Via packet managers
```shell
npm i @idkncc/frekui@beta
```
```shell
yarn add @idkncc/frekui@beta
```
### Build yourself
```shell
yarn
yarn build
yarn link
# in other project
yarn link frekui
```
## Usage
### In CSS
#### SCSS
> Tailwind is required!
```scss
// You can import whole
@import "~@idkncc/frekui/scss/frekui.scss";
// OR you can selectively import
@import "~@idkncc/frekui/scss/mixins";
@import "~@idkncc/frekui/scss/button";
```
#### CSS
```css
@import url(https://unpkg.com/@idkncc/frekui@latest/dist/frekui.standalone.css);
/* with tailwind */
/* v */
@import url(https://unpkg.com/@idkncc/frekui@latest/dist/frekui.min.css);
```
### JS (f.e. React)
```js
import "@idkncc/frekui/dist/frekui.standalone.css"
// or if tailwind installed:
import "@idkncc/frekui/dist/frekui.min.css"
```
### Plain HTML (without Tailwind)
```html
```
### Other
Folder [`/dist`](dist/) contains all built files