# @moneygeek/ui-components

> A set of base react based components for MoneyGeek

Latest version **1.122.0** (published 2021-03-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install @moneygeek/ui-components
pnpm add @moneygeek/ui-components
yarn add @moneygeek/ui-components
bun add @moneygeek/ui-components
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.122.0 |
| Published | 2021-03-18 |
| First published | 2020-02-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 27 |
| Unpacked size | 4.5 MB |
| Known vulnerabilities | 0 (+35 in 4 direct dependencies) |
| Install scripts | no |
| Maintainers | mdxprograms |

## Links

- npm: https://www.npmjs.com/package/@moneygeek/ui-components
- npm.io page: https://npm.io/package/@moneygeek/ui-components

## Dependencies (27)

- [docz](https://npm.io/package/docz.md) ^2.3.1
- [jest](https://npm.io/package/jest.md) ^25.1.0
- [axios](https://npm.io/package/axios.md) ^0.19.2
- [react](https://npm.io/package/react.md) ^16.12.0
- [eslint](https://npm.io/package/eslint.md) ^6.8.0
- [gatsby](https://npm.io/package/gatsby.md) ^2.23.3
- [react-ga](https://npm.io/package/react-ga.md) ^2.7.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.12.0
- [remixicon](https://npm.io/package/remixicon.md) ^2.5.0
- [babel-jest](https://npm.io/package/babel-jest.md) ^25.1.0
- [highcharts](https://npm.io/package/highcharts.md) ^8.0.4
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [gatsby-link](https://npm.io/package/gatsby-link.md) ^2.4.11
- [react-scripts](https://npm.io/package/react-scripts.md) ^3.4.0
- [react-activity](https://npm.io/package/react-activity.md) ^1.2.2
- [cloudinary-react](https://npm.io/package/cloudinary-react.md) ^1.5.0
- [styled-normalize](https://npm.io/package/styled-normalize.md) ^8.0.7
- [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.10.2
- [styled-components](https://npm.io/package/styled-components.md) ^5.1.1
- [webpack-dev-server](https://npm.io/package/webpack-dev-server.md) 3.10.2
- [@babel/preset-react](https://npm.io/package/@babel/preset-react.md) ^7.8.3
- [react-test-renderer](https://npm.io/package/react-test-renderer.md) ^16.13.0
- [highcharts-react-official](https://npm.io/package/highcharts-react-official.md) ^3.0.0
- [react-ratings-declarative](https://npm.io/package/react-ratings-declarative.md) ^3.4.1
- [gatsby-react-router-scroll](https://npm.io/package/gatsby-react-router-scroll.md) ^3.0.10
- [gatsby-plugin-env-variables](https://npm.io/package/gatsby-plugin-env-variables.md) ^1.0.1
- [@pmmmwh/react-refresh-webpack-plugin](https://npm.io/package/@pmmmwh/react-refresh-webpack-plugin.md) ^0.2.0

## Recent versions

- 1.122.0 (latest) — 2021-03-18
- 1.121.0 — 2021-02-15
- 1.120.0 — 2021-02-10
- 1.119.0 — 2021-02-02
- 1.118.0 — 2021-02-01
- 1.117.0 — 2021-01-28
- 1.116.0 — 2021-01-12
- 1.115.0 — 2021-01-07
- 1.114.0 — 2021-01-06
- 1.113.0 — 2020-12-30
- 1.112.0 — 2020-12-28
- 1.111.0 — 2020-12-21
- 1.110.0 — 2020-12-14
- 1.109.0 — 2020-12-08
- 1.108.0 — 2020-12-01
- … 107 more at https://npm.io/package/@moneygeek/ui-components/versions

## README

MoneyGeek UI Components
---

![npm](https://img.shields.io/npm/v/@moneygeek/ui-components?color=green&label=%40moneygeek%2Fui-components&style=flat-square)

## Usage

The MoneyGeek ui-components library is a set of react based DOM components aimed to increase the features of web pages and blog posts of the MoneyGeek websites. This library currently have available the next components to use:

 * Best Ranking
 * Button
 * Column
 * Expand/Collapse
 * Icon
 * OrderedList
 * Quote
 * Quote Widget
 * PremiumRanking

### Installation

```bash
npm i -S @moneygeek/ui-components
```

The previous command would install these components in a NodeJS project and they could be used like in the following example.

```jsx harmony
import { Button } from "@moneygeek/ui-components";

<Button handleClick={() => alert("Clicked!")}>MG Button</Button> 
```

## Development

Each component contains three different sections, the component, styles and the unit tests. For styling we are using the React based `styled-components` library, for unit tests we are using `jest` and `eslint` as the project linter. 

### Setup

If you are using Unix like systems to install the right version of NodeJS it is convenient to use the following command:

```bash
nvm install
```

If you are using Windows based systems you can download the last LTS version of NodeJS from its website (https://nodejs.org/en/).

Once NodeJS is installed you can start adding the project modules using the next command:

```bash
npm i
```

If you want to use `yarn` instead of `npm` you could install it using the next command:

```bash
npm i -g yarn
```
You could install the project libraries through `yarn` using the following command:
```bash
yarn
```
### Bulding the Docz Development Bundle

To build the documentation of the existing components you need to run the following command:

```bash
npm run docz:dev
```
or

```bash
yarn docz:dev
```

This would generate a local website in the `http://localhost:3000` address with the components that exist currently in the project.

### Building the project and running all the test suite with linters included

To run the whole project Continuous Integration you can use the next command:

```bash
npm run build:ci
```
or
```bash
yarn build:ci
```

This would show you if there are any linter errors and whether all the unit tests passed successfully.

### Running only the unit tests

If you only need to run the unit tests you could use the following command:

```bash
npm test
```
or
```bash
yarn test
```

### Running the linters

If you only need to run the linter (Eslint) you can run it using the next command:

```bash
npm run lint
```
or
```bash
yarn lint
```

### Building Parcel transpiler and Docz source code

For building Parcel and Docz transpilers you can use the following command:

```bash
npm run build
```
or
```bash
yarn build
```
### Building Parcel 

For building Parcel you could use the next command:

```bash
npm run parcel:build
```
or
```bash
yarn parcel:build
```

### Building Docz 

For building Docz you could use the following command:

```bash
npm run docz:build
```
or
```bash
yarn docz:build
```

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