# clippy-web-component

> A Clippy web component

Latest version **0.0.4** (published 2020-06-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install clippy-web-component
pnpm add clippy-web-component
yarn add clippy-web-component
bun add clippy-web-component
```

## 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.0.4 |
| Published | 2020-06-26 |
| First published | 2020-06-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 47.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Towmeykaw |
| Maintainers | towmeykaw |
| Keywords | web component, lit-element, typescript, clippy |

## Links

- npm: https://www.npmjs.com/package/clippy-web-component
- Repository: https://github.com/Towmeykaw/clippy-web-component
- npm.io page: https://npm.io/package/clippy-web-component

## Dependencies (1)

- [lit-element](https://npm.io/package/lit-element.md) ^2.3.1

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2020-06-26
- 0.0.3 — 2020-06-25
- 0.0.2 — 2020-06-25
- 0.0.1 — 2020-06-25

## README

# clippy-web-component
A Web Component for adding Clippy to a website

## Install

`npm install clippy-web-component`

## Example Usage

### LitElement
`import 'clippy-web-component'`

`<clippy-element .name="Bonzi" .hide=true .speakText="Hello world"></clippy-element>`

### Angular 
`import 'clippy-web-component'`

`<clippy-element speakText="Hello world"></clippy-element>`

Also in your app.module.ts add 

`schemas: [ CUSTOM_ELEMENTS_SCHEMA ],` 

### Available properties

    name: Specify which character should be used. Possible values include(Bonzi, Clippy, F1, Genie, Genius, Links, Merlin, Peedy, Rocky, Rover). Default value: 'Clippy'
    
    hide: Will show or hide the component. Default value: false
    
    top: Set the top start value of the element. Default value: 0
    
    left: Set the left start value of the element. Default value: 0
    
    speakText: Text that the element will speak through the speech bubble. Empty string removes the bubble. Default value: ''

### Try it out
To try it out just run 

`npm run build`

`npm run serve`

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