API
<simple-boost>
The simple-boost tipping component
Attributes
Name | Description | Type | Default |
address | The recipient. Either a LNURL-pay/Lightning Address or a node pubkey | string | '' |
nwc | The recipient NWC. | string | '' |
amount | The payment amount. Either denominated in sats (default) or in a defined fiat currency. | number | 100 |
memo | The payment description. | string | '' |
currency | Currency of the payment. Defaults to sats. If a fiat currency (e.g. USD, EUR, etc.) is used the amount will be converted to sats on payment | string | 'sats' |
no-confetti | Disable the confetti after a payment is sent | boolean | false |
theme | The button theme. Supported options: alby, default, hey, figma, figma-filled, next, next-filled, bootstrap, bootstrap-filled, gumroad, spotify | string | 'default' |
Properties
Name | Attribute | Description | Type | Default |
address | address | The recipient. Either a LNURL-pay/Lightning Address or a node pubkey | string | '' |
nwc | nwc | The recipient NWC. | string | '' |
amount | amount | The payment amount. Either denominated in sats (default) or in a defined fiat currency. | number | 100 |
memo | memo | The payment description. | string | '' |
currency | currency | Currency of the payment. Defaults to sats. If a fiat currency (e.g. USD, EUR, etc.) is used the amount will be converted to sats on payment | string | 'sats' |
noConfetti | no-confetti | Disable the confetti after a payment is sent | boolean | false |
theme | theme | The button theme. Supported options: alby, default, hey, figma, figma-filled, next, next-filled, bootstrap, bootstrap-filled, gumroad, spotify | string | 'default' |
isLoading | | | boolean | false |
jsConfetti | | | | new JSConfetti() |
_nwcClient | | | webln.NostrWebLNProvider | null | null |
formattedAmount | | | | |
nwcClient | | | | |
Methods
Name | Parameters | Description | Return |
getAmountInSats | | | |
clickHandler |
Name | Description | Type |
e | | MouseEvent |
| | |
handleSubmit | | | |
Events
Name | Description |
success | Indicates when a payment was sent |
Slots
Name | Description |
(default) | This element has a slot |
CSS Shadow Parts
Name | Description |
button | The button |