# @rimble/utils

> Rimble Utils is part of an array of tools to help web3 dApp developers launch products faster and with better UX.

Latest version **1.2.3** (published 2019-10-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @rimble/utils
pnpm add @rimble/utils
yarn add @rimble/utils
bun add @rimble/utils
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.3 |
| Published | 2019-10-16 |
| First published | 2019-04-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 33 |
| Maintainers | gesq, mikelockz |
| Keywords | web3, dapp, utilities, rimble |

## Links

- npm: https://www.npmjs.com/package/@rimble/utils
- Repository: https://github.com/ConsenSys/rimble-web3-components
- Homepage: https://rimble.consensys.design
- Issues: https://github.com/ConsenSys/rimble-web3-components/issues
- npm.io page: https://npm.io/package/@rimble/utils

## Dependencies (2)

- [bowser](https://npm.io/package/bowser.md) ^2.2.0
- [rimble-ui](https://npm.io/package/rimble-ui.md) ^0.9.1

## Recent versions

- 1.2.3 (latest) — 2019-10-16
- 1.2.1 — 2019-06-04
- 1.2.0 — 2019-06-03
- 1.1.4 — 2019-05-15
- 1.1.3 — 2019-05-14
- 1.1.1 — 2019-05-13
- 1.0.0 — 2019-04-29
- 0.0.1-alpha.0 — 2019-04-23
- 0.0.0 — 2019-04-23

## README

# rimble-utils

Rimble Utils is part of an array of tools to help web3 dApp developers launch products faster and with better UX.

## Getting started

Clone this repository and install its dependencies:

```sh
// with npm
npm install @rimble/utils --save

// with yarn
yarn add @rimble/utils
```

## Usage Example

Import RimbleUtils library and call functions.

```jsx
import RimbleUtils from '@rimble/utils';

const canDoWeb3 = RimbleUtils.browserIsWeb3Compatible(); // returns true or false boolean
const currentNetworkName = RimbleUtils.getEthNetworkNameById(4); // returns "Rinkeby" string
const isMobile = RimbleUtils.isMobileDevice(); // returns true or false boolean
```

## Methods of RimbleUtils

| Name                  | Parameters          | Returns | Description                                                                                      |
| --------------------- | ------------------- | ------- | ------------------------------------------------------------------------------------------------ |
| browserIsWeb3Capable  | none                | boolean | Examines brower's UserAgent and determines if browser is recent Chrome, FireFox, Brave, or Opera |
| getEthNetworkNameById | Ethereum network ID | string  | Converts an Ethereum network ID into a network name                                              |
| isMobileBrowser       | none                | boolean | Examines browser's UserAgent and determines if the current device is a mobile platform           |

## Documentation

[Documentation](https://rimble.consensys.design/components/web3-components/NetworkIndicator)

### Issues

[Open an issue](https://github.com/ConsenSys/rimble-web3-components/issues) for any bugs or feature requests

### Contributing

We are open source and welcome your [contributions](https://github.com/ConsenSys/rimble-web3-components/CONTRIBUTIONS.md) !

### License

MIT © [ConsenSys](https://github.com/ConsenSys)

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