# @oceanbase/icons-svg

> Use svg icon like @ant-design/icons.

Latest version **1.0.10** (published 2024-09-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install @oceanbase/icons-svg
pnpm add @oceanbase/icons-svg
yarn add @oceanbase/icons-svg
bun add @oceanbase/icons-svg
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.10 |
| Published | 2024-09-20 |
| First published | 2023-06-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 186.2 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | dengfuping |
| Maintainers | dengfuping |
| Keywords | svg, icons, ant-design/icons |

## Links

- npm: https://www.npmjs.com/package/@oceanbase/icons-svg
- Repository: https://github.com/dengfuping/icons-svg
- Issues: https://github.com/dengfuping/icons-svg/issues
- npm.io page: https://npm.io/package/@oceanbase/icons-svg

## Dependencies (11)

- [cpy](https://npm.io/package/cpy.md) ^8.1.2
- [svgo](https://npm.io/package/svgo.md) ^1.3.2
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [ramda](https://npm.io/package/ramda.md) ^0.27.0
- [yargs](https://npm.io/package/yargs.md) ^17.0.0-candidate.0
- [globby](https://npm.io/package/globby.md) ^11.0.0
- [insert-css](https://npm.io/package/insert-css.md) ^2.0.0
- [lodash.template](https://npm.io/package/lodash.template.md) ^4.5.0
- [lodash.camelcase](https://npm.io/package/lodash.camelcase.md) ^4.3.0
- [@rgrove/parse-xml](https://npm.io/package/@rgrove/parse-xml.md) ^2.0.2
- [lodash.upperfirst](https://npm.io/package/lodash.upperfirst.md) ^4.3.1

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [stockfish](https://npm.io/package/stockfish.md) — 27.0K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads

## Recent versions

- 1.0.10 (latest) — 2024-09-20
- 1.0.9 — 2024-09-20
- 1.0.8 — 2024-09-14
- 1.0.7 — 2024-09-13
- 1.0.6 — 2024-03-05
- 1.0.5 — 2023-10-17
- 1.0.4 — 2023-06-16
- 1.0.3 — 2023-06-16
- 1.0.2 — 2023-06-16
- 1.0.1 — 2023-06-15
- 1.0.0 — 2023-06-15

## README

## 📦 Install

```bash
npm install @oceanbase/icons-svg
```

## 📢 Requirement

Directory tree should be like below:

```bash
├── package.json
├── scripts
│   ├── generate.ts
├── src
├── svg
│   ├── filled
│   ├── outlined
│   ├── twotone
│   └── colored
```

## 🔨 Usage

`scripts/generate.ts`:

```ts
import { resolve } from 'path';
import { appendFileSync } from 'fs';
import { reactIconsGeneratorFromSVGDir } from '@oceanbase/icons-svg';

export async function generateIcons() {
  await reactIconsGeneratorFromSVGDir({
    entry: resolve(__dirname, '../svg'),
    output: resolve(__dirname, '../src'),
    typescript: true,
  });
}
generateIcons();
```

`package.json`:

```json
{
  "scripts": {
    "build": "npm run generate && ${YOUR_BUILD_COMMAND}",
    "generate": "rm -rf src && ts-node scripts/generate.ts"
  }
}
```

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