# @dataorb.co/ui

> [![Version](https://img.shields.io/npm/v/@dataorb.co/ui?style=flat&colorA=4945ff&colorB=4945ff)](https://www.npmjs.com/package/@dataorb.co/ui) [![Downloads](https://img.shields.io/npm/dt/@dataorb.co/ui.svg?style=flat&colorA=4945ff&colorB=4945ff)](https://

Latest version **0.0.2-alpha** (published 2024-04-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dataorb.co/ui
pnpm add @dataorb.co/ui
yarn add @dataorb.co/ui
bun add @dataorb.co/ui
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2-alpha |
| Published | 2024-04-03 |
| First published | 2024-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 13 |
| Unpacked size | 2.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | dataorbco |

## Links

- npm: https://www.npmjs.com/package/@dataorb.co/ui
- npm.io page: https://npm.io/package/@dataorb.co/ui

## Dependencies (13)

- [prop-types](https://npm.io/package/prop-types.md) ^15.8.1
- [aria-hidden](https://npm.io/package/aria-hidden.md) ^1.2.3
- [react-remove-scroll](https://npm.io/package/react-remove-scroll.md) ^2.5.7
- [@codemirror/lang-json](https://npm.io/package/@codemirror/lang-json.md) ^6.0.1
- [@uiw/react-codemirror](https://npm.io/package/@uiw/react-codemirror.md) ^4.21.24
- [@floating-ui/react-dom](https://npm.io/package/@floating-ui/react-dom.md) ^2.0.8
- [@internationalized/date](https://npm.io/package/@internationalized/date.md) ^3.5.2
- [compute-scroll-into-view](https://npm.io/package/compute-scroll-into-view.md) ^3.1.0
- [@dataorb.co/ui-primitives](https://npm.io/package/@dataorb.co/ui-primitives.md) ^0.0.1-alpha
- [@internationalized/number](https://npm.io/package/@internationalized/number.md) ^3.5.1
- [@radix-ui/react-focus-scope](https://npm.io/package/@radix-ui/react-focus-scope.md) 1.0.4
- [@radix-ui/react-dropdown-menu](https://npm.io/package/@radix-ui/react-dropdown-menu.md) ^2.0.6
- [@radix-ui/react-dismissable-layer](https://npm.io/package/@radix-ui/react-dismissable-layer.md) ^1.0.5

## Recent versions

- 0.0.2-alpha (latest) — 2024-04-03
- 0.0.1-alpha — 2024-03-28
- 0.0.0-alpha — 2024-03-19

## README

# DataOrb Design System

[![Version](https://img.shields.io/npm/v/@dataorb.co/ui?style=flat&colorA=4945ff&colorB=4945ff)](https://www.npmjs.com/package/@dataorb.co/ui)
[![Downloads](https://img.shields.io/npm/dt/@dataorb.co/ui.svg?style=flat&colorA=4945ff&colorB=4945ff)](https://www.npmjs.com/package/@dataorb.co/ui)
[![Discord Shield](https://img.shields.io/discord/811989166782021633?style=flat&colorA=4945ff&colorB=4945ff&label=discord&logo=discord&logoColor=f0f0ff)](https://discord.gg/dataorb)

<b>A UI component library for creating amazing DataOrb extensions.</b>

## Installation

```sh
$ yarn add react react-dom @dataorb.co/ui @dataorb.co/icons styled-components react-router-dom

# or

$ npm i react react-dom @dataorb.co/ui @dataorb.co/icons styled-components react-router-dom
```

## Getting Started

Wrap your application with the `DesignSystemProvider`. You can additionally pass a theme and/or locale, although you don't have to as we have default values for both.

```jsx
import { DesignSystemProvider, lightTheme } from '@dataorb.co/ui';

function MyApp({ children }) {
  return (
    <DesignSystemProvider locale="en-GB" theme={lightTheme}>
      {children}
    </DesignSystemProvider>
  );
}

export default App;
```

Then, checkout the complete [Storybook documentation](https://dataorb-design-system.vercel.app/) to find the components you want to use and how to use them.

## Contributing

Please follow our [CONTRIBUTING](https://github.com/DataorbCo/design-system/blob/main/CONTRIBUTING.md) guidelines.

## License

Licensed under the MIT License, Copyright © 2015-present [DataOrb Solutions SAS](https://dataorb.co).

See [LICENSE](https://github.com/DataorbCo/design-system/blob/main/LICENSE) for more information.

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