# @bright-lab/core

> @Bright-lab/core is a core npm package based on Material UI and will be including some BRIGHT components. Stay tuned.

Latest version **0.2.33** (published 2022-10-11) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @bright-lab/core
pnpm add @bright-lab/core
yarn add @bright-lab/core
bun add @bright-lab/core
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.33 |
| Published | 2022-10-11 |
| First published | 2022-03-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 56.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Bright-lab Team |
| Maintainers | amine-simple-code, sergemassaad, charlesdaccache |
| Keywords | react, smart, simple, easy, components, ui |

## Links

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

## Dependencies (5)

- [core-js](https://npm.io/package/core-js.md) ^3.18.1
- [@uppy/core](https://npm.io/package/@uppy/core.md) ^2.1.1
- [prop-types](https://npm.io/package/prop-types.md) ^15.8.1
- [@uppy/react](https://npm.io/package/@uppy/react.md) ^2.1.1
- [@uppy/aws-s3](https://npm.io/package/@uppy/aws-s3.md) ^2.0.5

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@mesalvo/react-ui](https://npm.io/package/@mesalvo/react-ui.md) — 1.7K weekly downloads

## Recent versions

- 0.2.33 (latest) — 2022-10-11
- 0.2.32 — 2022-10-11
- 0.2.31 — 2022-10-11
- 0.2.30 — 2022-10-11
- 0.2.29 — 2022-10-10
- 0.2.28 — 2022-10-06
- 0.2.27 — 2022-10-06
- 0.2.26 — 2022-09-27
- 0.2.25 — 2022-09-27
- 0.2.24 — 2022-09-27
- 0.2.23 — 2022-09-27
- 0.2.22 — 2022-09-20
- 0.2.21 — 2022-09-19
- 0.2.20 — 2022-09-19
- 0.2.19 — 2022-09-16
- … 43 more at https://npm.io/package/@bright-lab/core/versions

## README

<!-- markdownlint-disable-next-line -->
<p align="center">
<img src="https://bright-lab.s3.eu-west-1.amazonaws.com/bl_icon.png" alt="Bright Lab logo">
</p>
<br>

<h1 align="center">Bright Lab Core</h1>

**Bright Lab Core** contains foundational React UI component libraries for shipping new features faster and it is based on <a href="https://mui.com/" target="_blank">Material UI</a> and will be including some BRIGHT components.

- [_Material UI_](https://mui.com/material-ui/getting-started/overview/) is a comprehensive library of components that features our implementation of Google's [Material Design](https://material.io/design/introduction/) system.

<div align="center">

[![npm downloads](https://img.shields.io/npm/dy/@bright-lab/core.svg)](https://www.npmjs.com/package/@bright-lab/core)
[![minizipped size](https://img.shields.io/bundlephobia/minzip/@bright-lab/core)](https://bundlephobia.com/package/@bright-lab/core)
[![npm latest package](https://img.shields.io/npm/v/@bright-lab/core/latest.svg)](https://www.npmjs.com/package/@mui/material)

</div>

## Installation

### @bright-lab/core

@bright-lab/core is available as an [npm package](https://www.npmjs.com/package/@bright-lab/core).

```sh
// with npm
npm install @bright-lab/core

// with yarn
yarn add @bright-lab/core
```

**Note**: @bright-lab/core is still in alpha.
We are adding new components regularly and updating exisitng ones. You're welcome to contribute!

## Getting started with @bright-lab/core

Here is an example of a basic app using @bright-lab/core's `Form` component:

```jsx
import * as React from 'react';
import { Form } from '@bright-lab/core';

let fields = [
  {
    id: 'full_name',
    name: 'full_name',
    label: 'Full Name',
    type: 'TextField',
    required: true,
    grid: {
      xs: 12,
      md: 6,
    },
  },
  {
    id: 'image_url',
    name: 'image_url',
    label: 'Image',
    type: 'FileUpload',
    required: true,
    grid: {
      xs: 12,
      md: 6,
    },
  },
  {
    id: 'deactivated',
    name: 'deactivated',
    label: 'Deactivated',
    type: 'RadioGroup',
    required: true,
    grid: {
      xs: 12,
      md: 6,
    },
    data: [
      {
        title: 'Yes',
        value: '0',
      },
      {
        title: 'No',
        value: '1',
      },
    ],
  },
  {
    id: 'company_obj',
    name: 'company_obj',
    label: 'Company',
    type: 'Select',
    required: true,
    grid: {
      xs: 12,
      md: 6,
    },
    data: [
      {
        title: 'Yes',
        value: '0',
      },
      {
        title: 'No',
        value: '1',
      },
    ],
  },
];

function App() {
  return (
    <Form
      fields={fields}
      errorValues={{}}
      handleChange={(values) => console.log('changed', values)}
      defaultValues={{}}
    />
  );
}
```

## Changelog

The [changelog](https://github.com/BRIGHTLAB/core/releases) is regularly updated to reflect what's changed in each new release.

## License

This project is licensed under the terms of the
[MIT license](/LICENSE).

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