<simple-boost>

The one-click tipping button

API

<simple-boost>

The simple-boost tipping component

Attributes

NameDescriptionTypeDefault
addressThe recipient. Either a LNURL-pay/Lightning Address or a node pubkeystring''
nwcThe recipient NWC.string''
amountThe payment amount. Either denominated in sats (default) or in a defined fiat currency.number100
memoThe payment description.string''
currencyCurrency 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 paymentstring'sats'
no-confettiDisable the confetti after a payment is sentbooleanfalse
themeThe button theme. Supported options: alby, default, hey, figma, figma-filled, next, next-filled, bootstrap, bootstrap-filled, gumroad, spotifystring'default'

Properties

NameAttributeDescriptionTypeDefault
addressaddressThe recipient. Either a LNURL-pay/Lightning Address or a node pubkeystring''
nwcnwcThe recipient NWC.string''
amountamountThe payment amount. Either denominated in sats (default) or in a defined fiat currency.number100
memomemoThe payment description.string''
currencycurrencyCurrency 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 paymentstring'sats'
noConfettino-confettiDisable the confetti after a payment is sentbooleanfalse
themethemeThe button theme. Supported options: alby, default, hey, figma, figma-filled, next, next-filled, bootstrap, bootstrap-filled, gumroad, spotifystring'default'
isLoadingbooleanfalse
jsConfettinew JSConfetti()
_nwcClientwebln.NostrWebLNProvider | nullnull
formattedAmount
nwcClient

Methods

NameParametersDescriptionReturn
getAmountInSats
clickHandler
NameDescriptionType
eMouseEvent
handleSubmit

Events

NameDescription
successIndicates when a payment was sent

Slots

NameDescription
(default)This element has a slot

CSS Shadow Parts

NameDescription
buttonThe button