# artbox

> Artbox is a svg path library module for Angular projects. It uses a separate Firestore API to access data and requires authorizing. Currently access is private during beta.

Latest version **0.0.6** (published 2020-09-07) · 0 weekly downloads

## Install

```sh
npm install artbox
pnpm add artbox
yarn add artbox
bun add artbox
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2020-09-07 |
| First published | 2020-08-27 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 125.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | amatisme |

## Links

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

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^1.10.0

## Recent versions

- 0.0.6 (latest) — 2020-09-07
- 0.0.4 — 2020-08-28
- 0.0.3 — 2020-08-28
- 0.0.2 — 2020-08-28
- 0.0.1 — 2020-08-27

## README

### What is Artbox?

Artbox is a svg path library module for Angular projects. It uses a separate Firestore API to access data and requires authorizing. Currently access is private during beta.

# Core Features

- SVG as a Service
- Easy to add any web project by abstracting to a component
- Path library to increase in size over time (hopefully)

## Installation

**I do not recommend installing at the time! Requires private API key only available to beta testers.** The project is in development and is unstable. Please wait for a production release. There is no timetable at this moment. Currently the library is very small and there exists no documentation.

In your Module:
```
import { ArtboxModule } from 'artbox';

@NgModule({
  ...
  imports: [
    ...,
    ArtboxModule,
  ],
  ...
})
```
To set an API key for the service, one method is to create a keyfile named 'artbox.keyfile.ts', then import.

In your artbox.keyfile.ts
```
export const CLIENT_KEY = [*YOUR_CLIENT_KEY*]
```
In your Component or Service:
```
import { CLIENT_KEY } from './artbox.keyfile'
...
constructor(private artbox: ArtboxService) {
    //set the access key
    artbox.CLIENT_KEY = CLIENT_KEY
}
...
```

## Compatibility

Not backwards compatible with View Engine, using Ivy.

## Usage

In your HTML, add a artbox element reference with a shape input directive.
```
<artbox [shape]="'heart'"></artbox>
``` 

## Developer Notes

Thank you for stumbling upon this, I hope it will be usefull in the future. If you are curious and would like to add paths to this collection, please send me an email.

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