@aleph-fi/widget-react

Aleph Widget for React applications.

Installation

npm install @aleph-fi/widget-react
# or
pnpm install @aleph-fi/widget-react
# or
yarn add @aleph-fi/widget-react

Usage

import { AlephWidget } from "@aleph-fi/widget-react";

function App() {
  return (
    <div>
      <AlephWidget vaultId="your-vault-id" theme="light" autoResize />
    </div>
  );
}

Props

Prop	Type	Required	Default	Description
vaultId	string	Yes	-	Vault ID to display in the widget
theme	"light" | "dark"	No	"light"	Widget theme
height	string | number	No	400	Widget height (initial/minimum height)
autoResize	boolean	No	false	Enable automatic height resizing based on widget content
baseUrl	string	No	"https://aleph-widget-dev.up.railway.app"	Base URL for the widget iframe source
className	string	No	""	Additional className for the iframe container
style	React.CSSProperties	No	{}	Additional inline styles for the iframe
onReady	() => void	No	-	Callback fired when widget is ready
onError	(error: Error) => void	No	-	Callback fired when widget encounters an error

For more details, see the React package documentation.

License

Business Source License 1.1 - See LICENSE file for details