# @smartgift/hero-ui-library

> `hero-ui` is a react library with a set of components ready to use in your project.

Latest version **0.8.28-theming.102** (published 2023-12-26) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @smartgift/hero-ui-library
pnpm add @smartgift/hero-ui-library
yarn add @smartgift/hero-ui-library
bun add @smartgift/hero-ui-library
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.8.28-theming.102 |
| Published | 2023-12-26 |
| First published | 2022-03-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 17 |
| Unpacked size | 885.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | isahanoncel, mucahidyazar, orhankutlu, canercay, smartgift-webmaster |

## Links

- npm: https://www.npmjs.com/package/@smartgift/hero-ui-library
- npm.io page: https://npm.io/package/@smartgift/hero-ui-library

## Dependencies (17)

- [draft-js](https://npm.io/package/draft-js.md) 0.11.7
- [polished](https://npm.io/package/polished.md) 4.2.2
- [react-select](https://npm.io/package/react-select.md) 5.4.0
- [framer-motion](https://npm.io/package/framer-motion.md) 6.3.16
- [icomoon-react](https://npm.io/package/icomoon-react.md) 3.0.0
- [draftjs-to-html](https://npm.io/package/draftjs-to-html.md) 0.9.1
- [html-to-draftjs](https://npm.io/package/html-to-draftjs.md) 1.5.0
- [draftjs-to-markdown](https://npm.io/package/draftjs-to-markdown.md) 0.6.0
- [react-phone-input-2](https://npm.io/package/react-phone-input-2.md) ^2.15.1
- [react-popper-tooltip](https://npm.io/package/react-popper-tooltip.md) 4.4.2
- [@draft-js-plugins/emoji](https://npm.io/package/@draft-js-plugins/emoji.md) 4.6.3
- [@draft-js-plugins/anchor](https://npm.io/package/@draft-js-plugins/anchor.md) 4.2.0
- [@draft-js-plugins/editor](https://npm.io/package/@draft-js-plugins/editor.md) 4.1.3
- [@draft-js-plugins/buttons](https://npm.io/package/@draft-js-plugins/buttons.md) ^4.3.3
- [@draft-js-plugins/counter](https://npm.io/package/@draft-js-plugins/counter.md) ^4.1.3
- [draft-js-toolbar-link-plugin](https://npm.io/package/draft-js-toolbar-link-plugin.md) 1.0.1
- [@draft-js-plugins/static-toolbar](https://npm.io/package/@draft-js-plugins/static-toolbar.md) 4.1.3

## Recent versions

- 0.8.28-theming.102 (latest) — 2023-12-26
- 1.0.0-alpha.25 (alpha) — 2023-12-21
- 0.6.8-beta.14 (beta) — 2022-07-05
- 1.0.0-alpha.24 — 2023-12-21
- 1.0.0-alpha.22 — 2023-12-21
- 1.0.0-alpha.21 — 2023-12-21
- 1.0.0-alpha.20 — 2023-12-21
- 1.0.0-alpha.19 — 2023-12-21
- 1.0.0-alpha.18 — 2023-12-21
- 1.0.0-alpha.17 — 2023-12-21
- 1.0.0-alpha.15 — 2023-12-21
- 1.0.0-alpha.13 — 2023-12-21
- 1.0.0-alpha.12 — 2023-12-21
- 1.0.0-alpha.11 — 2023-12-21
- 1.0.0-alpha.10 — 2023-12-21
- … 260 more at https://npm.io/package/@smartgift/hero-ui-library/versions

## README

# HeroUI

`hero-ui` is a react library with a set of components ready to use in your project.

There're plenty of libraries available in react that will help you to increase your productivity however most of them contain a lot of css and are really hard to style based on your project's requirements.

## Installation

To use hero-ui you need to type in your terminal:

```js
yarn add @smartgift/hero-ui-library
```

## Usage

First we need to wrap our application with `<ThemeProvider>` component.

```js
import {ThemeProvider} from '@smartgift/hero-ui-library`;

function App() {
  return (
    <ThemeProvider>
      ...
    </ThemeProvider>
  )
}
```

After you wrapped your app with our ThemeProvider you can use all the components with our default theme.

For example:

```js
import {Button} from '@smartgift/hero-ui-library`;

function App() {
  return (
    <Button onClick={()=>{}}>
      Click me
    </Button>
  )
}
```

## Styling

We set all of our styling by styled-components. And we send the styling with the components as 'S'. (We import all styles as S and set it like this `Component.S = S`). You will understand more clear. Look at below.

```js
/* /src/components/style.tsx */
import styled from 'styled-components';

const Button = styled.button``;

export { Button };
```

```js
/* /src/components/Button.tsx */
import * as S from './style'

const Button = () => {...}

Button.S = S
```

and you can import our button your project and change its style like below.

```js
/* /yourProject/anystyle.{jsx/tsx} */
import styled from 'styled-components';
import { Button } from '@smartgift/hero-ui-library';

const StyledButton = styled(Button)`
  background-color: red;
`;

export { StyledButton as Button };
```

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