# @kano/kbc-tokens

> Design tokens for kano apps and components

Latest version **2.0.6** (published 2021-06-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install @kano/kbc-tokens
pnpm add @kano/kbc-tokens
yarn add @kano/kbc-tokens
bun add @kano/kbc-tokens
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.6 |
| Published | 2021-06-05 |
| First published | 2020-02-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 36.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kano Computing |
| Maintainers | alicemarshall, kanocomputing, rpazdera, hicksatkano, holographicleah, chaitz, joe-thom, tomkano, ting88003355, onishiweb, alexb-kano, charlie-kano, wassupduck |

## Links

- npm: https://www.npmjs.com/package/@kano/kbc-tokens
- npm.io page: https://npm.io/package/@kano/kbc-tokens

## Dependencies (1)

- [camelcase](https://npm.io/package/camelcase.md) ^5.3.1

## Recent versions

- 2.0.6 (latest) — 2021-06-05
- 2.0.5 — 2021-05-28
- 2.0.4 — 2021-04-08
- 2.0.3 — 2021-04-07
- 2.0.2 — 2021-04-07
- 2.0.1 — 2021-03-04
- 2.0.0 — 2021-01-08
- 2.0.0-pre.0 — 2021-01-06
- 2.0.0-alpha.0 — 2021-01-06
- 1.0.5 — 2020-10-01
- 1.0.4 — 2020-09-23
- 1.0.3 — 2020-09-10
- 1.0.2 — 2020-08-20
- 1.0.1 — 2020-08-04
- 1.0.0 — 2020-07-03
- … 29 more at https://npm.io/package/@kano/kbc-tokens/versions

## README

# `kbc-tokens`

A set of Scss and JSON tokens for styling kano components and apps.

## Usage

### JS

In JavaScript files, import all base tokens as an object:

```js
import * as KbcTokens from '@kano/kbc-tokens';
```

#### Types

There are also types made available which correspond to the variables in the [Sass maps](#maps).

All types available are:

```js
import { colorsType } from '@kano/kbc-tokens/lib/colors';
import { allColorsType } from '@kano/kbc-tokens/lib/all-colours';
import { themeColorsType } from '@kano/kbc-tokens/lib/theme-colors';
import { spacersType } from '@kano/kbc-tokens/lib/spacers';
import { containerMaxWidthsType } from '@kano/kbc-tokens/lib/container-max-widths';
import { breakpointsType } from '@kano/kbc-tokens/lib/breakpoints';
```

### Sass

In Sass, there are the main variables which can be imported from:

```scss
@import '~@kano/kbc-tokens/lib/index.scss';
```

### Overwriting default variables

Colour and typography variables from `kbc-tokens` are possible to be overwritten by the local application. To do this in your application, create local variables with the same variable name before importing variables from `kbc-tokens`:

```scss
// App variables
@import 'variables';
// kbc-tokens variables
@import '~@kano/kbc-tokens/lib/index.scss';
```

#### Maps

You can also import maps of variables:

```scss
// import the $all-colours-map variable
@import '~@kano/kbc-tokens/lib/all-colours.map.scss';
```

The available maps are:

```scss
// import the $colours-map variable
@import '~@kano/kbc-tokens/lib/colours.map.scss';
// import the $theme-colours-map variable
@import '~@kano/kbc-tokens/lib/theme-colours.map.scss';
// import the $all-colours-map variable
@import '~@kano/kbc-tokens/lib/all-colours.map.scss';
// import the $breakpoints-map variable
@import '~@kano/kbc-tokens/lib/breakpoints.map.scss';
// import the $container-max-widths-map variable
@import '~@kano/kbc-tokens/lib/container-max-widths.map.scss';
// import the $spacers-map variable
@import '~@kano/kbc-tokens/lib/spacers.map.scss';
```

---
_Source: https://npm.io/package/@kano/kbc-tokens · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
