# rosid-handler-components

> UI to help you build and document web components

Latest version **3.1.5** (published 2017-11-24) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install rosid-handler-components
pnpm add rosid-handler-components
yarn add rosid-handler-components
bun add rosid-handler-components
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.1.5 |
| Published | 2017-11-24 |
| First published | 2017-05-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 18 |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 356 |
| Maintainers | electerious |
| Keywords | rosid, handler, transform, ui, fractal, components |

## Links

- npm: https://www.npmjs.com/package/rosid-handler-components
- Repository: https://github.com/comwrap/rosid-handler-components
- Issues: https://github.com/comwrap/rosid-handler-components/issues
- npm.io page: https://npm.io/package/rosid-handler-components

## Dependencies (18)

- [pify](https://npm.io/package/pify.md) ^3.0.0
- [react](https://npm.io/package/react.md) ^16.1.1
- [redux](https://npm.io/package/redux.md) ^3.7.2
- [glamor](https://npm.io/package/glamor.md) ^3.0.0-2
- [marked](https://npm.io/package/marked.md) ^0.3.6
- [history](https://npm.io/package/history.md) ^4.7.2
- [react-dom](https://npm.io/package/react-dom.md) ^16.1.1
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.0
- [color-alpha](https://npm.io/package/color-alpha.md) ^1.0.2
- [react-redux](https://npm.io/package/react-redux.md) ^5.0.6
- [url-pattern](https://npm.io/package/url-pattern.md) ^1.0.3
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.12.0
- [is-plain-obj](https://npm.io/package/is-plain-obj.md) ^1.1.0
- [searchstring](https://npm.io/package/searchstring.md) ^1.0.2
- [normalize-url](https://npm.io/package/normalize-url.md) ^1.9.1
- [rosid-handler-js](https://npm.io/package/rosid-handler-js.md) ^10.0.1
- [components-lookup](https://npm.io/package/components-lookup.md) ^4.0.2
- [react-document-title](https://npm.io/package/react-document-title.md) ^2.0.3

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 3.1.5 (latest) — 2017-11-24
- 3.0.0-0 (beta) — 2017-07-31
- 3.1.4 — 2017-11-08
- 3.1.3 — 2017-11-03
- 3.1.2 — 2017-08-16
- 3.1.1 — 2017-08-08
- 3.1.0 — 2017-08-04
- 3.0.0 — 2017-08-01
- 2.0.1 — 2017-07-25
- 2.0.0 — 2017-07-24
- 1.8.3 — 2017-07-11
- 1.8.2 — 2017-07-11
- 1.8.1 — 2017-06-29
- 1.8.0 — 2017-06-28
- 1.7.1 — 2017-06-23
- … 15 more at https://npm.io/package/rosid-handler-components/versions

## README

# rosid-handler-components

[![Travis Build Status](https://travis-ci.org/comwrap/rosid-handler-components.svg?branch=master)](https://travis-ci.org/comwrap/rosid-handler-components) [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/6fxwnrdhoh7xw9n1?svg=true)](https://ci.appveyor.com/project/electerious/rosid-handler-components) [![Coverage Status](https://coveralls.io/repos/github/comwrap/rosid-handler-components/badge.svg?branch=master)](https://coveralls.io/github/comwrap/rosid-handler-components?branch=master)  [![Dependencies](https://david-dm.org/comwrap/rosid-handler-components.svg)](https://david-dm.org/comwrap/rosid-handler-components#info=dependencies)

UI to help you build and document web components.

## Install

```
npm install rosid-handler-components
```

## Usage

### API

```js
const components = require('rosid-handler-components')

components('.html').then(console.log) // Returns HTML of the UI
components('.json').then(console.log) // Returns JSON for the UI
```

### Rosid

Add the following object to your `rosidfile.json`, `rosidfile.js` or [routes array](https://github.com/electerious/Rosid/blob/master/docs/Routes.md). `rosid-handler-components` will return the HTML of the UI or the JSON for the UI depending on the path.

```json
{
	"name"    : "Components",
	"path"    : "ui/**/index.{html,html.json}",
	"handler" : "rosid-handler-components"
}
```

Disable automatic page reloads for the UI to get realtime updates when developing components. You can do so by using the `--static` or `-s` option in the CLI or by using the `static` option.

```sh
rosid serve src/ dist/ -s '/ui/index.html'
```

```js
Rosid.serve('src/', { static: '/ui/index.html' }, (err) => {})
```

## Parameters

- `filePath` `{?*}` Fictive path that ends with `.html` or `.json`
- `opts` `{?Object}` Options.

## Returns

- `{Promise<String|Buffer>}` HTML or JSON of the UI.

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