# @feizheng/react-figure

> A tiny figure image for react.

Latest version **1.0.1** (published 2020-02-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @feizheng/react-figure
pnpm add @feizheng/react-figure
yarn add @feizheng/react-figure
bun add @feizheng/react-figure
```

## 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.0.1 |
| Published | 2020-02-08 |
| First published | 2020-02-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 7.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | afei |
| Maintainers | afeiship |
| Keywords | react, component |

## Links

- npm: https://www.npmjs.com/package/@feizheng/react-figure
- Repository: https://github.com/afeiship/react-figure
- Homepage: https://github.com/afeiship/react-figure#readme
- Issues: https://github.com/afeiship/react-figure/issues
- npm.io page: https://npm.io/package/@feizheng/react-figure

## Dependencies (4)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [@feizheng/noop](https://npm.io/package/@feizheng/noop.md) ^1.0.0
- [@feizheng/webpack-lib-kits](https://npm.io/package/@feizheng/webpack-lib-kits.md) ^1.1.9

## 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

- 1.0.1 (latest) — 2020-02-08
- 1.0.0 — 2020-02-07

## README

# react-figure
> A tiny figure image for react.

## installation
```shell
npm install -S @feizheng/react-figure
```

## update
```shell
npm update @feizheng/react-figure
```

## properties
| Name      | Type   | Default | Description                           |
| --------- | ------ | ------- | ------------------------------------- |
| className | string | -       | The extended className for component. |
| caption   | any    | -       | Default image caption.                |


## usage
1. import css
  ```scss
  @import "~@feizheng/react-figure/dist/style.scss";

  // customize your styles:
  $react-figure-options: ()
  ```
2. import js
  ```js
  import ReactFigure from '@feizheng/react-figure';
  import ReactDOM from 'react-dom';
  import React from 'react';
  import './assets/style.scss';

  class App extends React.Component {
    componentDidMount() {}
    render() {
      return (
        <div className="app-container">
          <ReactFigure caption="test picture">
            <img
              src="https://miro.medium.com/max/2798/1*RAa-e7v7WghBqatRXBy3WQ.jpeg"
              alt=""
            />
          </ReactFigure>
        </div>
      );
    }
  }

  ReactDOM.render(<App />, document.getElementById('app'));

  ```

## documentation
- https://afeiship.github.io/react-figure/

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