# @tikui/core

> Tikui core

Latest version **8.0.0** (published 2026-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @tikui/core
pnpm add @tikui/core
yarn add @tikui/core
bun add @tikui/core
```

Provides the command `tikui-core`.

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 8.0.0 |
| Published | 2026-08-10 |
| First published | 2019-12-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=22 |
| Dependencies | 15 |
| Unpacked size | 73 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| Author | Anthony Rey |
| Maintainers | anrey, nonomoho |
| Keywords | ui, ui kit, design system, pattern library |

## Links

- npm: https://www.npmjs.com/package/@tikui/core
- Repository: https://github.com/tikui/tikui-core
- Homepage: https://github.com/tikui/tikui-core#readme
- Issues: https://github.com/tikui/tikui-core/issues
- npm.io page: https://npm.io/package/@tikui/core

## Dependencies (15)

- [pug](https://npm.io/package/pug.md) 3.0.4
- [cors](https://npm.io/package/cors.md) 2.8.6
- [reload](https://npm.io/package/reload.md) 3.4.3
- [rimraf](https://npm.io/package/rimraf.md) 6.1.3
- [express](https://npm.io/package/express.md) 5.2.1
- [prismjs](https://npm.io/package/prismjs.md) 1.30.0
- [showdown](https://npm.io/package/showdown.md) 2.1.0
- [through2](https://npm.io/package/through2.md) 5.0.11
- [commander](https://npm.io/package/commander.md) 15.0.0
- [node-watch](https://npm.io/package/node-watch.md) 0.7.4
- [escape-html](https://npm.io/package/escape-html.md) 1.0.3
- [concurrently](https://npm.io/package/concurrently.md) 10.0.4
- [recursive-copy](https://npm.io/package/recursive-copy.md) 2.0.14
- [@johnsoncodehk/html2pug](https://npm.io/package/@johnsoncodehk/html2pug.md) 1.0.0
- [pug-multiple-basedirs-plugin](https://npm.io/package/pug-multiple-basedirs-plugin.md) 0.1.5

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 8.0.0 (latest) — 2026-08-10
- 8.0.0-alpha.2 (alpha) — 2026-08-10
- 8.0.0-alpha.1 — 2026-08-10
- 8.0.0-alpha.0 — 2026-08-10
- 7.0.1 — 2026-01-22
- 7.0.0 — 2025-09-06
- 7.0.0-alpha.0 — 2025-09-06
- 6.3.0 — 2025-01-04
- 6.2.3 — 2024-12-17
- 6.2.2 — 2024-11-18
- 6.2.1 — 2024-10-02
- 6.2.0 — 2024-08-23
- 6.1.1 — 2024-08-13
- 6.1.0 — 2024-07-31
- 6.1.0-alpha.0 — 2024-07-31
- … 69 more at https://npm.io/package/@tikui/core/versions

## README

# Tikui Core

Tikui core is the heart of Tikui. Combined to a documentation and some configurations you will be able to create a Tikui project.

## Prerequisites

* Nodejs

## How to use

### Classic way

You can use it by using [Tikui CLI](https://www.github.com/tikui/tikui-cli).

### As a dependency

The other way to use it is on a node project as a dependency, here is an example of use:

```shell
mkdir example-project
cd example-project
npm init
# Follow instructions
npm i @tikui/core tikuidoc-tikui sass
echo '{"documentation": "tikui"}' > tikuiconfig.json
mkdir src
npx tikui-core serve
```

Tikui is started, you may see how sources are organized to understand how to organize your components by looking at the [Tikui](https://www.github.com/tikui/tikui) sources structure.

## Development

### Install

```shell
npm i
```

### Contribute

Tikui core contains integration and unit tests to specify features, you have to launch tests using npm:

```shell
npm test
```

Then you can add other tests to make a new feature and when all your feature tests are green you can create a Pull Request.

If you want to check the served generated Tikui is correct, please launch:

```shell
npm run component-test:open
```

Then you can add new [Cypress](https://www.cypress.io/) scenarios and tests.

It's also possible to launch Component Tests in preview mode using:

```shell
npm run component-test:build
npm run component-test:preview:open
```

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