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 | '' |
| amount | The payment amount. Either denominated in sats (default) or in a defined fiat currency. | number | 100 |
| 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' |
| method | The lightning payment method to use (lnurl or keysend) | string | 'lnurl' |
| custom-key | The name of a custom record key to send along with the keysend payment. Only used for keysend payments | null | null |
| custom-value | A custom value to pass along with the payment. This is considered the value that belongs to the customKey. Only used for keysend payments | null | null |
| 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 | '' |
| amount | amount | The payment amount. Either denominated in sats (default) or in a defined fiat currency. | number | 100 |
| 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' |
| method | method | The lightning payment method to use (lnurl or keysend) | string | 'lnurl' |
| customKey | custom-key | The name of a custom record key to send along with the keysend payment. Only used for keysend payments | null | null |
| customValue | custom-value | A custom value to pass along with the payment. This is considered the value that belongs to the customKey. Only used for keysend payments | null | null |
| 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() |
| formattedAmount | | | | |
Methods
| Name | Parameters | Description | Return |
| getAmountInSats | | | |
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 |