# @internet-identity-labs/nfid-ui-kit-core

> A Tailwind CSS plugin for NFID applications

Latest version **0.0.1-alpha.3** (published 2022-04-13) · 0 weekly downloads

## Install

```sh
npm install @internet-identity-labs/nfid-ui-kit-core
pnpm add @internet-identity-labs/nfid-ui-kit-core
yarn add @internet-identity-labs/nfid-ui-kit-core
bun add @internet-identity-labs/nfid-ui-kit-core
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-alpha.3 |
| Published | 2022-04-13 |
| First published | 2022-04-11 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Philipp Litzenberger |
| Maintainers | litzidentity, dostro |

## Links

- npm: https://www.npmjs.com/package/@internet-identity-labs/nfid-ui-kit-core
- Repository: https://github.com/internet-identity-labs/NFID-SDK
- Homepage: https://github.com/internet-identity-labs/NFID-SDK#readme
- Issues: https://github.com/internet-identity-labs/NFID-SDK/issues
- npm.io page: https://npm.io/package/@internet-identity-labs/nfid-ui-kit-core

## Recent versions

- 0.0.1-alpha.3 (latest) — 2022-04-13
- 0.0.1-alpha.2 — 2022-04-11
- 0.0.1-alpha.1 — 2022-04-11
- 0.0.1-alpha.0 — 2022-04-11

## README

## NFID UI Kit Core

This package contains the core utilities of the NFID UI Kit. 

It is built on top of TailwindCSS and provides a set of utility classes that are used by the different libraries and give a consistent look and feel across all of our sample applications.

----

### Getting started
1. Plugins which are added to our Tailwind theme are nested under [the utils folder](./src/utils/).
2. The [`theme.json`](src/theme.js) contains the in-house styles from NFID.
3. When creating a new utility for a component, create a folder if it doesn't exist and add the utility classes within the `index.js` file.

In order to use the NFID UI Kit in your application, all you have to do is import the package into your `tailwind.config.js`:

```diff 
module.exports = {
  content: ['./src/**/*.{js,jsx,ts,tsx}'],
  theme: {
    extend: {},
  },
+  plugins: [require('@internet-identity-labs/nfid-ui-kit-core')],
};
```

---
_Source: https://npm.io/package/@internet-identity-labs/nfid-ui-kit-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._