@internetarchive/ia-sharing-options v1.0.2

\

This webcomponent follows the open-wc recommendation.

Installation

npm i ia-sharing-options

or

yarn add @internetarchive/ia-sharing-options

Usage

<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

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

Linting with ESLint

To scan the project for linting errors, run

npm run lint

Testing with Karma

To run the suite of karma tests, run

npm run test

To run the tests in watch mode (for TDD, for example), run

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

npm start

To run a local development server that serves the basic demo located in demo/index.html