# @b-flower/bdm-react

> Components for BDM development

Latest version **0.3.4** (published 2019-12-09) · ISC license · 0 weekly downloads

## Install

```sh
npm install @b-flower/bdm-react
pnpm add @b-flower/bdm-react
yarn add @b-flower/bdm-react
bun add @b-flower/bdm-react
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.4 |
| Published | 2019-12-09 |
| First published | 2018-11-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 204.9 KB |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| Author | Gabriel Chang |
| Maintainers | amelon, gabchang, kcoulibaly |
| Keywords | bdm, react, mrocs, b-flower, b-eden |

## Links

- npm: https://www.npmjs.com/package/@b-flower/bdm-react
- Repository: https://bitbucket.org/bflower/bdm-react
- Homepage: https://bitbucket.org/bflower/bdm-react#readme
- npm.io page: https://npm.io/package/@b-flower/bdm-react

## Dependencies (8)

- [ramda](https://npm.io/package/ramda.md) ^0.26.0
- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [babel-eslint](https://npm.io/package/babel-eslint.md) ^10.0.1
- [react-markdown](https://npm.io/package/react-markdown.md) ^4.2.2
- [webpack-dev-server](https://npm.io/package/webpack-dev-server.md) ^3.1.14
- [version-bump-prompt](https://npm.io/package/version-bump-prompt.md) ^4.2.2
- [@babel/plugin-proposal-decorators](https://npm.io/package/@babel/plugin-proposal-decorators.md) ^7.3.0
- [@babel/plugin-proposal-class-properties](https://npm.io/package/@babel/plugin-proposal-class-properties.md) ^7.3.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

- 0.3.4 (latest) — 2019-12-09
- 0.3.3 — 2019-12-09
- 0.3.2 — 2019-12-09
- 0.3.1 — 2019-12-09
- 0.3.0 — 2019-12-09
- 0.2.2 — 2019-01-24
- 0.2.1 — 2019-01-24
- 0.2.0 — 2019-01-24
- 0.1.3 — 2018-11-28
- 0.1.2 — 2018-11-28
- 0.1.1 — 2018-11-27
- 0.1.0 — 2018-11-27
- 0.0.2 — 2018-11-27
- 0.0.1 — 2018-11-27

## README

# BDM-React components

Basic components for use with React & @b-flower/bdm environment.


# Components

## Button

Same as `@material-ui` button with a `big` size option.

```javascript
import '@b-flower/bdm-react/core/Button'

<Button size="big">
```

## Flex

Flex system layout

### Properties

|property|values|  |
|--------|------|--|
|component|`String|Component`|Component to use for render, default `div`|
|direction|`String`<br/>row\|row-reverse\|column\|column-reverse|Cross axis direction|
|align|`String`<br/>flex-start\|flex-end\|center\|baseline\|stretch|Cross axis alignement|
|justify|`String`|Justification|
|wrap|`String`<br/>nowrap\|wrap\|wrap-reverse|Wether to wrap if contents overflow|
|flex|`Number`|Flex shortcut only : 0 -> n, relative size for a Flex.Item|
|basis|`Number|String`|Base item size|
|shrink|`Number|String`|Item can shrink|
|grow|`Number`|Item can grow|
|width|`String`|Any allowed CSS value|
|height|`String`|Any allowed CSS value|
|...|| \+ any prop supported by `component`|

### Usage
```javascript
import Flex from '@b-flower/bdm-react/core/Flex'

 /* default container - direction : row */
 <Flex/>

 /* alias for Flex - direction : row */
 <Flex.Row/>

 /* container - direction : column */
 <Flex.Column/>

 /* default content - flex : 1 */
 <Flex.Item/>
```

## Example
```javascript
<Flex ...props>
  <Flex.Item flex={1}>
   // default size, takes available space (flex:1)
  </Flex.Item>
  </Flex.Item flex={0}>
    // resize to content size
  </Flex.Item>
 </Flex>
```

## Header

Title & subtitle component

```
import Header from '@b-flower/bdm-react/core/Header'

<Header title="My Title"/>
```

## Loader

Extended `@material-ui`'s `CircularProgress` component

### Properties

|property|values|  |
|--------|------|--|
|modal|`Boolean`|Full screen & centered loader
|...|| \+ any prop supported by `CircularProgress`|


### Usage

```
import Loader from '@b-flower/bdm-react/core/Loader'

<Loader modal/>
```

## Markdown

Markdown parser & renderer (uses `react-markdown`)


### Properties

|property|values|  |
|--------|------|--|
|component|`String|Component`|Component to use for render, default `div`|
|source|`String`|Markdown text|
|options|`Object`|`react-markdown` options|
|...|| \+ any prop supported by `component`|


### Usage
```
import Markdown from '@b-flower/bdm-react/core/Markdown'

<Markdown />
```

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