# @brj/ui

> Common BRJ UI system.

Latest version **1.2.1** (published 2023-03-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @brj/ui
pnpm add @brj/ui
yarn add @brj/ui
bun add @brj/ui
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2023-03-26 |
| First published | 2022-06-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 13 |
| Unpacked size | 451.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jan Barášek |
| Maintainers | janbarasek |
| Keywords | BRJ, UI, React, Material-UI |

## Links

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

## Dependencies (13)

- [next](https://npm.io/package/next.md) latest
- [@mui/lab](https://npm.io/package/@mui/lab.md) ^5.0.0-alpha.75
- [typescript](https://npm.io/package/typescript.md) ^4.6.3
- [@mui/system](https://npm.io/package/@mui/system.md) ^5.5.3
- [@types/jest](https://npm.io/package/@types/jest.md) ~27.0.3
- [@types/node](https://npm.io/package/@types/node.md) ^17.0.14
- [@types/uuid](https://npm.io/package/@types/uuid.md) ^8.3.4
- [@types/react](https://npm.io/package/@types/react.md) ^18.0.12
- [@mui/material](https://npm.io/package/@mui/material.md) ^5.6.0
- [@emotion/react](https://npm.io/package/@emotion/react.md) ^11.9.0
- [@emotion/styled](https://npm.io/package/@emotion/styled.md) ^11.8.1
- [react-hook-form](https://npm.io/package/react-hook-form.md) ^7.29.0
- [@mui/icons-material](https://npm.io/package/@mui/icons-material.md) ^5.6.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.2.1 (latest) — 2023-03-26
- 1.2.0 — 2023-03-26
- 1.1.4 — 2023-03-25
- 1.1.3 — 2023-03-25
- 1.1.2 — 2023-03-25
- 1.1.1 — 2023-03-25
- 0.0.1 — 2022-06-08
- 0.0.0 — 2022-06-08

## README

BRJ/UI Library
==============

The BRJ/UI library is a set of React components built on top of Material UI. It aims to provide a set of basic UI components for use in web applications. Below is a list of the components included in the library, organized by file structure.

How to start using BRJ UI?
--------------------------

First, use the basic wrapper component `<BrjApp>` to wrap your entire application.

Sample usage:

```tsx
import { BrjApp } from '@brj/ui';

function App() {
  return (
    <BrjApp>
      <div>content</div>
    </BrjApp>
  );
}
```

This component automatically provides the basic interface for application context, hooks, core component registration, graphical theme and other settings. You can program any application inside this component.

Components
----------

| Component | Description |
|-----------|-------------|
| AuthorCard | A component for displaying author information|
| BrjApp | The main component for the BRJ app|
| BrjLogo | A component for displaying the BRJ logo|
| Card | A generic card component|
| Editor | A text editor component|
| Error404 | A component for displaying a 404 error page|
| Footer | The footer component for the BRJ app|
| PhoneNumber | A component for entering a phone number|
| HeaderIdentity | A component for displaying user identity|
| HeaderIdentityLoginButton | A component for displaying the login button in the identity section|
| HeaderIdentityUserPopper | A component for displaying user options in the identity section|
| HeaderMenuItem | A component for displaying menu items in the header|
| HeaderSearch | A component for search functionality in the header|
| HeaderSearchIcon | A component for displaying the search icon in the header|
| InternalServiceStatus | A component for displaying the status of internal services|
| PhpManualLogo | A component for displaying the PHP manual logo|
| SourceCode | A component for displaying source code|
| ThemeSwitch | A component for switching between light and dark themes|

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