https://github.com/tarantool/front-ui-kit
https://github.com/tarantool/front-ui-kit
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tarantool/front-ui-kit
- Owner: tarantool
- Created: 2019-08-27T19:56:55.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-08T06:45:29.000Z (over 3 years ago)
- Last Synced: 2025-06-18T10:17:12.688Z (about 1 year ago)
- Language: JavaScript
- Size: 16 MB
- Stars: 5
- Watchers: 21
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Tarantool UI Components Kit
It's UI components set for Tarantool's interfaces. Strongly recommended to use in every UI module.
[](https://travis-ci.com/tarantool/front-ui-kit)
## Usage
## Installing
Install package into your project from [npm](https://www.npmjs.com/package/@tarantool.io/ui-kit):
```shell static
npm i @tarantool.io/ui-kit
```
### Fonts
Add Inter font to your project.
You can attach font from Google Fonts using link:
```plain
https://fonts.googleapis.com/css2?family=Inter:wght@400;600&display=swap
```
Optionally you can add Source Code Pro to display monotype texts (code, errors, etc.):
```plain
https://fonts.googleapis.com/css2?family=Inter:wght@400;600&family=Source+Code+Pro:wght@400;500&display=swap
```
### Getting components
Import components and whatever from ui-kit in code:
```js static
import { Button } from '@tarantool.io/ui-kit';
...
return (
);
```
### Customizing
You can customize components passing additional css classes to `className` prop.
The `style` property is not recommended to use.
## Styleguide
Components list and usage recipes on https://tarantool.github.io/front-ui-kit/.
Use `npm run build` to build or `npm start` to run development server with your local styleguide.