# @internetarchive/ia-book-search-results

> Book search results pane for ia-menu-slider

Latest version **0.1.18** (published 2020-11-16) · AGPL-3.0-only license · 0 weekly downloads

## Install

```sh
npm install @internetarchive/ia-book-search-results
pnpm add @internetarchive/ia-book-search-results
yarn add @internetarchive/ia-book-search-results
bun add @internetarchive/ia-book-search-results
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.18 |
| Published | 2020-11-16 |
| First published | 2020-08-27 |
| Weekly downloads | 0 |
| License | AGPL-3.0-only |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 68.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Shane Riley, Isa Herico Velasco, Internet Archive |
| Maintainers | nsharma123, cdrini, shaneriley, jbuckner, iisa, hyzhak, kngenie, vbanos, bfalling, mitraardron, rchrd2 |

## Links

- npm: https://www.npmjs.com/package/@internetarchive/ia-book-search-results
- npm.io page: https://npm.io/package/@internetarchive/ia-book-search-results

## Dependencies (4)

- [lit-html](https://npm.io/package/lit-html.md) ^1.1.2
- [lit-element](https://npm.io/package/lit-element.md) ^2.2.1
- [@internetarchive/ia-activity-indicator](https://npm.io/package/@internetarchive/ia-activity-indicator.md) 0.0.1
- [@internetarchive/icon-collapse-sidebar](https://npm.io/package/@internetarchive/icon-collapse-sidebar.md) ^1.1.0

## Recent versions

- 0.1.18 (latest) — 2020-11-16
- 0.1.16 (canary) — 2020-11-13
- 0.1.17 — 2020-11-13
- 0.1.17-alpha3 — 2020-11-13
- 0.1.17-alpha2 — 2020-11-13
- 0.1.17-alpha1 — 2020-11-13
- 0.1.15-alpha-1 — 2020-11-13
- 0.1.15 — 2020-11-12
- 0.1.14 — 2020-10-26
- 0.1.14-alpha1 — 2020-10-23
- 0.1.13 — 2020-10-19
- 0.1.13-alpha3 — 2020-10-16
- 0.1.13-alpha2 — 2020-10-16
- 0.1.13-alpha1 — 2020-10-16
- 0.1.12 — 2020-10-09
- … 16 more at https://npm.io/package/@internetarchive/ia-book-search-results/versions

## README

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

# \<ia-book-search-results>

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

## Installation
```bash
npm i ia-book-search-results
```
or
```bash
yarn add @internetarchive/ia-menu-slider
```

## Usage
```html
<script type="module">
  import 'ia-book-search-results/ia-book-search-results.js';
</script>

<ia-book-search-results .query='bristol'></ia-book-search-results>
```

Supply the element with an optional array of search results to immediately
render. Each result can have these properties:

```js
{
  title: 'Book title', // The item's title
  cover: '//archive.org/img/cover.jpg', // The item's cover image
  hits: ['Hello {{{world}}}'], // Search results taken from the `matches` property in returned search results
}
```

## Styling

```css
ia-book-search-results {
  --primaryTextColor: #fff;
  --activeButtonBg: #282828;
  --searchResultText: #adaedc;
  --searchResultBg: #272958;
  --searchResultBorder: #fff;
}
```

## 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-book-search-results · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._