react-shields.io/README.md

Shields.io for react component, Quality metadata badges for open source projects.

react-shields
===

[![Build & Deploy](https://github.com/uiwjs/react-shields/workflows/Build%20&%20Deploy/badge.svg)](https://github.com/uiwjs/react-shields/actions)
[![](https://img.shields.io/github/issues/uiwjs/react-shields.svg)](https://github.com/uiwjs/react-shields/issues)
[![](https://img.shields.io/github/forks/uiwjs/react-shields.svg)](https://github.com/uiwjs/react-shields/network)
[![](https://img.shields.io/github/stars/uiwjs/react-shields.svg)](https://github.com/uiwjs/react-shields/stargazers)
[![](https://img.shields.io/github/v/release/uiwjs/react-shields.svg)](https://github.com/uiwjs/react-shields/releases)
[![](https://img.shields.io/npm/v/@uiw/react-shields.svg)](https://www.npmjs.com/package/@uiw/react-shields)
[![](https://jaywcjlove.github.io/sb/ico/gitee.svg)](https://gitee.com/uiw/react-shields)

<!--dividing-->

[Shields.io](https://shields.io/): Quality metadata badges open source projects for react component.

## Install

```bash
npm install --save @uiw/react-shields
# Via Yarn:
yarn add @uiw/react-shields
```

## Usage

```jsx
import Github from '@uiw/react-shields';

function Demo() {
  return (
    <>
      <Github.Issues user="uiwjs" repo="uiw" />
      <Github user="uiwjs" repo="uiw">
        <Github.Issues href="https://github.com/uiwjs/uiw" type="issues" />
        <Github.Issues type="issues-raw" />
        <Github.Issues type="issues-closed" />
      </Github>
      <Github.Size user="uiwjs" repo="uiw" />
      <Github user="uiwjs" repo="uiw">
        <Github.Size />
        <Github.Size type="repo-size" />
        <Github.Size type="size" />
      </Github>
    </>
  );
}
```

### Github.Social

```jsx
<Github.Social user="jaywcjlove" repo="uiw" href="https://github.com/jaywcjlove" />
<Github user="jaywcjlove" repo="awesome-mac">
  <Github.Social type="forks" />
  <Github.Social type="stars" />
  <Github.Social type="watchers" />
  <Github.Social type="followers" />
</Github>
```

### Npm.Version

```jsx
<Npm.Version scope="@uiw" packageName="react-shields" />
<Npm>
  <Npm.Version scope="@uiw" packageName="react-github-corners" />
  <Npm.Version packageName="hotkeys-js" />
  <Npm.Version packageName="kkt" version="latest" />
  <Npm.Version packageName="tsbb" />
  <Npm.Version
    scope="@uiw"
    type="peer-dependency"
    dependency="react"
    packageName="react-github-corners"
  />
</Npm>
```

### Npm.Size

```jsx
<Npm.Size scope="@uiw" packageName="react-shields" />
<Npm>
  <Npm.Size format="minzip" scope="@uiw" packageName="react-github-corners" />
  <Npm.Size packageName="hotkeys-js" />
  <Npm.Size packageName="kkt" version="latest" />
</Npm>
```

### Github.Issues

```jsx
<Github.Issues user="uiwjs" repo="uiw" />
<Github user="uiwjs" repo="uiw">
  <Github.Issues type="issues" />
  <Github.Issues type="issues-raw" />
  <Github.Issues type="issues-closed" />
  <Github.Issues type="issues-closed-raw" />
  <Github.Issues type="issues-pr" />
  <Github.Issues type="issues-pr-raw" />
  <Github.Issues type="issues-pr-closed" />
  <Github.Issues type="issues-pr-closed-raw" />
  <Github.Issues type="issues" label="bug" />
  <Github.Issues type="issues-raw" label="bug" />
  <Github.Issues type="issues-pr" label="bug" />
  <Github.Issues type="issues-pr-raw" label="bug" />
</Github>
```

### Github.Size

```jsx
<Github.Size user="uiwjs" repo="uiw" />
<Github user="uiwjs" repo="uiw">
  <Github.Size />
  <Github.Size type="repo-size" />
  <Github.Size type="size" />
</Github>
```

### Github.Downloads

```jsx
<Github.Downloads user="uiwjs" repo="uiw" />
<Github user="uiwjs" repo="uiw">
  <Github.Downloads />
  <Github.Downloads total={false}/>
  <Github.Downloads type="downloads-pre" />
  <Github.Downloads total={false} tag="v3.9.0"/>
  <Github.Downloads tag="v3.9.0"/>
</Github>
```

### Github.Version

```jsx
<Github.Version user="uiwjs" repo="uiw" />
<Github user="uiwjs" repo="uiw">
  <Github.Version type="version-tag" />
  <Github.Version type="package-json" />
  <Github.Version type="package-json" branch="dev" />
  <Github.Version user="jaywcjlove" repo="wxmp" type="manifest-json" />
  <Github.Version user="jaywcjlove" repo="wxmp" type="manifest-json" branch="master" />
  <Github.Version user="x-mod" repo="routine" type="go-mod" />
  <Github.Version user="x-mod" repo="routine" type="go-mod" branch="master" />
</Github>
```

### Github.License

```jsx
<Github.License user="uiwjs" repo="uiw" />
<Github user="uiwjs" repo="uiw">
  <Github.License />
</Github>
```

### Github.Analysis

```jsx
<Github.Analysis user="uiwjs" repo="uiw" />
<Github user="uiwjs" repo="uiw">
  <Github.Analysis type="languages-top" />
  <Github.Analysis type="search" query="github" />
</Github>
```

### Coverage.Coverages

```jsx
<Coverage.Coverages user="jaywcjlove" repo="hotkeys" />
<Coverage user="jaywcjlove" repo="hotkeys">
  <Coverage.Coverages type="github"  />
  <Coverage.Coverages type="github" />
</Coverage>
```

### Coverage.Codacy

```jsx
<Coverage.Codacy projectId="1c524e61cd8640e79b80d406eda8754b" />
<Coverage user="jaywcjlove" repo="hotkeys">
  <Coverage.Codacy projectId="1c524e61cd8640e79b80d406eda8754b" branch="master" />
  <Coverage.Codacy projectId="1c524e61cd8640e79b80d406eda8754b" />
</Coverage>
```

## Development

```bash
# Step 1, Run first, the listener component compiles the output .js file
npm run ts:watch
# Step 2, Listen for compiled output type .d.ts file
npm run types:watch
# Step 3, Development mode, listen to compile preview site instance
npm run doc:dev
```

Compile and release

```bash
npm run released
```