# @internetarchive/ia-sharing-options

> Sharing options for Internet Archive items

Latest version **1.0.2** (published 2022-12-29) · AGPL-3.0-only license · 0 weekly downloads

## Install

```sh
npm install @internetarchive/ia-sharing-options
pnpm add @internetarchive/ia-sharing-options
yarn add @internetarchive/ia-sharing-options
bun add @internetarchive/ia-sharing-options
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-12-29 |
| First published | 2020-08-28 |
| Weekly downloads | 0 |
| License | AGPL-3.0-only |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 55.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Shane Riley, Isa Herico Velasco, Internet Archive |
| Maintainers | tracey.pooh, latonv, markcarranza, ibnesayeed, bfalling, mitraardron, rchrd2, vbanos, kngenie, hyzhak, iisa, jbuckner, shaneriley, cdrini, nsharma123, mattm-archive, dualcnhq |

## Links

- npm: https://www.npmjs.com/package/@internetarchive/ia-sharing-options
- npm.io page: https://npm.io/package/@internetarchive/ia-sharing-options

## Dependencies (7)

- [lit](https://npm.io/package/lit.md) ^2.5.0
- [@internetarchive/icon-link](https://npm.io/package/@internetarchive/icon-link.md) ^1.3.3
- [@internetarchive/icon-email](https://npm.io/package/@internetarchive/icon-email.md) ^1.3.3
- [@internetarchive/icon-tumblr](https://npm.io/package/@internetarchive/icon-tumblr.md) ^1.3.3
- [@internetarchive/icon-twitter](https://npm.io/package/@internetarchive/icon-twitter.md) ^1.3.3
- [@internetarchive/icon-facebook](https://npm.io/package/@internetarchive/icon-facebook.md) ^1.3.3
- [@internetarchive/icon-pinterest](https://npm.io/package/@internetarchive/icon-pinterest.md) ^1.3.3

## Recent versions

- 1.0.2 (latest) — 2022-12-29
- 0.0.0-alpha.f838473 (canary) — 2020-08-28
- 1.0.2-a1 — 2022-12-29
- 1.0.1 — 2022-02-25
- 1.0.0 — 2022-02-25
- 0.1.4 — 2022-01-12
- 0.1.3 — 2022-01-12
- 0.1.3-3 — 2021-12-22
- 0.1.3-2 — 2021-12-22
- 0.1.3-alpha2 — 2021-08-06
- 0.1.3-alpha1 — 2021-08-06
- 0.1.2 — 2020-10-10
- 0.1.1 — 2020-10-01
- 0.1.0 — 2020-09-17
- 0.0.1 — 2020-09-16

## README

[![Build Status](https://travis-ci.com/internetarchive/iaux-sharing-options.svg?branch=master)](https://travis-ci.com/internetarchive/iaux-sharing-options)
[![codecov](https://codecov.io/gh/internetarchive/iaux-sharing-options/branch/master/graph/badge.svg)](https://codecov.io/gh/internetarchive/iaux-sharing-options)

# \<ia-sharing-options>

This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.

## Installation
```bash
npm i ia-sharing-options
```
or
```bash
yarn add @internetarchive/ia-sharing-options
```

## Usage
```html
<script type="module">
  import 'ia-sharing-options/ia-sharing-options.js';
</script>

<ia-sharing-options></ia-sharing-options>
```

The necessary properties to build all sharing URLs appear below:

```
{
  baseHost: "archive.org" // The domain name used to build sharing URLs
  identifier: "goody", // Item identifier
  type: "book", // Item type
  creator: "Welsh, Charles", // Item creator
  description: "The history of Little Goody Two-Shoes : otherwise called Mrs. Margery Two-Shoes ... [1766 edition]" // Item description
}
```

## Styling

```css
ia-sharing-options {
  --shareLinkColor: #fff;
  --shareIconBorder: #fff;
  --textareaColor: #fff;
  --textareaColor: #151515;
}
```

## Linting with ESLint
To scan the project for linting errors, run
```bash
npm run lint
```

## Testing with Karma
To run the suite of karma tests, run
```bash
npm run test
```

To run the tests in watch mode (for <abbr title="test driven development">TDD</abbr>, for example), run

```bash
npm run test:watch
```

## Tooling configs

For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

## Local Demo with `es-dev-server`
```bash
npm start
```
To run a local development server that serves the basic demo located in `demo/index.html`

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