# fillscreen-image

> Fill the screen with an image.

Latest version **0.3.0** (published 2017-07-08) · GPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install fillscreen-image
pnpm add fillscreen-image
yarn add fillscreen-image
bun add fillscreen-image
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2017-07-08 |
| First published | 2017-06-08 |
| Weekly downloads | 0 |
| License | GPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kenneth Ko |
| Maintainers | kennethko |

## Links

- npm: https://www.npmjs.com/package/fillscreen-image
- Repository: https://github.com/ko/fillscreen-image
- Homepage: https://github.com/ko/fillscreen-image#readme
- Issues: https://github.com/ko/fillscreen-image/issues
- npm.io page: https://npm.io/package/fillscreen-image

## Recent versions

- 0.3.0 (latest) — 2017-07-08
- 0.2.1 — 2017-06-08
- 0.2.0 — 2017-06-08

## README

# What

Given a metadata about an image and a window, we can
adjust what portion of the image is viewable within
the viewport. 

# Props

|Key|Value|
|---|---|
|json|imageType|
|domExists|boolean|

```
imageType = {
  visible: boolean,
  ratio: float,
  width: int,
  height: int,
  focus: {
    x: int,
    y: int,
  },
}
```

# Server Side Rendering

For SSR purposes, the default window is expected to be 800x800. You will need to update this on ```componentDidMount()``` (for instance) to get accurate window dimension readings.

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