# oreid-profile

> Popup User Profile Experience

Latest version **1.1.4** (published 2022-09-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install oreid-profile
pnpm add oreid-profile
yarn add oreid-profile
bun add oreid-profile
```

## 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.1.4 |
| Published | 2022-09-14 |
| First published | 2022-05-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 2.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | apimarket |

## Links

- npm: https://www.npmjs.com/package/oreid-profile
- npm.io page: https://npm.io/package/oreid-profile

## Dependencies (6)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [classnames](https://npm.io/package/classnames.md) ^2.3.1
- [@material-ui/lab](https://npm.io/package/@material-ui/lab.md) ^4.0.0-alpha.60
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.12.4
- [@material-ui/icons](https://npm.io/package/@material-ui/icons.md) ^4.11.3
- [react-copy-to-clipboard](https://npm.io/package/react-copy-to-clipboard.md) ^5.1.0

## Recent versions

- 1.1.4 (latest) — 2022-09-14
- 1.1.3 — 2022-09-12
- 1.1.2 — 2022-09-09
- 1.1.1 — 2022-09-08
- 1.1.0 — 2022-09-08
- 1.0.3 — 2022-06-02
- 1.0.3-beta.1 — 2022-06-02
- 1.0.3-beta.0 — 2022-06-02
- 1.0.2 — 2022-05-25
- 1.0.1-beta.0 — 2022-05-24
- 1.0.1 — 2022-05-24
- 1.0.0-beta.4 — 2022-05-24
- 1.0.0-beta.3 — 2022-05-24
- 1.0.0-beta.2 — 2022-05-24
- 1.0.0-beta.1 — 2022-05-24
- … 2 more at https://npm.io/package/oreid-profile/versions

## README

# ORE ID - React Profile

Popup User Profile Experience

This library should be used in a React application.
This library requires the `oreid-js` npm package.

## Overview

This library works with oreid-js to provide a "buttom user profile experience" and a "modal user profile" for oreid users.

## How to use

### Installation

```
npm install oreid-js oreid-profile
```

or

```
yarn add oreid-js oreid-profile
```

After installation, initalize `oreid-js`. We recommend that you initialize it once during your application's bootstrap.

### User's button profile

```tsx
<OreIdProfileButton
	align="right" // "left" | "right";
	oreId={oreId} // OreId instance
	style={{
		backgroundColor: "#2A3566",
		linkColor: "#3A9FFF",
		textColor: "#fff",
	}}
/>
```

### User's profile

```tsx
<OreIdProfile
	anchor={<button onClick={() => setShowModal(true)}>open profile</button>} // JSX.Element that the modal will be "linked to"
	open={isOpen} // boolean
	onClose={() => setIsOpen(false)} // onClose function
	oreId={oreId} // OreId instance
	align="right" // "left" | "right";
/>
```

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