This project includes web components for connecting to Lightning Wallets and enabling WebLN. Websites only need to implement a single interface to connect with multiple wallets (WebLN), and users can connect from both desktop and mobile devices. These components work with pure HTML and all Javascript libraries frameworks such as React, Angular, Vue, Solid.js, etc.
npm install @getalby/lightning-wallet-connect
or
yarn add @getalby/lightning-wallet-connect
or for use without any build tools:
<script src="https://cdn.jsdelivr.net/npm/@getalby/[email protected]/dist/index.browser.js"></script>
Screen.Recording.2023-04-27.at.01.17.19.mov
Lightning wallet connect exposes the following web components for allowing user to connect their desired Lightning wallet:
<lwc-button/>- launches the LWC Modal on click- Optional Arguments:
icon-only- display the button as an icon without "Connect wallet"disabled- mark the button as disabled. NOTE: in react disabled={false} will not work - attribute must be omitted
- Optional Arguments:
<lwc-modal/>- render the modal on its own<lwc-connector-list/>- render the list of connectors on their own- more components coming soon
Lightning wallet connect exposes the following events:
lwc:connectedwindow event which fires when a wallet is connected and window.webln is ready to uselwc:connectingwindow event which fires when LWC is connecting to a walletlwc:disconnectedwindow event which fires when user has disconnected from their walletlwc:modalopenedwindow event which fires when Lightning Wallet Connect modal is openedlwc:modalclosedwindow event which fires when Lightning Wallet Connect modal is closed
Current wallets supported:
- [Alby Browser extension] (https://getalby.com)
- Alby NWC
- Generic NWC URL
Example codepen: https://codepen.io/rolznz/pen/ZEmXGLd
<html>
<body>
<lwc-button></lwc-button>
<script src="https://cdn.jsdelivr.net/npm/@getalby/[email protected]/dist/index.browser.js"></script>
<script>
window.addEventListener('lwc:connected', async () => {
// TODO: hide the lwc-button
const invoice = // (...invoice generated by backend)
await window.webln.sendPayment(invoice);
confetti();
});
</script>
</body>
</html>Example replit: https://replit.com/@rolznz/make-me-an-image-lwc-version
import '@getalby/lightning-wallet-connect';
// in your component, listen to lightning wallet connected event
const [lwcConnected, setLwcConnected] = React.useState(false);
React.useEffect(() => {
const onConnected = () => setLwcConnected(true);
window.addEventListener('lwc:connected', onConnected);
return () => {
window.removeEventListener('lwc:connected', onConnected);
};
}, []);
const invoice = // (...invoice generated by backend)
return lwcConnected ? <>
<button onClick={() => window.webln.sendPayment(invoice)}/>
</> : <lwc-button/>;Open demos
Run yarn install && (cd dev/vite && yarn install)
Run yarn dev
Open dev
yarn build
yarn dev:build
yarn dev:build:browser
yarn test
We are happy to help, please contact us or create an issue.
- Twitter: @getAlby
- Telegram group
- support at getalby.com
- bitcoin.design Discord community (find us on the #alby channel)
- Read the Alby developer guide to better understand how Alby packages and APIs can be used to power your app.
This project is powered by Lit.
See Get started on the Lit site for more information.
MIT