# @jswork/react-searchlight

> Searchlight for react.

Latest version **1.0.0** (published 2021-02-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @jswork/react-searchlight
pnpm add @jswork/react-searchlight
yarn add @jswork/react-searchlight
bun add @jswork/react-searchlight
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-02-19 |
| First published | 2021-02-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 18.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | afei |
| Maintainers | afeiship |
| Keywords | react, searchlight, mask, light, component, components |

## Links

- npm: https://www.npmjs.com/package/@jswork/react-searchlight
- Repository: https://github.com/afeiship/react-searchlight
- Homepage: https://github.com/afeiship/react-searchlight#readme
- Issues: https://github.com/afeiship/react-searchlight/issues
- npm.io page: https://npm.io/package/@jswork/react-searchlight

## Dependencies (3)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [@jswork/noop](https://npm.io/package/@jswork/noop.md) ^1.0.0
- [react-draggable](https://npm.io/package/react-draggable.md) ^4.4.3

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2021-02-19

## README

# react-searchlight
> Searchlight for react.

[![version][version-image]][version-url]
[![license][license-image]][license-url]
[![size][size-image]][size-url]
[![download][download-image]][download-url]

## installation
```shell
npm install -S @jswork/react-searchlight
```

## properties
| Name      | Type   | Required | Default | Description                              |
| --------- | ------ | -------- | ------- | ---------------------------------------- |
| className | string | false    | -       | The extended className for component.    |
| options   | object | false    | -       | The default options for react-draggable. |


## usage
1. import css
  ```scss
  @import "~@jswork/react-searchlight/dist/style.css";

  // or use sass
  @import "~@jswork/react-searchlight/dist/style.scss";

  // customize your styles:
  $react-searchlight-options: ()
  ```
2. import js
  ```js
  import ReactDemokit from '@jswork/react-demokit';
  import React from 'react';
  import ReactDOM from 'react-dom';
  import ReactSearchlight from '@jswork/react-searchlight';
  import './assets/style.scss';

  class App extends React.Component {
    render() {
      return (
        <ReactDemokit
          className="p-3 app-container"
          url="https://github.com/afeiship/react-searchlight">
          <h1 className="text-center mb-5 text-white text-2xl">
            Searchlight for react.
          </h1>
          <iframe width="100%" src="https://m.baidu.com"></iframe>
          <ReactSearchlight />
        </ReactDemokit>
      );
    }
  }

  ReactDOM.render(<App />, document.getElementById('app'));

  ```

## documentation
- https://afeiship.github.io/react-searchlight/


## license
Code released under [the MIT license](https://github.com/afeiship/react-searchlight/blob/master/LICENSE.txt).

[version-image]: https://img.shields.io/npm/v/@jswork/react-searchlight
[version-url]: https://npmjs.org/package/@jswork/react-searchlight

[license-image]: https://img.shields.io/npm/l/@jswork/react-searchlight
[license-url]: https://github.com/afeiship/react-searchlight/blob/master/LICENSE.txt

[size-image]: https://img.shields.io/bundlephobia/minzip/@jswork/react-searchlight
[size-url]: https://github.com/afeiship/react-searchlight/blob/master/dist/react-searchlight.min.js

[download-image]: https://img.shields.io/npm/dm/@jswork/react-searchlight
[download-url]: https://www.npmjs.com/package/@jswork/react-searchlight

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