# @shardlabs/kusama-tips-widget

> ## Install

Latest version **1.0.23** (published 2021-01-22) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @shardlabs/kusama-tips-widget
pnpm add @shardlabs/kusama-tips-widget
yarn add @shardlabs/kusama-tips-widget
bun add @shardlabs/kusama-tips-widget
```

## 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.23 |
| Published | 2021-01-22 |
| First published | 2020-12-04 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Darko Macesic |
| Maintainers | blockchain-it, edi_shard_labs, jakic007, dark64 |
| Keywords | kusama, tips, treasury, widget |

## Links

- npm: https://www.npmjs.com/package/@shardlabs/kusama-tips-widget
- Repository: https://github.com/Shard-Labs/kusama-tips-widget
- Homepage: https://github.com/Shard-Labs/kusama-tips-widget#readme
- Issues: https://github.com/Shard-Labs/kusama-tips-widget/issues
- npm.io page: https://npm.io/package/@shardlabs/kusama-tips-widget

## Dependencies (11)

- [bn.js](https://npm.io/package/bn.js.md) ^5.1.3
- [buffer](https://npm.io/package/buffer.md) ^5.6.0
- [es5-ext](https://npm.io/package/es5-ext.md) ^0.10.53
- [process](https://npm.io/package/process.md) ^0.11.10
- [sirv-cli](https://npm.io/package/sirv-cli.md) ^1.0.0
- [@polkadot/api](https://npm.io/package/@polkadot/api.md) ^3.5.1
- [@polkadot/util](https://npm.io/package/@polkadot/util.md) ^5.3.1
- [crypto-browserify](https://npm.io/package/crypto-browserify.md) ^3.12.0
- [stream-browserify](https://npm.io/package/stream-browserify.md) ^3.0.0
- [@polkadot/util-crypto](https://npm.io/package/@polkadot/util-crypto.md) ^5.3.1
- [@polkadot/extension-dapp](https://npm.io/package/@polkadot/extension-dapp.md) ^0.36.1

## 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

- 1.0.23 (latest) — 2021-01-22
- 1.0.22 — 2021-01-22
- 1.0.21 — 2021-01-19
- 1.0.20 — 2021-01-07
- 1.0.19 — 2021-01-07
- 1.0.18 — 2021-01-05
- 1.0.17 — 2021-01-04
- 1.0.16 — 2020-12-30
- 1.0.15 — 2020-12-30
- 1.0.14 — 2020-12-24
- 1.0.13 — 2020-12-24
- 1.0.12 — 2020-12-18
- 1.0.11 — 2020-12-18
- 1.0.10 — 2020-12-17
- 1.0.9 — 2020-12-15
- … 9 more at https://npm.io/package/@shardlabs/kusama-tips-widget/versions

## README

# Kusama Tips Widget

## Install

Using CDN: Add the following script to the end of your `<head>` section.

```html
<script src="https://unpkg.com/@shardlabs/kusama-tips-widget@latest/dist/bundle.min.js"></script>
```

## Usage

Binding the widget:

```js
kusamaTipsWidget.bind(target, options)
```

Minimal example:

```html
<script>
  kusamaTipsWidget.bind(document.body, {
    beneficiary: "5EhR5PRsX...",
  });
</script>
```

Use custom button element:

```html
<script>
  kusamaTipsWidget.bind(document.body, {
    beneficiary: "5EhR5PRsX...",
    element: document.getElementById("my-button"),
  });
</script>
```

You can disable proposals by passing `allowProposing: false` to the options object:

```html
<script>
  kusamaTipsWidget.bind(document.body, {
    beneficiary: "5EhR5PRsX...",
    buttonText: "Donate KSM",
    allowProposing: false,
  });
</script>
```

## Options

| Property | Description | Required | Default |
|-|-|-|-|
| beneficiary | The account to be credited with the assets. Use your substrate address here. | Yes | - |
| element | A custom DOM element on which a click handler will be registered. | No | - |
| buttonText | A custom text for the button if the default value does not fit your use case. | No | Kusama Tips |
| allowProposing | A flag to control tip proposing. This flag can be set to `false` in cases where tip proposing is not desired or should not be allowed. Tip proposing is allowed by default. | No | true |

---
_Source: https://npm.io/package/@shardlabs/kusama-tips-widget · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
