# cosmian_ui

> Cosmian UI contains a set of React components to create beautiful Cosmian applications.

Latest version **0.0.50** (published 2023-10-12) · 0 weekly downloads

## Install

```sh
npm install cosmian_ui
pnpm add cosmian_ui
yarn add cosmian_ui
bun add cosmian_ui
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.50 |
| Published | 2023-10-12 |
| First published | 2023-01-04 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 3.7 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | cosmian |

## Links

- npm: https://www.npmjs.com/package/cosmian_ui
- npm.io page: https://npm.io/package/cosmian_ui

## Dependencies (7)

- [antd](https://npm.io/package/antd.md) ^4.24.4
- [json](https://npm.io/package/json.md) ^11.0.0
- [uuid](https://npm.io/package/uuid.md) ^9.0.0
- [react](https://npm.io/package/react.md) ^18.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [react-icons](https://npm.io/package/react-icons.md) ^4.7.1
- [react-code-blocks](https://npm.io/package/react-code-blocks.md) ^0.0.9-0

## Recent versions

- 0.0.50 (latest) — 2023-10-12
- 0.0.49 — 2023-06-30
- 0.0.48 — 2023-06-30
- 0.0.47 — 2023-06-30
- 0.0.46 — 2023-06-27
- 0.0.45 — 2023-05-31
- 0.0.44 — 2023-05-31
- 0.0.43 — 2023-05-23
- 0.0.42 — 2023-04-27
- 0.0.41 — 2023-04-27
- 0.0.38 — 2023-04-27
- 0.0.37 — 2023-04-27
- 0.0.36 — 2023-04-26
- 0.0.35 — 2023-03-17
- 0.0.34 — 2023-03-16
- … 31 more at https://npm.io/package/cosmian_ui/versions

## README

# Welcome to Cosmian UI

Cosmian UI contains a set of React components to create beautiful Cosmian applications.

- Works with React 17 and 18 application only
- Written in TypeScript with predictable static types

## Components overview

https://cosmian.github.io/cosmian_ui_library

## Install

Install Cosmian UI libray in your app using npm or yarn:

```bash
npm install cosmian_ui
# or
yarn add cosmian_ui
```

And import cosmian_ui stylesheets at the top of your main component:

```javascript
// App.tsx

import "cosmian_ui/style.css";
```

## Usage

Import a component and use it in your app:

```javascript
import { Button } from "cosmian_ui";
```

Example with a React app:

```javascript
import React from "react";
import { Container, Button } from "cosmian_ui";
import "cosmian_ui/style.css";

const App = () => (
  <Container>
    <p>Welcome user</p>
    <Button type="primary" onClick={console.log("Clicked")}>
      Click
    </Button>
  </Container>
);
```

## Developers: create UI components

- Create new components in `src/components`.
- Create dedicated story for each components in `src/stories`.
- Run storybook in development mode with `npm run storybook`.

### Publish UI library

- Upgrade the package version (with `npm version patch`, `npm version minor` or `npm version major`).
- Build library with `npm run build`.
- Publish with `npm publish --access=public`.
- Publish storybook with `npm run deploy-storybook`. On github repository, add an empty `.nojekyll` file at the root folder.

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