This is the full developer documentation for Wallet SDK by Frak
# Wallet SDK by Frak
> Seamlessly integrate Web3 functionality into your applications with user-friendly wallet interactions, engagement tracking, and reward systems.
import IntegrationCards from "@/components/IntegrationCards.astro";
```ts
import crypto from 'crypto';
type Purchase = {
id: string;
customerId: string;
status: "pending" | "confirmed" | "cancelled" | "refunded";
token: string;
currency?: string;
totalPrice?: string;
items?: {
productId: string;
quantity: number;
price: string;
name: string;
title: string;
image?: string;
}[];
}
async function sendPurchaseWebhook(
purchase: Purchase
): Promise {
const body = JSON.stringify(purchase);
const hmac = await crypto
.createHmac('sha256', process.env.FRAK_PURCHASE_WEBHOOK_SECRET)
.update(body)
.digest('hex');
await fetch(process.env.FRAK_PURCHASE_WEBHOOK, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-hmac-sha256': hmac,
'x-test': process.env.NODE_ENV === 'production' ? 'false' : 'true'
},
body
});
}
// Usage example
const purchase = {
id: 'order_123',
customerId: 'cust_456',
status: 'confirmed',
token: 'purchase_token_789',
currency: 'USD',
totalPrice: '99.99',
items: [{
productId: 'prod_001',
quantity: 1,
price: '99.99',
name: 'premium-subscription',
title: 'Premium Subscription'
}]
};
sendPurchaseWebhook(purchase)
.then(response => console.log('Webhook sent successfully:', response))
.catch(error => console.error('Error sending webhook:', error));
```
```php
function sendPurchaseWebhook(array $purchase): void {
$webhookUrl = 'your_webhook_url_from_dashboard';
$secretKey = 'your_secret_key_from_dashboard';
$isTest = true; // Set to false in production
$body = json_encode($purchase);
$hmac = hash_hmac('sha256', $body, $secretKey);
$ch = curl_init($webhookUrl);
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $body,
CURLOPT_RETURNTRANSFER => false,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'x-hmac-sha256: ' . $hmac,
'x-test: ' . ($isTest ? 'true' : 'false')
]
]);
curl_exec($ch);
curl_close($ch);
}
// Usage example
$purchase = [
'id' => 'order_123',
'customerId' => 'cust_456',
'status' => 'confirmed',
'token' => 'purchase_token_789',
'currency' => 'USD',
'totalPrice' => '99.99',
'items' => [
[
'productId' => 'prod_001',
'quantity' => 1,
'price' => '99.99',
'name' => 'premium-subscription',
'title' => 'Premium Subscription'
]
]
];
sendPurchaseWebhook($purchase);
```
## HMAC Signature
Each webhook request should include a valid HMAC signature of the entire body payload, ensuring the request's integrity and authenticity. The secret used to generate this HMAC signature is available in your business dashboard.
## Response
All webhook types expect a JSON response indicating whether the request was successfully processed.
## Notes
- Ensure that the `id`, `customerId`, `status`, and `token` fields are consistent between the client and the server to ensure successful tracking.
- The webhooks automatically update the on-chain purchase oracle, which anonymously tracks the purchase finality status.
- You can find the specific webhook URL for your merchant in the business dashboard, under the `Purchase Tracker` section of your merchant.
# Getting Started with Frak Components
> Learn how to set up and start using Frak Components in your project
# Getting Started with Frak Components
This guide will walk you through the process of setting up and using Frak Components in your project.
You can find examples of Frak Components at [https://showcase.frak.id/](https://showcase.frak.id/).
## Prerequisites
Before you begin, ensure you have:
- A modern web browser
- Basic knowledge of HTML and JavaScript
## 1. Register Your Merchant
:::note
Merchant registration is a crucial step that enables key functionalities of Frak Components.
:::
Before using Frak Components, you need a merchant account on the Frak Business Platform:
1. Visit [https://business.frak.id/](https://business.frak.id/)
2. Sign up or log in to your account — your main storefront domain is registered automatically at sign-up.
3. (Optional) If your site lives on a subdomain different from the registered main domain, add it under **Allowed Domains** on the dashboard.
For a detailed walkthrough, see our [Business Registration Guide](/guides/dashboard/register/).
## 2. Setup the Frak Components
Once your merchant is set up, install Frak Components in your project.
Add the following script tag to your HTML file:
```html
```
## 3. Basic Configuration
After setup, you need to add a `config` object by assigning a global variable `FrakSetup`.
You can generate a config object using the [Frak SDK Builder](https://showcase.frak.id/configuration).
```html
```
More information about the [FrakSetup](/developers/components/frak-setup) object.
## 4. Add Components
Now you can start adding Frak Components to your project. Here's an example of how to add a share button:
```html
` component displays contextual banners on your website. It automatically detects the user's context and shows one of two variants:
- **Referral banner** — Promotes sharing and rewards to eligible users.
- **In-app browser banner** — Prompts users browsing in an in-app browser (Instagram, TikTok, etc.) to open the page in their default browser for a better experience. This variant is opt-in: enable it with the `allowInappRedirect` attribute.
## Requirements
- An initialized `FrakSetup` configuration object
More information about the [FrakSetup](/developers/components/frak-setup) object.
## Parameters
| Attribute | Type | Description |
|-----------|------|-------------|
| `placement` | `string` | Placement ID for [backend-driven configuration](/developers/concepts/placements). |
| `classname` | `string` | CSS class names applied to the root element. |
| `interaction` | `string` | Filter rewards by interaction type (e.g. `"purchase"`, `"referral"`). When omitted, the best reward across all types is shown. |
| `referralTitle` | `string` | Override the referral banner title. |
| `referralDescription` | `string` | Override the referral banner description. |
| `referralCta` | `string` | Override the referral banner CTA button text. |
| `inappTitle` | `string` | Override the in-app browser banner title. |
| `inappDescription` | `string` | Override the in-app browser banner description. |
| `inappCta` | `string` | Override the in-app browser banner CTA button text. |
| `imageUrl` | `string` | Override the image shown on the left of the referral banner. Falls back to the built-in gift icon when omitted. |
| `preview` | `string` | When set, forces the banner to render in preview mode (e.g. in Shopify theme editor). |
| `previewMode` | `"referral"` \| `"inapp"` | Which variant to preview. Only used when `preview` is set. Defaults to `"referral"`. |
| `allowInappRedirect` | `boolean` \| `"true"` \| `"false"` | Allow the banner to switch to in-app browser mode and prompt users to open the system browser. Opt-in, defaults to `false`. |
## Usage Examples
### Basic Banner
```html
` component renders a button that redirects users from in-app browsers (Instagram, TikTok, Facebook, etc.) to the device's default browser. This ensures a better user experience for features like WebAuthn authentication that don't work well in WebViews.
:::note
This component only renders on mobile devices. On desktop, it returns nothing.
:::
## Requirements
- An initialized `FrakSetup` configuration object
More information about the [FrakSetup](/developers/components/frak-setup) object.
## Parameters
| Attribute | Type | Default | Description |
|-----------|------|---------|-------------|
| `text` | `string` | `"Open in App"` | Text to display on the button. |
| `placement` | `string` | — | Placement ID for [backend-driven configuration](/developers/concepts/placements). |
| `classname` | `string` | — | CSS class names applied to the root element. |
## Usage Examples
### Basic Button
```html
` component is designed for checkout confirmation pages. It displays a sharing prompt to buyers, encouraging them to share the product with friends. The component adapts its message based on whether the user is a **referrer** (existing advocate) or a **referee** (was referred by someone).
## Requirements
- An initialized `FrakSetup` configuration object
- Purchase tracking data (customer ID, order ID, and token) for attribution
More information about the [FrakSetup](/developers/components/frak-setup) object.
## Parameters
| Attribute | Type | Description |
|-----------|------|-------------|
| `customerId` | `string` | Merchant customer ID for purchase tracking. All three tracking props (`customerId`, `orderId`, `token`) must be present for tracking to fire. |
| `orderId` | `string` | Merchant order ID for purchase tracking. |
| `token` | `string` | Checkout token for purchase tracking. |
| `sharingUrl` | `string` | Base URL to share. Falls back to the merchant domain when omitted. |
| `merchantId` | `string` | Override the merchant ID resolved from SDK config. |
| `placement` | `string` | Placement ID for [backend-driven configuration](/developers/concepts/placements). |
| `classname` | `string` | CSS class names applied to the root element. |
| `variant` | `"referrer"` \| `"referee"` | Force a display variant instead of relying on backend evaluation. |
| `badgeText` | `string` | Label for the badge pill above the message. Hidden when omitted. |
| `referrerText` | `string` | Override the message shown to referrers. Use `{REWARD}` as placeholder. |
| `refereeText` | `string` | Override the message shown to referees. Use `{REWARD}` as placeholder. |
| `ctaText` | `string` | Override the CTA button text. Use `{REWARD}` as placeholder. |
| `imageUrl` | `string` | Override the image shown on the left of the card. Falls back to the built-in gift icon when omitted. |
| `products` | `string` | JSON-stringified array of product cards forwarded to the sharing page when the CTA is clicked (set the JS `products` property for a real array). |
| `preview` | `string` | Render in preview mode (e.g. Shopify/WordPress theme editor): bypasses the client-ready gate and no-ops the click handler. |
| `previewVariant` | `"referrer"` \| `"referee"` | Which variant to show when `preview` is set. Defaults to `"referrer"`. |
## Usage Examples
### Basic Post-Purchase
```html
` component opens a modal in the Frak Wallet interface with configurable steps, allowing for complex user interactions such as login, opening session and share.
## Requirements
- An initialized `FrakSetup` configuration object
More information about the [FrakSetup](/developers/components/frak-setup) object.
### Parameters
| Attribute | Type | Default | Description |
|-----------|------|---------|-------------|
| `text` | `string` | `"Share and earn!"` | Text to display on the button. Include the `{REWARD}` placeholder to opt into the live reward flow (the SDK substitutes the estimated reward amount). |
| `classname` | `string` | — | CSS class names applied to the button. |
| `placement` | `string` | — | Placement ID for [backend-driven configuration](/developers/concepts/placements). |
| `clickAction` | `"embedded-wallet"` \| `"sharing-page"` | `"sharing-page"` | Which UI to open when the button is clicked. Legacy values like `"share-modal"` are accepted at runtime and routed to the sharing page. |
| `noRewardText` | `string` | — | Fallback text used when `text` contains `{REWARD}` but no reward is available. |
| `targetInteraction` | `string` | — | Target interaction type used to calculate the displayed reward. |
| `preview` | `string` | — | Render in preview mode (e.g. Shopify/WordPress theme editor): the button stays visually enabled and the click handler is a no-op. |
## Usage Examples
### Basic Share Button
```html
```ts twoslash
// [!include ~/snippets/types/FrakWalletSdkConfig.ts]
```
```js
/**
* @typedef {Object} FrakWalletSdkConfig
* @property {string} [walletUrl] - The URL of the Frak Wallet service
* @property {Object} metadata - Metadata about your application
* @property {string} [metadata.name] - The name of your application
* @property {string} [metadata.merchantId] - Your merchant ID (UUID) from the Frak dashboard
* @property {string} [metadata.lang] - The default language ("en" | "fr")
* @property {string} [metadata.currency] - The default currency ("eur" | "usd" | "gbp")
* @property {string} [metadata.logoUrl] - Logo URL displayed in modals and components
* @property {string} [metadata.homepageLink] - Link to your homepage
* @property {Object} [customizations] - Customization options
* @property {string} [customizations.css] - URL to a CSS file for styling
* @property {Object} [customizations.i18n] - Translation overrides for SDK components
* @property {string} [domain] - The domain of your application
* @property {boolean} [waitForBackendConfig] - Wait for backend config before rendering (default: true)
* @property {Object} [attribution] - Default attribution params (UTM / via / ref) appended to outbound sharing URLs
* @property {string[]} [preload] - UI views to preload in the listener iframe ("modal" | "sharing", default: ["sharing"])
*/
```
Let's break down each property:
### `walletUrl` (optional)
This is the URL of the Frak Wallet service. Use one of the following values:
- Production: `"https://wallet.frak.id"`
- Development: `"https://wallet-dev.frak.id"`
:::tip
This property is optional. If not provided, it defaults to the production URL (`"https://wallet.frak.id"`).
:::
### `metadata`
This object contains metadata about your application:
- `name` (optional): The name of your application. Displayed in modals and SSO pages.
- `merchantId` (optional): Your merchant ID from the Frak dashboard (UUID format). Used for referral tracking and analytics. If not provided, it will be auto-fetched from the backend using your domain.
- `lang` (optional): The display language (`"en"` or `"fr"`). Defaults to the browser language.
- `currency` (optional): The display currency (`"eur"`, `"usd"`, or `"gbp"`). Defaults to `"eur"`.
- `logoUrl` (optional): Logo URL displayed in modals and a few components.
- `homepageLink` (optional): Link to your homepage, used in SSO pages and some components.
### `customizations`
This object contains customization options for the displayed Frak elements:
- `css` (optional): A URL to a CSS file (must end with `.css`) that styles the Frak Wallet interface when displayed in your application.
- `i18n` (optional): An object containing text overrides for SDK components. Can be a single-language config or a multi-language config keyed by language code.
:::caution
URL-based i18n configuration has been removed. Only inline objects are supported.
:::
### `domain` (optional)
The domain of your application. This is used to identify your application in the Frak ecosystem.
:::tip
This property is optional. If not provided, it will be automatically retrieved during initialization.
:::
### `waitForBackendConfig` (optional)
Controls whether components wait for the [backend-driven configuration](/developers/concepts/backend-configuration) to be resolved before rendering.
- `true` (default): Components show a loading spinner until backend config is resolved.
- `false`: Components render immediately with local config and HTML attributes.
### `attribution` (optional)
Default attribution parameters (`utmSource`, `utmMedium`, `utmCampaign`, `utmTerm`, `via`, `ref`) appended to outbound sharing URLs. Per-call `displaySharingPage` overrides take precedence, then backend config, then this SDK-level default. `utmContent` is intentionally excluded, as it is per-content rather than a merchant-wide default.
### `preload` (optional)
UI views to preload inside the listener iframe for a snappier first display. Accepts an array of `"modal"` and/or `"sharing"`.
:::tip
Defaults to `["sharing"]`.
:::
## Example Configuration
Here's an example of a complete configuration object:
```ts twoslash
// @noErrors
import type { FrakWalletSdkConfig } from '@frak-labs/core-sdk';
const frakConfig: FrakWalletSdkConfig = {
walletUrl: "https://wallet.frak.id",
metadata: {
name: "My Awesome dApp",
lang: "en",
currency: "usd",
logoUrl: "https://my-app.com/logo.png",
homepageLink: "https://my-app.com",
},
customizations: {
css: "https://my-app.com/frak-styles.css",
i18n: {
en: {
"sdk.modal.title": "Welcome!",
},
fr: {
"sdk.modal.title": "Bienvenue !",
"sharing.title": "Partage ce produit!",
}
}
},
domain: "my-app.com",
};
```
## Using the Configuration
How you use this configuration depends on whether you're using React or vanilla JavaScript:
### React
In a React application, use the `FrakConfigProvider` to provide this configuration to your app:
```tsx twoslash
// @noErrors
import { FrakConfigProvider, FrakIFrameClientProvider } from '@frak-labs/react-sdk';
const frakConfig = {
metadata: {
name: "My Awesome dApp",
},
};
function App() {
return (
{/* Your app components */}
);
}
```
### Vanilla JavaScript
In a vanilla JavaScript application, pass this configuration when creating a Frak client:
```ts twoslash
// @noErrors
import { createIFrameFrakClient, createIframe } from '@frak-labs/core-sdk';
const frakConfig = {
metadata: {
name: "My Awesome dApp",
},
};
const iframe = createIframe({ config: frakConfig });
const client = await createIFrameFrakClient({ config: frakConfig, iframe });
```
## Best Practices
1. **Environment-based Configuration**: Consider using different configurations for development and production environments. This allows you to use the development Frak Wallet during testing.
2. **Secure CSS**: If you're providing a custom CSS file, ensure it's served over HTTPS to prevent security issues.
3. **Domain Consistency**: If you provide a `domain`, make sure it matches the actual domain where your application is hosted. Mismatches can lead to authentication issues.
4. **Iframe Creation**: Always use the `createIframe` helper function provided by the SDK to create the iframe. This ensures proper setup and compatibility.
:::caution
Remember to handle any potential errors when creating the iframe or initializing the client.
:::
By properly configuring the Wallet SDK, you ensure that it can communicate effectively with the Frak Wallet and provide a seamless experience for your users.
## Next Steps
- [Backend-Driven Configuration](/developers/concepts/backend-configuration) — Learn how the SDK dynamically resolves settings from the Frak backend.
- [Placements](/developers/concepts/placements) — Customize component behavior for different sections of your website.
- [Tracking User Interactions](/developers/concepts/interactions) — Learn about interaction tracking.
# Understanding Interactions
> Learn how to leverage interactions in the Wallet SDK for tracking user engagement, implementing reward systems, and enhancing your application's functionality.
# Interactions
Interactions are the cornerstone of user engagement tracking in the Wallet SDK. They allow developers to record events based on user actions within their applications, enabling features like reward systems and engagement analytics.
## How Interactions Work
1. **Automatic Tracking**: The SDK tracks user arrivals, referrals, and sharing events through a simple fire-and-forget API.
2. **Merchant Resolution**: The SDK automatically resolves your merchant identity from your domain — no need to pass product or merchant IDs manually.
3. **Offline Support**: If a user isn't logged in, interactions are stored locally in the browser and sent once a session is established, ensuring privacy and data integrity.
4. **Transparent Process**: The entire interaction recording process is seamless and invisible to the user.
## Interaction Types
The SDK supports three interaction types:
- **`arrival`** — Track when a user lands on your site, with optional referral attribution.
- **`sharing`** — Track when a user shares your content via the sharing modal.
- **`custom`** — Track any custom event specific to your application.
## Sending Interactions
Use the [`sendInteraction`](/developers/references/core-sdk/actions/functions/sendinteraction/) action to record events:
```ts twoslash
// @noErrors
import { sendInteraction } from '@frak-labs/core-sdk/actions';
// Track a user arrival with referral attribution
await sendInteraction(client, {
type: "arrival",
referrerWallet: "0x1234...abcd",
});
// Track a sharing event
await sendInteraction(client, { type: "sharing" });
// Send a custom interaction
await sendInteraction(client, {
type: "custom",
customType: "newsletter_signup",
data: { email: "user@example.com" },
});
```
`sendInteraction` is fire-and-forget: errors are caught and logged, not thrown.
## Referral Interactions
For referral tracking, the SDK provides a dedicated helper that handles the full referral flow automatically:
```ts twoslash
// @noErrors
import { referralInteraction } from '@frak-labs/core-sdk/actions';
const result = await referralInteraction(client, {
options: {
alwaysAppendUrl: true,
merchantId: "550e8400-e29b-41d4-a716-446655440000",
},
});
```
See [`referralInteraction`](/developers/references/core-sdk/actions/functions/referralinteraction/) for details.
## Benefits of Interactions
- **Engagement Tracking**: Monitor user activity on your platform.
- **Reward Systems**: Implement campaigns that distribute rewards based on user interactions.
- **Privacy-Preserving**: Interactions are only sent when a user has an active session.
- **Flexible Integration**: Use built-in types or define custom interactions for your specific use case.
## Best Practices
- Use the `referralInteraction` helper for referral flows instead of manually composing arrival interactions.
- Set default UTM / attribution params via the SDK [`attribution` config](/developers/concepts/configuration/#attribution-optional) to improve marketing attribution on shared links.
- Use `idempotencyKey` on custom interactions to prevent duplicate event recording.
For detailed parameter information, refer to the [`SendInteractionParamsType`](/developers/references/core-sdk/index/type-aliases/sendinteractionparamstype/) reference.
# Placements
> Use placements to customize SDK components for different sections of your website
# Placements
Placements let you define named configurations that customize how SDK components behave on different sections of your website. Instead of using the same global settings everywhere, you can create placements like `"homepage"`, `"product-page"`, or `"checkout"` — each with its own text, styling, and behavior.
## How Placements Work
1. **Create placements** in the [business dashboard](/guides/dashboard) under your merchant's customization settings.
2. **Assign a placement** to any SDK component using the `placement` attribute or prop.
3. **The component resolves** its configuration from the [backend-driven config](/developers/concepts/backend-configuration), applying placement-specific overrides on top of global defaults.
```
Global Config (dashboard defaults)
└── Placement: "homepage"
│ └── buttonShare: { text: "Share this!", clickAction: "sharing-page" }
│ └── banner: { referralTitle: "Join our community" }
└── Placement: "checkout"
└── postPurchase: { ctaText: "Share and earn {REWARD}!" }
└── buttonShare: { text: "Tell your friends" }
```
## Using Placements with Web Components
All Frak web components accept a `placement` attribute. When provided, the component looks up its configuration from the matching placement in the backend config.
### Share Button
```html
` | Placement-specific translation overrides. |
| `css` | `string` | Global CSS applied to modals displayed from this placement. |
## Placement vs. HTML Attributes
Component settings can come from two sources: **placement configuration** (backend-driven) and **HTML attributes** (inline). When both are present, HTML attributes take precedence, allowing you to override placement defaults for specific instances.
```html
My Frak-Enabled App
My Frak-Enabled App
Initializing...
Login with Frak
```
## Next Steps
With this setup, you have a basic Vanilla JavaScript application integrated with the Wallet SDK. Users can now connect their Frak Wallet and log in. From here, you can start implementing more advanced features such as:
- Sending interactions
- Implementing referral systems
- Creating reward campaigns
Refer to the specific action documentation for details on implementing these features in a Vanilla JS environment.
# Installation via Package Manager
> Learn how to integrate the Wallet SDK into your JavaScript / Typescript application for seamless Web3 interactions.
import { Tabs, TabItem } from "@astrojs/starlight/components";
# Installation via Package Manager
This guide will walk you through the process of integrating the Wallet SDK into your JavaScript / Typescript application.
By the end, you'll have a basic setup that allows users to connect their Frak Wallet and perform interactions.
## Prerequisites
Before you begin, ensure that:
1. You have a package manager set up on your project (npm / bun / pnpm or yarn).
2. You have a merchant account on the [Frak business dashboard](https://business.frak.id/) with your storefront's domain registered. The main domain is registered automatically at sign-up; for subdomains, add them under **Allowed Domains** on the dashboard.
If you haven't completed these steps, please refer to the [Getting Started](/guides) guide.
## Step 1: Install Dependencies
```bash
npm install @frak-labs/core-sdk
```
```bash
yarn install @frak-labs/core-sdk
```
```bash
pnpm install @frak-labs/core-sdk
```
```bash
bun install @frak-labs/core-sdk
```
## Step 2: Set Up the Frak Client
Create a new TypeScript file (e.g., `frak-setup.ts`) to set up the Frak client:
```typescript
import { setupClient, type FrakWalletSdkConfig } from '@frak-labs/core-sdk';
const frakConfig: FrakWalletSdkConfig = {
metadata: {
name: 'Your App Name',
},
};
export async function setupFrakClient() {
const client = await setupClient({ config: frakConfig });
if (!client) {
console.error('Failed to create Frak client');
return null;
}
return client;
}
export { frakConfig };
```
For more detailed configuration options, see [FrakWalletSdkConfig](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/).
## Step 3: Check Wallet Status
Create a function to check and display the wallet status, using the [`watchWalletStatus`](/developers/references/core-sdk/actions/functions/watchwalletstatus/) action:
```typescript
import { watchWalletStatus } from '@frak-labs/core-sdk/actions';
import { setupFrakClient } from './frak-setup';
export async function displayWalletStatus() {
const client = await setupFrakClient();
if (!client) {
console.error('Frak client not initialized');
return;
}
const statusElement = document.getElementById('wallet-status');
if (!statusElement) return;
statusElement.textContent = 'Checking wallet status...';
try {
await watchWalletStatus(client, (status) => {
if (!statusElement) return;
statusElement.textContent = `Wallet status: ${status.key === 'connected' ? 'Connected' : 'Not connected'}`;
});
} catch (error) {
statusElement.textContent = `Error: ${error instanceof Error ? error.message : 'Unknown error'}`;
}
}
// Call this function when the page loads
window.addEventListener('load', displayWalletStatus);
```
## Step 4: Implement Login Modal
Create a function to handle the login process, using the [`displayModal`](/developers/references/core-sdk/actions/functions/displaymodal/) action:
```typescript
import { displayModal } from '@frak-labs/core-sdk/actions';
import { setupFrakClient } from './frak-setup';
export async function handleLogin() {
const client = await setupFrakClient();
if (!client) {
console.error('Frak client not initialized');
return;
}
const loginButton = document.getElementById('login-button') as HTMLButtonElement | null;
if (!loginButton) return;
loginButton.disabled = true;
loginButton.textContent = 'Logging in...';
try {
await displayModal(client, {
steps: {
login: {},
final: {
action: { key: "sharing" },
}
}
});
loginButton.textContent = 'Logged In';
} catch (error) {
console.error('Login error:', error);
loginButton.textContent = 'Login Failed';
} finally {
loginButton.disabled = false;
}
}
// Attach the login handler to the button
window.addEventListener('load', () => {
const loginButton = document.getElementById('login-button');
loginButton?.addEventListener('click', handleLogin);
});
```
## Step 5: Put It All Together
Create an HTML file that includes your bundled JavaScript:
```html
My Frak-Enabled App
My Frak-Enabled App
Initializing...
Login with Frak
```
Note: Make sure your bundler (webpack, vite, etc.) is properly configured to handle TypeScript files and generate the bundle.js file.
## Next Steps
With this setup, you have a basic TypeScript application integrated with the Wallet SDK. Users can now connect their Frak Wallet and log in. From here, you can start implementing more advanced features such as:
- Sending interactions
- Implementing referral systems
- Creating reward campaigns
Refer to the specific action documentation for details on implementing these features using the SDK's TypeScript interfaces and types.
# React Start Guide
> Learn how to integrate the Wallet SDK into your React application for seamless Web3 interactions.
import { Tabs, TabItem } from "@astrojs/starlight/components";
# React Integration Guide
This guide will walk you through the process of integrating the Wallet SDK into your React application. By the end, you'll have a basic setup that allows users to connect their Frak Wallet and perform simple interactions.
## Prerequisites
Before you begin, ensure that:
1. You have a React project set up.
2. You have a merchant account on the [Frak business dashboard](https://business.frak.id/) with your storefront's domain registered. The main domain is registered automatically at sign-up; for subdomains, add them under **Allowed Domains** on the dashboard.
If you haven't completed these steps, please refer to the [Getting Started](/guides) guide.
## Step 1: Install Dependencies
First, install the required packages:
```bash
npm install @frak-labs/react-sdk @tanstack/react-query
```
```bash
yarn add @frak-labs/react-sdk @tanstack/react-query
```
```bash
pnpm add @frak-labs/react-sdk @tanstack/react-query
```
```bash
bun add @frak-labs/react-sdk @tanstack/react-query
```
## Step 2: Set Up the Frak Client
Create a new component to set up the Frak client and iframe:
```tsx twoslash title="FrakProvider.tsx"
// @noErrors
// [!include ~/snippets/integration/FrakProvider.tsx]
```
Wrap your main App component with this provider:
```tsx twoslash title="App.tsx"
// @noErrors
import { FrakProvider } from './FrakProvider';
function App() {
return (
{/* Your app content */}
);
}
export default App;
```
For more detailed configuration options, see [FrakWalletSdkConfig](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/).
## Step 3: Check Wallet Status
Create a component to check and display the wallet status using the [useWalletStatus](/developers/references/react-sdk/functions/usewalletstatus/) hook:
```tsx twoslash title="WalletStatus.tsx"
// @noErrors
// [!include ~/snippets/integration/react-app.tsx:wallet-status]
```
## Step 4: Implement Login Modal
Create a component for the login modal, using the [useDisplayModal](/developers/references/react-sdk/functions/usedisplaymodal/) hook:
```tsx twoslash title="LoginButton.tsx"
// @noErrors
// [!include ~/snippets/integration/react-app.tsx:login-button]
```
## Step 5: Put It All Together
Update your main App component to include the wallet status and login button:
```tsx twoslash
// @noErrors
// [!include ~/snippets/integration/react-app.tsx:app]
```
```tsx twoslash
// @noErrors
// [!include ~/snippets/integration/react-app.tsx]
```
```tsx twoslash
// @noErrors
// [!include ~/snippets/integration/FrakProvider.tsx]
```
## Next Steps
With this setup, you have a basic React application integrated with the Wallet SDK. Users can now connect their Frak Wallet and log in. From here, you can start implementing more advanced features such as:
- Sending interactions
- Implementing referral systems
- Creating reward campaigns
Refer to the specific action and hook documentation for details on implementing these features.
# Banner
> **Banner**(`__namedParameters`): `Element` \| `null`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/Banner.tsx:75](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/Banner.tsx#L75)
Auto-detecting notification banner component.
Renders an inline banner on the merchant page with one of two distinct
visual styles depending on the detected mode:
- **Referral mode** (white): Shown after a successful referral link
processing. Displays a gift icon, reward copy, and a "Got it" CTA.
- **In-app browser mode** (dark transparent): Shown when the page is
opened inside a social media in-app browser (Instagram, Facebook).
Offers an inline link to redirect to the default browser plus a
close button to dismiss.
In-app browser mode takes priority over referral mode.
Uses Light DOM + vanilla-extract styles from `@frak-labs/design-system`.
## Parameters
### \_\_namedParameters
#### allowInappRedirect?
`boolean` \| `"true"` \| `"false"`
When `true` (default `false`), the banner is allowed to switch to
in-app browser mode (Instagram / Facebook WebView) and prompt the
user to escape to the system browser.
Most flows now work inside in-app browsers via the anonymous-id
flow, so the redirect is opt-in. Enable it only on surfaces that
actually drive users into a WebAuthn-bound action (login,
sendTransaction, SIWE authenticate).
Accepts the boolean `true` (TS/JSX) or the string `"true"` (HTML
attribute). Any other value — including `false`, `"false"`, the
empty string, or attribute absence — keeps the redirect disabled.
#### classname?
`string` = `""`
CSS class names passed through to the root element (Light DOM).
#### imageUrl?
`string`
Override the image displayed on the left of the referral banner.
Accepts an image URL. Falls back to the built-in gift icon when omitted.
The image is constrained to the icon slot via `object-fit: contain`,
so any aspect ratio renders correctly.
#### inappCta?
`string`
Override the in-app browser banner CTA button text.
#### inappDescription?
`string`
Override the in-app browser banner description.
#### inappTitle?
`string`
Override the in-app browser banner title.
#### interaction?
`"referral"` \| `"create_referral_link"` \| `"purchase"` \| `` `custom.${string}` ``
Filter rewards by interaction type (e.g. "purchase", "referral").
When omitted, the best reward across all interaction types is shown.
#### placement?
`string`
Placement ID for backend-driven CSS customization.
#### preview?
`string`
When set, forces the banner to render in preview mode (e.g. in Shopify theme editor).
Bypasses normal event/browser detection and shows static content.
#### previewMode?
`"referral"` \| `"inapp"`
Which banner variant to preview: "referral" or "inapp".
Only used when preview is set. Defaults to "referral".
#### referralCta?
`string`
Override the referral banner CTA button text.
#### referralDescription?
`string`
Override the referral banner description.
#### referralTitle?
`string`
Override the referral banner title.
## Returns
`Element` \| `null`
## Examples
Basic usage (auto-detects mode):
```html
` tag
## Examples
Basic usage:
```html
` tag
## Examples
Basic usage:
```html
` tag (only renders on mobile devices)
## Examples
Basic usage:
```html
`). The HTML
attribute path is required for server-rendered surfaces — e.g.
WooCommerce / Magento plugins — because `preact-custom-element`
delivers attribute values as raw strings.
Empty arrays / unparseable strings are treated as "no products" so
the sharing page renders without the product card section.
#### refereeText?
`string`
Override the message shown to referees.
Use `{REWARD}` as placeholder for the reward amount.
#### referrerText?
`string`
Override the message shown to referrers.
Use `{REWARD}` as placeholder for the reward amount.
#### sharingUrl?
`string`
Base URL to share. Falls back to the merchant domain returned by
the backend when omitted.
#### token?
`string`
Checkout token for purchase tracking fallback.
#### variant?
`"referrer"` \| `"referee"`
Force a display variant instead of relying on the backend evaluation.
## Returns
`Element` \| `null`
## Examples
Minimal — just show the card:
```html
`.
Combines standard HTMLElement with [BannerProps](/developers/references/components/type-aliases/bannerprops/).
## Extends
- `HTMLElement`.[`BannerProps`](/developers/references/components/type-aliases/bannerprops/)
## Properties
### accessKey
> **accessKey**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13688
The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)
#### Inherited from
`HTMLElement.accessKey`
***
### accessKeyLabel
> `readonly` **accessKeyLabel**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13694
The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)
#### Inherited from
`HTMLElement.accessKeyLabel`
***
### allowInappRedirect?
> `optional` **allowInappRedirect?**: `boolean` \| `"true"` \| `"false"`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:76](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L76)
When `true` (default `false`), the banner is allowed to switch to
in-app browser mode (Instagram / Facebook WebView) and prompt the
user to escape to the system browser.
Most flows now work inside in-app browsers via the anonymous-id
flow, so the redirect is opt-in. Enable it only on surfaces that
actually drive users into a WebAuthn-bound action (login,
sendTransaction, SIWE authenticate).
Accepts the boolean `true` (TS/JSX) or the string `"true"` (HTML
attribute). Any other value — including `false`, `"false"`, the
empty string, or attribute absence — keeps the redirect disabled.
#### Inherited from
`BannerProps.allowInappRedirect`
***
### ariaActiveDescendantElement
> **ariaActiveDescendantElement**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2607
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)
#### Inherited from
`HTMLElement.ariaActiveDescendantElement`
***
### ariaAtomic
> **ariaAtomic**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2609
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)
#### Inherited from
`HTMLElement.ariaAtomic`
***
### ariaAutoComplete
> **ariaAutoComplete**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2611
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)
#### Inherited from
`HTMLElement.ariaAutoComplete`
***
### ariaBrailleLabel
> **ariaBrailleLabel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2613
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)
#### Inherited from
`HTMLElement.ariaBrailleLabel`
***
### ariaBrailleRoleDescription
> **ariaBrailleRoleDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2615
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)
#### Inherited from
`HTMLElement.ariaBrailleRoleDescription`
***
### ariaBusy
> **ariaBusy**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2617
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)
#### Inherited from
`HTMLElement.ariaBusy`
***
### ariaChecked
> **ariaChecked**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2619
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)
#### Inherited from
`HTMLElement.ariaChecked`
***
### ariaColCount
> **ariaColCount**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2621
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)
#### Inherited from
`HTMLElement.ariaColCount`
***
### ariaColIndex
> **ariaColIndex**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2623
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)
#### Inherited from
`HTMLElement.ariaColIndex`
***
### ariaColIndexText
> **ariaColIndexText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2625
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)
#### Inherited from
`HTMLElement.ariaColIndexText`
***
### ariaColSpan
> **ariaColSpan**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2627
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)
#### Inherited from
`HTMLElement.ariaColSpan`
***
### ariaControlsElements
> **ariaControlsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2629
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)
#### Inherited from
`HTMLElement.ariaControlsElements`
***
### ariaCurrent
> **ariaCurrent**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2631
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)
#### Inherited from
`HTMLElement.ariaCurrent`
***
### ariaDescribedByElements
> **ariaDescribedByElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2633
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)
#### Inherited from
`HTMLElement.ariaDescribedByElements`
***
### ariaDescription
> **ariaDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2635
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)
#### Inherited from
`HTMLElement.ariaDescription`
***
### ariaDetailsElements
> **ariaDetailsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2637
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)
#### Inherited from
`HTMLElement.ariaDetailsElements`
***
### ariaDisabled
> **ariaDisabled**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2639
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)
#### Inherited from
`HTMLElement.ariaDisabled`
***
### ariaErrorMessageElements
> **ariaErrorMessageElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2641
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)
#### Inherited from
`HTMLElement.ariaErrorMessageElements`
***
### ariaExpanded
> **ariaExpanded**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2643
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)
#### Inherited from
`HTMLElement.ariaExpanded`
***
### ariaFlowToElements
> **ariaFlowToElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2645
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)
#### Inherited from
`HTMLElement.ariaFlowToElements`
***
### ariaHasPopup
> **ariaHasPopup**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2647
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)
#### Inherited from
`HTMLElement.ariaHasPopup`
***
### ariaHidden
> **ariaHidden**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2649
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)
#### Inherited from
`HTMLElement.ariaHidden`
***
### ariaInvalid
> **ariaInvalid**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2651
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)
#### Inherited from
`HTMLElement.ariaInvalid`
***
### ariaKeyShortcuts
> **ariaKeyShortcuts**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2653
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)
#### Inherited from
`HTMLElement.ariaKeyShortcuts`
***
### ariaLabel
> **ariaLabel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2655
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)
#### Inherited from
`HTMLElement.ariaLabel`
***
### ariaLabelledByElements
> **ariaLabelledByElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2657
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)
#### Inherited from
`HTMLElement.ariaLabelledByElements`
***
### ariaLevel
> **ariaLevel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2659
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)
#### Inherited from
`HTMLElement.ariaLevel`
***
### ariaLive
> **ariaLive**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2661
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)
#### Inherited from
`HTMLElement.ariaLive`
***
### ariaModal
> **ariaModal**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2663
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)
#### Inherited from
`HTMLElement.ariaModal`
***
### ariaMultiLine
> **ariaMultiLine**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2665
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)
#### Inherited from
`HTMLElement.ariaMultiLine`
***
### ariaMultiSelectable
> **ariaMultiSelectable**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2667
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)
#### Inherited from
`HTMLElement.ariaMultiSelectable`
***
### ariaOrientation
> **ariaOrientation**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2669
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)
#### Inherited from
`HTMLElement.ariaOrientation`
***
### ariaOwnsElements
> **ariaOwnsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2671
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)
#### Inherited from
`HTMLElement.ariaOwnsElements`
***
### ariaPlaceholder
> **ariaPlaceholder**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2673
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)
#### Inherited from
`HTMLElement.ariaPlaceholder`
***
### ariaPosInSet
> **ariaPosInSet**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2675
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)
#### Inherited from
`HTMLElement.ariaPosInSet`
***
### ariaPressed
> **ariaPressed**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2677
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)
#### Inherited from
`HTMLElement.ariaPressed`
***
### ariaReadOnly
> **ariaReadOnly**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2679
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)
#### Inherited from
`HTMLElement.ariaReadOnly`
***
### ariaRelevant
> **ariaRelevant**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2681
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)
#### Inherited from
`HTMLElement.ariaRelevant`
***
### ariaRequired
> **ariaRequired**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2683
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)
#### Inherited from
`HTMLElement.ariaRequired`
***
### ariaRoleDescription
> **ariaRoleDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2685
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)
#### Inherited from
`HTMLElement.ariaRoleDescription`
***
### ariaRowCount
> **ariaRowCount**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2687
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)
#### Inherited from
`HTMLElement.ariaRowCount`
***
### ariaRowIndex
> **ariaRowIndex**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2689
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)
#### Inherited from
`HTMLElement.ariaRowIndex`
***
### ariaRowIndexText
> **ariaRowIndexText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2691
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)
#### Inherited from
`HTMLElement.ariaRowIndexText`
***
### ariaRowSpan
> **ariaRowSpan**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2693
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)
#### Inherited from
`HTMLElement.ariaRowSpan`
***
### ariaSelected
> **ariaSelected**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2695
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)
#### Inherited from
`HTMLElement.ariaSelected`
***
### ariaSetSize
> **ariaSetSize**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2697
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)
#### Inherited from
`HTMLElement.ariaSetSize`
***
### ariaSort
> **ariaSort**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2699
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)
#### Inherited from
`HTMLElement.ariaSort`
***
### ariaValueMax
> **ariaValueMax**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2701
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)
#### Inherited from
`HTMLElement.ariaValueMax`
***
### ariaValueMin
> **ariaValueMin**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2703
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)
#### Inherited from
`HTMLElement.ariaValueMin`
***
### ariaValueNow
> **ariaValueNow**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2705
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)
#### Inherited from
`HTMLElement.ariaValueNow`
***
### ariaValueText
> **ariaValueText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2707
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)
#### Inherited from
`HTMLElement.ariaValueText`
***
### assignedSlot
> `readonly` **assignedSlot**: `HTMLSlotElement` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:30826
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)
#### Inherited from
`HTMLElement.assignedSlot`
***
### ATTRIBUTE\_NODE
> `readonly` **ATTRIBUTE\_NODE**: `2`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21835
#### Inherited from
`HTMLElement.ATTRIBUTE_NODE`
***
### attributes
> `readonly` **attributes**: `NamedNodeMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10707
The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)
#### Inherited from
`HTMLElement.attributes`
***
### attributeStyleMap
> `readonly` **attributeStyleMap**: `StylePropertyMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11117
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)
#### Inherited from
`HTMLElement.attributeStyleMap`
***
### autocapitalize
> **autocapitalize**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13700
The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)
#### Inherited from
`HTMLElement.autocapitalize`
***
### autocorrect
> **autocorrect**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13706
The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)
#### Inherited from
`HTMLElement.autocorrect`
***
### autofocus
> **autofocus**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16065
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)
#### Inherited from
`HTMLElement.autofocus`
***
### baseURI
> `readonly` **baseURI**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21664
The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)
#### Inherited from
`HTMLElement.baseURI`
***
### CDATA\_SECTION\_NODE
> `readonly` **CDATA\_SECTION\_NODE**: `4`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21839
node is a CDATASection node.
#### Inherited from
`HTMLElement.CDATA_SECTION_NODE`
***
### childElementCount
> `readonly` **childElementCount**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22668
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)
#### Inherited from
`HTMLElement.childElementCount`
***
### childNodes
> `readonly` **childNodes**: `NodeListOf`\<`ChildNode`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21670
The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)
#### Inherited from
`HTMLElement.childNodes`
***
### children
> `readonly` **children**: `HTMLCollection`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22674
Returns the child elements.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)
#### Inherited from
`HTMLElement.children`
***
### classname?
> `optional` **classname?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:15](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L15)
CSS class names passed through to the root element (Light DOM).
#### Inherited from
`BannerProps.classname`
***
### className
> **className**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10720
The **`className`** property of the of the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)
#### Inherited from
`HTMLElement.className`
***
### clientHeight
> `readonly` **clientHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10726
The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)
#### Inherited from
`HTMLElement.clientHeight`
***
### clientLeft
> `readonly` **clientLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10732
The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)
#### Inherited from
`HTMLElement.clientLeft`
***
### clientTop
> `readonly` **clientTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10738
The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)
#### Inherited from
`HTMLElement.clientTop`
***
### clientWidth
> `readonly` **clientWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10744
The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)
#### Inherited from
`HTMLElement.clientWidth`
***
### COMMENT\_NODE
> `readonly` **COMMENT\_NODE**: `8`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21845
node is a Comment node.
#### Inherited from
`HTMLElement.COMMENT_NODE`
***
### contentEditable
> **contentEditable**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11125
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)
#### Inherited from
`HTMLElement.contentEditable`
***
### currentCSSZoom
> `readonly` **currentCSSZoom**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10750
The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)
#### Inherited from
`HTMLElement.currentCSSZoom`
***
### dataset
> `readonly` **dataset**: `DOMStringMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16067
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)
#### Inherited from
`HTMLElement.dataset`
***
### dir
> **dir**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13712
The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)
#### Inherited from
`HTMLElement.dir`
***
### DOCUMENT\_FRAGMENT\_NODE
> `readonly` **DOCUMENT\_FRAGMENT\_NODE**: `11`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21851
node is a DocumentFragment node.
#### Inherited from
`HTMLElement.DOCUMENT_FRAGMENT_NODE`
***
### DOCUMENT\_NODE
> `readonly` **DOCUMENT\_NODE**: `9`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21847
node is a document.
#### Inherited from
`HTMLElement.DOCUMENT_NODE`
***
### DOCUMENT\_POSITION\_CONTAINED\_BY
> `readonly` **DOCUMENT\_POSITION\_CONTAINED\_BY**: `16`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21862
Set when other is a descendant of node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_CONTAINED_BY`
***
### DOCUMENT\_POSITION\_CONTAINS
> `readonly` **DOCUMENT\_POSITION\_CONTAINS**: `8`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21860
Set when other is an ancestor of node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_CONTAINS`
***
### DOCUMENT\_POSITION\_DISCONNECTED
> `readonly` **DOCUMENT\_POSITION\_DISCONNECTED**: `1`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21854
Set when node and other are not in the same tree.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_DISCONNECTED`
***
### DOCUMENT\_POSITION\_FOLLOWING
> `readonly` **DOCUMENT\_POSITION\_FOLLOWING**: `4`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21858
Set when other is following node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_FOLLOWING`
***
### DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC
> `readonly` **DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC**: `32`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21863
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC`
***
### DOCUMENT\_POSITION\_PRECEDING
> `readonly` **DOCUMENT\_POSITION\_PRECEDING**: `2`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21856
Set when other is preceding node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_PRECEDING`
***
### DOCUMENT\_TYPE\_NODE
> `readonly` **DOCUMENT\_TYPE\_NODE**: `10`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21849
node is a doctype.
#### Inherited from
`HTMLElement.DOCUMENT_TYPE_NODE`
***
### draggable
> **draggable**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13718
The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)
#### Inherited from
`HTMLElement.draggable`
***
### ELEMENT\_NODE
> `readonly` **ELEMENT\_NODE**: `1`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21834
node is an element.
#### Inherited from
`HTMLElement.ELEMENT_NODE`
***
### enterKeyHint
> **enterKeyHint**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11127
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)
#### Inherited from
`HTMLElement.enterKeyHint`
***
### ENTITY\_NODE
> `readonly` **ENTITY\_NODE**: `6`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21841
#### Inherited from
`HTMLElement.ENTITY_NODE`
***
### ENTITY\_REFERENCE\_NODE
> `readonly` **ENTITY\_REFERENCE\_NODE**: `5`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21840
#### Inherited from
`HTMLElement.ENTITY_REFERENCE_NODE`
***
### firstChild
> `readonly` **firstChild**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21676
The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)
#### Inherited from
`HTMLElement.firstChild`
***
### firstElementChild
> `readonly` **firstElementChild**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22680
Returns the first child that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)
#### Inherited from
`HTMLElement.firstElementChild`
***
### hidden
> **hidden**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13724
The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)
#### Inherited from
`HTMLElement.hidden`
***
### id
> **id**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10756
The **`id`** property of the Element interface represents the element's identifier, reflecting the **`id`** global attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/id)
#### Inherited from
`HTMLElement.id`
***
### imageUrl?
> `optional` **imageUrl?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:51](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L51)
Override the image displayed on the left of the referral banner.
Accepts an image URL. Falls back to the built-in gift icon when omitted.
The image is constrained to the icon slot via `object-fit: contain`,
so any aspect ratio renders correctly.
#### Inherited from
`BannerProps.imageUrl`
***
### inappCta?
> `optional` **inappCta?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:44](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L44)
Override the in-app browser banner CTA button text.
#### Inherited from
`BannerProps.inappCta`
***
### inappDescription?
> `optional` **inappDescription?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:40](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L40)
Override the in-app browser banner description.
#### Inherited from
`BannerProps.inappDescription`
***
### inappTitle?
> `optional` **inappTitle?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:36](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L36)
Override the in-app browser banner title.
#### Inherited from
`BannerProps.inappTitle`
***
### inert
> **inert**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13730
The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)
#### Inherited from
`HTMLElement.inert`
***
### innerHTML
> **innerHTML**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10762
The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)
#### Inherited from
`HTMLElement.innerHTML`
***
### innerText
> **innerText**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13736
The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)
#### Inherited from
`HTMLElement.innerText`
***
### inputMode
> **inputMode**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11129
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)
#### Inherited from
`HTMLElement.inputMode`
***
### interaction?
> `optional` **interaction?**: `"referral"` \| `"create_referral_link"` \| `"purchase"` \| `` `custom.${string}` ``
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:20](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L20)
Filter rewards by interaction type (e.g. "purchase", "referral").
When omitted, the best reward across all interaction types is shown.
#### Inherited from
`BannerProps.interaction`
***
### isConnected
> `readonly` **isConnected**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21682
The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)
#### Inherited from
`HTMLElement.isConnected`
***
### isContentEditable
> `readonly` **isContentEditable**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11131
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)
#### Inherited from
`HTMLElement.isContentEditable`
***
### lang
> **lang**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13742
The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)
#### Inherited from
`HTMLElement.lang`
***
### lastChild
> `readonly` **lastChild**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21688
The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)
#### Inherited from
`HTMLElement.lastChild`
***
### lastElementChild
> `readonly` **lastElementChild**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22686
Returns the last child that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)
#### Inherited from
`HTMLElement.lastElementChild`
***
### localName
> `readonly` **localName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10768
The **`Element.localName`** read-only property returns the local part of the qualified name of an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)
#### Inherited from
`HTMLElement.localName`
***
### namespaceURI
> `readonly` **namespaceURI**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10774
The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)
#### Inherited from
`HTMLElement.namespaceURI`
***
### nextElementSibling
> `readonly` **nextElementSibling**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22003
Returns the first following sibling that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)
#### Inherited from
`HTMLElement.nextElementSibling`
***
### nextSibling
> `readonly` **nextSibling**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21694
The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)
#### Inherited from
`HTMLElement.nextSibling`
***
### nodeName
> `readonly` **nodeName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21700
The read-only **`nodeName`** property of Node returns the name of the current node as a string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)
#### Inherited from
`HTMLElement.nodeName`
***
### nodeType
> `readonly` **nodeType**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21706
The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)
#### Inherited from
`HTMLElement.nodeType`
***
### nodeValue
> **nodeValue**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21712
The **`nodeValue`** property of the Node interface returns or sets the value of the current node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)
#### Inherited from
`HTMLElement.nodeValue`
***
### nonce?
> `optional` **nonce?**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16069
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)
#### Inherited from
`HTMLElement.nonce`
***
### NOTATION\_NODE
> `readonly` **NOTATION\_NODE**: `12`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21852
#### Inherited from
`HTMLElement.NOTATION_NODE`
***
### offsetHeight
> `readonly` **offsetHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13748
The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)
#### Inherited from
`HTMLElement.offsetHeight`
***
### offsetLeft
> `readonly` **offsetLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13754
The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)
#### Inherited from
`HTMLElement.offsetLeft`
***
### offsetParent
> `readonly` **offsetParent**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13760
The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)
#### Inherited from
`HTMLElement.offsetParent`
***
### offsetTop
> `readonly` **offsetTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13766
The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)
#### Inherited from
`HTMLElement.offsetTop`
***
### offsetWidth
> `readonly` **offsetWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13772
The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)
#### Inherited from
`HTMLElement.offsetWidth`
***
### onabort
> **onabort**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12743
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)
#### Inherited from
`HTMLElement.onabort`
***
### onanimationcancel
> **onanimationcancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12745
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)
#### Inherited from
`HTMLElement.onanimationcancel`
***
### onanimationend
> **onanimationend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12747
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)
#### Inherited from
`HTMLElement.onanimationend`
***
### onanimationiteration
> **onanimationiteration**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12749
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)
#### Inherited from
`HTMLElement.onanimationiteration`
***
### onanimationstart
> **onanimationstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12751
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)
#### Inherited from
`HTMLElement.onanimationstart`
***
### onauxclick
> **onauxclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12753
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)
#### Inherited from
`HTMLElement.onauxclick`
***
### onbeforeinput
> **onbeforeinput**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12755
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)
#### Inherited from
`HTMLElement.onbeforeinput`
***
### onbeforematch
> **onbeforematch**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12757
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)
#### Inherited from
`HTMLElement.onbeforematch`
***
### onbeforetoggle
> **onbeforetoggle**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12759
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)
#### Inherited from
`HTMLElement.onbeforetoggle`
***
### onblur
> **onblur**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12761
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)
#### Inherited from
`HTMLElement.onblur`
***
### oncancel
> **oncancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12763
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)
#### Inherited from
`HTMLElement.oncancel`
***
### oncanplay
> **oncanplay**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12765
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)
#### Inherited from
`HTMLElement.oncanplay`
***
### oncanplaythrough
> **oncanplaythrough**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12767
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)
#### Inherited from
`HTMLElement.oncanplaythrough`
***
### onchange
> **onchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12769
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)
#### Inherited from
`HTMLElement.onchange`
***
### onclick
> **onclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12771
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)
#### Inherited from
`HTMLElement.onclick`
***
### onclose
> **onclose**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12773
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)
#### Inherited from
`HTMLElement.onclose`
***
### oncontextlost
> **oncontextlost**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12775
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)
#### Inherited from
`HTMLElement.oncontextlost`
***
### oncontextmenu
> **oncontextmenu**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12777
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)
#### Inherited from
`HTMLElement.oncontextmenu`
***
### oncontextrestored
> **oncontextrestored**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12779
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)
#### Inherited from
`HTMLElement.oncontextrestored`
***
### oncopy
> **oncopy**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12781
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)
#### Inherited from
`HTMLElement.oncopy`
***
### oncuechange
> **oncuechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12783
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)
#### Inherited from
`HTMLElement.oncuechange`
***
### oncut
> **oncut**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12785
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)
#### Inherited from
`HTMLElement.oncut`
***
### ondblclick
> **ondblclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12787
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)
#### Inherited from
`HTMLElement.ondblclick`
***
### ondrag
> **ondrag**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12789
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)
#### Inherited from
`HTMLElement.ondrag`
***
### ondragend
> **ondragend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12791
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)
#### Inherited from
`HTMLElement.ondragend`
***
### ondragenter
> **ondragenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12793
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)
#### Inherited from
`HTMLElement.ondragenter`
***
### ondragleave
> **ondragleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12795
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)
#### Inherited from
`HTMLElement.ondragleave`
***
### ondragover
> **ondragover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12797
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)
#### Inherited from
`HTMLElement.ondragover`
***
### ondragstart
> **ondragstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12799
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)
#### Inherited from
`HTMLElement.ondragstart`
***
### ondrop
> **ondrop**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12801
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)
#### Inherited from
`HTMLElement.ondrop`
***
### ondurationchange
> **ondurationchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12803
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)
#### Inherited from
`HTMLElement.ondurationchange`
***
### onemptied
> **onemptied**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12805
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)
#### Inherited from
`HTMLElement.onemptied`
***
### onended
> **onended**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12807
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)
#### Inherited from
`HTMLElement.onended`
***
### onerror
> **onerror**: `OnErrorEventHandler`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12809
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)
#### Inherited from
`HTMLElement.onerror`
***
### onfocus
> **onfocus**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12811
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)
#### Inherited from
`HTMLElement.onfocus`
***
### onformdata
> **onformdata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12813
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)
#### Inherited from
`HTMLElement.onformdata`
***
### onfullscreenchange
> **onfullscreenchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10776
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)
#### Inherited from
`HTMLElement.onfullscreenchange`
***
### onfullscreenerror
> **onfullscreenerror**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10778
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)
#### Inherited from
`HTMLElement.onfullscreenerror`
***
### ongotpointercapture
> **ongotpointercapture**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12815
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)
#### Inherited from
`HTMLElement.ongotpointercapture`
***
### oninput
> **oninput**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12817
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)
#### Inherited from
`HTMLElement.oninput`
***
### oninvalid
> **oninvalid**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12819
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)
#### Inherited from
`HTMLElement.oninvalid`
***
### onkeydown
> **onkeydown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12821
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)
#### Inherited from
`HTMLElement.onkeydown`
***
### ~~onkeypress~~
> **onkeypress**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12827
:::caution[Deprecated]
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)
:::
#### Inherited from
`HTMLElement.onkeypress`
***
### onkeyup
> **onkeyup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12829
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)
#### Inherited from
`HTMLElement.onkeyup`
***
### onload
> **onload**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12831
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)
#### Inherited from
`HTMLElement.onload`
***
### onloadeddata
> **onloadeddata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12833
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)
#### Inherited from
`HTMLElement.onloadeddata`
***
### onloadedmetadata
> **onloadedmetadata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12835
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)
#### Inherited from
`HTMLElement.onloadedmetadata`
***
### onloadstart
> **onloadstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12837
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)
#### Inherited from
`HTMLElement.onloadstart`
***
### onlostpointercapture
> **onlostpointercapture**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12839
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)
#### Inherited from
`HTMLElement.onlostpointercapture`
***
### onmousedown
> **onmousedown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12841
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)
#### Inherited from
`HTMLElement.onmousedown`
***
### onmouseenter
> **onmouseenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12843
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)
#### Inherited from
`HTMLElement.onmouseenter`
***
### onmouseleave
> **onmouseleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12845
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)
#### Inherited from
`HTMLElement.onmouseleave`
***
### onmousemove
> **onmousemove**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12847
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)
#### Inherited from
`HTMLElement.onmousemove`
***
### onmouseout
> **onmouseout**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12849
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)
#### Inherited from
`HTMLElement.onmouseout`
***
### onmouseover
> **onmouseover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12851
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)
#### Inherited from
`HTMLElement.onmouseover`
***
### onmouseup
> **onmouseup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12853
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)
#### Inherited from
`HTMLElement.onmouseup`
***
### onpaste
> **onpaste**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12855
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)
#### Inherited from
`HTMLElement.onpaste`
***
### onpause
> **onpause**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12857
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)
#### Inherited from
`HTMLElement.onpause`
***
### onplay
> **onplay**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12859
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)
#### Inherited from
`HTMLElement.onplay`
***
### onplaying
> **onplaying**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12861
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)
#### Inherited from
`HTMLElement.onplaying`
***
### onpointercancel
> **onpointercancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12863
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)
#### Inherited from
`HTMLElement.onpointercancel`
***
### onpointerdown
> **onpointerdown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12865
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)
#### Inherited from
`HTMLElement.onpointerdown`
***
### onpointerenter
> **onpointerenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12867
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)
#### Inherited from
`HTMLElement.onpointerenter`
***
### onpointerleave
> **onpointerleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12869
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)
#### Inherited from
`HTMLElement.onpointerleave`
***
### onpointermove
> **onpointermove**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12871
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)
#### Inherited from
`HTMLElement.onpointermove`
***
### onpointerout
> **onpointerout**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12873
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)
#### Inherited from
`HTMLElement.onpointerout`
***
### onpointerover
> **onpointerover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12875
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)
#### Inherited from
`HTMLElement.onpointerover`
***
### onpointerrawupdate
> **onpointerrawupdate**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12881
Available only in secure contexts.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)
#### Inherited from
`HTMLElement.onpointerrawupdate`
***
### onpointerup
> **onpointerup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12883
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)
#### Inherited from
`HTMLElement.onpointerup`
***
### onprogress
> **onprogress**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12885
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)
#### Inherited from
`HTMLElement.onprogress`
***
### onratechange
> **onratechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12887
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)
#### Inherited from
`HTMLElement.onratechange`
***
### onreset
> **onreset**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12889
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)
#### Inherited from
`HTMLElement.onreset`
***
### onresize
> **onresize**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12891
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)
#### Inherited from
`HTMLElement.onresize`
***
### onscroll
> **onscroll**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12893
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)
#### Inherited from
`HTMLElement.onscroll`
***
### onscrollend
> **onscrollend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12895
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)
#### Inherited from
`HTMLElement.onscrollend`
***
### onsecuritypolicyviolation
> **onsecuritypolicyviolation**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12897
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)
#### Inherited from
`HTMLElement.onsecuritypolicyviolation`
***
### onseeked
> **onseeked**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12899
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)
#### Inherited from
`HTMLElement.onseeked`
***
### onseeking
> **onseeking**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12901
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)
#### Inherited from
`HTMLElement.onseeking`
***
### onselect
> **onselect**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12903
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)
#### Inherited from
`HTMLElement.onselect`
***
### onselectionchange
> **onselectionchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12905
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)
#### Inherited from
`HTMLElement.onselectionchange`
***
### onselectstart
> **onselectstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12907
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)
#### Inherited from
`HTMLElement.onselectstart`
***
### onslotchange
> **onslotchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12909
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)
#### Inherited from
`HTMLElement.onslotchange`
***
### onstalled
> **onstalled**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12911
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)
#### Inherited from
`HTMLElement.onstalled`
***
### onsubmit
> **onsubmit**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12913
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)
#### Inherited from
`HTMLElement.onsubmit`
***
### onsuspend
> **onsuspend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12915
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)
#### Inherited from
`HTMLElement.onsuspend`
***
### ontimeupdate
> **ontimeupdate**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12917
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)
#### Inherited from
`HTMLElement.ontimeupdate`
***
### ontoggle
> **ontoggle**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12919
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)
#### Inherited from
`HTMLElement.ontoggle`
***
### ontouchcancel?
> `optional` **ontouchcancel?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12921
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)
#### Inherited from
`HTMLElement.ontouchcancel`
***
### ontouchend?
> `optional` **ontouchend?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12923
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)
#### Inherited from
`HTMLElement.ontouchend`
***
### ontouchmove?
> `optional` **ontouchmove?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12925
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)
#### Inherited from
`HTMLElement.ontouchmove`
***
### ontouchstart?
> `optional` **ontouchstart?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12927
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)
#### Inherited from
`HTMLElement.ontouchstart`
***
### ontransitioncancel
> **ontransitioncancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12929
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)
#### Inherited from
`HTMLElement.ontransitioncancel`
***
### ontransitionend
> **ontransitionend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12931
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)
#### Inherited from
`HTMLElement.ontransitionend`
***
### ontransitionrun
> **ontransitionrun**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12933
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)
#### Inherited from
`HTMLElement.ontransitionrun`
***
### ontransitionstart
> **ontransitionstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12935
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)
#### Inherited from
`HTMLElement.ontransitionstart`
***
### onvolumechange
> **onvolumechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12937
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)
#### Inherited from
`HTMLElement.onvolumechange`
***
### onwaiting
> **onwaiting**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12939
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)
#### Inherited from
`HTMLElement.onwaiting`
***
### ~~onwebkitanimationend~~
> **onwebkitanimationend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12945
:::caution[Deprecated]
This is a legacy alias of `onanimationend`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationend`
***
### ~~onwebkitanimationiteration~~
> **onwebkitanimationiteration**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12951
:::caution[Deprecated]
This is a legacy alias of `onanimationiteration`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationiteration`
***
### ~~onwebkitanimationstart~~
> **onwebkitanimationstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12957
:::caution[Deprecated]
This is a legacy alias of `onanimationstart`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationstart`
***
### ~~onwebkittransitionend~~
> **onwebkittransitionend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12963
:::caution[Deprecated]
This is a legacy alias of `ontransitionend`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)
:::
#### Inherited from
`HTMLElement.onwebkittransitionend`
***
### onwheel
> **onwheel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12965
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)
#### Inherited from
`HTMLElement.onwheel`
***
### outerHTML
> **outerHTML**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10784
The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)
#### Inherited from
`HTMLElement.outerHTML`
***
### outerText
> **outerText**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13778
The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)
#### Inherited from
`HTMLElement.outerText`
***
### ownerDocument
> `readonly` **ownerDocument**: `Document`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10785
The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)
#### Inherited from
`HTMLElement.ownerDocument`
***
### parentElement
> `readonly` **parentElement**: `HTMLElement` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21724
The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)
#### Inherited from
`HTMLElement.parentElement`
***
### parentNode
> `readonly` **parentNode**: `ParentNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21730
The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)
#### Inherited from
`HTMLElement.parentNode`
***
### placement?
> `optional` **placement?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L11)
Placement ID for backend-driven CSS customization.
#### Inherited from
`BannerProps.placement`
***
### popover
> **popover**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13784
The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)
#### Inherited from
`HTMLElement.popover`
***
### prefix
> `readonly` **prefix**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10798
The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)
#### Inherited from
`HTMLElement.prefix`
***
### preview?
> `optional` **preview?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:56](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L56)
When set, forces the banner to render in preview mode (e.g. in Shopify theme editor).
Bypasses normal event/browser detection and shows static content.
#### Inherited from
`BannerProps.preview`
***
### previewMode?
> `optional` **previewMode?**: `"referral"` \| `"inapp"`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:61](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L61)
Which banner variant to preview: "referral" or "inapp".
Only used when [preview](/developers/references/components/type-aliases/bannerprops/#preview) is set. Defaults to "referral".
#### Inherited from
`BannerProps.previewMode`
***
### previousElementSibling
> `readonly` **previousElementSibling**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22009
Returns the first preceding sibling that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)
#### Inherited from
`HTMLElement.previousElementSibling`
***
### previousSibling
> `readonly` **previousSibling**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21736
The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)
#### Inherited from
`HTMLElement.previousSibling`
***
### PROCESSING\_INSTRUCTION\_NODE
> `readonly` **PROCESSING\_INSTRUCTION\_NODE**: `7`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21843
node is a ProcessingInstruction node.
#### Inherited from
`HTMLElement.PROCESSING_INSTRUCTION_NODE`
***
### referralCta?
> `optional` **referralCta?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:32](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L32)
Override the referral banner CTA button text.
#### Inherited from
`BannerProps.referralCta`
***
### referralDescription?
> `optional` **referralDescription?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:28](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L28)
Override the referral banner description.
#### Inherited from
`BannerProps.referralDescription`
***
### referralTitle?
> `optional` **referralTitle?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:24](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L24)
Override the referral banner title.
#### Inherited from
`BannerProps.referralTitle`
***
### role
> **role**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2709
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)
#### Inherited from
`HTMLElement.role`
***
### scrollHeight
> `readonly` **scrollHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10804
The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)
#### Inherited from
`HTMLElement.scrollHeight`
***
### scrollLeft
> **scrollLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10810
The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)
#### Inherited from
`HTMLElement.scrollLeft`
***
### scrollTop
> **scrollTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10816
The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)
#### Inherited from
`HTMLElement.scrollTop`
***
### scrollWidth
> `readonly` **scrollWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10822
The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)
#### Inherited from
`HTMLElement.scrollWidth`
***
### shadowRoot
> `readonly` **shadowRoot**: `ShadowRoot` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10828
The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)
#### Inherited from
`HTMLElement.shadowRoot`
***
### slot
> **slot**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10834
The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)
#### Inherited from
`HTMLElement.slot`
***
### spellcheck
> **spellcheck**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13790
The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)
#### Inherited from
`HTMLElement.spellcheck`
***
### tabIndex
> **tabIndex**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16071
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)
#### Inherited from
`HTMLElement.tabIndex`
***
### tagName
> `readonly` **tagName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10840
The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)
#### Inherited from
`HTMLElement.tagName`
***
### TEXT\_NODE
> `readonly` **TEXT\_NODE**: `3`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21837
node is a Text node.
#### Inherited from
`HTMLElement.TEXT_NODE`
***
### title
> **title**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13796
The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)
#### Inherited from
`HTMLElement.title`
***
### translate
> **translate**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13802
The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)
#### Inherited from
`HTMLElement.translate`
***
### writingSuggestions
> **writingSuggestions**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13808
The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)
#### Inherited from
`HTMLElement.writingSuggestions`
## Accessors
### classList
#### Get Signature
> **get** **classList**(): `DOMTokenList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10713
The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)
##### Returns
`DOMTokenList`
#### Set Signature
> **set** **classList**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10714
##### Parameters
###### value
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.classList`
***
### part
#### Get Signature
> **get** **part**(): `DOMTokenList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10791
The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)
##### Returns
`DOMTokenList`
#### Set Signature
> **set** **part**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10792
##### Parameters
###### value
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.part`
***
### style
#### Get Signature
> **get** **style**(): `CSSStyleDeclaration`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11119
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)
##### Returns
`CSSStyleDeclaration`
#### Set Signature
> **set** **style**(`cssText`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11120
##### Parameters
###### cssText
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.style`
***
### textContent
#### Get Signature
> **get** **textContent**(): `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11102
[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)
##### Returns
`string`
#### Set Signature
> **set** **textContent**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11103
The **`textContent`** property of the Node interface represents the text content of the node and its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/textContent)
##### Parameters
###### value
`string` \| `null`
##### Returns
`void`
#### Inherited from
[`BannerElement`](/developers/references/components/interfaces/bannerelement/).[`textContent`](/developers/references/components/interfaces/bannerelement/#textcontent)
## Methods
### addEventListener()
#### Call Signature
> **addEventListener**\<`K`\>(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13839
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementEventMap`
##### Parameters
###### type
`K`
###### listener
(`this`, `ev`) => `any`
###### options?
`boolean` \| `AddEventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.addEventListener`
#### Call Signature
> **addEventListener**(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13840
##### Parameters
###### type
`string`
###### listener
`EventListenerOrEventListenerObject`
###### options?
`boolean` \| `AddEventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.addEventListener`
***
### after()
> **after**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7953
Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.after`
***
### animate()
> **animate**(`keyframes`, `options?`): `Animation`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2921
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)
#### Parameters
##### keyframes
`Keyframe`[] \| `PropertyIndexedKeyframes` \| `null`
##### options?
`number` \| `KeyframeAnimationOptions`
#### Returns
`Animation`
#### Inherited from
`HTMLElement.animate`
***
### append()
> **append**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22694
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.append`
***
### appendChild()
> **appendChild**\<`T`\>(`node`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21748
The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.appendChild`
***
### attachInternals()
> **attachInternals**(): `ElementInternals`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13814
The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)
#### Returns
`ElementInternals`
#### Inherited from
`HTMLElement.attachInternals`
***
### attachShadow()
> **attachShadow**(`init`): `ShadowRoot`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10846
The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)
#### Parameters
##### init
`ShadowRootInit`
#### Returns
`ShadowRoot`
#### Inherited from
`HTMLElement.attachShadow`
***
### before()
> **before**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7961
Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.before`
***
### blur()
> **blur**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16073
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)
#### Returns
`void`
#### Inherited from
`HTMLElement.blur`
***
### checkVisibility()
> **checkVisibility**(`options?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10852
The **`checkVisibility()`** method of the Element interface checks whether the element is visible.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)
#### Parameters
##### options?
`CheckVisibilityOptions`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.checkVisibility`
***
### click()
> **click**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13820
The **`HTMLElement.click()`** method simulates a mouse click on an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)
#### Returns
`void`
#### Inherited from
`HTMLElement.click`
***
### cloneNode()
> **cloneNode**(`subtree?`): `Node`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21754
The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)
#### Parameters
##### subtree?
`boolean`
#### Returns
`Node`
#### Inherited from
`HTMLElement.cloneNode`
***
### closest()
#### Call Signature
> **closest**\<`K`\>(`selector`): `HTMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10858
The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`HTMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`K`\>(`selector`): `SVGElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10859
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`SVGElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`K`\>(`selector`): `MathMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10860
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`MathMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`E`\>(`selectors`): `E` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10861
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`E` \| `null`
##### Inherited from
`HTMLElement.closest`
***
### compareDocumentPosition()
> **compareDocumentPosition**(`other`): `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21760
The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)
#### Parameters
##### other
`Node`
#### Returns
`number`
#### Inherited from
`HTMLElement.compareDocumentPosition`
***
### computedStyleMap()
> **computedStyleMap**(): `StylePropertyMapReadOnly`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10867
The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)
#### Returns
`StylePropertyMapReadOnly`
#### Inherited from
`HTMLElement.computedStyleMap`
***
### contains()
> **contains**(`other`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21766
The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)
#### Parameters
##### other
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.contains`
***
### dispatchEvent()
> **dispatchEvent**(`event`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11575
The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
#### Parameters
##### event
`Event`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.dispatchEvent`
***
### focus()
> **focus**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16075
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)
#### Parameters
##### options?
`FocusOptions`
#### Returns
`void`
#### Inherited from
`HTMLElement.focus`
***
### getAnimations()
> **getAnimations**(`options?`): `Animation`[]
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2923
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)
#### Parameters
##### options?
`GetAnimationsOptions`
#### Returns
`Animation`[]
#### Inherited from
`HTMLElement.getAnimations`
***
### getAttribute()
> **getAttribute**(`qualifiedName`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10873
The **`getAttribute()`** method of the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.getAttribute`
***
### getAttributeNames()
> **getAttributeNames**(): `string`[]
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10885
The **`getAttributeNames()`** method of the array.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)
#### Returns
`string`[]
#### Inherited from
`HTMLElement.getAttributeNames`
***
### getAttributeNode()
> **getAttributeNode**(`qualifiedName`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10891
Returns the specified attribute of the specified element, as an Attr node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)
#### Parameters
##### qualifiedName
`string`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.getAttributeNode`
***
### getAttributeNodeNS()
> **getAttributeNodeNS**(`namespace`, `localName`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10897
The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.getAttributeNodeNS`
***
### getAttributeNS()
> **getAttributeNS**(`namespace`, `localName`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10879
The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.getAttributeNS`
***
### getBoundingClientRect()
> **getBoundingClientRect**(): `DOMRect`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10903
The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)
#### Returns
`DOMRect`
#### Inherited from
`HTMLElement.getBoundingClientRect`
***
### getClientRects()
> **getClientRects**(): `DOMRectList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10909
The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)
#### Returns
`DOMRectList`
#### Inherited from
`HTMLElement.getClientRects`
***
### getElementsByClassName()
> **getElementsByClassName**(`classNames`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10915
The Element method **`getElementsByClassName()`** returns a live specified class name or names.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)
#### Parameters
##### classNames
`string`
#### Returns
`HTMLCollectionOf`\<`Element`\>
#### Inherited from
`HTMLElement.getElementsByClassName`
***
### getElementsByTagName()
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`HTMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10921
The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`HTMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`SVGElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10922
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`SVGElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`MathMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10923
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`MathMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10925
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**(`qualifiedName`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10926
##### Parameters
###### qualifiedName
`string`
##### Returns
`HTMLCollectionOf`\<`Element`\>
##### Inherited from
`HTMLElement.getElementsByTagName`
***
### getElementsByTagNameNS()
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`HTMLElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10932
The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)
##### Parameters
###### namespaceURI
`"http://www.w3.org/1999/xhtml"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`HTMLElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`SVGElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10933
##### Parameters
###### namespaceURI
`"http://www.w3.org/2000/svg"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`SVGElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`MathMLElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10934
##### Parameters
###### namespaceURI
`"http://www.w3.org/1998/Math/MathML"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`MathMLElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespace`, `localName`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10935
##### Parameters
###### namespace
`string` \| `null`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`Element`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
***
### getHTML()
> **getHTML**(`options?`): `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10941
The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)
#### Parameters
##### options?
`GetHTMLOptions`
#### Returns
`string`
#### Inherited from
`HTMLElement.getHTML`
***
### getRootNode()
> **getRootNode**(`options?`): `Node`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21772
The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)
#### Parameters
##### options?
`GetRootNodeOptions`
#### Returns
`Node`
#### Inherited from
`HTMLElement.getRootNode`
***
### hasAttribute()
> **hasAttribute**(`qualifiedName`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10947
The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttribute`
***
### hasAttributeNS()
> **hasAttributeNS**(`namespace`, `localName`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10953
The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttributeNS`
***
### hasAttributes()
> **hasAttributes**(): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10959
The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttributes`
***
### hasChildNodes()
> **hasChildNodes**(): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21778
The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasChildNodes`
***
### hasPointerCapture()
> **hasPointerCapture**(`pointerId`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10965
The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasPointerCapture`
***
### hidePopover()
> **hidePopover**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13826
The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)
#### Returns
`void`
#### Inherited from
`HTMLElement.hidePopover`
***
### insertAdjacentElement()
> **insertAdjacentElement**(`where`, `element`): `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10971
The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)
#### Parameters
##### where
`InsertPosition`
##### element
`Element`
#### Returns
`Element` \| `null`
#### Inherited from
`HTMLElement.insertAdjacentElement`
***
### insertAdjacentHTML()
> **insertAdjacentHTML**(`position`, `string`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10977
The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)
#### Parameters
##### position
`InsertPosition`
##### string
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.insertAdjacentHTML`
***
### insertAdjacentText()
> **insertAdjacentText**(`where`, `data`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10983
The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)
#### Parameters
##### where
`InsertPosition`
##### data
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.insertAdjacentText`
***
### insertBefore()
> **insertBefore**\<`T`\>(`node`, `child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21784
The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`T`
##### child
`Node` \| `null`
#### Returns
`T`
#### Inherited from
`HTMLElement.insertBefore`
***
### isDefaultNamespace()
> **isDefaultNamespace**(`namespace`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21790
The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)
#### Parameters
##### namespace
`string` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isDefaultNamespace`
***
### isEqualNode()
> **isEqualNode**(`otherNode`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21796
The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)
#### Parameters
##### otherNode
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isEqualNode`
***
### isSameNode()
> **isSameNode**(`otherNode`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21802
The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)
#### Parameters
##### otherNode
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isSameNode`
***
### lookupNamespaceURI()
> **lookupNamespaceURI**(`prefix`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21808
The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)
#### Parameters
##### prefix
`string` \| `null`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.lookupNamespaceURI`
***
### lookupPrefix()
> **lookupPrefix**(`namespace`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21814
The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)
#### Parameters
##### namespace
`string` \| `null`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.lookupPrefix`
***
### matches()
> **matches**(`selectors`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10989
The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)
#### Parameters
##### selectors
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.matches`
***
### normalize()
> **normalize**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21820
The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)
#### Returns
`void`
#### Inherited from
`HTMLElement.normalize`
***
### prepend()
> **prepend**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22702
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.prepend`
***
### querySelector()
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `HTMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22708
Returns the first element that is a descendant of node that matches selectors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`HTMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `SVGElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22709
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`SVGElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `MathMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22710
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`MathMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `HTMLElementDeprecatedTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22712
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`HTMLElementDeprecatedTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`E`\>(`selectors`): `E` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22713
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`E` \| `null`
##### Inherited from
`HTMLElement.querySelector`
***
### querySelectorAll()
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`HTMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22719
Returns all element descendants of node that match selectors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`HTMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`SVGElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22720
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`SVGElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`MathMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22721
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`MathMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22723
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`E`\>(`selectors`): `NodeListOf`\<`E`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22724
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`NodeListOf`\<`E`\>
##### Inherited from
`HTMLElement.querySelectorAll`
***
### releasePointerCapture()
> **releasePointerCapture**(`pointerId`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10995
The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`void`
#### Inherited from
`HTMLElement.releasePointerCapture`
***
### remove()
> **remove**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7967
Removes node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)
#### Returns
`void`
#### Inherited from
`HTMLElement.remove`
***
### removeAttribute()
> **removeAttribute**(`qualifiedName`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11001
The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.removeAttribute`
***
### removeAttributeNode()
> **removeAttributeNode**(`attr`): `Attr`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11013
The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr`
#### Inherited from
`HTMLElement.removeAttributeNode`
***
### removeAttributeNS()
> **removeAttributeNS**(`namespace`, `localName`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11007
The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.removeAttributeNS`
***
### removeChild()
> **removeChild**\<`T`\>(`child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21826
The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### child
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.removeChild`
***
### removeEventListener()
#### Call Signature
> **removeEventListener**\<`K`\>(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13841
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementEventMap`
##### Parameters
###### type
`K`
###### listener
(`this`, `ev`) => `any`
###### options?
`boolean` \| `EventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.removeEventListener`
#### Call Signature
> **removeEventListener**(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13842
##### Parameters
###### type
`string`
###### listener
`EventListenerOrEventListenerObject`
###### options?
`boolean` \| `EventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.removeEventListener`
***
### replaceChild()
> **replaceChild**\<`T`\>(`node`, `child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21832
The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`Node`
##### child
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.replaceChild`
***
### replaceChildren()
> **replaceChildren**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22732
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.replaceChildren`
***
### replaceWith()
> **replaceWith**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7975
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.replaceWith`
***
### requestFullscreen()
> **requestFullscreen**(`options?`): `Promise`\<`void`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11019
The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)
#### Parameters
##### options?
`FullscreenOptions`
#### Returns
`Promise`\<`void`\>
#### Inherited from
`HTMLElement.requestFullscreen`
***
### requestPointerLock()
> **requestPointerLock**(`options?`): `Promise`\<`void`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11025
The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)
#### Parameters
##### options?
`PointerLockOptions`
#### Returns
`Promise`\<`void`\>
#### Inherited from
`HTMLElement.requestPointerLock`
***
### scroll()
#### Call Signature
> **scroll**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11031
The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scroll`
#### Call Signature
> **scroll**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11032
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scroll`
***
### scrollBy()
#### Call Signature
> **scrollBy**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11038
The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollBy`
#### Call Signature
> **scrollBy**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11039
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollBy`
***
### scrollIntoView()
> **scrollIntoView**(`arg?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11045
The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)
#### Parameters
##### arg?
`boolean` \| `ScrollIntoViewOptions`
#### Returns
`void`
#### Inherited from
`HTMLElement.scrollIntoView`
***
### scrollTo()
#### Call Signature
> **scrollTo**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11051
The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollTo`
#### Call Signature
> **scrollTo**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11052
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollTo`
***
### setAttribute()
> **setAttribute**(`qualifiedName`, `value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11058
The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)
#### Parameters
##### qualifiedName
`string`
##### value
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setAttribute`
***
### setAttributeNode()
> **setAttributeNode**(`attr`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11070
The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.setAttributeNode`
***
### setAttributeNodeNS()
> **setAttributeNodeNS**(`attr`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11076
The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.setAttributeNodeNS`
***
### setAttributeNS()
> **setAttributeNS**(`namespace`, `qualifiedName`, `value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11064
`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### qualifiedName
`string`
##### value
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setAttributeNS`
***
### setHTMLUnsafe()
> **setHTMLUnsafe**(`html`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11082
The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)
#### Parameters
##### html
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setHTMLUnsafe`
***
### setPointerCapture()
> **setPointerCapture**(`pointerId`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11088
The **`setPointerCapture()`** method of the _capture target_ of future pointer events.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`void`
#### Inherited from
`HTMLElement.setPointerCapture`
***
### showPopover()
> **showPopover**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13832
The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)
#### Returns
`void`
#### Inherited from
`HTMLElement.showPopover`
***
### toggleAttribute()
> **toggleAttribute**(`qualifiedName`, `force?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11094
The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)
#### Parameters
##### qualifiedName
`string`
##### force?
`boolean`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.toggleAttribute`
***
### togglePopover()
> **togglePopover**(`options?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13838
The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)
#### Parameters
##### options?
`boolean`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.togglePopover`
***
### ~~webkitMatchesSelector()~~
> **webkitMatchesSelector**(`selectors`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11100
:::caution[Deprecated]
This is a legacy alias of `matches`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)
:::
#### Parameters
##### selectors
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.webkitMatchesSelector`
# ButtonShareElement
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/index.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/index.ts#L11)
Custom element interface for ``.
Combines standard HTMLElement with [ButtonShareProps](/developers/references/components/type-aliases/buttonshareprops/).
## Extends
- `HTMLElement`.[`ButtonShareProps`](/developers/references/components/type-aliases/buttonshareprops/)
## Properties
### accessKey
> **accessKey**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13688
The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)
#### Inherited from
`HTMLElement.accessKey`
***
### accessKeyLabel
> `readonly` **accessKeyLabel**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13694
The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)
#### Inherited from
`HTMLElement.accessKeyLabel`
***
### ariaActiveDescendantElement
> **ariaActiveDescendantElement**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2607
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)
#### Inherited from
`HTMLElement.ariaActiveDescendantElement`
***
### ariaAtomic
> **ariaAtomic**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2609
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)
#### Inherited from
`HTMLElement.ariaAtomic`
***
### ariaAutoComplete
> **ariaAutoComplete**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2611
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)
#### Inherited from
`HTMLElement.ariaAutoComplete`
***
### ariaBrailleLabel
> **ariaBrailleLabel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2613
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)
#### Inherited from
`HTMLElement.ariaBrailleLabel`
***
### ariaBrailleRoleDescription
> **ariaBrailleRoleDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2615
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)
#### Inherited from
`HTMLElement.ariaBrailleRoleDescription`
***
### ariaBusy
> **ariaBusy**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2617
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)
#### Inherited from
`HTMLElement.ariaBusy`
***
### ariaChecked
> **ariaChecked**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2619
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)
#### Inherited from
`HTMLElement.ariaChecked`
***
### ariaColCount
> **ariaColCount**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2621
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)
#### Inherited from
`HTMLElement.ariaColCount`
***
### ariaColIndex
> **ariaColIndex**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2623
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)
#### Inherited from
`HTMLElement.ariaColIndex`
***
### ariaColIndexText
> **ariaColIndexText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2625
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)
#### Inherited from
`HTMLElement.ariaColIndexText`
***
### ariaColSpan
> **ariaColSpan**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2627
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)
#### Inherited from
`HTMLElement.ariaColSpan`
***
### ariaControlsElements
> **ariaControlsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2629
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)
#### Inherited from
`HTMLElement.ariaControlsElements`
***
### ariaCurrent
> **ariaCurrent**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2631
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)
#### Inherited from
`HTMLElement.ariaCurrent`
***
### ariaDescribedByElements
> **ariaDescribedByElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2633
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)
#### Inherited from
`HTMLElement.ariaDescribedByElements`
***
### ariaDescription
> **ariaDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2635
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)
#### Inherited from
`HTMLElement.ariaDescription`
***
### ariaDetailsElements
> **ariaDetailsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2637
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)
#### Inherited from
`HTMLElement.ariaDetailsElements`
***
### ariaDisabled
> **ariaDisabled**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2639
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)
#### Inherited from
`HTMLElement.ariaDisabled`
***
### ariaErrorMessageElements
> **ariaErrorMessageElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2641
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)
#### Inherited from
`HTMLElement.ariaErrorMessageElements`
***
### ariaExpanded
> **ariaExpanded**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2643
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)
#### Inherited from
`HTMLElement.ariaExpanded`
***
### ariaFlowToElements
> **ariaFlowToElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2645
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)
#### Inherited from
`HTMLElement.ariaFlowToElements`
***
### ariaHasPopup
> **ariaHasPopup**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2647
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)
#### Inherited from
`HTMLElement.ariaHasPopup`
***
### ariaHidden
> **ariaHidden**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2649
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)
#### Inherited from
`HTMLElement.ariaHidden`
***
### ariaInvalid
> **ariaInvalid**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2651
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)
#### Inherited from
`HTMLElement.ariaInvalid`
***
### ariaKeyShortcuts
> **ariaKeyShortcuts**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2653
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)
#### Inherited from
`HTMLElement.ariaKeyShortcuts`
***
### ariaLabel
> **ariaLabel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2655
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)
#### Inherited from
`HTMLElement.ariaLabel`
***
### ariaLabelledByElements
> **ariaLabelledByElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2657
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)
#### Inherited from
`HTMLElement.ariaLabelledByElements`
***
### ariaLevel
> **ariaLevel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2659
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)
#### Inherited from
`HTMLElement.ariaLevel`
***
### ariaLive
> **ariaLive**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2661
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)
#### Inherited from
`HTMLElement.ariaLive`
***
### ariaModal
> **ariaModal**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2663
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)
#### Inherited from
`HTMLElement.ariaModal`
***
### ariaMultiLine
> **ariaMultiLine**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2665
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)
#### Inherited from
`HTMLElement.ariaMultiLine`
***
### ariaMultiSelectable
> **ariaMultiSelectable**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2667
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)
#### Inherited from
`HTMLElement.ariaMultiSelectable`
***
### ariaOrientation
> **ariaOrientation**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2669
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)
#### Inherited from
`HTMLElement.ariaOrientation`
***
### ariaOwnsElements
> **ariaOwnsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2671
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)
#### Inherited from
`HTMLElement.ariaOwnsElements`
***
### ariaPlaceholder
> **ariaPlaceholder**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2673
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)
#### Inherited from
`HTMLElement.ariaPlaceholder`
***
### ariaPosInSet
> **ariaPosInSet**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2675
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)
#### Inherited from
`HTMLElement.ariaPosInSet`
***
### ariaPressed
> **ariaPressed**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2677
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)
#### Inherited from
`HTMLElement.ariaPressed`
***
### ariaReadOnly
> **ariaReadOnly**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2679
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)
#### Inherited from
`HTMLElement.ariaReadOnly`
***
### ariaRelevant
> **ariaRelevant**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2681
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)
#### Inherited from
`HTMLElement.ariaRelevant`
***
### ariaRequired
> **ariaRequired**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2683
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)
#### Inherited from
`HTMLElement.ariaRequired`
***
### ariaRoleDescription
> **ariaRoleDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2685
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)
#### Inherited from
`HTMLElement.ariaRoleDescription`
***
### ariaRowCount
> **ariaRowCount**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2687
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)
#### Inherited from
`HTMLElement.ariaRowCount`
***
### ariaRowIndex
> **ariaRowIndex**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2689
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)
#### Inherited from
`HTMLElement.ariaRowIndex`
***
### ariaRowIndexText
> **ariaRowIndexText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2691
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)
#### Inherited from
`HTMLElement.ariaRowIndexText`
***
### ariaRowSpan
> **ariaRowSpan**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2693
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)
#### Inherited from
`HTMLElement.ariaRowSpan`
***
### ariaSelected
> **ariaSelected**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2695
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)
#### Inherited from
`HTMLElement.ariaSelected`
***
### ariaSetSize
> **ariaSetSize**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2697
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)
#### Inherited from
`HTMLElement.ariaSetSize`
***
### ariaSort
> **ariaSort**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2699
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)
#### Inherited from
`HTMLElement.ariaSort`
***
### ariaValueMax
> **ariaValueMax**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2701
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)
#### Inherited from
`HTMLElement.ariaValueMax`
***
### ariaValueMin
> **ariaValueMin**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2703
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)
#### Inherited from
`HTMLElement.ariaValueMin`
***
### ariaValueNow
> **ariaValueNow**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2705
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)
#### Inherited from
`HTMLElement.ariaValueNow`
***
### ariaValueText
> **ariaValueText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2707
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)
#### Inherited from
`HTMLElement.ariaValueText`
***
### assignedSlot
> `readonly` **assignedSlot**: `HTMLSlotElement` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:30826
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)
#### Inherited from
`HTMLElement.assignedSlot`
***
### ATTRIBUTE\_NODE
> `readonly` **ATTRIBUTE\_NODE**: `2`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21835
#### Inherited from
`HTMLElement.ATTRIBUTE_NODE`
***
### attributes
> `readonly` **attributes**: `NamedNodeMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10707
The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)
#### Inherited from
`HTMLElement.attributes`
***
### attributeStyleMap
> `readonly` **attributeStyleMap**: `StylePropertyMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11117
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)
#### Inherited from
`HTMLElement.attributeStyleMap`
***
### autocapitalize
> **autocapitalize**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13700
The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)
#### Inherited from
`HTMLElement.autocapitalize`
***
### autocorrect
> **autocorrect**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13706
The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)
#### Inherited from
`HTMLElement.autocorrect`
***
### autofocus
> **autofocus**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16065
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)
#### Inherited from
`HTMLElement.autofocus`
***
### baseURI
> `readonly` **baseURI**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21664
The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)
#### Inherited from
`HTMLElement.baseURI`
***
### CDATA\_SECTION\_NODE
> `readonly` **CDATA\_SECTION\_NODE**: `4`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21839
node is a CDATASection node.
#### Inherited from
`HTMLElement.CDATA_SECTION_NODE`
***
### childElementCount
> `readonly` **childElementCount**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22668
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)
#### Inherited from
`HTMLElement.childElementCount`
***
### childNodes
> `readonly` **childNodes**: `NodeListOf`\<`ChildNode`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21670
The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)
#### Inherited from
`HTMLElement.childNodes`
***
### children
> `readonly` **children**: `HTMLCollection`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22674
Returns the child elements.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)
#### Inherited from
`HTMLElement.children`
***
### classname?
> `optional` **classname?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:25](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L25)
Classname to apply to the button
#### Inherited from
`ButtonShareProps.classname`
***
### className
> **className**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10720
The **`className`** property of the of the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)
#### Inherited from
`HTMLElement.className`
***
### clickAction?
> `optional` **clickAction?**: `"embedded-wallet"` \| `"sharing-page"`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:44](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L44)
Which UI to open on click.
Legacy values (e.g. `"share-modal"`) are accepted at runtime and
gracefully route to the full-page sharing UI — the modal-flow
share path was retired in favour of `displaySharingPage`.
#### Default Value
`"sharing-page"`
#### Inherited from
`ButtonShareProps.clickAction`
***
### clientHeight
> `readonly` **clientHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10726
The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)
#### Inherited from
`HTMLElement.clientHeight`
***
### clientLeft
> `readonly` **clientLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10732
The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)
#### Inherited from
`HTMLElement.clientLeft`
***
### clientTop
> `readonly` **clientTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10738
The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)
#### Inherited from
`HTMLElement.clientTop`
***
### clientWidth
> `readonly` **clientWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10744
The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)
#### Inherited from
`HTMLElement.clientWidth`
***
### COMMENT\_NODE
> `readonly` **COMMENT\_NODE**: `8`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21845
node is a Comment node.
#### Inherited from
`HTMLElement.COMMENT_NODE`
***
### contentEditable
> **contentEditable**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11125
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)
#### Inherited from
`HTMLElement.contentEditable`
***
### currentCSSZoom
> `readonly` **currentCSSZoom**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10750
The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)
#### Inherited from
`HTMLElement.currentCSSZoom`
***
### dataset
> `readonly` **dataset**: `DOMStringMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16067
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)
#### Inherited from
`HTMLElement.dataset`
***
### dir
> **dir**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13712
The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)
#### Inherited from
`HTMLElement.dir`
***
### DOCUMENT\_FRAGMENT\_NODE
> `readonly` **DOCUMENT\_FRAGMENT\_NODE**: `11`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21851
node is a DocumentFragment node.
#### Inherited from
`HTMLElement.DOCUMENT_FRAGMENT_NODE`
***
### DOCUMENT\_NODE
> `readonly` **DOCUMENT\_NODE**: `9`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21847
node is a document.
#### Inherited from
`HTMLElement.DOCUMENT_NODE`
***
### DOCUMENT\_POSITION\_CONTAINED\_BY
> `readonly` **DOCUMENT\_POSITION\_CONTAINED\_BY**: `16`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21862
Set when other is a descendant of node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_CONTAINED_BY`
***
### DOCUMENT\_POSITION\_CONTAINS
> `readonly` **DOCUMENT\_POSITION\_CONTAINS**: `8`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21860
Set when other is an ancestor of node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_CONTAINS`
***
### DOCUMENT\_POSITION\_DISCONNECTED
> `readonly` **DOCUMENT\_POSITION\_DISCONNECTED**: `1`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21854
Set when node and other are not in the same tree.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_DISCONNECTED`
***
### DOCUMENT\_POSITION\_FOLLOWING
> `readonly` **DOCUMENT\_POSITION\_FOLLOWING**: `4`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21858
Set when other is following node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_FOLLOWING`
***
### DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC
> `readonly` **DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC**: `32`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21863
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC`
***
### DOCUMENT\_POSITION\_PRECEDING
> `readonly` **DOCUMENT\_POSITION\_PRECEDING**: `2`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21856
Set when other is preceding node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_PRECEDING`
***
### DOCUMENT\_TYPE\_NODE
> `readonly` **DOCUMENT\_TYPE\_NODE**: `10`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21849
node is a doctype.
#### Inherited from
`HTMLElement.DOCUMENT_TYPE_NODE`
***
### draggable
> **draggable**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13718
The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)
#### Inherited from
`HTMLElement.draggable`
***
### ELEMENT\_NODE
> `readonly` **ELEMENT\_NODE**: `1`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21834
node is an element.
#### Inherited from
`HTMLElement.ELEMENT_NODE`
***
### enterKeyHint
> **enterKeyHint**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11127
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)
#### Inherited from
`HTMLElement.enterKeyHint`
***
### ENTITY\_NODE
> `readonly` **ENTITY\_NODE**: `6`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21841
#### Inherited from
`HTMLElement.ENTITY_NODE`
***
### ENTITY\_REFERENCE\_NODE
> `readonly` **ENTITY\_REFERENCE\_NODE**: `5`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21840
#### Inherited from
`HTMLElement.ENTITY_REFERENCE_NODE`
***
### firstChild
> `readonly` **firstChild**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21676
The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)
#### Inherited from
`HTMLElement.firstChild`
***
### firstElementChild
> `readonly` **firstElementChild**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22680
Returns the first child that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)
#### Inherited from
`HTMLElement.firstElementChild`
***
### hidden
> **hidden**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13724
The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)
#### Inherited from
`HTMLElement.hidden`
***
### id
> **id**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10756
The **`id`** property of the Element interface represents the element's identifier, reflecting the **`id`** global attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/id)
#### Inherited from
`HTMLElement.id`
***
### inert
> **inert**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13730
The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)
#### Inherited from
`HTMLElement.inert`
***
### innerHTML
> **innerHTML**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10762
The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)
#### Inherited from
`HTMLElement.innerHTML`
***
### innerText
> **innerText**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13736
The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)
#### Inherited from
`HTMLElement.innerText`
***
### inputMode
> **inputMode**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11129
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)
#### Inherited from
`HTMLElement.inputMode`
***
### isConnected
> `readonly` **isConnected**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21682
The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)
#### Inherited from
`HTMLElement.isConnected`
***
### isContentEditable
> `readonly` **isContentEditable**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11131
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)
#### Inherited from
`HTMLElement.isContentEditable`
***
### lang
> **lang**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13742
The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)
#### Inherited from
`HTMLElement.lang`
***
### lastChild
> `readonly` **lastChild**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21688
The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)
#### Inherited from
`HTMLElement.lastChild`
***
### lastElementChild
> `readonly` **lastElementChild**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22686
Returns the last child that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)
#### Inherited from
`HTMLElement.lastElementChild`
***
### localName
> `readonly` **localName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10768
The **`Element.localName`** read-only property returns the local part of the qualified name of an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)
#### Inherited from
`HTMLElement.localName`
***
### namespaceURI
> `readonly` **namespaceURI**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10774
The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)
#### Inherited from
`HTMLElement.namespaceURI`
***
### nextElementSibling
> `readonly` **nextElementSibling**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22003
Returns the first following sibling that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)
#### Inherited from
`HTMLElement.nextElementSibling`
***
### nextSibling
> `readonly` **nextSibling**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21694
The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)
#### Inherited from
`HTMLElement.nextSibling`
***
### nodeName
> `readonly` **nodeName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21700
The read-only **`nodeName`** property of Node returns the name of the current node as a string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)
#### Inherited from
`HTMLElement.nodeName`
***
### nodeType
> `readonly` **nodeType**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21706
The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)
#### Inherited from
`HTMLElement.nodeType`
***
### nodeValue
> **nodeValue**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21712
The **`nodeValue`** property of the Node interface returns or sets the value of the current node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)
#### Inherited from
`HTMLElement.nodeValue`
***
### nonce?
> `optional` **nonce?**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16069
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)
#### Inherited from
`HTMLElement.nonce`
***
### noRewardText?
> `optional` **noRewardText?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:30](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L30)
Fallback text when `text` contains the `{REWARD}` placeholder but no
reward is available.
#### Inherited from
`ButtonShareProps.noRewardText`
***
### NOTATION\_NODE
> `readonly` **NOTATION\_NODE**: `12`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21852
#### Inherited from
`HTMLElement.NOTATION_NODE`
***
### offsetHeight
> `readonly` **offsetHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13748
The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)
#### Inherited from
`HTMLElement.offsetHeight`
***
### offsetLeft
> `readonly` **offsetLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13754
The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)
#### Inherited from
`HTMLElement.offsetLeft`
***
### offsetParent
> `readonly` **offsetParent**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13760
The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)
#### Inherited from
`HTMLElement.offsetParent`
***
### offsetTop
> `readonly` **offsetTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13766
The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)
#### Inherited from
`HTMLElement.offsetTop`
***
### offsetWidth
> `readonly` **offsetWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13772
The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)
#### Inherited from
`HTMLElement.offsetWidth`
***
### onabort
> **onabort**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12743
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)
#### Inherited from
`HTMLElement.onabort`
***
### onanimationcancel
> **onanimationcancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12745
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)
#### Inherited from
`HTMLElement.onanimationcancel`
***
### onanimationend
> **onanimationend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12747
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)
#### Inherited from
`HTMLElement.onanimationend`
***
### onanimationiteration
> **onanimationiteration**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12749
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)
#### Inherited from
`HTMLElement.onanimationiteration`
***
### onanimationstart
> **onanimationstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12751
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)
#### Inherited from
`HTMLElement.onanimationstart`
***
### onauxclick
> **onauxclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12753
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)
#### Inherited from
`HTMLElement.onauxclick`
***
### onbeforeinput
> **onbeforeinput**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12755
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)
#### Inherited from
`HTMLElement.onbeforeinput`
***
### onbeforematch
> **onbeforematch**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12757
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)
#### Inherited from
`HTMLElement.onbeforematch`
***
### onbeforetoggle
> **onbeforetoggle**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12759
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)
#### Inherited from
`HTMLElement.onbeforetoggle`
***
### onblur
> **onblur**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12761
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)
#### Inherited from
`HTMLElement.onblur`
***
### oncancel
> **oncancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12763
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)
#### Inherited from
`HTMLElement.oncancel`
***
### oncanplay
> **oncanplay**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12765
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)
#### Inherited from
`HTMLElement.oncanplay`
***
### oncanplaythrough
> **oncanplaythrough**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12767
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)
#### Inherited from
`HTMLElement.oncanplaythrough`
***
### onchange
> **onchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12769
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)
#### Inherited from
`HTMLElement.onchange`
***
### onclick
> **onclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12771
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)
#### Inherited from
`HTMLElement.onclick`
***
### onclose
> **onclose**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12773
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)
#### Inherited from
`HTMLElement.onclose`
***
### oncontextlost
> **oncontextlost**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12775
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)
#### Inherited from
`HTMLElement.oncontextlost`
***
### oncontextmenu
> **oncontextmenu**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12777
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)
#### Inherited from
`HTMLElement.oncontextmenu`
***
### oncontextrestored
> **oncontextrestored**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12779
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)
#### Inherited from
`HTMLElement.oncontextrestored`
***
### oncopy
> **oncopy**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12781
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)
#### Inherited from
`HTMLElement.oncopy`
***
### oncuechange
> **oncuechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12783
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)
#### Inherited from
`HTMLElement.oncuechange`
***
### oncut
> **oncut**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12785
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)
#### Inherited from
`HTMLElement.oncut`
***
### ondblclick
> **ondblclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12787
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)
#### Inherited from
`HTMLElement.ondblclick`
***
### ondrag
> **ondrag**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12789
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)
#### Inherited from
`HTMLElement.ondrag`
***
### ondragend
> **ondragend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12791
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)
#### Inherited from
`HTMLElement.ondragend`
***
### ondragenter
> **ondragenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12793
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)
#### Inherited from
`HTMLElement.ondragenter`
***
### ondragleave
> **ondragleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12795
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)
#### Inherited from
`HTMLElement.ondragleave`
***
### ondragover
> **ondragover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12797
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)
#### Inherited from
`HTMLElement.ondragover`
***
### ondragstart
> **ondragstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12799
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)
#### Inherited from
`HTMLElement.ondragstart`
***
### ondrop
> **ondrop**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12801
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)
#### Inherited from
`HTMLElement.ondrop`
***
### ondurationchange
> **ondurationchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12803
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)
#### Inherited from
`HTMLElement.ondurationchange`
***
### onemptied
> **onemptied**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12805
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)
#### Inherited from
`HTMLElement.onemptied`
***
### onended
> **onended**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12807
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)
#### Inherited from
`HTMLElement.onended`
***
### onerror
> **onerror**: `OnErrorEventHandler`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12809
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)
#### Inherited from
`HTMLElement.onerror`
***
### onfocus
> **onfocus**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12811
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)
#### Inherited from
`HTMLElement.onfocus`
***
### onformdata
> **onformdata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12813
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)
#### Inherited from
`HTMLElement.onformdata`
***
### onfullscreenchange
> **onfullscreenchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10776
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)
#### Inherited from
`HTMLElement.onfullscreenchange`
***
### onfullscreenerror
> **onfullscreenerror**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10778
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)
#### Inherited from
`HTMLElement.onfullscreenerror`
***
### ongotpointercapture
> **ongotpointercapture**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12815
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)
#### Inherited from
`HTMLElement.ongotpointercapture`
***
### oninput
> **oninput**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12817
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)
#### Inherited from
`HTMLElement.oninput`
***
### oninvalid
> **oninvalid**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12819
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)
#### Inherited from
`HTMLElement.oninvalid`
***
### onkeydown
> **onkeydown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12821
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)
#### Inherited from
`HTMLElement.onkeydown`
***
### ~~onkeypress~~
> **onkeypress**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12827
:::caution[Deprecated]
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)
:::
#### Inherited from
`HTMLElement.onkeypress`
***
### onkeyup
> **onkeyup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12829
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)
#### Inherited from
`HTMLElement.onkeyup`
***
### onload
> **onload**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12831
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)
#### Inherited from
`HTMLElement.onload`
***
### onloadeddata
> **onloadeddata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12833
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)
#### Inherited from
`HTMLElement.onloadeddata`
***
### onloadedmetadata
> **onloadedmetadata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12835
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)
#### Inherited from
`HTMLElement.onloadedmetadata`
***
### onloadstart
> **onloadstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12837
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)
#### Inherited from
`HTMLElement.onloadstart`
***
### onlostpointercapture
> **onlostpointercapture**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12839
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)
#### Inherited from
`HTMLElement.onlostpointercapture`
***
### onmousedown
> **onmousedown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12841
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)
#### Inherited from
`HTMLElement.onmousedown`
***
### onmouseenter
> **onmouseenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12843
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)
#### Inherited from
`HTMLElement.onmouseenter`
***
### onmouseleave
> **onmouseleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12845
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)
#### Inherited from
`HTMLElement.onmouseleave`
***
### onmousemove
> **onmousemove**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12847
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)
#### Inherited from
`HTMLElement.onmousemove`
***
### onmouseout
> **onmouseout**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12849
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)
#### Inherited from
`HTMLElement.onmouseout`
***
### onmouseover
> **onmouseover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12851
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)
#### Inherited from
`HTMLElement.onmouseover`
***
### onmouseup
> **onmouseup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12853
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)
#### Inherited from
`HTMLElement.onmouseup`
***
### onpaste
> **onpaste**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12855
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)
#### Inherited from
`HTMLElement.onpaste`
***
### onpause
> **onpause**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12857
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)
#### Inherited from
`HTMLElement.onpause`
***
### onplay
> **onplay**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12859
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)
#### Inherited from
`HTMLElement.onplay`
***
### onplaying
> **onplaying**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12861
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)
#### Inherited from
`HTMLElement.onplaying`
***
### onpointercancel
> **onpointercancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12863
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)
#### Inherited from
`HTMLElement.onpointercancel`
***
### onpointerdown
> **onpointerdown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12865
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)
#### Inherited from
`HTMLElement.onpointerdown`
***
### onpointerenter
> **onpointerenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12867
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)
#### Inherited from
`HTMLElement.onpointerenter`
***
### onpointerleave
> **onpointerleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12869
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)
#### Inherited from
`HTMLElement.onpointerleave`
***
### onpointermove
> **onpointermove**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12871
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)
#### Inherited from
`HTMLElement.onpointermove`
***
### onpointerout
> **onpointerout**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12873
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)
#### Inherited from
`HTMLElement.onpointerout`
***
### onpointerover
> **onpointerover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12875
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)
#### Inherited from
`HTMLElement.onpointerover`
***
### onpointerrawupdate
> **onpointerrawupdate**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12881
Available only in secure contexts.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)
#### Inherited from
`HTMLElement.onpointerrawupdate`
***
### onpointerup
> **onpointerup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12883
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)
#### Inherited from
`HTMLElement.onpointerup`
***
### onprogress
> **onprogress**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12885
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)
#### Inherited from
`HTMLElement.onprogress`
***
### onratechange
> **onratechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12887
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)
#### Inherited from
`HTMLElement.onratechange`
***
### onreset
> **onreset**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12889
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)
#### Inherited from
`HTMLElement.onreset`
***
### onresize
> **onresize**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12891
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)
#### Inherited from
`HTMLElement.onresize`
***
### onscroll
> **onscroll**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12893
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)
#### Inherited from
`HTMLElement.onscroll`
***
### onscrollend
> **onscrollend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12895
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)
#### Inherited from
`HTMLElement.onscrollend`
***
### onsecuritypolicyviolation
> **onsecuritypolicyviolation**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12897
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)
#### Inherited from
`HTMLElement.onsecuritypolicyviolation`
***
### onseeked
> **onseeked**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12899
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)
#### Inherited from
`HTMLElement.onseeked`
***
### onseeking
> **onseeking**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12901
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)
#### Inherited from
`HTMLElement.onseeking`
***
### onselect
> **onselect**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12903
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)
#### Inherited from
`HTMLElement.onselect`
***
### onselectionchange
> **onselectionchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12905
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)
#### Inherited from
`HTMLElement.onselectionchange`
***
### onselectstart
> **onselectstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12907
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)
#### Inherited from
`HTMLElement.onselectstart`
***
### onslotchange
> **onslotchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12909
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)
#### Inherited from
`HTMLElement.onslotchange`
***
### onstalled
> **onstalled**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12911
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)
#### Inherited from
`HTMLElement.onstalled`
***
### onsubmit
> **onsubmit**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12913
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)
#### Inherited from
`HTMLElement.onsubmit`
***
### onsuspend
> **onsuspend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12915
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)
#### Inherited from
`HTMLElement.onsuspend`
***
### ontimeupdate
> **ontimeupdate**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12917
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)
#### Inherited from
`HTMLElement.ontimeupdate`
***
### ontoggle
> **ontoggle**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12919
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)
#### Inherited from
`HTMLElement.ontoggle`
***
### ontouchcancel?
> `optional` **ontouchcancel?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12921
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)
#### Inherited from
`HTMLElement.ontouchcancel`
***
### ontouchend?
> `optional` **ontouchend?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12923
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)
#### Inherited from
`HTMLElement.ontouchend`
***
### ontouchmove?
> `optional` **ontouchmove?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12925
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)
#### Inherited from
`HTMLElement.ontouchmove`
***
### ontouchstart?
> `optional` **ontouchstart?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12927
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)
#### Inherited from
`HTMLElement.ontouchstart`
***
### ontransitioncancel
> **ontransitioncancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12929
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)
#### Inherited from
`HTMLElement.ontransitioncancel`
***
### ontransitionend
> **ontransitionend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12931
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)
#### Inherited from
`HTMLElement.ontransitionend`
***
### ontransitionrun
> **ontransitionrun**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12933
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)
#### Inherited from
`HTMLElement.ontransitionrun`
***
### ontransitionstart
> **ontransitionstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12935
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)
#### Inherited from
`HTMLElement.ontransitionstart`
***
### onvolumechange
> **onvolumechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12937
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)
#### Inherited from
`HTMLElement.onvolumechange`
***
### onwaiting
> **onwaiting**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12939
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)
#### Inherited from
`HTMLElement.onwaiting`
***
### ~~onwebkitanimationend~~
> **onwebkitanimationend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12945
:::caution[Deprecated]
This is a legacy alias of `onanimationend`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationend`
***
### ~~onwebkitanimationiteration~~
> **onwebkitanimationiteration**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12951
:::caution[Deprecated]
This is a legacy alias of `onanimationiteration`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationiteration`
***
### ~~onwebkitanimationstart~~
> **onwebkitanimationstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12957
:::caution[Deprecated]
This is a legacy alias of `onanimationstart`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationstart`
***
### ~~onwebkittransitionend~~
> **onwebkittransitionend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12963
:::caution[Deprecated]
This is a legacy alias of `ontransitionend`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)
:::
#### Inherited from
`HTMLElement.onwebkittransitionend`
***
### onwheel
> **onwheel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12965
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)
#### Inherited from
`HTMLElement.onwheel`
***
### outerHTML
> **outerHTML**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10784
The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)
#### Inherited from
`HTMLElement.outerHTML`
***
### outerText
> **outerText**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13778
The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)
#### Inherited from
`HTMLElement.outerText`
***
### ownerDocument
> `readonly` **ownerDocument**: `Document`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10785
The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)
#### Inherited from
`HTMLElement.ownerDocument`
***
### parentElement
> `readonly` **parentElement**: `HTMLElement` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21724
The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)
#### Inherited from
`HTMLElement.parentElement`
***
### parentNode
> `readonly` **parentNode**: `ParentNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21730
The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)
#### Inherited from
`HTMLElement.parentNode`
***
### placement?
> `optional` **placement?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L8)
#### Inherited from
`ButtonShareProps.placement`
***
### popover
> **popover**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13784
The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)
#### Inherited from
`HTMLElement.popover`
***
### prefix
> `readonly` **prefix**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10798
The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)
#### Inherited from
`HTMLElement.prefix`
***
### preview?
> `optional` **preview?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:51](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L51)
When set, renders the button in preview mode (e.g. Shopify/WP editor).
Skips the client-ready gating so the button is always enabled visually,
and no-ops the click handler so merchants can see the final layout with
their configured copy even when no Frak client is initialized.
#### Inherited from
`ButtonShareProps.preview`
***
### previousElementSibling
> `readonly` **previousElementSibling**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22009
Returns the first preceding sibling that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)
#### Inherited from
`HTMLElement.previousElementSibling`
***
### previousSibling
> `readonly` **previousSibling**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21736
The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)
#### Inherited from
`HTMLElement.previousSibling`
***
### PROCESSING\_INSTRUCTION\_NODE
> `readonly` **PROCESSING\_INSTRUCTION\_NODE**: `7`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21843
node is a ProcessingInstruction node.
#### Inherited from
`HTMLElement.PROCESSING_INSTRUCTION_NODE`
***
### role
> **role**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2709
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)
#### Inherited from
`HTMLElement.role`
***
### scrollHeight
> `readonly` **scrollHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10804
The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)
#### Inherited from
`HTMLElement.scrollHeight`
***
### scrollLeft
> **scrollLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10810
The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)
#### Inherited from
`HTMLElement.scrollLeft`
***
### scrollTop
> **scrollTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10816
The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)
#### Inherited from
`HTMLElement.scrollTop`
***
### scrollWidth
> `readonly` **scrollWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10822
The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)
#### Inherited from
`HTMLElement.scrollWidth`
***
### shadowRoot
> `readonly` **shadowRoot**: `ShadowRoot` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10828
The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)
#### Inherited from
`HTMLElement.shadowRoot`
***
### slot
> **slot**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10834
The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)
#### Inherited from
`HTMLElement.slot`
***
### spellcheck
> **spellcheck**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13790
The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)
#### Inherited from
`HTMLElement.spellcheck`
***
### tabIndex
> **tabIndex**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16071
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)
#### Inherited from
`HTMLElement.tabIndex`
***
### tagName
> `readonly` **tagName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10840
The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)
#### Inherited from
`HTMLElement.tagName`
***
### targetInteraction?
> `optional` **targetInteraction?**: `"referral"` \| `"create_referral_link"` \| `"purchase"` \| `` `custom.${string}` ``
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:34](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L34)
Target interaction behind this sharing action (will be used to get the right reward to display)
#### Inherited from
`ButtonShareProps.targetInteraction`
***
### text?
> `optional` **text?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:21](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L21)
Text to display on the button.
Including the placeholder `{REWARD}` (e.g. `Share and earn up to \{REWARD\}!`)
opts the button into the live reward flow: the SDK fetches the
estimated reward and substitutes the placeholder. When no reward is
available, `noRewardText` is used as a fallback (or the placeholder is
stripped if no fallback is provided).
When omitted, a built-in localized default is used based on the
resolved language (`"Share and earn!"` / `"Partagez et gagnez !"`).
#### Inherited from
`ButtonShareProps.text`
***
### TEXT\_NODE
> `readonly` **TEXT\_NODE**: `3`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21837
node is a Text node.
#### Inherited from
`HTMLElement.TEXT_NODE`
***
### title
> **title**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13796
The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)
#### Inherited from
`HTMLElement.title`
***
### translate
> **translate**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13802
The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)
#### Inherited from
`HTMLElement.translate`
***
### writingSuggestions
> **writingSuggestions**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13808
The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)
#### Inherited from
`HTMLElement.writingSuggestions`
## Accessors
### classList
#### Get Signature
> **get** **classList**(): `DOMTokenList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10713
The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)
##### Returns
`DOMTokenList`
#### Set Signature
> **set** **classList**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10714
##### Parameters
###### value
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.classList`
***
### part
#### Get Signature
> **get** **part**(): `DOMTokenList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10791
The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)
##### Returns
`DOMTokenList`
#### Set Signature
> **set** **part**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10792
##### Parameters
###### value
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.part`
***
### style
#### Get Signature
> **get** **style**(): `CSSStyleDeclaration`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11119
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)
##### Returns
`CSSStyleDeclaration`
#### Set Signature
> **set** **style**(`cssText`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11120
##### Parameters
###### cssText
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.style`
***
### textContent
#### Get Signature
> **get** **textContent**(): `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11102
[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)
##### Returns
`string`
#### Set Signature
> **set** **textContent**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11103
The **`textContent`** property of the Node interface represents the text content of the node and its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/textContent)
##### Parameters
###### value
`string` \| `null`
##### Returns
`void`
#### Inherited from
[`BannerElement`](/developers/references/components/interfaces/bannerelement/).[`textContent`](/developers/references/components/interfaces/bannerelement/#textcontent)
## Methods
### addEventListener()
#### Call Signature
> **addEventListener**\<`K`\>(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13839
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementEventMap`
##### Parameters
###### type
`K`
###### listener
(`this`, `ev`) => `any`
###### options?
`boolean` \| `AddEventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.addEventListener`
#### Call Signature
> **addEventListener**(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13840
##### Parameters
###### type
`string`
###### listener
`EventListenerOrEventListenerObject`
###### options?
`boolean` \| `AddEventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.addEventListener`
***
### after()
> **after**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7953
Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.after`
***
### animate()
> **animate**(`keyframes`, `options?`): `Animation`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2921
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)
#### Parameters
##### keyframes
`Keyframe`[] \| `PropertyIndexedKeyframes` \| `null`
##### options?
`number` \| `KeyframeAnimationOptions`
#### Returns
`Animation`
#### Inherited from
`HTMLElement.animate`
***
### append()
> **append**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22694
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.append`
***
### appendChild()
> **appendChild**\<`T`\>(`node`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21748
The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.appendChild`
***
### attachInternals()
> **attachInternals**(): `ElementInternals`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13814
The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)
#### Returns
`ElementInternals`
#### Inherited from
`HTMLElement.attachInternals`
***
### attachShadow()
> **attachShadow**(`init`): `ShadowRoot`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10846
The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)
#### Parameters
##### init
`ShadowRootInit`
#### Returns
`ShadowRoot`
#### Inherited from
`HTMLElement.attachShadow`
***
### before()
> **before**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7961
Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.before`
***
### blur()
> **blur**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16073
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)
#### Returns
`void`
#### Inherited from
`HTMLElement.blur`
***
### checkVisibility()
> **checkVisibility**(`options?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10852
The **`checkVisibility()`** method of the Element interface checks whether the element is visible.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)
#### Parameters
##### options?
`CheckVisibilityOptions`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.checkVisibility`
***
### click()
> **click**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13820
The **`HTMLElement.click()`** method simulates a mouse click on an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)
#### Returns
`void`
#### Inherited from
`HTMLElement.click`
***
### cloneNode()
> **cloneNode**(`subtree?`): `Node`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21754
The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)
#### Parameters
##### subtree?
`boolean`
#### Returns
`Node`
#### Inherited from
`HTMLElement.cloneNode`
***
### closest()
#### Call Signature
> **closest**\<`K`\>(`selector`): `HTMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10858
The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`HTMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`K`\>(`selector`): `SVGElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10859
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`SVGElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`K`\>(`selector`): `MathMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10860
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`MathMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`E`\>(`selectors`): `E` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10861
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`E` \| `null`
##### Inherited from
`HTMLElement.closest`
***
### compareDocumentPosition()
> **compareDocumentPosition**(`other`): `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21760
The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)
#### Parameters
##### other
`Node`
#### Returns
`number`
#### Inherited from
`HTMLElement.compareDocumentPosition`
***
### computedStyleMap()
> **computedStyleMap**(): `StylePropertyMapReadOnly`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10867
The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)
#### Returns
`StylePropertyMapReadOnly`
#### Inherited from
`HTMLElement.computedStyleMap`
***
### contains()
> **contains**(`other`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21766
The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)
#### Parameters
##### other
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.contains`
***
### dispatchEvent()
> **dispatchEvent**(`event`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11575
The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
#### Parameters
##### event
`Event`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.dispatchEvent`
***
### focus()
> **focus**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16075
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)
#### Parameters
##### options?
`FocusOptions`
#### Returns
`void`
#### Inherited from
`HTMLElement.focus`
***
### getAnimations()
> **getAnimations**(`options?`): `Animation`[]
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2923
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)
#### Parameters
##### options?
`GetAnimationsOptions`
#### Returns
`Animation`[]
#### Inherited from
`HTMLElement.getAnimations`
***
### getAttribute()
> **getAttribute**(`qualifiedName`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10873
The **`getAttribute()`** method of the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.getAttribute`
***
### getAttributeNames()
> **getAttributeNames**(): `string`[]
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10885
The **`getAttributeNames()`** method of the array.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)
#### Returns
`string`[]
#### Inherited from
`HTMLElement.getAttributeNames`
***
### getAttributeNode()
> **getAttributeNode**(`qualifiedName`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10891
Returns the specified attribute of the specified element, as an Attr node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)
#### Parameters
##### qualifiedName
`string`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.getAttributeNode`
***
### getAttributeNodeNS()
> **getAttributeNodeNS**(`namespace`, `localName`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10897
The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.getAttributeNodeNS`
***
### getAttributeNS()
> **getAttributeNS**(`namespace`, `localName`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10879
The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.getAttributeNS`
***
### getBoundingClientRect()
> **getBoundingClientRect**(): `DOMRect`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10903
The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)
#### Returns
`DOMRect`
#### Inherited from
`HTMLElement.getBoundingClientRect`
***
### getClientRects()
> **getClientRects**(): `DOMRectList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10909
The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)
#### Returns
`DOMRectList`
#### Inherited from
`HTMLElement.getClientRects`
***
### getElementsByClassName()
> **getElementsByClassName**(`classNames`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10915
The Element method **`getElementsByClassName()`** returns a live specified class name or names.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)
#### Parameters
##### classNames
`string`
#### Returns
`HTMLCollectionOf`\<`Element`\>
#### Inherited from
`HTMLElement.getElementsByClassName`
***
### getElementsByTagName()
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`HTMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10921
The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`HTMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`SVGElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10922
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`SVGElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`MathMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10923
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`MathMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10925
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**(`qualifiedName`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10926
##### Parameters
###### qualifiedName
`string`
##### Returns
`HTMLCollectionOf`\<`Element`\>
##### Inherited from
`HTMLElement.getElementsByTagName`
***
### getElementsByTagNameNS()
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`HTMLElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10932
The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)
##### Parameters
###### namespaceURI
`"http://www.w3.org/1999/xhtml"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`HTMLElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`SVGElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10933
##### Parameters
###### namespaceURI
`"http://www.w3.org/2000/svg"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`SVGElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`MathMLElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10934
##### Parameters
###### namespaceURI
`"http://www.w3.org/1998/Math/MathML"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`MathMLElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespace`, `localName`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10935
##### Parameters
###### namespace
`string` \| `null`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`Element`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
***
### getHTML()
> **getHTML**(`options?`): `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10941
The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)
#### Parameters
##### options?
`GetHTMLOptions`
#### Returns
`string`
#### Inherited from
`HTMLElement.getHTML`
***
### getRootNode()
> **getRootNode**(`options?`): `Node`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21772
The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)
#### Parameters
##### options?
`GetRootNodeOptions`
#### Returns
`Node`
#### Inherited from
`HTMLElement.getRootNode`
***
### hasAttribute()
> **hasAttribute**(`qualifiedName`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10947
The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttribute`
***
### hasAttributeNS()
> **hasAttributeNS**(`namespace`, `localName`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10953
The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttributeNS`
***
### hasAttributes()
> **hasAttributes**(): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10959
The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttributes`
***
### hasChildNodes()
> **hasChildNodes**(): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21778
The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasChildNodes`
***
### hasPointerCapture()
> **hasPointerCapture**(`pointerId`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10965
The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasPointerCapture`
***
### hidePopover()
> **hidePopover**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13826
The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)
#### Returns
`void`
#### Inherited from
`HTMLElement.hidePopover`
***
### insertAdjacentElement()
> **insertAdjacentElement**(`where`, `element`): `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10971
The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)
#### Parameters
##### where
`InsertPosition`
##### element
`Element`
#### Returns
`Element` \| `null`
#### Inherited from
`HTMLElement.insertAdjacentElement`
***
### insertAdjacentHTML()
> **insertAdjacentHTML**(`position`, `string`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10977
The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)
#### Parameters
##### position
`InsertPosition`
##### string
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.insertAdjacentHTML`
***
### insertAdjacentText()
> **insertAdjacentText**(`where`, `data`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10983
The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)
#### Parameters
##### where
`InsertPosition`
##### data
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.insertAdjacentText`
***
### insertBefore()
> **insertBefore**\<`T`\>(`node`, `child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21784
The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`T`
##### child
`Node` \| `null`
#### Returns
`T`
#### Inherited from
`HTMLElement.insertBefore`
***
### isDefaultNamespace()
> **isDefaultNamespace**(`namespace`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21790
The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)
#### Parameters
##### namespace
`string` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isDefaultNamespace`
***
### isEqualNode()
> **isEqualNode**(`otherNode`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21796
The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)
#### Parameters
##### otherNode
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isEqualNode`
***
### isSameNode()
> **isSameNode**(`otherNode`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21802
The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)
#### Parameters
##### otherNode
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isSameNode`
***
### lookupNamespaceURI()
> **lookupNamespaceURI**(`prefix`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21808
The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)
#### Parameters
##### prefix
`string` \| `null`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.lookupNamespaceURI`
***
### lookupPrefix()
> **lookupPrefix**(`namespace`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21814
The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)
#### Parameters
##### namespace
`string` \| `null`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.lookupPrefix`
***
### matches()
> **matches**(`selectors`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10989
The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)
#### Parameters
##### selectors
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.matches`
***
### normalize()
> **normalize**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21820
The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)
#### Returns
`void`
#### Inherited from
`HTMLElement.normalize`
***
### prepend()
> **prepend**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22702
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.prepend`
***
### querySelector()
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `HTMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22708
Returns the first element that is a descendant of node that matches selectors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`HTMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `SVGElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22709
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`SVGElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `MathMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22710
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`MathMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `HTMLElementDeprecatedTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22712
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`HTMLElementDeprecatedTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`E`\>(`selectors`): `E` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22713
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`E` \| `null`
##### Inherited from
`HTMLElement.querySelector`
***
### querySelectorAll()
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`HTMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22719
Returns all element descendants of node that match selectors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`HTMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`SVGElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22720
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`SVGElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`MathMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22721
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`MathMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22723
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`E`\>(`selectors`): `NodeListOf`\<`E`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22724
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`NodeListOf`\<`E`\>
##### Inherited from
`HTMLElement.querySelectorAll`
***
### releasePointerCapture()
> **releasePointerCapture**(`pointerId`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10995
The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`void`
#### Inherited from
`HTMLElement.releasePointerCapture`
***
### remove()
> **remove**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7967
Removes node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)
#### Returns
`void`
#### Inherited from
`HTMLElement.remove`
***
### removeAttribute()
> **removeAttribute**(`qualifiedName`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11001
The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.removeAttribute`
***
### removeAttributeNode()
> **removeAttributeNode**(`attr`): `Attr`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11013
The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr`
#### Inherited from
`HTMLElement.removeAttributeNode`
***
### removeAttributeNS()
> **removeAttributeNS**(`namespace`, `localName`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11007
The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.removeAttributeNS`
***
### removeChild()
> **removeChild**\<`T`\>(`child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21826
The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### child
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.removeChild`
***
### removeEventListener()
#### Call Signature
> **removeEventListener**\<`K`\>(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13841
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementEventMap`
##### Parameters
###### type
`K`
###### listener
(`this`, `ev`) => `any`
###### options?
`boolean` \| `EventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.removeEventListener`
#### Call Signature
> **removeEventListener**(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13842
##### Parameters
###### type
`string`
###### listener
`EventListenerOrEventListenerObject`
###### options?
`boolean` \| `EventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.removeEventListener`
***
### replaceChild()
> **replaceChild**\<`T`\>(`node`, `child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21832
The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`Node`
##### child
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.replaceChild`
***
### replaceChildren()
> **replaceChildren**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22732
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.replaceChildren`
***
### replaceWith()
> **replaceWith**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7975
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.replaceWith`
***
### requestFullscreen()
> **requestFullscreen**(`options?`): `Promise`\<`void`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11019
The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)
#### Parameters
##### options?
`FullscreenOptions`
#### Returns
`Promise`\<`void`\>
#### Inherited from
`HTMLElement.requestFullscreen`
***
### requestPointerLock()
> **requestPointerLock**(`options?`): `Promise`\<`void`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11025
The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)
#### Parameters
##### options?
`PointerLockOptions`
#### Returns
`Promise`\<`void`\>
#### Inherited from
`HTMLElement.requestPointerLock`
***
### scroll()
#### Call Signature
> **scroll**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11031
The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scroll`
#### Call Signature
> **scroll**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11032
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scroll`
***
### scrollBy()
#### Call Signature
> **scrollBy**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11038
The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollBy`
#### Call Signature
> **scrollBy**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11039
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollBy`
***
### scrollIntoView()
> **scrollIntoView**(`arg?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11045
The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)
#### Parameters
##### arg?
`boolean` \| `ScrollIntoViewOptions`
#### Returns
`void`
#### Inherited from
`HTMLElement.scrollIntoView`
***
### scrollTo()
#### Call Signature
> **scrollTo**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11051
The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollTo`
#### Call Signature
> **scrollTo**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11052
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollTo`
***
### setAttribute()
> **setAttribute**(`qualifiedName`, `value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11058
The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)
#### Parameters
##### qualifiedName
`string`
##### value
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setAttribute`
***
### setAttributeNode()
> **setAttributeNode**(`attr`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11070
The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.setAttributeNode`
***
### setAttributeNodeNS()
> **setAttributeNodeNS**(`attr`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11076
The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.setAttributeNodeNS`
***
### setAttributeNS()
> **setAttributeNS**(`namespace`, `qualifiedName`, `value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11064
`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### qualifiedName
`string`
##### value
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setAttributeNS`
***
### setHTMLUnsafe()
> **setHTMLUnsafe**(`html`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11082
The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)
#### Parameters
##### html
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setHTMLUnsafe`
***
### setPointerCapture()
> **setPointerCapture**(`pointerId`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11088
The **`setPointerCapture()`** method of the _capture target_ of future pointer events.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`void`
#### Inherited from
`HTMLElement.setPointerCapture`
***
### showPopover()
> **showPopover**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13832
The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)
#### Returns
`void`
#### Inherited from
`HTMLElement.showPopover`
***
### toggleAttribute()
> **toggleAttribute**(`qualifiedName`, `force?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11094
The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)
#### Parameters
##### qualifiedName
`string`
##### force?
`boolean`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.toggleAttribute`
***
### togglePopover()
> **togglePopover**(`options?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13838
The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)
#### Parameters
##### options?
`boolean`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.togglePopover`
***
### ~~webkitMatchesSelector()~~
> **webkitMatchesSelector**(`selectors`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11100
:::caution[Deprecated]
This is a legacy alias of `matches`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)
:::
#### Parameters
##### selectors
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.webkitMatchesSelector`
# ButtonWalletElement
Defined in: [vendor/wallet/sdk/components/src/components/ButtonWallet/index.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonWallet/index.ts#L11)
Custom element interface for ``.
Combines standard HTMLElement with [ButtonWalletProps](/developers/references/components/type-aliases/buttonwalletprops/).
## Extends
- `HTMLElement`.[`ButtonWalletProps`](/developers/references/components/type-aliases/buttonwalletprops/)
## Properties
### accessKey
> **accessKey**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13688
The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)
#### Inherited from
`HTMLElement.accessKey`
***
### accessKeyLabel
> `readonly` **accessKeyLabel**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13694
The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)
#### Inherited from
`HTMLElement.accessKeyLabel`
***
### ariaActiveDescendantElement
> **ariaActiveDescendantElement**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2607
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)
#### Inherited from
`HTMLElement.ariaActiveDescendantElement`
***
### ariaAtomic
> **ariaAtomic**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2609
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)
#### Inherited from
`HTMLElement.ariaAtomic`
***
### ariaAutoComplete
> **ariaAutoComplete**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2611
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)
#### Inherited from
`HTMLElement.ariaAutoComplete`
***
### ariaBrailleLabel
> **ariaBrailleLabel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2613
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)
#### Inherited from
`HTMLElement.ariaBrailleLabel`
***
### ariaBrailleRoleDescription
> **ariaBrailleRoleDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2615
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)
#### Inherited from
`HTMLElement.ariaBrailleRoleDescription`
***
### ariaBusy
> **ariaBusy**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2617
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)
#### Inherited from
`HTMLElement.ariaBusy`
***
### ariaChecked
> **ariaChecked**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2619
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)
#### Inherited from
`HTMLElement.ariaChecked`
***
### ariaColCount
> **ariaColCount**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2621
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)
#### Inherited from
`HTMLElement.ariaColCount`
***
### ariaColIndex
> **ariaColIndex**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2623
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)
#### Inherited from
`HTMLElement.ariaColIndex`
***
### ariaColIndexText
> **ariaColIndexText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2625
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)
#### Inherited from
`HTMLElement.ariaColIndexText`
***
### ariaColSpan
> **ariaColSpan**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2627
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)
#### Inherited from
`HTMLElement.ariaColSpan`
***
### ariaControlsElements
> **ariaControlsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2629
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)
#### Inherited from
`HTMLElement.ariaControlsElements`
***
### ariaCurrent
> **ariaCurrent**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2631
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)
#### Inherited from
`HTMLElement.ariaCurrent`
***
### ariaDescribedByElements
> **ariaDescribedByElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2633
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)
#### Inherited from
`HTMLElement.ariaDescribedByElements`
***
### ariaDescription
> **ariaDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2635
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)
#### Inherited from
`HTMLElement.ariaDescription`
***
### ariaDetailsElements
> **ariaDetailsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2637
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)
#### Inherited from
`HTMLElement.ariaDetailsElements`
***
### ariaDisabled
> **ariaDisabled**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2639
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)
#### Inherited from
`HTMLElement.ariaDisabled`
***
### ariaErrorMessageElements
> **ariaErrorMessageElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2641
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)
#### Inherited from
`HTMLElement.ariaErrorMessageElements`
***
### ariaExpanded
> **ariaExpanded**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2643
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)
#### Inherited from
`HTMLElement.ariaExpanded`
***
### ariaFlowToElements
> **ariaFlowToElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2645
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)
#### Inherited from
`HTMLElement.ariaFlowToElements`
***
### ariaHasPopup
> **ariaHasPopup**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2647
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)
#### Inherited from
`HTMLElement.ariaHasPopup`
***
### ariaHidden
> **ariaHidden**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2649
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)
#### Inherited from
`HTMLElement.ariaHidden`
***
### ariaInvalid
> **ariaInvalid**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2651
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)
#### Inherited from
`HTMLElement.ariaInvalid`
***
### ariaKeyShortcuts
> **ariaKeyShortcuts**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2653
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)
#### Inherited from
`HTMLElement.ariaKeyShortcuts`
***
### ariaLabel
> **ariaLabel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2655
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)
#### Inherited from
`HTMLElement.ariaLabel`
***
### ariaLabelledByElements
> **ariaLabelledByElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2657
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)
#### Inherited from
`HTMLElement.ariaLabelledByElements`
***
### ariaLevel
> **ariaLevel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2659
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)
#### Inherited from
`HTMLElement.ariaLevel`
***
### ariaLive
> **ariaLive**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2661
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)
#### Inherited from
`HTMLElement.ariaLive`
***
### ariaModal
> **ariaModal**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2663
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)
#### Inherited from
`HTMLElement.ariaModal`
***
### ariaMultiLine
> **ariaMultiLine**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2665
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)
#### Inherited from
`HTMLElement.ariaMultiLine`
***
### ariaMultiSelectable
> **ariaMultiSelectable**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2667
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)
#### Inherited from
`HTMLElement.ariaMultiSelectable`
***
### ariaOrientation
> **ariaOrientation**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2669
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)
#### Inherited from
`HTMLElement.ariaOrientation`
***
### ariaOwnsElements
> **ariaOwnsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2671
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)
#### Inherited from
`HTMLElement.ariaOwnsElements`
***
### ariaPlaceholder
> **ariaPlaceholder**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2673
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)
#### Inherited from
`HTMLElement.ariaPlaceholder`
***
### ariaPosInSet
> **ariaPosInSet**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2675
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)
#### Inherited from
`HTMLElement.ariaPosInSet`
***
### ariaPressed
> **ariaPressed**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2677
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)
#### Inherited from
`HTMLElement.ariaPressed`
***
### ariaReadOnly
> **ariaReadOnly**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2679
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)
#### Inherited from
`HTMLElement.ariaReadOnly`
***
### ariaRelevant
> **ariaRelevant**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2681
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)
#### Inherited from
`HTMLElement.ariaRelevant`
***
### ariaRequired
> **ariaRequired**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2683
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)
#### Inherited from
`HTMLElement.ariaRequired`
***
### ariaRoleDescription
> **ariaRoleDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2685
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)
#### Inherited from
`HTMLElement.ariaRoleDescription`
***
### ariaRowCount
> **ariaRowCount**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2687
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)
#### Inherited from
`HTMLElement.ariaRowCount`
***
### ariaRowIndex
> **ariaRowIndex**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2689
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)
#### Inherited from
`HTMLElement.ariaRowIndex`
***
### ariaRowIndexText
> **ariaRowIndexText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2691
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)
#### Inherited from
`HTMLElement.ariaRowIndexText`
***
### ariaRowSpan
> **ariaRowSpan**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2693
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)
#### Inherited from
`HTMLElement.ariaRowSpan`
***
### ariaSelected
> **ariaSelected**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2695
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)
#### Inherited from
`HTMLElement.ariaSelected`
***
### ariaSetSize
> **ariaSetSize**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2697
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)
#### Inherited from
`HTMLElement.ariaSetSize`
***
### ariaSort
> **ariaSort**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2699
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)
#### Inherited from
`HTMLElement.ariaSort`
***
### ariaValueMax
> **ariaValueMax**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2701
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)
#### Inherited from
`HTMLElement.ariaValueMax`
***
### ariaValueMin
> **ariaValueMin**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2703
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)
#### Inherited from
`HTMLElement.ariaValueMin`
***
### ariaValueNow
> **ariaValueNow**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2705
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)
#### Inherited from
`HTMLElement.ariaValueNow`
***
### ariaValueText
> **ariaValueText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2707
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)
#### Inherited from
`HTMLElement.ariaValueText`
***
### assignedSlot
> `readonly` **assignedSlot**: `HTMLSlotElement` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:30826
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)
#### Inherited from
`HTMLElement.assignedSlot`
***
### ATTRIBUTE\_NODE
> `readonly` **ATTRIBUTE\_NODE**: `2`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21835
#### Inherited from
`HTMLElement.ATTRIBUTE_NODE`
***
### attributes
> `readonly` **attributes**: `NamedNodeMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10707
The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)
#### Inherited from
`HTMLElement.attributes`
***
### attributeStyleMap
> `readonly` **attributeStyleMap**: `StylePropertyMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11117
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)
#### Inherited from
`HTMLElement.attributeStyleMap`
***
### autocapitalize
> **autocapitalize**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13700
The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)
#### Inherited from
`HTMLElement.autocapitalize`
***
### autocorrect
> **autocorrect**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13706
The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)
#### Inherited from
`HTMLElement.autocorrect`
***
### autofocus
> **autofocus**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16065
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)
#### Inherited from
`HTMLElement.autofocus`
***
### baseURI
> `readonly` **baseURI**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21664
The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)
#### Inherited from
`HTMLElement.baseURI`
***
### CDATA\_SECTION\_NODE
> `readonly` **CDATA\_SECTION\_NODE**: `4`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21839
node is a CDATASection node.
#### Inherited from
`HTMLElement.CDATA_SECTION_NODE`
***
### childElementCount
> `readonly` **childElementCount**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22668
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)
#### Inherited from
`HTMLElement.childElementCount`
***
### childNodes
> `readonly` **childNodes**: `NodeListOf`\<`ChildNode`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21670
The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)
#### Inherited from
`HTMLElement.childNodes`
***
### children
> `readonly` **children**: `HTMLCollection`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22674
Returns the child elements.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)
#### Inherited from
`HTMLElement.children`
***
### classname?
> `optional` **classname?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonWallet/types.ts:12](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonWallet/types.ts#L12)
Classname to apply to the button
#### Inherited from
`ButtonWalletProps.classname`
***
### className
> **className**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10720
The **`className`** property of the of the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)
#### Inherited from
`HTMLElement.className`
***
### clientHeight
> `readonly` **clientHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10726
The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)
#### Inherited from
`HTMLElement.clientHeight`
***
### clientLeft
> `readonly` **clientLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10732
The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)
#### Inherited from
`HTMLElement.clientLeft`
***
### clientTop
> `readonly` **clientTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10738
The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)
#### Inherited from
`HTMLElement.clientTop`
***
### clientWidth
> `readonly` **clientWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10744
The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)
#### Inherited from
`HTMLElement.clientWidth`
***
### COMMENT\_NODE
> `readonly` **COMMENT\_NODE**: `8`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21845
node is a Comment node.
#### Inherited from
`HTMLElement.COMMENT_NODE`
***
### contentEditable
> **contentEditable**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11125
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)
#### Inherited from
`HTMLElement.contentEditable`
***
### currentCSSZoom
> `readonly` **currentCSSZoom**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10750
The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)
#### Inherited from
`HTMLElement.currentCSSZoom`
***
### dataset
> `readonly` **dataset**: `DOMStringMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16067
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)
#### Inherited from
`HTMLElement.dataset`
***
### dir
> **dir**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13712
The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)
#### Inherited from
`HTMLElement.dir`
***
### DOCUMENT\_FRAGMENT\_NODE
> `readonly` **DOCUMENT\_FRAGMENT\_NODE**: `11`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21851
node is a DocumentFragment node.
#### Inherited from
`HTMLElement.DOCUMENT_FRAGMENT_NODE`
***
### DOCUMENT\_NODE
> `readonly` **DOCUMENT\_NODE**: `9`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21847
node is a document.
#### Inherited from
`HTMLElement.DOCUMENT_NODE`
***
### DOCUMENT\_POSITION\_CONTAINED\_BY
> `readonly` **DOCUMENT\_POSITION\_CONTAINED\_BY**: `16`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21862
Set when other is a descendant of node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_CONTAINED_BY`
***
### DOCUMENT\_POSITION\_CONTAINS
> `readonly` **DOCUMENT\_POSITION\_CONTAINS**: `8`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21860
Set when other is an ancestor of node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_CONTAINS`
***
### DOCUMENT\_POSITION\_DISCONNECTED
> `readonly` **DOCUMENT\_POSITION\_DISCONNECTED**: `1`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21854
Set when node and other are not in the same tree.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_DISCONNECTED`
***
### DOCUMENT\_POSITION\_FOLLOWING
> `readonly` **DOCUMENT\_POSITION\_FOLLOWING**: `4`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21858
Set when other is following node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_FOLLOWING`
***
### DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC
> `readonly` **DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC**: `32`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21863
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC`
***
### DOCUMENT\_POSITION\_PRECEDING
> `readonly` **DOCUMENT\_POSITION\_PRECEDING**: `2`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21856
Set when other is preceding node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_PRECEDING`
***
### DOCUMENT\_TYPE\_NODE
> `readonly` **DOCUMENT\_TYPE\_NODE**: `10`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21849
node is a doctype.
#### Inherited from
`HTMLElement.DOCUMENT_TYPE_NODE`
***
### draggable
> **draggable**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13718
The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)
#### Inherited from
`HTMLElement.draggable`
***
### ELEMENT\_NODE
> `readonly` **ELEMENT\_NODE**: `1`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21834
node is an element.
#### Inherited from
`HTMLElement.ELEMENT_NODE`
***
### enterKeyHint
> **enterKeyHint**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11127
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)
#### Inherited from
`HTMLElement.enterKeyHint`
***
### ENTITY\_NODE
> `readonly` **ENTITY\_NODE**: `6`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21841
#### Inherited from
`HTMLElement.ENTITY_NODE`
***
### ENTITY\_REFERENCE\_NODE
> `readonly` **ENTITY\_REFERENCE\_NODE**: `5`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21840
#### Inherited from
`HTMLElement.ENTITY_REFERENCE_NODE`
***
### firstChild
> `readonly` **firstChild**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21676
The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)
#### Inherited from
`HTMLElement.firstChild`
***
### firstElementChild
> `readonly` **firstElementChild**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22680
Returns the first child that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)
#### Inherited from
`HTMLElement.firstElementChild`
***
### hidden
> **hidden**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13724
The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)
#### Inherited from
`HTMLElement.hidden`
***
### id
> **id**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10756
The **`id`** property of the Element interface represents the element's identifier, reflecting the **`id`** global attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/id)
#### Inherited from
`HTMLElement.id`
***
### inert
> **inert**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13730
The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)
#### Inherited from
`HTMLElement.inert`
***
### innerHTML
> **innerHTML**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10762
The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)
#### Inherited from
`HTMLElement.innerHTML`
***
### innerText
> **innerText**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13736
The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)
#### Inherited from
`HTMLElement.innerText`
***
### inputMode
> **inputMode**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11129
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)
#### Inherited from
`HTMLElement.inputMode`
***
### isConnected
> `readonly` **isConnected**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21682
The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)
#### Inherited from
`HTMLElement.isConnected`
***
### isContentEditable
> `readonly` **isContentEditable**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11131
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)
#### Inherited from
`HTMLElement.isContentEditable`
***
### lang
> **lang**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13742
The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)
#### Inherited from
`HTMLElement.lang`
***
### lastChild
> `readonly` **lastChild**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21688
The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)
#### Inherited from
`HTMLElement.lastChild`
***
### lastElementChild
> `readonly` **lastElementChild**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22686
Returns the last child that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)
#### Inherited from
`HTMLElement.lastElementChild`
***
### localName
> `readonly` **localName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10768
The **`Element.localName`** read-only property returns the local part of the qualified name of an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)
#### Inherited from
`HTMLElement.localName`
***
### namespaceURI
> `readonly` **namespaceURI**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10774
The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)
#### Inherited from
`HTMLElement.namespaceURI`
***
### nextElementSibling
> `readonly` **nextElementSibling**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22003
Returns the first following sibling that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)
#### Inherited from
`HTMLElement.nextElementSibling`
***
### nextSibling
> `readonly` **nextSibling**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21694
The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)
#### Inherited from
`HTMLElement.nextSibling`
***
### nodeName
> `readonly` **nodeName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21700
The read-only **`nodeName`** property of Node returns the name of the current node as a string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)
#### Inherited from
`HTMLElement.nodeName`
***
### nodeType
> `readonly` **nodeType**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21706
The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)
#### Inherited from
`HTMLElement.nodeType`
***
### nodeValue
> **nodeValue**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21712
The **`nodeValue`** property of the Node interface returns or sets the value of the current node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)
#### Inherited from
`HTMLElement.nodeValue`
***
### nonce?
> `optional` **nonce?**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16069
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)
#### Inherited from
`HTMLElement.nonce`
***
### NOTATION\_NODE
> `readonly` **NOTATION\_NODE**: `12`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21852
#### Inherited from
`HTMLElement.NOTATION_NODE`
***
### offsetHeight
> `readonly` **offsetHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13748
The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)
#### Inherited from
`HTMLElement.offsetHeight`
***
### offsetLeft
> `readonly` **offsetLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13754
The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)
#### Inherited from
`HTMLElement.offsetLeft`
***
### offsetParent
> `readonly` **offsetParent**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13760
The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)
#### Inherited from
`HTMLElement.offsetParent`
***
### offsetTop
> `readonly` **offsetTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13766
The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)
#### Inherited from
`HTMLElement.offsetTop`
***
### offsetWidth
> `readonly` **offsetWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13772
The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)
#### Inherited from
`HTMLElement.offsetWidth`
***
### onabort
> **onabort**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12743
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)
#### Inherited from
`HTMLElement.onabort`
***
### onanimationcancel
> **onanimationcancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12745
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)
#### Inherited from
`HTMLElement.onanimationcancel`
***
### onanimationend
> **onanimationend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12747
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)
#### Inherited from
`HTMLElement.onanimationend`
***
### onanimationiteration
> **onanimationiteration**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12749
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)
#### Inherited from
`HTMLElement.onanimationiteration`
***
### onanimationstart
> **onanimationstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12751
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)
#### Inherited from
`HTMLElement.onanimationstart`
***
### onauxclick
> **onauxclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12753
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)
#### Inherited from
`HTMLElement.onauxclick`
***
### onbeforeinput
> **onbeforeinput**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12755
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)
#### Inherited from
`HTMLElement.onbeforeinput`
***
### onbeforematch
> **onbeforematch**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12757
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)
#### Inherited from
`HTMLElement.onbeforematch`
***
### onbeforetoggle
> **onbeforetoggle**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12759
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)
#### Inherited from
`HTMLElement.onbeforetoggle`
***
### onblur
> **onblur**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12761
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)
#### Inherited from
`HTMLElement.onblur`
***
### oncancel
> **oncancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12763
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)
#### Inherited from
`HTMLElement.oncancel`
***
### oncanplay
> **oncanplay**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12765
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)
#### Inherited from
`HTMLElement.oncanplay`
***
### oncanplaythrough
> **oncanplaythrough**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12767
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)
#### Inherited from
`HTMLElement.oncanplaythrough`
***
### onchange
> **onchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12769
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)
#### Inherited from
`HTMLElement.onchange`
***
### onclick
> **onclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12771
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)
#### Inherited from
`HTMLElement.onclick`
***
### onclose
> **onclose**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12773
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)
#### Inherited from
`HTMLElement.onclose`
***
### oncontextlost
> **oncontextlost**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12775
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)
#### Inherited from
`HTMLElement.oncontextlost`
***
### oncontextmenu
> **oncontextmenu**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12777
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)
#### Inherited from
`HTMLElement.oncontextmenu`
***
### oncontextrestored
> **oncontextrestored**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12779
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)
#### Inherited from
`HTMLElement.oncontextrestored`
***
### oncopy
> **oncopy**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12781
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)
#### Inherited from
`HTMLElement.oncopy`
***
### oncuechange
> **oncuechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12783
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)
#### Inherited from
`HTMLElement.oncuechange`
***
### oncut
> **oncut**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12785
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)
#### Inherited from
`HTMLElement.oncut`
***
### ondblclick
> **ondblclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12787
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)
#### Inherited from
`HTMLElement.ondblclick`
***
### ondrag
> **ondrag**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12789
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)
#### Inherited from
`HTMLElement.ondrag`
***
### ondragend
> **ondragend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12791
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)
#### Inherited from
`HTMLElement.ondragend`
***
### ondragenter
> **ondragenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12793
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)
#### Inherited from
`HTMLElement.ondragenter`
***
### ondragleave
> **ondragleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12795
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)
#### Inherited from
`HTMLElement.ondragleave`
***
### ondragover
> **ondragover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12797
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)
#### Inherited from
`HTMLElement.ondragover`
***
### ondragstart
> **ondragstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12799
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)
#### Inherited from
`HTMLElement.ondragstart`
***
### ondrop
> **ondrop**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12801
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)
#### Inherited from
`HTMLElement.ondrop`
***
### ondurationchange
> **ondurationchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12803
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)
#### Inherited from
`HTMLElement.ondurationchange`
***
### onemptied
> **onemptied**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12805
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)
#### Inherited from
`HTMLElement.onemptied`
***
### onended
> **onended**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12807
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)
#### Inherited from
`HTMLElement.onended`
***
### onerror
> **onerror**: `OnErrorEventHandler`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12809
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)
#### Inherited from
`HTMLElement.onerror`
***
### onfocus
> **onfocus**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12811
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)
#### Inherited from
`HTMLElement.onfocus`
***
### onformdata
> **onformdata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12813
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)
#### Inherited from
`HTMLElement.onformdata`
***
### onfullscreenchange
> **onfullscreenchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10776
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)
#### Inherited from
`HTMLElement.onfullscreenchange`
***
### onfullscreenerror
> **onfullscreenerror**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10778
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)
#### Inherited from
`HTMLElement.onfullscreenerror`
***
### ongotpointercapture
> **ongotpointercapture**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12815
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)
#### Inherited from
`HTMLElement.ongotpointercapture`
***
### oninput
> **oninput**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12817
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)
#### Inherited from
`HTMLElement.oninput`
***
### oninvalid
> **oninvalid**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12819
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)
#### Inherited from
`HTMLElement.oninvalid`
***
### onkeydown
> **onkeydown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12821
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)
#### Inherited from
`HTMLElement.onkeydown`
***
### ~~onkeypress~~
> **onkeypress**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12827
:::caution[Deprecated]
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)
:::
#### Inherited from
`HTMLElement.onkeypress`
***
### onkeyup
> **onkeyup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12829
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)
#### Inherited from
`HTMLElement.onkeyup`
***
### onload
> **onload**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12831
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)
#### Inherited from
`HTMLElement.onload`
***
### onloadeddata
> **onloadeddata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12833
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)
#### Inherited from
`HTMLElement.onloadeddata`
***
### onloadedmetadata
> **onloadedmetadata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12835
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)
#### Inherited from
`HTMLElement.onloadedmetadata`
***
### onloadstart
> **onloadstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12837
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)
#### Inherited from
`HTMLElement.onloadstart`
***
### onlostpointercapture
> **onlostpointercapture**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12839
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)
#### Inherited from
`HTMLElement.onlostpointercapture`
***
### onmousedown
> **onmousedown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12841
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)
#### Inherited from
`HTMLElement.onmousedown`
***
### onmouseenter
> **onmouseenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12843
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)
#### Inherited from
`HTMLElement.onmouseenter`
***
### onmouseleave
> **onmouseleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12845
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)
#### Inherited from
`HTMLElement.onmouseleave`
***
### onmousemove
> **onmousemove**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12847
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)
#### Inherited from
`HTMLElement.onmousemove`
***
### onmouseout
> **onmouseout**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12849
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)
#### Inherited from
`HTMLElement.onmouseout`
***
### onmouseover
> **onmouseover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12851
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)
#### Inherited from
`HTMLElement.onmouseover`
***
### onmouseup
> **onmouseup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12853
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)
#### Inherited from
`HTMLElement.onmouseup`
***
### onpaste
> **onpaste**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12855
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)
#### Inherited from
`HTMLElement.onpaste`
***
### onpause
> **onpause**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12857
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)
#### Inherited from
`HTMLElement.onpause`
***
### onplay
> **onplay**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12859
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)
#### Inherited from
`HTMLElement.onplay`
***
### onplaying
> **onplaying**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12861
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)
#### Inherited from
`HTMLElement.onplaying`
***
### onpointercancel
> **onpointercancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12863
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)
#### Inherited from
`HTMLElement.onpointercancel`
***
### onpointerdown
> **onpointerdown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12865
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)
#### Inherited from
`HTMLElement.onpointerdown`
***
### onpointerenter
> **onpointerenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12867
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)
#### Inherited from
`HTMLElement.onpointerenter`
***
### onpointerleave
> **onpointerleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12869
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)
#### Inherited from
`HTMLElement.onpointerleave`
***
### onpointermove
> **onpointermove**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12871
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)
#### Inherited from
`HTMLElement.onpointermove`
***
### onpointerout
> **onpointerout**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12873
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)
#### Inherited from
`HTMLElement.onpointerout`
***
### onpointerover
> **onpointerover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12875
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)
#### Inherited from
`HTMLElement.onpointerover`
***
### onpointerrawupdate
> **onpointerrawupdate**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12881
Available only in secure contexts.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)
#### Inherited from
`HTMLElement.onpointerrawupdate`
***
### onpointerup
> **onpointerup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12883
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)
#### Inherited from
`HTMLElement.onpointerup`
***
### onprogress
> **onprogress**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12885
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)
#### Inherited from
`HTMLElement.onprogress`
***
### onratechange
> **onratechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12887
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)
#### Inherited from
`HTMLElement.onratechange`
***
### onreset
> **onreset**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12889
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)
#### Inherited from
`HTMLElement.onreset`
***
### onresize
> **onresize**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12891
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)
#### Inherited from
`HTMLElement.onresize`
***
### onscroll
> **onscroll**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12893
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)
#### Inherited from
`HTMLElement.onscroll`
***
### onscrollend
> **onscrollend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12895
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)
#### Inherited from
`HTMLElement.onscrollend`
***
### onsecuritypolicyviolation
> **onsecuritypolicyviolation**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12897
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)
#### Inherited from
`HTMLElement.onsecuritypolicyviolation`
***
### onseeked
> **onseeked**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12899
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)
#### Inherited from
`HTMLElement.onseeked`
***
### onseeking
> **onseeking**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12901
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)
#### Inherited from
`HTMLElement.onseeking`
***
### onselect
> **onselect**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12903
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)
#### Inherited from
`HTMLElement.onselect`
***
### onselectionchange
> **onselectionchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12905
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)
#### Inherited from
`HTMLElement.onselectionchange`
***
### onselectstart
> **onselectstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12907
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)
#### Inherited from
`HTMLElement.onselectstart`
***
### onslotchange
> **onslotchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12909
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)
#### Inherited from
`HTMLElement.onslotchange`
***
### onstalled
> **onstalled**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12911
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)
#### Inherited from
`HTMLElement.onstalled`
***
### onsubmit
> **onsubmit**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12913
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)
#### Inherited from
`HTMLElement.onsubmit`
***
### onsuspend
> **onsuspend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12915
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)
#### Inherited from
`HTMLElement.onsuspend`
***
### ontimeupdate
> **ontimeupdate**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12917
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)
#### Inherited from
`HTMLElement.ontimeupdate`
***
### ontoggle
> **ontoggle**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12919
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)
#### Inherited from
`HTMLElement.ontoggle`
***
### ontouchcancel?
> `optional` **ontouchcancel?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12921
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)
#### Inherited from
`HTMLElement.ontouchcancel`
***
### ontouchend?
> `optional` **ontouchend?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12923
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)
#### Inherited from
`HTMLElement.ontouchend`
***
### ontouchmove?
> `optional` **ontouchmove?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12925
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)
#### Inherited from
`HTMLElement.ontouchmove`
***
### ontouchstart?
> `optional` **ontouchstart?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12927
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)
#### Inherited from
`HTMLElement.ontouchstart`
***
### ontransitioncancel
> **ontransitioncancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12929
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)
#### Inherited from
`HTMLElement.ontransitioncancel`
***
### ontransitionend
> **ontransitionend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12931
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)
#### Inherited from
`HTMLElement.ontransitionend`
***
### ontransitionrun
> **ontransitionrun**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12933
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)
#### Inherited from
`HTMLElement.ontransitionrun`
***
### ontransitionstart
> **ontransitionstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12935
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)
#### Inherited from
`HTMLElement.ontransitionstart`
***
### onvolumechange
> **onvolumechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12937
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)
#### Inherited from
`HTMLElement.onvolumechange`
***
### onwaiting
> **onwaiting**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12939
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)
#### Inherited from
`HTMLElement.onwaiting`
***
### ~~onwebkitanimationend~~
> **onwebkitanimationend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12945
:::caution[Deprecated]
This is a legacy alias of `onanimationend`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationend`
***
### ~~onwebkitanimationiteration~~
> **onwebkitanimationiteration**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12951
:::caution[Deprecated]
This is a legacy alias of `onanimationiteration`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationiteration`
***
### ~~onwebkitanimationstart~~
> **onwebkitanimationstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12957
:::caution[Deprecated]
This is a legacy alias of `onanimationstart`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationstart`
***
### ~~onwebkittransitionend~~
> **onwebkittransitionend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12963
:::caution[Deprecated]
This is a legacy alias of `ontransitionend`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)
:::
#### Inherited from
`HTMLElement.onwebkittransitionend`
***
### onwheel
> **onwheel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12965
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)
#### Inherited from
`HTMLElement.onwheel`
***
### outerHTML
> **outerHTML**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10784
The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)
#### Inherited from
`HTMLElement.outerHTML`
***
### outerText
> **outerText**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13778
The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)
#### Inherited from
`HTMLElement.outerText`
***
### ownerDocument
> `readonly` **ownerDocument**: `Document`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10785
The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)
#### Inherited from
`HTMLElement.ownerDocument`
***
### parentElement
> `readonly` **parentElement**: `HTMLElement` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21724
The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)
#### Inherited from
`HTMLElement.parentElement`
***
### parentNode
> `readonly` **parentNode**: `ParentNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21730
The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)
#### Inherited from
`HTMLElement.parentNode`
***
### placement?
> `optional` **placement?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonWallet/types.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonWallet/types.ts#L8)
#### Inherited from
`ButtonWalletProps.placement`
***
### popover
> **popover**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13784
The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)
#### Inherited from
`HTMLElement.popover`
***
### prefix
> `readonly` **prefix**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10798
The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)
#### Inherited from
`HTMLElement.prefix`
***
### previousElementSibling
> `readonly` **previousElementSibling**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22009
Returns the first preceding sibling that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)
#### Inherited from
`HTMLElement.previousElementSibling`
***
### previousSibling
> `readonly` **previousSibling**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21736
The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)
#### Inherited from
`HTMLElement.previousSibling`
***
### PROCESSING\_INSTRUCTION\_NODE
> `readonly` **PROCESSING\_INSTRUCTION\_NODE**: `7`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21843
node is a ProcessingInstruction node.
#### Inherited from
`HTMLElement.PROCESSING_INSTRUCTION_NODE`
***
### role
> **role**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2709
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)
#### Inherited from
`HTMLElement.role`
***
### scrollHeight
> `readonly` **scrollHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10804
The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)
#### Inherited from
`HTMLElement.scrollHeight`
***
### scrollLeft
> **scrollLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10810
The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)
#### Inherited from
`HTMLElement.scrollLeft`
***
### scrollTop
> **scrollTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10816
The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)
#### Inherited from
`HTMLElement.scrollTop`
***
### scrollWidth
> `readonly` **scrollWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10822
The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)
#### Inherited from
`HTMLElement.scrollWidth`
***
### shadowRoot
> `readonly` **shadowRoot**: `ShadowRoot` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10828
The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)
#### Inherited from
`HTMLElement.shadowRoot`
***
### slot
> **slot**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10834
The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)
#### Inherited from
`HTMLElement.slot`
***
### spellcheck
> **spellcheck**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13790
The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)
#### Inherited from
`HTMLElement.spellcheck`
***
### tabIndex
> **tabIndex**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16071
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)
#### Inherited from
`HTMLElement.tabIndex`
***
### tagName
> `readonly` **tagName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10840
The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)
#### Inherited from
`HTMLElement.tagName`
***
### targetInteraction?
> `optional` **targetInteraction?**: `"referral"` \| `"create_referral_link"` \| `"purchase"` \| `` `custom.${string}` ``
Defined in: [vendor/wallet/sdk/components/src/components/ButtonWallet/types.ts:21](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonWallet/types.ts#L21)
Target interaction behind this sharing action (will be used to get the right reward to display)
#### Inherited from
`ButtonWalletProps.targetInteraction`
***
### TEXT\_NODE
> `readonly` **TEXT\_NODE**: `3`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21837
node is a Text node.
#### Inherited from
`HTMLElement.TEXT_NODE`
***
### title
> **title**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13796
The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)
#### Inherited from
`HTMLElement.title`
***
### translate
> **translate**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13802
The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)
#### Inherited from
`HTMLElement.translate`
***
### useReward?
> `optional` **useReward?**: `boolean`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonWallet/types.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonWallet/types.ts#L17)
Do we display the reward on the button?
#### Default Value
`false`
#### Inherited from
`ButtonWalletProps.useReward`
***
### writingSuggestions
> **writingSuggestions**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13808
The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)
#### Inherited from
`HTMLElement.writingSuggestions`
## Accessors
### classList
#### Get Signature
> **get** **classList**(): `DOMTokenList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10713
The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)
##### Returns
`DOMTokenList`
#### Set Signature
> **set** **classList**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10714
##### Parameters
###### value
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.classList`
***
### part
#### Get Signature
> **get** **part**(): `DOMTokenList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10791
The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)
##### Returns
`DOMTokenList`
#### Set Signature
> **set** **part**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10792
##### Parameters
###### value
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.part`
***
### style
#### Get Signature
> **get** **style**(): `CSSStyleDeclaration`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11119
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)
##### Returns
`CSSStyleDeclaration`
#### Set Signature
> **set** **style**(`cssText`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11120
##### Parameters
###### cssText
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.style`
***
### textContent
#### Get Signature
> **get** **textContent**(): `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11102
[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)
##### Returns
`string`
#### Set Signature
> **set** **textContent**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11103
The **`textContent`** property of the Node interface represents the text content of the node and its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/textContent)
##### Parameters
###### value
`string` \| `null`
##### Returns
`void`
#### Inherited from
[`BannerElement`](/developers/references/components/interfaces/bannerelement/).[`textContent`](/developers/references/components/interfaces/bannerelement/#textcontent)
## Methods
### addEventListener()
#### Call Signature
> **addEventListener**\<`K`\>(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13839
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementEventMap`
##### Parameters
###### type
`K`
###### listener
(`this`, `ev`) => `any`
###### options?
`boolean` \| `AddEventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.addEventListener`
#### Call Signature
> **addEventListener**(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13840
##### Parameters
###### type
`string`
###### listener
`EventListenerOrEventListenerObject`
###### options?
`boolean` \| `AddEventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.addEventListener`
***
### after()
> **after**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7953
Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.after`
***
### animate()
> **animate**(`keyframes`, `options?`): `Animation`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2921
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)
#### Parameters
##### keyframes
`Keyframe`[] \| `PropertyIndexedKeyframes` \| `null`
##### options?
`number` \| `KeyframeAnimationOptions`
#### Returns
`Animation`
#### Inherited from
`HTMLElement.animate`
***
### append()
> **append**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22694
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.append`
***
### appendChild()
> **appendChild**\<`T`\>(`node`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21748
The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.appendChild`
***
### attachInternals()
> **attachInternals**(): `ElementInternals`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13814
The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)
#### Returns
`ElementInternals`
#### Inherited from
`HTMLElement.attachInternals`
***
### attachShadow()
> **attachShadow**(`init`): `ShadowRoot`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10846
The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)
#### Parameters
##### init
`ShadowRootInit`
#### Returns
`ShadowRoot`
#### Inherited from
`HTMLElement.attachShadow`
***
### before()
> **before**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7961
Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.before`
***
### blur()
> **blur**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16073
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)
#### Returns
`void`
#### Inherited from
`HTMLElement.blur`
***
### checkVisibility()
> **checkVisibility**(`options?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10852
The **`checkVisibility()`** method of the Element interface checks whether the element is visible.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)
#### Parameters
##### options?
`CheckVisibilityOptions`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.checkVisibility`
***
### click()
> **click**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13820
The **`HTMLElement.click()`** method simulates a mouse click on an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)
#### Returns
`void`
#### Inherited from
`HTMLElement.click`
***
### cloneNode()
> **cloneNode**(`subtree?`): `Node`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21754
The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)
#### Parameters
##### subtree?
`boolean`
#### Returns
`Node`
#### Inherited from
`HTMLElement.cloneNode`
***
### closest()
#### Call Signature
> **closest**\<`K`\>(`selector`): `HTMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10858
The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`HTMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`K`\>(`selector`): `SVGElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10859
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`SVGElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`K`\>(`selector`): `MathMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10860
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`MathMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`E`\>(`selectors`): `E` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10861
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`E` \| `null`
##### Inherited from
`HTMLElement.closest`
***
### compareDocumentPosition()
> **compareDocumentPosition**(`other`): `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21760
The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)
#### Parameters
##### other
`Node`
#### Returns
`number`
#### Inherited from
`HTMLElement.compareDocumentPosition`
***
### computedStyleMap()
> **computedStyleMap**(): `StylePropertyMapReadOnly`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10867
The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)
#### Returns
`StylePropertyMapReadOnly`
#### Inherited from
`HTMLElement.computedStyleMap`
***
### contains()
> **contains**(`other`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21766
The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)
#### Parameters
##### other
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.contains`
***
### dispatchEvent()
> **dispatchEvent**(`event`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11575
The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
#### Parameters
##### event
`Event`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.dispatchEvent`
***
### focus()
> **focus**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16075
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)
#### Parameters
##### options?
`FocusOptions`
#### Returns
`void`
#### Inherited from
`HTMLElement.focus`
***
### getAnimations()
> **getAnimations**(`options?`): `Animation`[]
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2923
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)
#### Parameters
##### options?
`GetAnimationsOptions`
#### Returns
`Animation`[]
#### Inherited from
`HTMLElement.getAnimations`
***
### getAttribute()
> **getAttribute**(`qualifiedName`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10873
The **`getAttribute()`** method of the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.getAttribute`
***
### getAttributeNames()
> **getAttributeNames**(): `string`[]
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10885
The **`getAttributeNames()`** method of the array.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)
#### Returns
`string`[]
#### Inherited from
`HTMLElement.getAttributeNames`
***
### getAttributeNode()
> **getAttributeNode**(`qualifiedName`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10891
Returns the specified attribute of the specified element, as an Attr node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)
#### Parameters
##### qualifiedName
`string`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.getAttributeNode`
***
### getAttributeNodeNS()
> **getAttributeNodeNS**(`namespace`, `localName`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10897
The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.getAttributeNodeNS`
***
### getAttributeNS()
> **getAttributeNS**(`namespace`, `localName`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10879
The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.getAttributeNS`
***
### getBoundingClientRect()
> **getBoundingClientRect**(): `DOMRect`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10903
The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)
#### Returns
`DOMRect`
#### Inherited from
`HTMLElement.getBoundingClientRect`
***
### getClientRects()
> **getClientRects**(): `DOMRectList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10909
The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)
#### Returns
`DOMRectList`
#### Inherited from
`HTMLElement.getClientRects`
***
### getElementsByClassName()
> **getElementsByClassName**(`classNames`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10915
The Element method **`getElementsByClassName()`** returns a live specified class name or names.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)
#### Parameters
##### classNames
`string`
#### Returns
`HTMLCollectionOf`\<`Element`\>
#### Inherited from
`HTMLElement.getElementsByClassName`
***
### getElementsByTagName()
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`HTMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10921
The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`HTMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`SVGElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10922
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`SVGElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`MathMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10923
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`MathMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10925
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**(`qualifiedName`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10926
##### Parameters
###### qualifiedName
`string`
##### Returns
`HTMLCollectionOf`\<`Element`\>
##### Inherited from
`HTMLElement.getElementsByTagName`
***
### getElementsByTagNameNS()
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`HTMLElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10932
The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)
##### Parameters
###### namespaceURI
`"http://www.w3.org/1999/xhtml"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`HTMLElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`SVGElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10933
##### Parameters
###### namespaceURI
`"http://www.w3.org/2000/svg"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`SVGElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`MathMLElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10934
##### Parameters
###### namespaceURI
`"http://www.w3.org/1998/Math/MathML"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`MathMLElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespace`, `localName`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10935
##### Parameters
###### namespace
`string` \| `null`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`Element`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
***
### getHTML()
> **getHTML**(`options?`): `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10941
The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)
#### Parameters
##### options?
`GetHTMLOptions`
#### Returns
`string`
#### Inherited from
`HTMLElement.getHTML`
***
### getRootNode()
> **getRootNode**(`options?`): `Node`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21772
The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)
#### Parameters
##### options?
`GetRootNodeOptions`
#### Returns
`Node`
#### Inherited from
`HTMLElement.getRootNode`
***
### hasAttribute()
> **hasAttribute**(`qualifiedName`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10947
The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttribute`
***
### hasAttributeNS()
> **hasAttributeNS**(`namespace`, `localName`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10953
The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttributeNS`
***
### hasAttributes()
> **hasAttributes**(): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10959
The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttributes`
***
### hasChildNodes()
> **hasChildNodes**(): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21778
The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasChildNodes`
***
### hasPointerCapture()
> **hasPointerCapture**(`pointerId`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10965
The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasPointerCapture`
***
### hidePopover()
> **hidePopover**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13826
The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)
#### Returns
`void`
#### Inherited from
`HTMLElement.hidePopover`
***
### insertAdjacentElement()
> **insertAdjacentElement**(`where`, `element`): `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10971
The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)
#### Parameters
##### where
`InsertPosition`
##### element
`Element`
#### Returns
`Element` \| `null`
#### Inherited from
`HTMLElement.insertAdjacentElement`
***
### insertAdjacentHTML()
> **insertAdjacentHTML**(`position`, `string`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10977
The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)
#### Parameters
##### position
`InsertPosition`
##### string
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.insertAdjacentHTML`
***
### insertAdjacentText()
> **insertAdjacentText**(`where`, `data`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10983
The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)
#### Parameters
##### where
`InsertPosition`
##### data
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.insertAdjacentText`
***
### insertBefore()
> **insertBefore**\<`T`\>(`node`, `child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21784
The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`T`
##### child
`Node` \| `null`
#### Returns
`T`
#### Inherited from
`HTMLElement.insertBefore`
***
### isDefaultNamespace()
> **isDefaultNamespace**(`namespace`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21790
The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)
#### Parameters
##### namespace
`string` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isDefaultNamespace`
***
### isEqualNode()
> **isEqualNode**(`otherNode`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21796
The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)
#### Parameters
##### otherNode
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isEqualNode`
***
### isSameNode()
> **isSameNode**(`otherNode`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21802
The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)
#### Parameters
##### otherNode
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isSameNode`
***
### lookupNamespaceURI()
> **lookupNamespaceURI**(`prefix`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21808
The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)
#### Parameters
##### prefix
`string` \| `null`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.lookupNamespaceURI`
***
### lookupPrefix()
> **lookupPrefix**(`namespace`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21814
The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)
#### Parameters
##### namespace
`string` \| `null`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.lookupPrefix`
***
### matches()
> **matches**(`selectors`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10989
The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)
#### Parameters
##### selectors
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.matches`
***
### normalize()
> **normalize**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21820
The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)
#### Returns
`void`
#### Inherited from
`HTMLElement.normalize`
***
### prepend()
> **prepend**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22702
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.prepend`
***
### querySelector()
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `HTMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22708
Returns the first element that is a descendant of node that matches selectors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`HTMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `SVGElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22709
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`SVGElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `MathMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22710
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`MathMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `HTMLElementDeprecatedTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22712
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`HTMLElementDeprecatedTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`E`\>(`selectors`): `E` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22713
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`E` \| `null`
##### Inherited from
`HTMLElement.querySelector`
***
### querySelectorAll()
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`HTMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22719
Returns all element descendants of node that match selectors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`HTMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`SVGElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22720
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`SVGElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`MathMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22721
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`MathMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22723
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`E`\>(`selectors`): `NodeListOf`\<`E`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22724
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`NodeListOf`\<`E`\>
##### Inherited from
`HTMLElement.querySelectorAll`
***
### releasePointerCapture()
> **releasePointerCapture**(`pointerId`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10995
The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`void`
#### Inherited from
`HTMLElement.releasePointerCapture`
***
### remove()
> **remove**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7967
Removes node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)
#### Returns
`void`
#### Inherited from
`HTMLElement.remove`
***
### removeAttribute()
> **removeAttribute**(`qualifiedName`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11001
The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.removeAttribute`
***
### removeAttributeNode()
> **removeAttributeNode**(`attr`): `Attr`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11013
The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr`
#### Inherited from
`HTMLElement.removeAttributeNode`
***
### removeAttributeNS()
> **removeAttributeNS**(`namespace`, `localName`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11007
The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.removeAttributeNS`
***
### removeChild()
> **removeChild**\<`T`\>(`child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21826
The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### child
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.removeChild`
***
### removeEventListener()
#### Call Signature
> **removeEventListener**\<`K`\>(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13841
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementEventMap`
##### Parameters
###### type
`K`
###### listener
(`this`, `ev`) => `any`
###### options?
`boolean` \| `EventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.removeEventListener`
#### Call Signature
> **removeEventListener**(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13842
##### Parameters
###### type
`string`
###### listener
`EventListenerOrEventListenerObject`
###### options?
`boolean` \| `EventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.removeEventListener`
***
### replaceChild()
> **replaceChild**\<`T`\>(`node`, `child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21832
The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`Node`
##### child
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.replaceChild`
***
### replaceChildren()
> **replaceChildren**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22732
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.replaceChildren`
***
### replaceWith()
> **replaceWith**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7975
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.replaceWith`
***
### requestFullscreen()
> **requestFullscreen**(`options?`): `Promise`\<`void`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11019
The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)
#### Parameters
##### options?
`FullscreenOptions`
#### Returns
`Promise`\<`void`\>
#### Inherited from
`HTMLElement.requestFullscreen`
***
### requestPointerLock()
> **requestPointerLock**(`options?`): `Promise`\<`void`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11025
The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)
#### Parameters
##### options?
`PointerLockOptions`
#### Returns
`Promise`\<`void`\>
#### Inherited from
`HTMLElement.requestPointerLock`
***
### scroll()
#### Call Signature
> **scroll**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11031
The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scroll`
#### Call Signature
> **scroll**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11032
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scroll`
***
### scrollBy()
#### Call Signature
> **scrollBy**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11038
The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollBy`
#### Call Signature
> **scrollBy**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11039
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollBy`
***
### scrollIntoView()
> **scrollIntoView**(`arg?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11045
The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)
#### Parameters
##### arg?
`boolean` \| `ScrollIntoViewOptions`
#### Returns
`void`
#### Inherited from
`HTMLElement.scrollIntoView`
***
### scrollTo()
#### Call Signature
> **scrollTo**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11051
The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollTo`
#### Call Signature
> **scrollTo**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11052
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollTo`
***
### setAttribute()
> **setAttribute**(`qualifiedName`, `value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11058
The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)
#### Parameters
##### qualifiedName
`string`
##### value
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setAttribute`
***
### setAttributeNode()
> **setAttributeNode**(`attr`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11070
The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.setAttributeNode`
***
### setAttributeNodeNS()
> **setAttributeNodeNS**(`attr`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11076
The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.setAttributeNodeNS`
***
### setAttributeNS()
> **setAttributeNS**(`namespace`, `qualifiedName`, `value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11064
`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### qualifiedName
`string`
##### value
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setAttributeNS`
***
### setHTMLUnsafe()
> **setHTMLUnsafe**(`html`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11082
The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)
#### Parameters
##### html
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setHTMLUnsafe`
***
### setPointerCapture()
> **setPointerCapture**(`pointerId`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11088
The **`setPointerCapture()`** method of the _capture target_ of future pointer events.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`void`
#### Inherited from
`HTMLElement.setPointerCapture`
***
### showPopover()
> **showPopover**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13832
The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)
#### Returns
`void`
#### Inherited from
`HTMLElement.showPopover`
***
### toggleAttribute()
> **toggleAttribute**(`qualifiedName`, `force?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11094
The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)
#### Parameters
##### qualifiedName
`string`
##### force?
`boolean`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.toggleAttribute`
***
### togglePopover()
> **togglePopover**(`options?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13838
The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)
#### Parameters
##### options?
`boolean`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.togglePopover`
***
### ~~webkitMatchesSelector()~~
> **webkitMatchesSelector**(`selectors`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11100
:::caution[Deprecated]
This is a legacy alias of `matches`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)
:::
#### Parameters
##### selectors
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.webkitMatchesSelector`
# OpenInAppButtonElement
Defined in: [vendor/wallet/sdk/components/src/components/OpenInAppButton/index.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/OpenInAppButton/index.ts#L11)
Custom element interface for ``.
Combines standard HTMLElement with [OpenInAppButtonProps](/developers/references/components/type-aliases/openinappbuttonprops/).
## Extends
- `HTMLElement`.[`OpenInAppButtonProps`](/developers/references/components/type-aliases/openinappbuttonprops/)
## Properties
### accessKey
> **accessKey**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13688
The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)
#### Inherited from
`HTMLElement.accessKey`
***
### accessKeyLabel
> `readonly` **accessKeyLabel**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13694
The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)
#### Inherited from
`HTMLElement.accessKeyLabel`
***
### ariaActiveDescendantElement
> **ariaActiveDescendantElement**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2607
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)
#### Inherited from
`HTMLElement.ariaActiveDescendantElement`
***
### ariaAtomic
> **ariaAtomic**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2609
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)
#### Inherited from
`HTMLElement.ariaAtomic`
***
### ariaAutoComplete
> **ariaAutoComplete**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2611
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)
#### Inherited from
`HTMLElement.ariaAutoComplete`
***
### ariaBrailleLabel
> **ariaBrailleLabel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2613
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)
#### Inherited from
`HTMLElement.ariaBrailleLabel`
***
### ariaBrailleRoleDescription
> **ariaBrailleRoleDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2615
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)
#### Inherited from
`HTMLElement.ariaBrailleRoleDescription`
***
### ariaBusy
> **ariaBusy**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2617
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)
#### Inherited from
`HTMLElement.ariaBusy`
***
### ariaChecked
> **ariaChecked**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2619
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)
#### Inherited from
`HTMLElement.ariaChecked`
***
### ariaColCount
> **ariaColCount**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2621
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)
#### Inherited from
`HTMLElement.ariaColCount`
***
### ariaColIndex
> **ariaColIndex**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2623
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)
#### Inherited from
`HTMLElement.ariaColIndex`
***
### ariaColIndexText
> **ariaColIndexText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2625
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)
#### Inherited from
`HTMLElement.ariaColIndexText`
***
### ariaColSpan
> **ariaColSpan**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2627
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)
#### Inherited from
`HTMLElement.ariaColSpan`
***
### ariaControlsElements
> **ariaControlsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2629
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)
#### Inherited from
`HTMLElement.ariaControlsElements`
***
### ariaCurrent
> **ariaCurrent**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2631
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)
#### Inherited from
`HTMLElement.ariaCurrent`
***
### ariaDescribedByElements
> **ariaDescribedByElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2633
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)
#### Inherited from
`HTMLElement.ariaDescribedByElements`
***
### ariaDescription
> **ariaDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2635
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)
#### Inherited from
`HTMLElement.ariaDescription`
***
### ariaDetailsElements
> **ariaDetailsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2637
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)
#### Inherited from
`HTMLElement.ariaDetailsElements`
***
### ariaDisabled
> **ariaDisabled**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2639
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)
#### Inherited from
`HTMLElement.ariaDisabled`
***
### ariaErrorMessageElements
> **ariaErrorMessageElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2641
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)
#### Inherited from
`HTMLElement.ariaErrorMessageElements`
***
### ariaExpanded
> **ariaExpanded**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2643
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)
#### Inherited from
`HTMLElement.ariaExpanded`
***
### ariaFlowToElements
> **ariaFlowToElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2645
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)
#### Inherited from
`HTMLElement.ariaFlowToElements`
***
### ariaHasPopup
> **ariaHasPopup**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2647
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)
#### Inherited from
`HTMLElement.ariaHasPopup`
***
### ariaHidden
> **ariaHidden**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2649
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)
#### Inherited from
`HTMLElement.ariaHidden`
***
### ariaInvalid
> **ariaInvalid**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2651
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)
#### Inherited from
`HTMLElement.ariaInvalid`
***
### ariaKeyShortcuts
> **ariaKeyShortcuts**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2653
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)
#### Inherited from
`HTMLElement.ariaKeyShortcuts`
***
### ariaLabel
> **ariaLabel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2655
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)
#### Inherited from
`HTMLElement.ariaLabel`
***
### ariaLabelledByElements
> **ariaLabelledByElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2657
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)
#### Inherited from
`HTMLElement.ariaLabelledByElements`
***
### ariaLevel
> **ariaLevel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2659
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)
#### Inherited from
`HTMLElement.ariaLevel`
***
### ariaLive
> **ariaLive**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2661
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)
#### Inherited from
`HTMLElement.ariaLive`
***
### ariaModal
> **ariaModal**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2663
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)
#### Inherited from
`HTMLElement.ariaModal`
***
### ariaMultiLine
> **ariaMultiLine**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2665
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)
#### Inherited from
`HTMLElement.ariaMultiLine`
***
### ariaMultiSelectable
> **ariaMultiSelectable**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2667
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)
#### Inherited from
`HTMLElement.ariaMultiSelectable`
***
### ariaOrientation
> **ariaOrientation**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2669
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)
#### Inherited from
`HTMLElement.ariaOrientation`
***
### ariaOwnsElements
> **ariaOwnsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2671
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)
#### Inherited from
`HTMLElement.ariaOwnsElements`
***
### ariaPlaceholder
> **ariaPlaceholder**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2673
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)
#### Inherited from
`HTMLElement.ariaPlaceholder`
***
### ariaPosInSet
> **ariaPosInSet**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2675
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)
#### Inherited from
`HTMLElement.ariaPosInSet`
***
### ariaPressed
> **ariaPressed**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2677
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)
#### Inherited from
`HTMLElement.ariaPressed`
***
### ariaReadOnly
> **ariaReadOnly**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2679
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)
#### Inherited from
`HTMLElement.ariaReadOnly`
***
### ariaRelevant
> **ariaRelevant**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2681
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)
#### Inherited from
`HTMLElement.ariaRelevant`
***
### ariaRequired
> **ariaRequired**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2683
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)
#### Inherited from
`HTMLElement.ariaRequired`
***
### ariaRoleDescription
> **ariaRoleDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2685
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)
#### Inherited from
`HTMLElement.ariaRoleDescription`
***
### ariaRowCount
> **ariaRowCount**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2687
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)
#### Inherited from
`HTMLElement.ariaRowCount`
***
### ariaRowIndex
> **ariaRowIndex**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2689
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)
#### Inherited from
`HTMLElement.ariaRowIndex`
***
### ariaRowIndexText
> **ariaRowIndexText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2691
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)
#### Inherited from
`HTMLElement.ariaRowIndexText`
***
### ariaRowSpan
> **ariaRowSpan**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2693
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)
#### Inherited from
`HTMLElement.ariaRowSpan`
***
### ariaSelected
> **ariaSelected**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2695
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)
#### Inherited from
`HTMLElement.ariaSelected`
***
### ariaSetSize
> **ariaSetSize**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2697
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)
#### Inherited from
`HTMLElement.ariaSetSize`
***
### ariaSort
> **ariaSort**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2699
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)
#### Inherited from
`HTMLElement.ariaSort`
***
### ariaValueMax
> **ariaValueMax**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2701
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)
#### Inherited from
`HTMLElement.ariaValueMax`
***
### ariaValueMin
> **ariaValueMin**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2703
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)
#### Inherited from
`HTMLElement.ariaValueMin`
***
### ariaValueNow
> **ariaValueNow**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2705
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)
#### Inherited from
`HTMLElement.ariaValueNow`
***
### ariaValueText
> **ariaValueText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2707
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)
#### Inherited from
`HTMLElement.ariaValueText`
***
### assignedSlot
> `readonly` **assignedSlot**: `HTMLSlotElement` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:30826
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)
#### Inherited from
`HTMLElement.assignedSlot`
***
### ATTRIBUTE\_NODE
> `readonly` **ATTRIBUTE\_NODE**: `2`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21835
#### Inherited from
`HTMLElement.ATTRIBUTE_NODE`
***
### attributes
> `readonly` **attributes**: `NamedNodeMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10707
The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)
#### Inherited from
`HTMLElement.attributes`
***
### attributeStyleMap
> `readonly` **attributeStyleMap**: `StylePropertyMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11117
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)
#### Inherited from
`HTMLElement.attributeStyleMap`
***
### autocapitalize
> **autocapitalize**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13700
The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)
#### Inherited from
`HTMLElement.autocapitalize`
***
### autocorrect
> **autocorrect**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13706
The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)
#### Inherited from
`HTMLElement.autocorrect`
***
### autofocus
> **autofocus**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16065
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)
#### Inherited from
`HTMLElement.autofocus`
***
### baseURI
> `readonly` **baseURI**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21664
The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)
#### Inherited from
`HTMLElement.baseURI`
***
### CDATA\_SECTION\_NODE
> `readonly` **CDATA\_SECTION\_NODE**: `4`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21839
node is a CDATASection node.
#### Inherited from
`HTMLElement.CDATA_SECTION_NODE`
***
### childElementCount
> `readonly` **childElementCount**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22668
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)
#### Inherited from
`HTMLElement.childElementCount`
***
### childNodes
> `readonly` **childNodes**: `NodeListOf`\<`ChildNode`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21670
The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)
#### Inherited from
`HTMLElement.childNodes`
***
### children
> `readonly` **children**: `HTMLCollection`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22674
Returns the child elements.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)
#### Inherited from
`HTMLElement.children`
***
### classname?
> `optional` **classname?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/OpenInAppButton/types.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/OpenInAppButton/types.ts#L17)
Classname to apply to the button
#### Inherited from
`OpenInAppButtonProps.classname`
***
### className
> **className**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10720
The **`className`** property of the of the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)
#### Inherited from
`HTMLElement.className`
***
### clientHeight
> `readonly` **clientHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10726
The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)
#### Inherited from
`HTMLElement.clientHeight`
***
### clientLeft
> `readonly` **clientLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10732
The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)
#### Inherited from
`HTMLElement.clientLeft`
***
### clientTop
> `readonly` **clientTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10738
The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)
#### Inherited from
`HTMLElement.clientTop`
***
### clientWidth
> `readonly` **clientWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10744
The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)
#### Inherited from
`HTMLElement.clientWidth`
***
### COMMENT\_NODE
> `readonly` **COMMENT\_NODE**: `8`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21845
node is a Comment node.
#### Inherited from
`HTMLElement.COMMENT_NODE`
***
### contentEditable
> **contentEditable**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11125
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)
#### Inherited from
`HTMLElement.contentEditable`
***
### currentCSSZoom
> `readonly` **currentCSSZoom**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10750
The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)
#### Inherited from
`HTMLElement.currentCSSZoom`
***
### dataset
> `readonly` **dataset**: `DOMStringMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16067
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)
#### Inherited from
`HTMLElement.dataset`
***
### dir
> **dir**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13712
The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)
#### Inherited from
`HTMLElement.dir`
***
### DOCUMENT\_FRAGMENT\_NODE
> `readonly` **DOCUMENT\_FRAGMENT\_NODE**: `11`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21851
node is a DocumentFragment node.
#### Inherited from
`HTMLElement.DOCUMENT_FRAGMENT_NODE`
***
### DOCUMENT\_NODE
> `readonly` **DOCUMENT\_NODE**: `9`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21847
node is a document.
#### Inherited from
`HTMLElement.DOCUMENT_NODE`
***
### DOCUMENT\_POSITION\_CONTAINED\_BY
> `readonly` **DOCUMENT\_POSITION\_CONTAINED\_BY**: `16`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21862
Set when other is a descendant of node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_CONTAINED_BY`
***
### DOCUMENT\_POSITION\_CONTAINS
> `readonly` **DOCUMENT\_POSITION\_CONTAINS**: `8`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21860
Set when other is an ancestor of node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_CONTAINS`
***
### DOCUMENT\_POSITION\_DISCONNECTED
> `readonly` **DOCUMENT\_POSITION\_DISCONNECTED**: `1`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21854
Set when node and other are not in the same tree.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_DISCONNECTED`
***
### DOCUMENT\_POSITION\_FOLLOWING
> `readonly` **DOCUMENT\_POSITION\_FOLLOWING**: `4`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21858
Set when other is following node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_FOLLOWING`
***
### DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC
> `readonly` **DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC**: `32`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21863
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC`
***
### DOCUMENT\_POSITION\_PRECEDING
> `readonly` **DOCUMENT\_POSITION\_PRECEDING**: `2`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21856
Set when other is preceding node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_PRECEDING`
***
### DOCUMENT\_TYPE\_NODE
> `readonly` **DOCUMENT\_TYPE\_NODE**: `10`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21849
node is a doctype.
#### Inherited from
`HTMLElement.DOCUMENT_TYPE_NODE`
***
### draggable
> **draggable**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13718
The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)
#### Inherited from
`HTMLElement.draggable`
***
### ELEMENT\_NODE
> `readonly` **ELEMENT\_NODE**: `1`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21834
node is an element.
#### Inherited from
`HTMLElement.ELEMENT_NODE`
***
### enterKeyHint
> **enterKeyHint**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11127
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)
#### Inherited from
`HTMLElement.enterKeyHint`
***
### ENTITY\_NODE
> `readonly` **ENTITY\_NODE**: `6`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21841
#### Inherited from
`HTMLElement.ENTITY_NODE`
***
### ENTITY\_REFERENCE\_NODE
> `readonly` **ENTITY\_REFERENCE\_NODE**: `5`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21840
#### Inherited from
`HTMLElement.ENTITY_REFERENCE_NODE`
***
### firstChild
> `readonly` **firstChild**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21676
The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)
#### Inherited from
`HTMLElement.firstChild`
***
### firstElementChild
> `readonly` **firstElementChild**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22680
Returns the first child that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)
#### Inherited from
`HTMLElement.firstElementChild`
***
### hidden
> **hidden**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13724
The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)
#### Inherited from
`HTMLElement.hidden`
***
### id
> **id**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10756
The **`id`** property of the Element interface represents the element's identifier, reflecting the **`id`** global attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/id)
#### Inherited from
`HTMLElement.id`
***
### inert
> **inert**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13730
The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)
#### Inherited from
`HTMLElement.inert`
***
### innerHTML
> **innerHTML**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10762
The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)
#### Inherited from
`HTMLElement.innerHTML`
***
### innerText
> **innerText**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13736
The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)
#### Inherited from
`HTMLElement.innerText`
***
### inputMode
> **inputMode**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11129
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)
#### Inherited from
`HTMLElement.inputMode`
***
### isConnected
> `readonly` **isConnected**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21682
The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)
#### Inherited from
`HTMLElement.isConnected`
***
### isContentEditable
> `readonly` **isContentEditable**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11131
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)
#### Inherited from
`HTMLElement.isContentEditable`
***
### lang
> **lang**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13742
The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)
#### Inherited from
`HTMLElement.lang`
***
### lastChild
> `readonly` **lastChild**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21688
The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)
#### Inherited from
`HTMLElement.lastChild`
***
### lastElementChild
> `readonly` **lastElementChild**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22686
Returns the last child that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)
#### Inherited from
`HTMLElement.lastElementChild`
***
### localName
> `readonly` **localName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10768
The **`Element.localName`** read-only property returns the local part of the qualified name of an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)
#### Inherited from
`HTMLElement.localName`
***
### namespaceURI
> `readonly` **namespaceURI**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10774
The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)
#### Inherited from
`HTMLElement.namespaceURI`
***
### nextElementSibling
> `readonly` **nextElementSibling**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22003
Returns the first following sibling that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)
#### Inherited from
`HTMLElement.nextElementSibling`
***
### nextSibling
> `readonly` **nextSibling**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21694
The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)
#### Inherited from
`HTMLElement.nextSibling`
***
### nodeName
> `readonly` **nodeName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21700
The read-only **`nodeName`** property of Node returns the name of the current node as a string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)
#### Inherited from
`HTMLElement.nodeName`
***
### nodeType
> `readonly` **nodeType**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21706
The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)
#### Inherited from
`HTMLElement.nodeType`
***
### nodeValue
> **nodeValue**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21712
The **`nodeValue`** property of the Node interface returns or sets the value of the current node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)
#### Inherited from
`HTMLElement.nodeValue`
***
### nonce?
> `optional` **nonce?**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16069
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)
#### Inherited from
`HTMLElement.nonce`
***
### NOTATION\_NODE
> `readonly` **NOTATION\_NODE**: `12`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21852
#### Inherited from
`HTMLElement.NOTATION_NODE`
***
### offsetHeight
> `readonly` **offsetHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13748
The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)
#### Inherited from
`HTMLElement.offsetHeight`
***
### offsetLeft
> `readonly` **offsetLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13754
The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)
#### Inherited from
`HTMLElement.offsetLeft`
***
### offsetParent
> `readonly` **offsetParent**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13760
The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)
#### Inherited from
`HTMLElement.offsetParent`
***
### offsetTop
> `readonly` **offsetTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13766
The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)
#### Inherited from
`HTMLElement.offsetTop`
***
### offsetWidth
> `readonly` **offsetWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13772
The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)
#### Inherited from
`HTMLElement.offsetWidth`
***
### onabort
> **onabort**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12743
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)
#### Inherited from
`HTMLElement.onabort`
***
### onanimationcancel
> **onanimationcancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12745
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)
#### Inherited from
`HTMLElement.onanimationcancel`
***
### onanimationend
> **onanimationend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12747
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)
#### Inherited from
`HTMLElement.onanimationend`
***
### onanimationiteration
> **onanimationiteration**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12749
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)
#### Inherited from
`HTMLElement.onanimationiteration`
***
### onanimationstart
> **onanimationstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12751
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)
#### Inherited from
`HTMLElement.onanimationstart`
***
### onauxclick
> **onauxclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12753
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)
#### Inherited from
`HTMLElement.onauxclick`
***
### onbeforeinput
> **onbeforeinput**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12755
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)
#### Inherited from
`HTMLElement.onbeforeinput`
***
### onbeforematch
> **onbeforematch**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12757
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)
#### Inherited from
`HTMLElement.onbeforematch`
***
### onbeforetoggle
> **onbeforetoggle**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12759
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)
#### Inherited from
`HTMLElement.onbeforetoggle`
***
### onblur
> **onblur**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12761
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)
#### Inherited from
`HTMLElement.onblur`
***
### oncancel
> **oncancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12763
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)
#### Inherited from
`HTMLElement.oncancel`
***
### oncanplay
> **oncanplay**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12765
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)
#### Inherited from
`HTMLElement.oncanplay`
***
### oncanplaythrough
> **oncanplaythrough**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12767
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)
#### Inherited from
`HTMLElement.oncanplaythrough`
***
### onchange
> **onchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12769
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)
#### Inherited from
`HTMLElement.onchange`
***
### onclick
> **onclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12771
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)
#### Inherited from
`HTMLElement.onclick`
***
### onclose
> **onclose**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12773
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)
#### Inherited from
`HTMLElement.onclose`
***
### oncontextlost
> **oncontextlost**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12775
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)
#### Inherited from
`HTMLElement.oncontextlost`
***
### oncontextmenu
> **oncontextmenu**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12777
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)
#### Inherited from
`HTMLElement.oncontextmenu`
***
### oncontextrestored
> **oncontextrestored**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12779
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)
#### Inherited from
`HTMLElement.oncontextrestored`
***
### oncopy
> **oncopy**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12781
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)
#### Inherited from
`HTMLElement.oncopy`
***
### oncuechange
> **oncuechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12783
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)
#### Inherited from
`HTMLElement.oncuechange`
***
### oncut
> **oncut**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12785
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)
#### Inherited from
`HTMLElement.oncut`
***
### ondblclick
> **ondblclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12787
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)
#### Inherited from
`HTMLElement.ondblclick`
***
### ondrag
> **ondrag**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12789
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)
#### Inherited from
`HTMLElement.ondrag`
***
### ondragend
> **ondragend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12791
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)
#### Inherited from
`HTMLElement.ondragend`
***
### ondragenter
> **ondragenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12793
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)
#### Inherited from
`HTMLElement.ondragenter`
***
### ondragleave
> **ondragleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12795
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)
#### Inherited from
`HTMLElement.ondragleave`
***
### ondragover
> **ondragover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12797
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)
#### Inherited from
`HTMLElement.ondragover`
***
### ondragstart
> **ondragstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12799
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)
#### Inherited from
`HTMLElement.ondragstart`
***
### ondrop
> **ondrop**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12801
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)
#### Inherited from
`HTMLElement.ondrop`
***
### ondurationchange
> **ondurationchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12803
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)
#### Inherited from
`HTMLElement.ondurationchange`
***
### onemptied
> **onemptied**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12805
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)
#### Inherited from
`HTMLElement.onemptied`
***
### onended
> **onended**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12807
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)
#### Inherited from
`HTMLElement.onended`
***
### onerror
> **onerror**: `OnErrorEventHandler`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12809
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)
#### Inherited from
`HTMLElement.onerror`
***
### onfocus
> **onfocus**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12811
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)
#### Inherited from
`HTMLElement.onfocus`
***
### onformdata
> **onformdata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12813
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)
#### Inherited from
`HTMLElement.onformdata`
***
### onfullscreenchange
> **onfullscreenchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10776
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)
#### Inherited from
`HTMLElement.onfullscreenchange`
***
### onfullscreenerror
> **onfullscreenerror**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10778
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)
#### Inherited from
`HTMLElement.onfullscreenerror`
***
### ongotpointercapture
> **ongotpointercapture**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12815
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)
#### Inherited from
`HTMLElement.ongotpointercapture`
***
### oninput
> **oninput**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12817
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)
#### Inherited from
`HTMLElement.oninput`
***
### oninvalid
> **oninvalid**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12819
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)
#### Inherited from
`HTMLElement.oninvalid`
***
### onkeydown
> **onkeydown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12821
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)
#### Inherited from
`HTMLElement.onkeydown`
***
### ~~onkeypress~~
> **onkeypress**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12827
:::caution[Deprecated]
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)
:::
#### Inherited from
`HTMLElement.onkeypress`
***
### onkeyup
> **onkeyup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12829
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)
#### Inherited from
`HTMLElement.onkeyup`
***
### onload
> **onload**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12831
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)
#### Inherited from
`HTMLElement.onload`
***
### onloadeddata
> **onloadeddata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12833
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)
#### Inherited from
`HTMLElement.onloadeddata`
***
### onloadedmetadata
> **onloadedmetadata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12835
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)
#### Inherited from
`HTMLElement.onloadedmetadata`
***
### onloadstart
> **onloadstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12837
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)
#### Inherited from
`HTMLElement.onloadstart`
***
### onlostpointercapture
> **onlostpointercapture**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12839
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)
#### Inherited from
`HTMLElement.onlostpointercapture`
***
### onmousedown
> **onmousedown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12841
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)
#### Inherited from
`HTMLElement.onmousedown`
***
### onmouseenter
> **onmouseenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12843
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)
#### Inherited from
`HTMLElement.onmouseenter`
***
### onmouseleave
> **onmouseleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12845
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)
#### Inherited from
`HTMLElement.onmouseleave`
***
### onmousemove
> **onmousemove**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12847
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)
#### Inherited from
`HTMLElement.onmousemove`
***
### onmouseout
> **onmouseout**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12849
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)
#### Inherited from
`HTMLElement.onmouseout`
***
### onmouseover
> **onmouseover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12851
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)
#### Inherited from
`HTMLElement.onmouseover`
***
### onmouseup
> **onmouseup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12853
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)
#### Inherited from
`HTMLElement.onmouseup`
***
### onpaste
> **onpaste**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12855
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)
#### Inherited from
`HTMLElement.onpaste`
***
### onpause
> **onpause**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12857
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)
#### Inherited from
`HTMLElement.onpause`
***
### onplay
> **onplay**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12859
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)
#### Inherited from
`HTMLElement.onplay`
***
### onplaying
> **onplaying**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12861
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)
#### Inherited from
`HTMLElement.onplaying`
***
### onpointercancel
> **onpointercancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12863
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)
#### Inherited from
`HTMLElement.onpointercancel`
***
### onpointerdown
> **onpointerdown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12865
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)
#### Inherited from
`HTMLElement.onpointerdown`
***
### onpointerenter
> **onpointerenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12867
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)
#### Inherited from
`HTMLElement.onpointerenter`
***
### onpointerleave
> **onpointerleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12869
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)
#### Inherited from
`HTMLElement.onpointerleave`
***
### onpointermove
> **onpointermove**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12871
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)
#### Inherited from
`HTMLElement.onpointermove`
***
### onpointerout
> **onpointerout**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12873
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)
#### Inherited from
`HTMLElement.onpointerout`
***
### onpointerover
> **onpointerover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12875
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)
#### Inherited from
`HTMLElement.onpointerover`
***
### onpointerrawupdate
> **onpointerrawupdate**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12881
Available only in secure contexts.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)
#### Inherited from
`HTMLElement.onpointerrawupdate`
***
### onpointerup
> **onpointerup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12883
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)
#### Inherited from
`HTMLElement.onpointerup`
***
### onprogress
> **onprogress**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12885
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)
#### Inherited from
`HTMLElement.onprogress`
***
### onratechange
> **onratechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12887
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)
#### Inherited from
`HTMLElement.onratechange`
***
### onreset
> **onreset**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12889
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)
#### Inherited from
`HTMLElement.onreset`
***
### onresize
> **onresize**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12891
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)
#### Inherited from
`HTMLElement.onresize`
***
### onscroll
> **onscroll**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12893
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)
#### Inherited from
`HTMLElement.onscroll`
***
### onscrollend
> **onscrollend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12895
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)
#### Inherited from
`HTMLElement.onscrollend`
***
### onsecuritypolicyviolation
> **onsecuritypolicyviolation**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12897
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)
#### Inherited from
`HTMLElement.onsecuritypolicyviolation`
***
### onseeked
> **onseeked**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12899
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)
#### Inherited from
`HTMLElement.onseeked`
***
### onseeking
> **onseeking**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12901
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)
#### Inherited from
`HTMLElement.onseeking`
***
### onselect
> **onselect**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12903
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)
#### Inherited from
`HTMLElement.onselect`
***
### onselectionchange
> **onselectionchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12905
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)
#### Inherited from
`HTMLElement.onselectionchange`
***
### onselectstart
> **onselectstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12907
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)
#### Inherited from
`HTMLElement.onselectstart`
***
### onslotchange
> **onslotchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12909
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)
#### Inherited from
`HTMLElement.onslotchange`
***
### onstalled
> **onstalled**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12911
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)
#### Inherited from
`HTMLElement.onstalled`
***
### onsubmit
> **onsubmit**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12913
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)
#### Inherited from
`HTMLElement.onsubmit`
***
### onsuspend
> **onsuspend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12915
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)
#### Inherited from
`HTMLElement.onsuspend`
***
### ontimeupdate
> **ontimeupdate**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12917
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)
#### Inherited from
`HTMLElement.ontimeupdate`
***
### ontoggle
> **ontoggle**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12919
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)
#### Inherited from
`HTMLElement.ontoggle`
***
### ontouchcancel?
> `optional` **ontouchcancel?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12921
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)
#### Inherited from
`HTMLElement.ontouchcancel`
***
### ontouchend?
> `optional` **ontouchend?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12923
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)
#### Inherited from
`HTMLElement.ontouchend`
***
### ontouchmove?
> `optional` **ontouchmove?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12925
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)
#### Inherited from
`HTMLElement.ontouchmove`
***
### ontouchstart?
> `optional` **ontouchstart?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12927
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)
#### Inherited from
`HTMLElement.ontouchstart`
***
### ontransitioncancel
> **ontransitioncancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12929
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)
#### Inherited from
`HTMLElement.ontransitioncancel`
***
### ontransitionend
> **ontransitionend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12931
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)
#### Inherited from
`HTMLElement.ontransitionend`
***
### ontransitionrun
> **ontransitionrun**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12933
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)
#### Inherited from
`HTMLElement.ontransitionrun`
***
### ontransitionstart
> **ontransitionstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12935
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)
#### Inherited from
`HTMLElement.ontransitionstart`
***
### onvolumechange
> **onvolumechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12937
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)
#### Inherited from
`HTMLElement.onvolumechange`
***
### onwaiting
> **onwaiting**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12939
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)
#### Inherited from
`HTMLElement.onwaiting`
***
### ~~onwebkitanimationend~~
> **onwebkitanimationend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12945
:::caution[Deprecated]
This is a legacy alias of `onanimationend`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationend`
***
### ~~onwebkitanimationiteration~~
> **onwebkitanimationiteration**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12951
:::caution[Deprecated]
This is a legacy alias of `onanimationiteration`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationiteration`
***
### ~~onwebkitanimationstart~~
> **onwebkitanimationstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12957
:::caution[Deprecated]
This is a legacy alias of `onanimationstart`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationstart`
***
### ~~onwebkittransitionend~~
> **onwebkittransitionend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12963
:::caution[Deprecated]
This is a legacy alias of `ontransitionend`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)
:::
#### Inherited from
`HTMLElement.onwebkittransitionend`
***
### onwheel
> **onwheel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12965
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)
#### Inherited from
`HTMLElement.onwheel`
***
### outerHTML
> **outerHTML**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10784
The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)
#### Inherited from
`HTMLElement.outerHTML`
***
### outerText
> **outerText**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13778
The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)
#### Inherited from
`HTMLElement.outerText`
***
### ownerDocument
> `readonly` **ownerDocument**: `Document`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10785
The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)
#### Inherited from
`HTMLElement.ownerDocument`
***
### parentElement
> `readonly` **parentElement**: `HTMLElement` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21724
The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)
#### Inherited from
`HTMLElement.parentElement`
***
### parentNode
> `readonly` **parentNode**: `ParentNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21730
The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)
#### Inherited from
`HTMLElement.parentNode`
***
### placement?
> `optional` **placement?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/OpenInAppButton/types.ts:6](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/OpenInAppButton/types.ts#L6)
#### Inherited from
`OpenInAppButtonProps.placement`
***
### popover
> **popover**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13784
The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)
#### Inherited from
`HTMLElement.popover`
***
### prefix
> `readonly` **prefix**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10798
The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)
#### Inherited from
`HTMLElement.prefix`
***
### previousElementSibling
> `readonly` **previousElementSibling**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22009
Returns the first preceding sibling that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)
#### Inherited from
`HTMLElement.previousElementSibling`
***
### previousSibling
> `readonly` **previousSibling**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21736
The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)
#### Inherited from
`HTMLElement.previousSibling`
***
### PROCESSING\_INSTRUCTION\_NODE
> `readonly` **PROCESSING\_INSTRUCTION\_NODE**: `7`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21843
node is a ProcessingInstruction node.
#### Inherited from
`HTMLElement.PROCESSING_INSTRUCTION_NODE`
***
### role
> **role**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2709
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)
#### Inherited from
`HTMLElement.role`
***
### scrollHeight
> `readonly` **scrollHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10804
The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)
#### Inherited from
`HTMLElement.scrollHeight`
***
### scrollLeft
> **scrollLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10810
The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)
#### Inherited from
`HTMLElement.scrollLeft`
***
### scrollTop
> **scrollTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10816
The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)
#### Inherited from
`HTMLElement.scrollTop`
***
### scrollWidth
> `readonly` **scrollWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10822
The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)
#### Inherited from
`HTMLElement.scrollWidth`
***
### shadowRoot
> `readonly` **shadowRoot**: `ShadowRoot` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10828
The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)
#### Inherited from
`HTMLElement.shadowRoot`
***
### slot
> **slot**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10834
The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)
#### Inherited from
`HTMLElement.slot`
***
### spellcheck
> **spellcheck**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13790
The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)
#### Inherited from
`HTMLElement.spellcheck`
***
### tabIndex
> **tabIndex**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16071
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)
#### Inherited from
`HTMLElement.tabIndex`
***
### tagName
> `readonly` **tagName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10840
The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)
#### Inherited from
`HTMLElement.tagName`
***
### text?
> `optional` **text?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/OpenInAppButton/types.ts:13](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/OpenInAppButton/types.ts#L13)
Text to display on the button.
When omitted, a built-in localized default is used based on the
resolved language (`"Open in App"` / `"Ouvrir dans l'app"`).
#### Inherited from
`OpenInAppButtonProps.text`
***
### TEXT\_NODE
> `readonly` **TEXT\_NODE**: `3`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21837
node is a Text node.
#### Inherited from
`HTMLElement.TEXT_NODE`
***
### title
> **title**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13796
The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)
#### Inherited from
`HTMLElement.title`
***
### translate
> **translate**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13802
The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)
#### Inherited from
`HTMLElement.translate`
***
### writingSuggestions
> **writingSuggestions**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13808
The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)
#### Inherited from
`HTMLElement.writingSuggestions`
## Accessors
### classList
#### Get Signature
> **get** **classList**(): `DOMTokenList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10713
The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)
##### Returns
`DOMTokenList`
#### Set Signature
> **set** **classList**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10714
##### Parameters
###### value
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.classList`
***
### part
#### Get Signature
> **get** **part**(): `DOMTokenList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10791
The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)
##### Returns
`DOMTokenList`
#### Set Signature
> **set** **part**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10792
##### Parameters
###### value
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.part`
***
### style
#### Get Signature
> **get** **style**(): `CSSStyleDeclaration`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11119
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)
##### Returns
`CSSStyleDeclaration`
#### Set Signature
> **set** **style**(`cssText`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11120
##### Parameters
###### cssText
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.style`
***
### textContent
#### Get Signature
> **get** **textContent**(): `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11102
[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)
##### Returns
`string`
#### Set Signature
> **set** **textContent**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11103
The **`textContent`** property of the Node interface represents the text content of the node and its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/textContent)
##### Parameters
###### value
`string` \| `null`
##### Returns
`void`
#### Inherited from
[`BannerElement`](/developers/references/components/interfaces/bannerelement/).[`textContent`](/developers/references/components/interfaces/bannerelement/#textcontent)
## Methods
### addEventListener()
#### Call Signature
> **addEventListener**\<`K`\>(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13839
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementEventMap`
##### Parameters
###### type
`K`
###### listener
(`this`, `ev`) => `any`
###### options?
`boolean` \| `AddEventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.addEventListener`
#### Call Signature
> **addEventListener**(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13840
##### Parameters
###### type
`string`
###### listener
`EventListenerOrEventListenerObject`
###### options?
`boolean` \| `AddEventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.addEventListener`
***
### after()
> **after**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7953
Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.after`
***
### animate()
> **animate**(`keyframes`, `options?`): `Animation`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2921
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)
#### Parameters
##### keyframes
`Keyframe`[] \| `PropertyIndexedKeyframes` \| `null`
##### options?
`number` \| `KeyframeAnimationOptions`
#### Returns
`Animation`
#### Inherited from
`HTMLElement.animate`
***
### append()
> **append**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22694
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.append`
***
### appendChild()
> **appendChild**\<`T`\>(`node`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21748
The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.appendChild`
***
### attachInternals()
> **attachInternals**(): `ElementInternals`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13814
The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)
#### Returns
`ElementInternals`
#### Inherited from
`HTMLElement.attachInternals`
***
### attachShadow()
> **attachShadow**(`init`): `ShadowRoot`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10846
The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)
#### Parameters
##### init
`ShadowRootInit`
#### Returns
`ShadowRoot`
#### Inherited from
`HTMLElement.attachShadow`
***
### before()
> **before**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7961
Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.before`
***
### blur()
> **blur**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16073
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)
#### Returns
`void`
#### Inherited from
`HTMLElement.blur`
***
### checkVisibility()
> **checkVisibility**(`options?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10852
The **`checkVisibility()`** method of the Element interface checks whether the element is visible.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)
#### Parameters
##### options?
`CheckVisibilityOptions`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.checkVisibility`
***
### click()
> **click**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13820
The **`HTMLElement.click()`** method simulates a mouse click on an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)
#### Returns
`void`
#### Inherited from
`HTMLElement.click`
***
### cloneNode()
> **cloneNode**(`subtree?`): `Node`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21754
The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)
#### Parameters
##### subtree?
`boolean`
#### Returns
`Node`
#### Inherited from
`HTMLElement.cloneNode`
***
### closest()
#### Call Signature
> **closest**\<`K`\>(`selector`): `HTMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10858
The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`HTMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`K`\>(`selector`): `SVGElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10859
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`SVGElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`K`\>(`selector`): `MathMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10860
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`MathMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`E`\>(`selectors`): `E` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10861
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`E` \| `null`
##### Inherited from
`HTMLElement.closest`
***
### compareDocumentPosition()
> **compareDocumentPosition**(`other`): `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21760
The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)
#### Parameters
##### other
`Node`
#### Returns
`number`
#### Inherited from
`HTMLElement.compareDocumentPosition`
***
### computedStyleMap()
> **computedStyleMap**(): `StylePropertyMapReadOnly`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10867
The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)
#### Returns
`StylePropertyMapReadOnly`
#### Inherited from
`HTMLElement.computedStyleMap`
***
### contains()
> **contains**(`other`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21766
The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)
#### Parameters
##### other
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.contains`
***
### dispatchEvent()
> **dispatchEvent**(`event`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11575
The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
#### Parameters
##### event
`Event`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.dispatchEvent`
***
### focus()
> **focus**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16075
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)
#### Parameters
##### options?
`FocusOptions`
#### Returns
`void`
#### Inherited from
`HTMLElement.focus`
***
### getAnimations()
> **getAnimations**(`options?`): `Animation`[]
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2923
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)
#### Parameters
##### options?
`GetAnimationsOptions`
#### Returns
`Animation`[]
#### Inherited from
`HTMLElement.getAnimations`
***
### getAttribute()
> **getAttribute**(`qualifiedName`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10873
The **`getAttribute()`** method of the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.getAttribute`
***
### getAttributeNames()
> **getAttributeNames**(): `string`[]
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10885
The **`getAttributeNames()`** method of the array.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)
#### Returns
`string`[]
#### Inherited from
`HTMLElement.getAttributeNames`
***
### getAttributeNode()
> **getAttributeNode**(`qualifiedName`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10891
Returns the specified attribute of the specified element, as an Attr node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)
#### Parameters
##### qualifiedName
`string`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.getAttributeNode`
***
### getAttributeNodeNS()
> **getAttributeNodeNS**(`namespace`, `localName`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10897
The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.getAttributeNodeNS`
***
### getAttributeNS()
> **getAttributeNS**(`namespace`, `localName`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10879
The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.getAttributeNS`
***
### getBoundingClientRect()
> **getBoundingClientRect**(): `DOMRect`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10903
The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)
#### Returns
`DOMRect`
#### Inherited from
`HTMLElement.getBoundingClientRect`
***
### getClientRects()
> **getClientRects**(): `DOMRectList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10909
The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)
#### Returns
`DOMRectList`
#### Inherited from
`HTMLElement.getClientRects`
***
### getElementsByClassName()
> **getElementsByClassName**(`classNames`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10915
The Element method **`getElementsByClassName()`** returns a live specified class name or names.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)
#### Parameters
##### classNames
`string`
#### Returns
`HTMLCollectionOf`\<`Element`\>
#### Inherited from
`HTMLElement.getElementsByClassName`
***
### getElementsByTagName()
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`HTMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10921
The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`HTMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`SVGElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10922
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`SVGElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`MathMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10923
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`MathMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10925
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**(`qualifiedName`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10926
##### Parameters
###### qualifiedName
`string`
##### Returns
`HTMLCollectionOf`\<`Element`\>
##### Inherited from
`HTMLElement.getElementsByTagName`
***
### getElementsByTagNameNS()
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`HTMLElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10932
The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)
##### Parameters
###### namespaceURI
`"http://www.w3.org/1999/xhtml"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`HTMLElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`SVGElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10933
##### Parameters
###### namespaceURI
`"http://www.w3.org/2000/svg"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`SVGElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`MathMLElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10934
##### Parameters
###### namespaceURI
`"http://www.w3.org/1998/Math/MathML"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`MathMLElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespace`, `localName`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10935
##### Parameters
###### namespace
`string` \| `null`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`Element`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
***
### getHTML()
> **getHTML**(`options?`): `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10941
The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)
#### Parameters
##### options?
`GetHTMLOptions`
#### Returns
`string`
#### Inherited from
`HTMLElement.getHTML`
***
### getRootNode()
> **getRootNode**(`options?`): `Node`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21772
The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)
#### Parameters
##### options?
`GetRootNodeOptions`
#### Returns
`Node`
#### Inherited from
`HTMLElement.getRootNode`
***
### hasAttribute()
> **hasAttribute**(`qualifiedName`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10947
The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttribute`
***
### hasAttributeNS()
> **hasAttributeNS**(`namespace`, `localName`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10953
The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttributeNS`
***
### hasAttributes()
> **hasAttributes**(): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10959
The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttributes`
***
### hasChildNodes()
> **hasChildNodes**(): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21778
The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasChildNodes`
***
### hasPointerCapture()
> **hasPointerCapture**(`pointerId`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10965
The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasPointerCapture`
***
### hidePopover()
> **hidePopover**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13826
The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)
#### Returns
`void`
#### Inherited from
`HTMLElement.hidePopover`
***
### insertAdjacentElement()
> **insertAdjacentElement**(`where`, `element`): `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10971
The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)
#### Parameters
##### where
`InsertPosition`
##### element
`Element`
#### Returns
`Element` \| `null`
#### Inherited from
`HTMLElement.insertAdjacentElement`
***
### insertAdjacentHTML()
> **insertAdjacentHTML**(`position`, `string`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10977
The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)
#### Parameters
##### position
`InsertPosition`
##### string
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.insertAdjacentHTML`
***
### insertAdjacentText()
> **insertAdjacentText**(`where`, `data`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10983
The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)
#### Parameters
##### where
`InsertPosition`
##### data
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.insertAdjacentText`
***
### insertBefore()
> **insertBefore**\<`T`\>(`node`, `child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21784
The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`T`
##### child
`Node` \| `null`
#### Returns
`T`
#### Inherited from
`HTMLElement.insertBefore`
***
### isDefaultNamespace()
> **isDefaultNamespace**(`namespace`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21790
The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)
#### Parameters
##### namespace
`string` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isDefaultNamespace`
***
### isEqualNode()
> **isEqualNode**(`otherNode`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21796
The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)
#### Parameters
##### otherNode
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isEqualNode`
***
### isSameNode()
> **isSameNode**(`otherNode`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21802
The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)
#### Parameters
##### otherNode
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isSameNode`
***
### lookupNamespaceURI()
> **lookupNamespaceURI**(`prefix`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21808
The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)
#### Parameters
##### prefix
`string` \| `null`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.lookupNamespaceURI`
***
### lookupPrefix()
> **lookupPrefix**(`namespace`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21814
The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)
#### Parameters
##### namespace
`string` \| `null`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.lookupPrefix`
***
### matches()
> **matches**(`selectors`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10989
The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)
#### Parameters
##### selectors
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.matches`
***
### normalize()
> **normalize**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21820
The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)
#### Returns
`void`
#### Inherited from
`HTMLElement.normalize`
***
### prepend()
> **prepend**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22702
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.prepend`
***
### querySelector()
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `HTMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22708
Returns the first element that is a descendant of node that matches selectors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`HTMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `SVGElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22709
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`SVGElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `MathMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22710
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`MathMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `HTMLElementDeprecatedTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22712
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`HTMLElementDeprecatedTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`E`\>(`selectors`): `E` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22713
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`E` \| `null`
##### Inherited from
`HTMLElement.querySelector`
***
### querySelectorAll()
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`HTMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22719
Returns all element descendants of node that match selectors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`HTMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`SVGElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22720
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`SVGElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`MathMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22721
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`MathMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22723
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`E`\>(`selectors`): `NodeListOf`\<`E`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22724
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`NodeListOf`\<`E`\>
##### Inherited from
`HTMLElement.querySelectorAll`
***
### releasePointerCapture()
> **releasePointerCapture**(`pointerId`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10995
The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`void`
#### Inherited from
`HTMLElement.releasePointerCapture`
***
### remove()
> **remove**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7967
Removes node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)
#### Returns
`void`
#### Inherited from
`HTMLElement.remove`
***
### removeAttribute()
> **removeAttribute**(`qualifiedName`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11001
The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.removeAttribute`
***
### removeAttributeNode()
> **removeAttributeNode**(`attr`): `Attr`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11013
The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr`
#### Inherited from
`HTMLElement.removeAttributeNode`
***
### removeAttributeNS()
> **removeAttributeNS**(`namespace`, `localName`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11007
The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.removeAttributeNS`
***
### removeChild()
> **removeChild**\<`T`\>(`child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21826
The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### child
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.removeChild`
***
### removeEventListener()
#### Call Signature
> **removeEventListener**\<`K`\>(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13841
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementEventMap`
##### Parameters
###### type
`K`
###### listener
(`this`, `ev`) => `any`
###### options?
`boolean` \| `EventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.removeEventListener`
#### Call Signature
> **removeEventListener**(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13842
##### Parameters
###### type
`string`
###### listener
`EventListenerOrEventListenerObject`
###### options?
`boolean` \| `EventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.removeEventListener`
***
### replaceChild()
> **replaceChild**\<`T`\>(`node`, `child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21832
The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`Node`
##### child
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.replaceChild`
***
### replaceChildren()
> **replaceChildren**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22732
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.replaceChildren`
***
### replaceWith()
> **replaceWith**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7975
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.replaceWith`
***
### requestFullscreen()
> **requestFullscreen**(`options?`): `Promise`\<`void`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11019
The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)
#### Parameters
##### options?
`FullscreenOptions`
#### Returns
`Promise`\<`void`\>
#### Inherited from
`HTMLElement.requestFullscreen`
***
### requestPointerLock()
> **requestPointerLock**(`options?`): `Promise`\<`void`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11025
The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)
#### Parameters
##### options?
`PointerLockOptions`
#### Returns
`Promise`\<`void`\>
#### Inherited from
`HTMLElement.requestPointerLock`
***
### scroll()
#### Call Signature
> **scroll**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11031
The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scroll`
#### Call Signature
> **scroll**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11032
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scroll`
***
### scrollBy()
#### Call Signature
> **scrollBy**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11038
The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollBy`
#### Call Signature
> **scrollBy**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11039
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollBy`
***
### scrollIntoView()
> **scrollIntoView**(`arg?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11045
The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)
#### Parameters
##### arg?
`boolean` \| `ScrollIntoViewOptions`
#### Returns
`void`
#### Inherited from
`HTMLElement.scrollIntoView`
***
### scrollTo()
#### Call Signature
> **scrollTo**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11051
The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollTo`
#### Call Signature
> **scrollTo**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11052
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollTo`
***
### setAttribute()
> **setAttribute**(`qualifiedName`, `value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11058
The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)
#### Parameters
##### qualifiedName
`string`
##### value
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setAttribute`
***
### setAttributeNode()
> **setAttributeNode**(`attr`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11070
The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.setAttributeNode`
***
### setAttributeNodeNS()
> **setAttributeNodeNS**(`attr`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11076
The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.setAttributeNodeNS`
***
### setAttributeNS()
> **setAttributeNS**(`namespace`, `qualifiedName`, `value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11064
`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### qualifiedName
`string`
##### value
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setAttributeNS`
***
### setHTMLUnsafe()
> **setHTMLUnsafe**(`html`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11082
The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)
#### Parameters
##### html
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setHTMLUnsafe`
***
### setPointerCapture()
> **setPointerCapture**(`pointerId`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11088
The **`setPointerCapture()`** method of the _capture target_ of future pointer events.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`void`
#### Inherited from
`HTMLElement.setPointerCapture`
***
### showPopover()
> **showPopover**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13832
The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)
#### Returns
`void`
#### Inherited from
`HTMLElement.showPopover`
***
### toggleAttribute()
> **toggleAttribute**(`qualifiedName`, `force?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11094
The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)
#### Parameters
##### qualifiedName
`string`
##### force?
`boolean`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.toggleAttribute`
***
### togglePopover()
> **togglePopover**(`options?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13838
The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)
#### Parameters
##### options?
`boolean`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.togglePopover`
***
### ~~webkitMatchesSelector()~~
> **webkitMatchesSelector**(`selectors`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11100
:::caution[Deprecated]
This is a legacy alias of `matches`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)
:::
#### Parameters
##### selectors
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.webkitMatchesSelector`
# PostPurchaseElement
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/index.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/index.ts#L11)
Custom element interface for ``.
Combines standard HTMLElement with [PostPurchaseProps](/developers/references/components/type-aliases/postpurchaseprops/).
## Extends
- `HTMLElement`.[`PostPurchaseProps`](/developers/references/components/type-aliases/postpurchaseprops/)
## Properties
### accessKey
> **accessKey**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13688
The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)
#### Inherited from
`HTMLElement.accessKey`
***
### accessKeyLabel
> `readonly` **accessKeyLabel**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13694
The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)
#### Inherited from
`HTMLElement.accessKeyLabel`
***
### ariaActiveDescendantElement
> **ariaActiveDescendantElement**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2607
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)
#### Inherited from
`HTMLElement.ariaActiveDescendantElement`
***
### ariaAtomic
> **ariaAtomic**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2609
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)
#### Inherited from
`HTMLElement.ariaAtomic`
***
### ariaAutoComplete
> **ariaAutoComplete**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2611
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)
#### Inherited from
`HTMLElement.ariaAutoComplete`
***
### ariaBrailleLabel
> **ariaBrailleLabel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2613
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)
#### Inherited from
`HTMLElement.ariaBrailleLabel`
***
### ariaBrailleRoleDescription
> **ariaBrailleRoleDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2615
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)
#### Inherited from
`HTMLElement.ariaBrailleRoleDescription`
***
### ariaBusy
> **ariaBusy**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2617
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)
#### Inherited from
`HTMLElement.ariaBusy`
***
### ariaChecked
> **ariaChecked**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2619
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)
#### Inherited from
`HTMLElement.ariaChecked`
***
### ariaColCount
> **ariaColCount**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2621
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)
#### Inherited from
`HTMLElement.ariaColCount`
***
### ariaColIndex
> **ariaColIndex**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2623
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)
#### Inherited from
`HTMLElement.ariaColIndex`
***
### ariaColIndexText
> **ariaColIndexText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2625
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)
#### Inherited from
`HTMLElement.ariaColIndexText`
***
### ariaColSpan
> **ariaColSpan**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2627
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)
#### Inherited from
`HTMLElement.ariaColSpan`
***
### ariaControlsElements
> **ariaControlsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2629
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)
#### Inherited from
`HTMLElement.ariaControlsElements`
***
### ariaCurrent
> **ariaCurrent**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2631
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)
#### Inherited from
`HTMLElement.ariaCurrent`
***
### ariaDescribedByElements
> **ariaDescribedByElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2633
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)
#### Inherited from
`HTMLElement.ariaDescribedByElements`
***
### ariaDescription
> **ariaDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2635
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)
#### Inherited from
`HTMLElement.ariaDescription`
***
### ariaDetailsElements
> **ariaDetailsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2637
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)
#### Inherited from
`HTMLElement.ariaDetailsElements`
***
### ariaDisabled
> **ariaDisabled**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2639
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)
#### Inherited from
`HTMLElement.ariaDisabled`
***
### ariaErrorMessageElements
> **ariaErrorMessageElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2641
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)
#### Inherited from
`HTMLElement.ariaErrorMessageElements`
***
### ariaExpanded
> **ariaExpanded**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2643
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)
#### Inherited from
`HTMLElement.ariaExpanded`
***
### ariaFlowToElements
> **ariaFlowToElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2645
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)
#### Inherited from
`HTMLElement.ariaFlowToElements`
***
### ariaHasPopup
> **ariaHasPopup**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2647
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)
#### Inherited from
`HTMLElement.ariaHasPopup`
***
### ariaHidden
> **ariaHidden**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2649
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)
#### Inherited from
`HTMLElement.ariaHidden`
***
### ariaInvalid
> **ariaInvalid**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2651
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)
#### Inherited from
`HTMLElement.ariaInvalid`
***
### ariaKeyShortcuts
> **ariaKeyShortcuts**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2653
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)
#### Inherited from
`HTMLElement.ariaKeyShortcuts`
***
### ariaLabel
> **ariaLabel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2655
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)
#### Inherited from
`HTMLElement.ariaLabel`
***
### ariaLabelledByElements
> **ariaLabelledByElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2657
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)
#### Inherited from
`HTMLElement.ariaLabelledByElements`
***
### ariaLevel
> **ariaLevel**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2659
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)
#### Inherited from
`HTMLElement.ariaLevel`
***
### ariaLive
> **ariaLive**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2661
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)
#### Inherited from
`HTMLElement.ariaLive`
***
### ariaModal
> **ariaModal**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2663
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)
#### Inherited from
`HTMLElement.ariaModal`
***
### ariaMultiLine
> **ariaMultiLine**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2665
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)
#### Inherited from
`HTMLElement.ariaMultiLine`
***
### ariaMultiSelectable
> **ariaMultiSelectable**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2667
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)
#### Inherited from
`HTMLElement.ariaMultiSelectable`
***
### ariaOrientation
> **ariaOrientation**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2669
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)
#### Inherited from
`HTMLElement.ariaOrientation`
***
### ariaOwnsElements
> **ariaOwnsElements**: readonly `Element`[] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2671
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)
#### Inherited from
`HTMLElement.ariaOwnsElements`
***
### ariaPlaceholder
> **ariaPlaceholder**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2673
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)
#### Inherited from
`HTMLElement.ariaPlaceholder`
***
### ariaPosInSet
> **ariaPosInSet**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2675
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)
#### Inherited from
`HTMLElement.ariaPosInSet`
***
### ariaPressed
> **ariaPressed**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2677
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)
#### Inherited from
`HTMLElement.ariaPressed`
***
### ariaReadOnly
> **ariaReadOnly**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2679
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)
#### Inherited from
`HTMLElement.ariaReadOnly`
***
### ariaRelevant
> **ariaRelevant**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2681
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)
#### Inherited from
`HTMLElement.ariaRelevant`
***
### ariaRequired
> **ariaRequired**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2683
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)
#### Inherited from
`HTMLElement.ariaRequired`
***
### ariaRoleDescription
> **ariaRoleDescription**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2685
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)
#### Inherited from
`HTMLElement.ariaRoleDescription`
***
### ariaRowCount
> **ariaRowCount**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2687
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)
#### Inherited from
`HTMLElement.ariaRowCount`
***
### ariaRowIndex
> **ariaRowIndex**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2689
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)
#### Inherited from
`HTMLElement.ariaRowIndex`
***
### ariaRowIndexText
> **ariaRowIndexText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2691
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)
#### Inherited from
`HTMLElement.ariaRowIndexText`
***
### ariaRowSpan
> **ariaRowSpan**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2693
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)
#### Inherited from
`HTMLElement.ariaRowSpan`
***
### ariaSelected
> **ariaSelected**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2695
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)
#### Inherited from
`HTMLElement.ariaSelected`
***
### ariaSetSize
> **ariaSetSize**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2697
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)
#### Inherited from
`HTMLElement.ariaSetSize`
***
### ariaSort
> **ariaSort**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2699
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)
#### Inherited from
`HTMLElement.ariaSort`
***
### ariaValueMax
> **ariaValueMax**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2701
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)
#### Inherited from
`HTMLElement.ariaValueMax`
***
### ariaValueMin
> **ariaValueMin**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2703
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)
#### Inherited from
`HTMLElement.ariaValueMin`
***
### ariaValueNow
> **ariaValueNow**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2705
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)
#### Inherited from
`HTMLElement.ariaValueNow`
***
### ariaValueText
> **ariaValueText**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2707
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)
#### Inherited from
`HTMLElement.ariaValueText`
***
### assignedSlot
> `readonly` **assignedSlot**: `HTMLSlotElement` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:30826
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)
#### Inherited from
`HTMLElement.assignedSlot`
***
### ATTRIBUTE\_NODE
> `readonly` **ATTRIBUTE\_NODE**: `2`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21835
#### Inherited from
`HTMLElement.ATTRIBUTE_NODE`
***
### attributes
> `readonly` **attributes**: `NamedNodeMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10707
The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)
#### Inherited from
`HTMLElement.attributes`
***
### attributeStyleMap
> `readonly` **attributeStyleMap**: `StylePropertyMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11117
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)
#### Inherited from
`HTMLElement.attributeStyleMap`
***
### autocapitalize
> **autocapitalize**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13700
The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)
#### Inherited from
`HTMLElement.autocapitalize`
***
### autocorrect
> **autocorrect**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13706
The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)
#### Inherited from
`HTMLElement.autocorrect`
***
### autofocus
> **autofocus**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16065
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)
#### Inherited from
`HTMLElement.autofocus`
***
### badgeText?
> `optional` **badgeText?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:47](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L47)
Label for the pill badge displayed above the message.
When omitted (and no placement config provides one), the badge is hidden.
#### Inherited from
`PostPurchaseProps.badgeText`
***
### baseURI
> `readonly` **baseURI**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21664
The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)
#### Inherited from
`HTMLElement.baseURI`
***
### CDATA\_SECTION\_NODE
> `readonly` **CDATA\_SECTION\_NODE**: `4`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21839
node is a CDATASection node.
#### Inherited from
`HTMLElement.CDATA_SECTION_NODE`
***
### childElementCount
> `readonly` **childElementCount**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22668
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)
#### Inherited from
`HTMLElement.childElementCount`
***
### childNodes
> `readonly` **childNodes**: `NodeListOf`\<`ChildNode`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21670
The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)
#### Inherited from
`HTMLElement.childNodes`
***
### children
> `readonly` **children**: `HTMLCollection`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22674
Returns the child elements.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)
#### Inherited from
`HTMLElement.children`
***
### classname?
> `optional` **classname?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:38](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L38)
CSS class names passed through to the root element (Light DOM).
#### Inherited from
`PostPurchaseProps.classname`
***
### className
> **className**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10720
The **`className`** property of the of the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)
#### Inherited from
`HTMLElement.className`
***
### clientHeight
> `readonly` **clientHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10726
The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)
#### Inherited from
`HTMLElement.clientHeight`
***
### clientLeft
> `readonly` **clientLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10732
The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)
#### Inherited from
`HTMLElement.clientLeft`
***
### clientTop
> `readonly` **clientTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10738
The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)
#### Inherited from
`HTMLElement.clientTop`
***
### clientWidth
> `readonly` **clientWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10744
The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)
#### Inherited from
`HTMLElement.clientWidth`
***
### COMMENT\_NODE
> `readonly` **COMMENT\_NODE**: `8`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21845
node is a Comment node.
#### Inherited from
`HTMLElement.COMMENT_NODE`
***
### contentEditable
> **contentEditable**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11125
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)
#### Inherited from
`HTMLElement.contentEditable`
***
### ctaText?
> `optional` **ctaText?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:62](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L62)
Override the CTA button text.
Use `{REWARD}` as placeholder for the reward amount.
#### Inherited from
`PostPurchaseProps.ctaText`
***
### currentCSSZoom
> `readonly` **currentCSSZoom**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10750
The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)
#### Inherited from
`HTMLElement.currentCSSZoom`
***
### customerId?
> `optional` **customerId?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:13](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L13)
Merchant customer ID for purchase tracking fallback.
All three tracking props (`customerId`, `orderId`, `token`) must be
present for tracking to fire.
#### Inherited from
`PostPurchaseProps.customerId`
***
### dataset
> `readonly` **dataset**: `DOMStringMap`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16067
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)
#### Inherited from
`HTMLElement.dataset`
***
### dir
> **dir**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13712
The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)
#### Inherited from
`HTMLElement.dir`
***
### DOCUMENT\_FRAGMENT\_NODE
> `readonly` **DOCUMENT\_FRAGMENT\_NODE**: `11`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21851
node is a DocumentFragment node.
#### Inherited from
`HTMLElement.DOCUMENT_FRAGMENT_NODE`
***
### DOCUMENT\_NODE
> `readonly` **DOCUMENT\_NODE**: `9`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21847
node is a document.
#### Inherited from
`HTMLElement.DOCUMENT_NODE`
***
### DOCUMENT\_POSITION\_CONTAINED\_BY
> `readonly` **DOCUMENT\_POSITION\_CONTAINED\_BY**: `16`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21862
Set when other is a descendant of node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_CONTAINED_BY`
***
### DOCUMENT\_POSITION\_CONTAINS
> `readonly` **DOCUMENT\_POSITION\_CONTAINS**: `8`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21860
Set when other is an ancestor of node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_CONTAINS`
***
### DOCUMENT\_POSITION\_DISCONNECTED
> `readonly` **DOCUMENT\_POSITION\_DISCONNECTED**: `1`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21854
Set when node and other are not in the same tree.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_DISCONNECTED`
***
### DOCUMENT\_POSITION\_FOLLOWING
> `readonly` **DOCUMENT\_POSITION\_FOLLOWING**: `4`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21858
Set when other is following node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_FOLLOWING`
***
### DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC
> `readonly` **DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC**: `32`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21863
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC`
***
### DOCUMENT\_POSITION\_PRECEDING
> `readonly` **DOCUMENT\_POSITION\_PRECEDING**: `2`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21856
Set when other is preceding node.
#### Inherited from
`HTMLElement.DOCUMENT_POSITION_PRECEDING`
***
### DOCUMENT\_TYPE\_NODE
> `readonly` **DOCUMENT\_TYPE\_NODE**: `10`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21849
node is a doctype.
#### Inherited from
`HTMLElement.DOCUMENT_TYPE_NODE`
***
### draggable
> **draggable**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13718
The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)
#### Inherited from
`HTMLElement.draggable`
***
### ELEMENT\_NODE
> `readonly` **ELEMENT\_NODE**: `1`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21834
node is an element.
#### Inherited from
`HTMLElement.ELEMENT_NODE`
***
### enterKeyHint
> **enterKeyHint**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11127
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)
#### Inherited from
`HTMLElement.enterKeyHint`
***
### ENTITY\_NODE
> `readonly` **ENTITY\_NODE**: `6`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21841
#### Inherited from
`HTMLElement.ENTITY_NODE`
***
### ENTITY\_REFERENCE\_NODE
> `readonly` **ENTITY\_REFERENCE\_NODE**: `5`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21840
#### Inherited from
`HTMLElement.ENTITY_REFERENCE_NODE`
***
### firstChild
> `readonly` **firstChild**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21676
The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)
#### Inherited from
`HTMLElement.firstChild`
***
### firstElementChild
> `readonly` **firstElementChild**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22680
Returns the first child that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)
#### Inherited from
`HTMLElement.firstElementChild`
***
### hidden
> **hidden**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13724
The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)
#### Inherited from
`HTMLElement.hidden`
***
### id
> **id**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10756
The **`id`** property of the Element interface represents the element's identifier, reflecting the **`id`** global attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/id)
#### Inherited from
`HTMLElement.id`
***
### imageUrl?
> `optional` **imageUrl?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:69](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L69)
Override the image displayed on the left of the post-purchase card.
Accepts an image URL. Falls back to the built-in gift icon when omitted.
The image is constrained to the icon slot via `object-fit: contain`,
so any aspect ratio renders correctly.
#### Inherited from
`PostPurchaseProps.imageUrl`
***
### inert
> **inert**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13730
The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)
#### Inherited from
`HTMLElement.inert`
***
### innerHTML
> **innerHTML**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10762
The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)
#### Inherited from
`HTMLElement.innerHTML`
***
### innerText
> **innerText**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13736
The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)
#### Inherited from
`HTMLElement.innerText`
***
### inputMode
> **inputMode**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11129
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)
#### Inherited from
`HTMLElement.inputMode`
***
### isConnected
> `readonly` **isConnected**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21682
The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)
#### Inherited from
`HTMLElement.isConnected`
***
### isContentEditable
> `readonly` **isContentEditable**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11131
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)
#### Inherited from
`HTMLElement.isContentEditable`
***
### lang
> **lang**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13742
The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)
#### Inherited from
`HTMLElement.lang`
***
### lastChild
> `readonly` **lastChild**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21688
The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)
#### Inherited from
`HTMLElement.lastChild`
***
### lastElementChild
> `readonly` **lastElementChild**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22686
Returns the last child that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)
#### Inherited from
`HTMLElement.lastElementChild`
***
### localName
> `readonly` **localName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10768
The **`Element.localName`** read-only property returns the local part of the qualified name of an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)
#### Inherited from
`HTMLElement.localName`
***
### merchantId?
> `optional` **merchantId?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:30](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L30)
Override the merchant ID resolved from the SDK config.
#### Inherited from
`PostPurchaseProps.merchantId`
***
### namespaceURI
> `readonly` **namespaceURI**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10774
The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)
#### Inherited from
`HTMLElement.namespaceURI`
***
### nextElementSibling
> `readonly` **nextElementSibling**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22003
Returns the first following sibling that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)
#### Inherited from
`HTMLElement.nextElementSibling`
***
### nextSibling
> `readonly` **nextSibling**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21694
The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)
#### Inherited from
`HTMLElement.nextSibling`
***
### nodeName
> `readonly` **nodeName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21700
The read-only **`nodeName`** property of Node returns the name of the current node as a string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)
#### Inherited from
`HTMLElement.nodeName`
***
### nodeType
> `readonly` **nodeType**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21706
The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)
#### Inherited from
`HTMLElement.nodeType`
***
### nodeValue
> **nodeValue**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21712
The **`nodeValue`** property of the Node interface returns or sets the value of the current node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)
#### Inherited from
`HTMLElement.nodeValue`
***
### nonce?
> `optional` **nonce?**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16069
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)
#### Inherited from
`HTMLElement.nonce`
***
### NOTATION\_NODE
> `readonly` **NOTATION\_NODE**: `12`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21852
#### Inherited from
`HTMLElement.NOTATION_NODE`
***
### offsetHeight
> `readonly` **offsetHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13748
The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)
#### Inherited from
`HTMLElement.offsetHeight`
***
### offsetLeft
> `readonly` **offsetLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13754
The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)
#### Inherited from
`HTMLElement.offsetLeft`
***
### offsetParent
> `readonly` **offsetParent**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13760
The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)
#### Inherited from
`HTMLElement.offsetParent`
***
### offsetTop
> `readonly` **offsetTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13766
The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)
#### Inherited from
`HTMLElement.offsetTop`
***
### offsetWidth
> `readonly` **offsetWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13772
The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)
#### Inherited from
`HTMLElement.offsetWidth`
***
### onabort
> **onabort**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12743
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)
#### Inherited from
`HTMLElement.onabort`
***
### onanimationcancel
> **onanimationcancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12745
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)
#### Inherited from
`HTMLElement.onanimationcancel`
***
### onanimationend
> **onanimationend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12747
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)
#### Inherited from
`HTMLElement.onanimationend`
***
### onanimationiteration
> **onanimationiteration**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12749
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)
#### Inherited from
`HTMLElement.onanimationiteration`
***
### onanimationstart
> **onanimationstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12751
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)
#### Inherited from
`HTMLElement.onanimationstart`
***
### onauxclick
> **onauxclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12753
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)
#### Inherited from
`HTMLElement.onauxclick`
***
### onbeforeinput
> **onbeforeinput**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12755
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)
#### Inherited from
`HTMLElement.onbeforeinput`
***
### onbeforematch
> **onbeforematch**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12757
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)
#### Inherited from
`HTMLElement.onbeforematch`
***
### onbeforetoggle
> **onbeforetoggle**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12759
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)
#### Inherited from
`HTMLElement.onbeforetoggle`
***
### onblur
> **onblur**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12761
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)
#### Inherited from
`HTMLElement.onblur`
***
### oncancel
> **oncancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12763
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)
#### Inherited from
`HTMLElement.oncancel`
***
### oncanplay
> **oncanplay**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12765
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)
#### Inherited from
`HTMLElement.oncanplay`
***
### oncanplaythrough
> **oncanplaythrough**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12767
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)
#### Inherited from
`HTMLElement.oncanplaythrough`
***
### onchange
> **onchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12769
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)
#### Inherited from
`HTMLElement.onchange`
***
### onclick
> **onclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12771
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)
#### Inherited from
`HTMLElement.onclick`
***
### onclose
> **onclose**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12773
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)
#### Inherited from
`HTMLElement.onclose`
***
### oncontextlost
> **oncontextlost**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12775
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)
#### Inherited from
`HTMLElement.oncontextlost`
***
### oncontextmenu
> **oncontextmenu**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12777
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)
#### Inherited from
`HTMLElement.oncontextmenu`
***
### oncontextrestored
> **oncontextrestored**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12779
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)
#### Inherited from
`HTMLElement.oncontextrestored`
***
### oncopy
> **oncopy**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12781
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)
#### Inherited from
`HTMLElement.oncopy`
***
### oncuechange
> **oncuechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12783
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)
#### Inherited from
`HTMLElement.oncuechange`
***
### oncut
> **oncut**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12785
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)
#### Inherited from
`HTMLElement.oncut`
***
### ondblclick
> **ondblclick**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12787
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)
#### Inherited from
`HTMLElement.ondblclick`
***
### ondrag
> **ondrag**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12789
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)
#### Inherited from
`HTMLElement.ondrag`
***
### ondragend
> **ondragend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12791
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)
#### Inherited from
`HTMLElement.ondragend`
***
### ondragenter
> **ondragenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12793
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)
#### Inherited from
`HTMLElement.ondragenter`
***
### ondragleave
> **ondragleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12795
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)
#### Inherited from
`HTMLElement.ondragleave`
***
### ondragover
> **ondragover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12797
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)
#### Inherited from
`HTMLElement.ondragover`
***
### ondragstart
> **ondragstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12799
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)
#### Inherited from
`HTMLElement.ondragstart`
***
### ondrop
> **ondrop**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12801
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)
#### Inherited from
`HTMLElement.ondrop`
***
### ondurationchange
> **ondurationchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12803
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)
#### Inherited from
`HTMLElement.ondurationchange`
***
### onemptied
> **onemptied**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12805
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)
#### Inherited from
`HTMLElement.onemptied`
***
### onended
> **onended**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12807
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)
#### Inherited from
`HTMLElement.onended`
***
### onerror
> **onerror**: `OnErrorEventHandler`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12809
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)
#### Inherited from
`HTMLElement.onerror`
***
### onfocus
> **onfocus**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12811
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)
#### Inherited from
`HTMLElement.onfocus`
***
### onformdata
> **onformdata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12813
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)
#### Inherited from
`HTMLElement.onformdata`
***
### onfullscreenchange
> **onfullscreenchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10776
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)
#### Inherited from
`HTMLElement.onfullscreenchange`
***
### onfullscreenerror
> **onfullscreenerror**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10778
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)
#### Inherited from
`HTMLElement.onfullscreenerror`
***
### ongotpointercapture
> **ongotpointercapture**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12815
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)
#### Inherited from
`HTMLElement.ongotpointercapture`
***
### oninput
> **oninput**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12817
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)
#### Inherited from
`HTMLElement.oninput`
***
### oninvalid
> **oninvalid**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12819
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)
#### Inherited from
`HTMLElement.oninvalid`
***
### onkeydown
> **onkeydown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12821
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)
#### Inherited from
`HTMLElement.onkeydown`
***
### ~~onkeypress~~
> **onkeypress**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12827
:::caution[Deprecated]
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)
:::
#### Inherited from
`HTMLElement.onkeypress`
***
### onkeyup
> **onkeyup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12829
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)
#### Inherited from
`HTMLElement.onkeyup`
***
### onload
> **onload**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12831
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)
#### Inherited from
`HTMLElement.onload`
***
### onloadeddata
> **onloadeddata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12833
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)
#### Inherited from
`HTMLElement.onloadeddata`
***
### onloadedmetadata
> **onloadedmetadata**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12835
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)
#### Inherited from
`HTMLElement.onloadedmetadata`
***
### onloadstart
> **onloadstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12837
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)
#### Inherited from
`HTMLElement.onloadstart`
***
### onlostpointercapture
> **onlostpointercapture**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12839
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)
#### Inherited from
`HTMLElement.onlostpointercapture`
***
### onmousedown
> **onmousedown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12841
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)
#### Inherited from
`HTMLElement.onmousedown`
***
### onmouseenter
> **onmouseenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12843
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)
#### Inherited from
`HTMLElement.onmouseenter`
***
### onmouseleave
> **onmouseleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12845
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)
#### Inherited from
`HTMLElement.onmouseleave`
***
### onmousemove
> **onmousemove**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12847
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)
#### Inherited from
`HTMLElement.onmousemove`
***
### onmouseout
> **onmouseout**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12849
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)
#### Inherited from
`HTMLElement.onmouseout`
***
### onmouseover
> **onmouseover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12851
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)
#### Inherited from
`HTMLElement.onmouseover`
***
### onmouseup
> **onmouseup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12853
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)
#### Inherited from
`HTMLElement.onmouseup`
***
### onpaste
> **onpaste**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12855
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)
#### Inherited from
`HTMLElement.onpaste`
***
### onpause
> **onpause**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12857
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)
#### Inherited from
`HTMLElement.onpause`
***
### onplay
> **onplay**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12859
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)
#### Inherited from
`HTMLElement.onplay`
***
### onplaying
> **onplaying**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12861
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)
#### Inherited from
`HTMLElement.onplaying`
***
### onpointercancel
> **onpointercancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12863
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)
#### Inherited from
`HTMLElement.onpointercancel`
***
### onpointerdown
> **onpointerdown**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12865
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)
#### Inherited from
`HTMLElement.onpointerdown`
***
### onpointerenter
> **onpointerenter**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12867
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)
#### Inherited from
`HTMLElement.onpointerenter`
***
### onpointerleave
> **onpointerleave**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12869
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)
#### Inherited from
`HTMLElement.onpointerleave`
***
### onpointermove
> **onpointermove**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12871
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)
#### Inherited from
`HTMLElement.onpointermove`
***
### onpointerout
> **onpointerout**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12873
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)
#### Inherited from
`HTMLElement.onpointerout`
***
### onpointerover
> **onpointerover**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12875
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)
#### Inherited from
`HTMLElement.onpointerover`
***
### onpointerrawupdate
> **onpointerrawupdate**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12881
Available only in secure contexts.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)
#### Inherited from
`HTMLElement.onpointerrawupdate`
***
### onpointerup
> **onpointerup**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12883
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)
#### Inherited from
`HTMLElement.onpointerup`
***
### onprogress
> **onprogress**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12885
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)
#### Inherited from
`HTMLElement.onprogress`
***
### onratechange
> **onratechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12887
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)
#### Inherited from
`HTMLElement.onratechange`
***
### onreset
> **onreset**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12889
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)
#### Inherited from
`HTMLElement.onreset`
***
### onresize
> **onresize**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12891
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)
#### Inherited from
`HTMLElement.onresize`
***
### onscroll
> **onscroll**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12893
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)
#### Inherited from
`HTMLElement.onscroll`
***
### onscrollend
> **onscrollend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12895
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)
#### Inherited from
`HTMLElement.onscrollend`
***
### onsecuritypolicyviolation
> **onsecuritypolicyviolation**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12897
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)
#### Inherited from
`HTMLElement.onsecuritypolicyviolation`
***
### onseeked
> **onseeked**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12899
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)
#### Inherited from
`HTMLElement.onseeked`
***
### onseeking
> **onseeking**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12901
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)
#### Inherited from
`HTMLElement.onseeking`
***
### onselect
> **onselect**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12903
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)
#### Inherited from
`HTMLElement.onselect`
***
### onselectionchange
> **onselectionchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12905
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)
#### Inherited from
`HTMLElement.onselectionchange`
***
### onselectstart
> **onselectstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12907
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)
#### Inherited from
`HTMLElement.onselectstart`
***
### onslotchange
> **onslotchange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12909
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)
#### Inherited from
`HTMLElement.onslotchange`
***
### onstalled
> **onstalled**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12911
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)
#### Inherited from
`HTMLElement.onstalled`
***
### onsubmit
> **onsubmit**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12913
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)
#### Inherited from
`HTMLElement.onsubmit`
***
### onsuspend
> **onsuspend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12915
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)
#### Inherited from
`HTMLElement.onsuspend`
***
### ontimeupdate
> **ontimeupdate**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12917
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)
#### Inherited from
`HTMLElement.ontimeupdate`
***
### ontoggle
> **ontoggle**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12919
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)
#### Inherited from
`HTMLElement.ontoggle`
***
### ontouchcancel?
> `optional` **ontouchcancel?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12921
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)
#### Inherited from
`HTMLElement.ontouchcancel`
***
### ontouchend?
> `optional` **ontouchend?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12923
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)
#### Inherited from
`HTMLElement.ontouchend`
***
### ontouchmove?
> `optional` **ontouchmove?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12925
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)
#### Inherited from
`HTMLElement.ontouchmove`
***
### ontouchstart?
> `optional` **ontouchstart?**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12927
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)
#### Inherited from
`HTMLElement.ontouchstart`
***
### ontransitioncancel
> **ontransitioncancel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12929
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)
#### Inherited from
`HTMLElement.ontransitioncancel`
***
### ontransitionend
> **ontransitionend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12931
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)
#### Inherited from
`HTMLElement.ontransitionend`
***
### ontransitionrun
> **ontransitionrun**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12933
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)
#### Inherited from
`HTMLElement.ontransitionrun`
***
### ontransitionstart
> **ontransitionstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12935
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)
#### Inherited from
`HTMLElement.ontransitionstart`
***
### onvolumechange
> **onvolumechange**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12937
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)
#### Inherited from
`HTMLElement.onvolumechange`
***
### onwaiting
> **onwaiting**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12939
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)
#### Inherited from
`HTMLElement.onwaiting`
***
### ~~onwebkitanimationend~~
> **onwebkitanimationend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12945
:::caution[Deprecated]
This is a legacy alias of `onanimationend`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationend`
***
### ~~onwebkitanimationiteration~~
> **onwebkitanimationiteration**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12951
:::caution[Deprecated]
This is a legacy alias of `onanimationiteration`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationiteration`
***
### ~~onwebkitanimationstart~~
> **onwebkitanimationstart**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12957
:::caution[Deprecated]
This is a legacy alias of `onanimationstart`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)
:::
#### Inherited from
`HTMLElement.onwebkitanimationstart`
***
### ~~onwebkittransitionend~~
> **onwebkittransitionend**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12963
:::caution[Deprecated]
This is a legacy alias of `ontransitionend`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)
:::
#### Inherited from
`HTMLElement.onwebkittransitionend`
***
### onwheel
> **onwheel**: ((`this`, `ev`) => `any`) \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:12965
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)
#### Inherited from
`HTMLElement.onwheel`
***
### orderId?
> `optional` **orderId?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L17)
Merchant order ID for purchase tracking fallback.
#### Inherited from
`PostPurchaseProps.orderId`
***
### outerHTML
> **outerHTML**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10784
The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)
#### Inherited from
`HTMLElement.outerHTML`
***
### outerText
> **outerText**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13778
The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)
#### Inherited from
`HTMLElement.outerText`
***
### ownerDocument
> `readonly` **ownerDocument**: `Document`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10785
The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)
#### Inherited from
`HTMLElement.ownerDocument`
***
### parentElement
> `readonly` **parentElement**: `HTMLElement` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21724
The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)
#### Inherited from
`HTMLElement.parentElement`
***
### parentNode
> `readonly` **parentNode**: `ParentNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21730
The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)
#### Inherited from
`HTMLElement.parentNode`
***
### placement?
> `optional` **placement?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:34](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L34)
Placement ID for backend-driven CSS customization.
#### Inherited from
`PostPurchaseProps.placement`
***
### popover
> **popover**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13784
The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)
#### Inherited from
`HTMLElement.popover`
***
### prefix
> `readonly` **prefix**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10798
The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)
#### Inherited from
`HTMLElement.prefix`
***
### preview?
> `optional` **preview?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:90](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L90)
When set, renders the card in preview mode (e.g. Shopify/WP editor).
Bypasses the client-ready / RPC gates that normally hide the card
until the backend resolves, and no-ops the click handler so merchants
can see the final layout with their configured copy.
#### Inherited from
`PostPurchaseProps.preview`
***
### previewVariant?
> `optional` **previewVariant?**: `"referrer"` \| `"referee"`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:95](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L95)
Which variant to show when [preview](/developers/references/components/type-aliases/postpurchaseprops/#preview) is set.
Defaults to `"referrer"`.
#### Inherited from
`PostPurchaseProps.previewVariant`
***
### previousElementSibling
> `readonly` **previousElementSibling**: `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22009
Returns the first preceding sibling that is an element, and null otherwise.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)
#### Inherited from
`HTMLElement.previousElementSibling`
***
### previousSibling
> `readonly` **previousSibling**: `ChildNode` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21736
The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)
#### Inherited from
`HTMLElement.previousSibling`
***
### PROCESSING\_INSTRUCTION\_NODE
> `readonly` **PROCESSING\_INSTRUCTION\_NODE**: `7`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21843
node is a ProcessingInstruction node.
#### Inherited from
`HTMLElement.PROCESSING_INSTRUCTION_NODE`
***
### products?
> `optional` **products?**: `string` \| `SharingPageProduct`[]
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:83](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L83)
Optional product cards forwarded to the sharing page when the user
clicks the CTA. Accepts either a real SharingPageProduct
array (when set imperatively via the JS property,
`el.products = [...]`) or a JSON-stringified array (when set as an
HTML attribute, ``). The HTML
attribute path is required for server-rendered surfaces — e.g.
WooCommerce / Magento plugins — because `preact-custom-element`
delivers attribute values as raw strings.
Empty arrays / unparseable strings are treated as "no products" so
the sharing page renders without the product card section.
#### Inherited from
`PostPurchaseProps.products`
***
### refereeText?
> `optional` **refereeText?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:57](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L57)
Override the message shown to referees.
Use `{REWARD}` as placeholder for the reward amount.
#### Inherited from
`PostPurchaseProps.refereeText`
***
### referrerText?
> `optional` **referrerText?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:52](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L52)
Override the message shown to referrers.
Use `{REWARD}` as placeholder for the reward amount.
#### Inherited from
`PostPurchaseProps.referrerText`
***
### role
> **role**: `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2709
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)
#### Inherited from
`HTMLElement.role`
***
### scrollHeight
> `readonly` **scrollHeight**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10804
The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)
#### Inherited from
`HTMLElement.scrollHeight`
***
### scrollLeft
> **scrollLeft**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10810
The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)
#### Inherited from
`HTMLElement.scrollLeft`
***
### scrollTop
> **scrollTop**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10816
The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)
#### Inherited from
`HTMLElement.scrollTop`
***
### scrollWidth
> `readonly` **scrollWidth**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10822
The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)
#### Inherited from
`HTMLElement.scrollWidth`
***
### shadowRoot
> `readonly` **shadowRoot**: `ShadowRoot` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10828
The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)
#### Inherited from
`HTMLElement.shadowRoot`
***
### sharingUrl?
> `optional` **sharingUrl?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:26](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L26)
Base URL to share. Falls back to the merchant domain returned by
the backend when omitted.
#### Inherited from
`PostPurchaseProps.sharingUrl`
***
### slot
> **slot**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10834
The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)
#### Inherited from
`HTMLElement.slot`
***
### spellcheck
> **spellcheck**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13790
The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)
#### Inherited from
`HTMLElement.spellcheck`
***
### tabIndex
> **tabIndex**: `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16071
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)
#### Inherited from
`HTMLElement.tabIndex`
***
### tagName
> `readonly` **tagName**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10840
The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)
#### Inherited from
`HTMLElement.tagName`
***
### TEXT\_NODE
> `readonly` **TEXT\_NODE**: `3`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21837
node is a Text node.
#### Inherited from
`HTMLElement.TEXT_NODE`
***
### title
> **title**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13796
The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)
#### Inherited from
`HTMLElement.title`
***
### token?
> `optional` **token?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:21](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L21)
Checkout token for purchase tracking fallback.
#### Inherited from
`PostPurchaseProps.token`
***
### translate
> **translate**: `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13802
The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)
#### Inherited from
`HTMLElement.translate`
***
### variant?
> `optional` **variant?**: `"referrer"` \| `"referee"`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:42](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L42)
Force a display variant instead of relying on the backend evaluation.
#### Inherited from
`PostPurchaseProps.variant`
***
### writingSuggestions
> **writingSuggestions**: `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13808
The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)
#### Inherited from
`HTMLElement.writingSuggestions`
## Accessors
### classList
#### Get Signature
> **get** **classList**(): `DOMTokenList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10713
The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)
##### Returns
`DOMTokenList`
#### Set Signature
> **set** **classList**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10714
##### Parameters
###### value
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.classList`
***
### part
#### Get Signature
> **get** **part**(): `DOMTokenList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10791
The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)
##### Returns
`DOMTokenList`
#### Set Signature
> **set** **part**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10792
##### Parameters
###### value
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.part`
***
### style
#### Get Signature
> **get** **style**(): `CSSStyleDeclaration`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11119
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)
##### Returns
`CSSStyleDeclaration`
#### Set Signature
> **set** **style**(`cssText`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11120
##### Parameters
###### cssText
`string`
##### Returns
`void`
#### Inherited from
`HTMLElement.style`
***
### textContent
#### Get Signature
> **get** **textContent**(): `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11102
[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)
##### Returns
`string`
#### Set Signature
> **set** **textContent**(`value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11103
The **`textContent`** property of the Node interface represents the text content of the node and its descendants.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/textContent)
##### Parameters
###### value
`string` \| `null`
##### Returns
`void`
#### Inherited from
[`BannerElement`](/developers/references/components/interfaces/bannerelement/).[`textContent`](/developers/references/components/interfaces/bannerelement/#textcontent)
## Methods
### addEventListener()
#### Call Signature
> **addEventListener**\<`K`\>(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13839
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementEventMap`
##### Parameters
###### type
`K`
###### listener
(`this`, `ev`) => `any`
###### options?
`boolean` \| `AddEventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.addEventListener`
#### Call Signature
> **addEventListener**(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13840
##### Parameters
###### type
`string`
###### listener
`EventListenerOrEventListenerObject`
###### options?
`boolean` \| `AddEventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.addEventListener`
***
### after()
> **after**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7953
Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.after`
***
### animate()
> **animate**(`keyframes`, `options?`): `Animation`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2921
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)
#### Parameters
##### keyframes
`Keyframe`[] \| `PropertyIndexedKeyframes` \| `null`
##### options?
`number` \| `KeyframeAnimationOptions`
#### Returns
`Animation`
#### Inherited from
`HTMLElement.animate`
***
### append()
> **append**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22694
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.append`
***
### appendChild()
> **appendChild**\<`T`\>(`node`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21748
The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.appendChild`
***
### attachInternals()
> **attachInternals**(): `ElementInternals`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13814
The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)
#### Returns
`ElementInternals`
#### Inherited from
`HTMLElement.attachInternals`
***
### attachShadow()
> **attachShadow**(`init`): `ShadowRoot`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10846
The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)
#### Parameters
##### init
`ShadowRootInit`
#### Returns
`ShadowRoot`
#### Inherited from
`HTMLElement.attachShadow`
***
### before()
> **before**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7961
Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.before`
***
### blur()
> **blur**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16073
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)
#### Returns
`void`
#### Inherited from
`HTMLElement.blur`
***
### checkVisibility()
> **checkVisibility**(`options?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10852
The **`checkVisibility()`** method of the Element interface checks whether the element is visible.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)
#### Parameters
##### options?
`CheckVisibilityOptions`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.checkVisibility`
***
### click()
> **click**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13820
The **`HTMLElement.click()`** method simulates a mouse click on an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)
#### Returns
`void`
#### Inherited from
`HTMLElement.click`
***
### cloneNode()
> **cloneNode**(`subtree?`): `Node`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21754
The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)
#### Parameters
##### subtree?
`boolean`
#### Returns
`Node`
#### Inherited from
`HTMLElement.cloneNode`
***
### closest()
#### Call Signature
> **closest**\<`K`\>(`selector`): `HTMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10858
The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`HTMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`K`\>(`selector`): `SVGElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10859
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`SVGElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`K`\>(`selector`): `MathMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10860
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selector
`K`
##### Returns
`MathMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.closest`
#### Call Signature
> **closest**\<`E`\>(`selectors`): `E` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10861
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`E` \| `null`
##### Inherited from
`HTMLElement.closest`
***
### compareDocumentPosition()
> **compareDocumentPosition**(`other`): `number`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21760
The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)
#### Parameters
##### other
`Node`
#### Returns
`number`
#### Inherited from
`HTMLElement.compareDocumentPosition`
***
### computedStyleMap()
> **computedStyleMap**(): `StylePropertyMapReadOnly`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10867
The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)
#### Returns
`StylePropertyMapReadOnly`
#### Inherited from
`HTMLElement.computedStyleMap`
***
### contains()
> **contains**(`other`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21766
The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)
#### Parameters
##### other
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.contains`
***
### dispatchEvent()
> **dispatchEvent**(`event`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11575
The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
#### Parameters
##### event
`Event`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.dispatchEvent`
***
### focus()
> **focus**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:16075
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)
#### Parameters
##### options?
`FocusOptions`
#### Returns
`void`
#### Inherited from
`HTMLElement.focus`
***
### getAnimations()
> **getAnimations**(`options?`): `Animation`[]
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:2923
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)
#### Parameters
##### options?
`GetAnimationsOptions`
#### Returns
`Animation`[]
#### Inherited from
`HTMLElement.getAnimations`
***
### getAttribute()
> **getAttribute**(`qualifiedName`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10873
The **`getAttribute()`** method of the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.getAttribute`
***
### getAttributeNames()
> **getAttributeNames**(): `string`[]
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10885
The **`getAttributeNames()`** method of the array.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)
#### Returns
`string`[]
#### Inherited from
`HTMLElement.getAttributeNames`
***
### getAttributeNode()
> **getAttributeNode**(`qualifiedName`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10891
Returns the specified attribute of the specified element, as an Attr node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)
#### Parameters
##### qualifiedName
`string`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.getAttributeNode`
***
### getAttributeNodeNS()
> **getAttributeNodeNS**(`namespace`, `localName`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10897
The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.getAttributeNodeNS`
***
### getAttributeNS()
> **getAttributeNS**(`namespace`, `localName`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10879
The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.getAttributeNS`
***
### getBoundingClientRect()
> **getBoundingClientRect**(): `DOMRect`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10903
The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)
#### Returns
`DOMRect`
#### Inherited from
`HTMLElement.getBoundingClientRect`
***
### getClientRects()
> **getClientRects**(): `DOMRectList`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10909
The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)
#### Returns
`DOMRectList`
#### Inherited from
`HTMLElement.getClientRects`
***
### getElementsByClassName()
> **getElementsByClassName**(`classNames`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10915
The Element method **`getElementsByClassName()`** returns a live specified class name or names.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)
#### Parameters
##### classNames
`string`
#### Returns
`HTMLCollectionOf`\<`Element`\>
#### Inherited from
`HTMLElement.getElementsByClassName`
***
### getElementsByTagName()
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`HTMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10921
The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`HTMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`SVGElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10922
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`SVGElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`MathMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10923
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`MathMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**\<`K`\>(`qualifiedName`): `HTMLCollectionOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10925
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### qualifiedName
`K`
##### Returns
`HTMLCollectionOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.getElementsByTagName`
#### Call Signature
> **getElementsByTagName**(`qualifiedName`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10926
##### Parameters
###### qualifiedName
`string`
##### Returns
`HTMLCollectionOf`\<`Element`\>
##### Inherited from
`HTMLElement.getElementsByTagName`
***
### getElementsByTagNameNS()
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`HTMLElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10932
The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)
##### Parameters
###### namespaceURI
`"http://www.w3.org/1999/xhtml"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`HTMLElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`SVGElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10933
##### Parameters
###### namespaceURI
`"http://www.w3.org/2000/svg"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`SVGElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`\<`MathMLElement`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10934
##### Parameters
###### namespaceURI
`"http://www.w3.org/1998/Math/MathML"`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`MathMLElement`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
#### Call Signature
> **getElementsByTagNameNS**(`namespace`, `localName`): `HTMLCollectionOf`\<`Element`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10935
##### Parameters
###### namespace
`string` \| `null`
###### localName
`string`
##### Returns
`HTMLCollectionOf`\<`Element`\>
##### Inherited from
`HTMLElement.getElementsByTagNameNS`
***
### getHTML()
> **getHTML**(`options?`): `string`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10941
The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)
#### Parameters
##### options?
`GetHTMLOptions`
#### Returns
`string`
#### Inherited from
`HTMLElement.getHTML`
***
### getRootNode()
> **getRootNode**(`options?`): `Node`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21772
The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)
#### Parameters
##### options?
`GetRootNodeOptions`
#### Returns
`Node`
#### Inherited from
`HTMLElement.getRootNode`
***
### hasAttribute()
> **hasAttribute**(`qualifiedName`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10947
The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttribute`
***
### hasAttributeNS()
> **hasAttributeNS**(`namespace`, `localName`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10953
The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttributeNS`
***
### hasAttributes()
> **hasAttributes**(): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10959
The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasAttributes`
***
### hasChildNodes()
> **hasChildNodes**(): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21778
The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasChildNodes`
***
### hasPointerCapture()
> **hasPointerCapture**(`pointerId`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10965
The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.hasPointerCapture`
***
### hidePopover()
> **hidePopover**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13826
The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)
#### Returns
`void`
#### Inherited from
`HTMLElement.hidePopover`
***
### insertAdjacentElement()
> **insertAdjacentElement**(`where`, `element`): `Element` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10971
The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)
#### Parameters
##### where
`InsertPosition`
##### element
`Element`
#### Returns
`Element` \| `null`
#### Inherited from
`HTMLElement.insertAdjacentElement`
***
### insertAdjacentHTML()
> **insertAdjacentHTML**(`position`, `string`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10977
The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)
#### Parameters
##### position
`InsertPosition`
##### string
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.insertAdjacentHTML`
***
### insertAdjacentText()
> **insertAdjacentText**(`where`, `data`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10983
The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)
#### Parameters
##### where
`InsertPosition`
##### data
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.insertAdjacentText`
***
### insertBefore()
> **insertBefore**\<`T`\>(`node`, `child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21784
The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`T`
##### child
`Node` \| `null`
#### Returns
`T`
#### Inherited from
`HTMLElement.insertBefore`
***
### isDefaultNamespace()
> **isDefaultNamespace**(`namespace`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21790
The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)
#### Parameters
##### namespace
`string` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isDefaultNamespace`
***
### isEqualNode()
> **isEqualNode**(`otherNode`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21796
The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)
#### Parameters
##### otherNode
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isEqualNode`
***
### isSameNode()
> **isSameNode**(`otherNode`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21802
The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)
#### Parameters
##### otherNode
`Node` \| `null`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.isSameNode`
***
### lookupNamespaceURI()
> **lookupNamespaceURI**(`prefix`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21808
The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)
#### Parameters
##### prefix
`string` \| `null`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.lookupNamespaceURI`
***
### lookupPrefix()
> **lookupPrefix**(`namespace`): `string` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21814
The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)
#### Parameters
##### namespace
`string` \| `null`
#### Returns
`string` \| `null`
#### Inherited from
`HTMLElement.lookupPrefix`
***
### matches()
> **matches**(`selectors`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10989
The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)
#### Parameters
##### selectors
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.matches`
***
### normalize()
> **normalize**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21820
The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)
#### Returns
`void`
#### Inherited from
`HTMLElement.normalize`
***
### prepend()
> **prepend**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22702
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.prepend`
***
### querySelector()
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `HTMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22708
Returns the first element that is a descendant of node that matches selectors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`HTMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `SVGElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22709
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`SVGElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `MathMLElementTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22710
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`MathMLElementTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`K`\>(`selectors`): `HTMLElementDeprecatedTagNameMap`\[`K`\] \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22712
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`HTMLElementDeprecatedTagNameMap`\[`K`\] \| `null`
##### Inherited from
`HTMLElement.querySelector`
#### Call Signature
> **querySelector**\<`E`\>(`selectors`): `E` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22713
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`E` \| `null`
##### Inherited from
`HTMLElement.querySelector`
***
### querySelectorAll()
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`HTMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22719
Returns all element descendants of node that match selectors.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`HTMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`SVGElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22720
##### Type Parameters
###### K
`K` *extends* keyof `SVGElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`SVGElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`MathMLElementTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22721
##### Type Parameters
###### K
`K` *extends* keyof `MathMLElementTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`MathMLElementTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`K`\>(`selectors`): `NodeListOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22723
:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementDeprecatedTagNameMap`
##### Parameters
###### selectors
`K`
##### Returns
`NodeListOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\>
##### Inherited from
`HTMLElement.querySelectorAll`
#### Call Signature
> **querySelectorAll**\<`E`\>(`selectors`): `NodeListOf`\<`E`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22724
##### Type Parameters
###### E
`E` *extends* `Element` = `Element`
##### Parameters
###### selectors
`string`
##### Returns
`NodeListOf`\<`E`\>
##### Inherited from
`HTMLElement.querySelectorAll`
***
### releasePointerCapture()
> **releasePointerCapture**(`pointerId`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:10995
The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`void`
#### Inherited from
`HTMLElement.releasePointerCapture`
***
### remove()
> **remove**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7967
Removes node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)
#### Returns
`void`
#### Inherited from
`HTMLElement.remove`
***
### removeAttribute()
> **removeAttribute**(`qualifiedName`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11001
The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)
#### Parameters
##### qualifiedName
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.removeAttribute`
***
### removeAttributeNode()
> **removeAttributeNode**(`attr`): `Attr`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11013
The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr`
#### Inherited from
`HTMLElement.removeAttributeNode`
***
### removeAttributeNS()
> **removeAttributeNS**(`namespace`, `localName`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11007
The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### localName
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.removeAttributeNS`
***
### removeChild()
> **removeChild**\<`T`\>(`child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21826
The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### child
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.removeChild`
***
### removeEventListener()
#### Call Signature
> **removeEventListener**\<`K`\>(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13841
##### Type Parameters
###### K
`K` *extends* keyof `HTMLElementEventMap`
##### Parameters
###### type
`K`
###### listener
(`this`, `ev`) => `any`
###### options?
`boolean` \| `EventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.removeEventListener`
#### Call Signature
> **removeEventListener**(`type`, `listener`, `options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13842
##### Parameters
###### type
`string`
###### listener
`EventListenerOrEventListenerObject`
###### options?
`boolean` \| `EventListenerOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.removeEventListener`
***
### replaceChild()
> **replaceChild**\<`T`\>(`node`, `child`): `T`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:21832
The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)
#### Type Parameters
##### T
`T` *extends* `Node`
#### Parameters
##### node
`Node`
##### child
`T`
#### Returns
`T`
#### Inherited from
`HTMLElement.replaceChild`
***
### replaceChildren()
> **replaceChildren**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:22732
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.replaceChildren`
***
### replaceWith()
> **replaceWith**(...`nodes`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:7975
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)
#### Parameters
##### nodes
...(`string` \| `Node`)[]
#### Returns
`void`
#### Inherited from
`HTMLElement.replaceWith`
***
### requestFullscreen()
> **requestFullscreen**(`options?`): `Promise`\<`void`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11019
The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)
#### Parameters
##### options?
`FullscreenOptions`
#### Returns
`Promise`\<`void`\>
#### Inherited from
`HTMLElement.requestFullscreen`
***
### requestPointerLock()
> **requestPointerLock**(`options?`): `Promise`\<`void`\>
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11025
The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)
#### Parameters
##### options?
`PointerLockOptions`
#### Returns
`Promise`\<`void`\>
#### Inherited from
`HTMLElement.requestPointerLock`
***
### scroll()
#### Call Signature
> **scroll**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11031
The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scroll`
#### Call Signature
> **scroll**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11032
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scroll`
***
### scrollBy()
#### Call Signature
> **scrollBy**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11038
The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollBy`
#### Call Signature
> **scrollBy**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11039
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollBy`
***
### scrollIntoView()
> **scrollIntoView**(`arg?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11045
The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)
#### Parameters
##### arg?
`boolean` \| `ScrollIntoViewOptions`
#### Returns
`void`
#### Inherited from
`HTMLElement.scrollIntoView`
***
### scrollTo()
#### Call Signature
> **scrollTo**(`options?`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11051
The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)
##### Parameters
###### options?
`ScrollToOptions`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollTo`
#### Call Signature
> **scrollTo**(`x`, `y`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11052
##### Parameters
###### x
`number`
###### y
`number`
##### Returns
`void`
##### Inherited from
`HTMLElement.scrollTo`
***
### setAttribute()
> **setAttribute**(`qualifiedName`, `value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11058
The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)
#### Parameters
##### qualifiedName
`string`
##### value
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setAttribute`
***
### setAttributeNode()
> **setAttributeNode**(`attr`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11070
The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.setAttributeNode`
***
### setAttributeNodeNS()
> **setAttributeNodeNS**(`attr`): `Attr` \| `null`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11076
The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)
#### Parameters
##### attr
`Attr`
#### Returns
`Attr` \| `null`
#### Inherited from
`HTMLElement.setAttributeNodeNS`
***
### setAttributeNS()
> **setAttributeNS**(`namespace`, `qualifiedName`, `value`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11064
`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)
#### Parameters
##### namespace
`string` \| `null`
##### qualifiedName
`string`
##### value
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setAttributeNS`
***
### setHTMLUnsafe()
> **setHTMLUnsafe**(`html`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11082
The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)
#### Parameters
##### html
`string`
#### Returns
`void`
#### Inherited from
`HTMLElement.setHTMLUnsafe`
***
### setPointerCapture()
> **setPointerCapture**(`pointerId`): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11088
The **`setPointerCapture()`** method of the _capture target_ of future pointer events.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)
#### Parameters
##### pointerId
`number`
#### Returns
`void`
#### Inherited from
`HTMLElement.setPointerCapture`
***
### showPopover()
> **showPopover**(): `void`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13832
The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)
#### Returns
`void`
#### Inherited from
`HTMLElement.showPopover`
***
### toggleAttribute()
> **toggleAttribute**(`qualifiedName`, `force?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11094
The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)
#### Parameters
##### qualifiedName
`string`
##### force?
`boolean`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.toggleAttribute`
***
### togglePopover()
> **togglePopover**(`options?`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:13838
The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)
#### Parameters
##### options?
`boolean`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.togglePopover`
***
### ~~webkitMatchesSelector()~~
> **webkitMatchesSelector**(`selectors`): `boolean`
Defined in: node\_modules/.bun/typescript@5.9.3/node\_modules/typescript/lib/lib.dom.d.ts:11100
:::caution[Deprecated]
This is a legacy alias of `matches`.
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)
:::
#### Parameters
##### selectors
`string`
#### Returns
`boolean`
#### Inherited from
`HTMLElement.webkitMatchesSelector`
# BannerProps
> **BannerProps** = \{ `allowInappRedirect?`: `boolean` \| `"true"` \| `"false"`; `classname?`: `string`; `imageUrl?`: `string`; `inappCta?`: `string`; `inappDescription?`: `string`; `inappTitle?`: `string`; `interaction?`: `InteractionTypeKey`; `placement?`: `string`; `preview?`: `string`; `previewMode?`: `"referral"` \| `"inapp"`; `referralCta?`: `string`; `referralDescription?`: `string`; `referralTitle?`: `string`; \}
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:7](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L7)
The props type for [Banner](/developers/references/components/functions/banner/).
## Extended by
- [`BannerElement`](/developers/references/components/interfaces/bannerelement/)
## Properties
### allowInappRedirect?
> `optional` **allowInappRedirect?**: `boolean` \| `"true"` \| `"false"`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:76](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L76)
When `true` (default `false`), the banner is allowed to switch to
in-app browser mode (Instagram / Facebook WebView) and prompt the
user to escape to the system browser.
Most flows now work inside in-app browsers via the anonymous-id
flow, so the redirect is opt-in. Enable it only on surfaces that
actually drive users into a WebAuthn-bound action (login,
sendTransaction, SIWE authenticate).
Accepts the boolean `true` (TS/JSX) or the string `"true"` (HTML
attribute). Any other value — including `false`, `"false"`, the
empty string, or attribute absence — keeps the redirect disabled.
***
### classname?
> `optional` **classname?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:15](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L15)
CSS class names passed through to the root element (Light DOM).
***
### imageUrl?
> `optional` **imageUrl?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:51](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L51)
Override the image displayed on the left of the referral banner.
Accepts an image URL. Falls back to the built-in gift icon when omitted.
The image is constrained to the icon slot via `object-fit: contain`,
so any aspect ratio renders correctly.
***
### inappCta?
> `optional` **inappCta?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:44](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L44)
Override the in-app browser banner CTA button text.
***
### inappDescription?
> `optional` **inappDescription?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:40](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L40)
Override the in-app browser banner description.
***
### inappTitle?
> `optional` **inappTitle?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:36](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L36)
Override the in-app browser banner title.
***
### interaction?
> `optional` **interaction?**: `InteractionTypeKey`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:20](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L20)
Filter rewards by interaction type (e.g. "purchase", "referral").
When omitted, the best reward across all interaction types is shown.
***
### placement?
> `optional` **placement?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L11)
Placement ID for backend-driven CSS customization.
***
### preview?
> `optional` **preview?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:56](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L56)
When set, forces the banner to render in preview mode (e.g. in Shopify theme editor).
Bypasses normal event/browser detection and shows static content.
***
### previewMode?
> `optional` **previewMode?**: `"referral"` \| `"inapp"`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:61](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L61)
Which banner variant to preview: "referral" or "inapp".
Only used when [preview](/developers/references/components/type-aliases/bannerprops/#preview) is set. Defaults to "referral".
***
### referralCta?
> `optional` **referralCta?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:32](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L32)
Override the referral banner CTA button text.
***
### referralDescription?
> `optional` **referralDescription?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:28](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L28)
Override the referral banner description.
***
### referralTitle?
> `optional` **referralTitle?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/Banner/types.ts:24](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/Banner/types.ts#L24)
Override the referral banner title.
# ButtonShareProps
> **ButtonShareProps** = \{ `classname?`: `string`; `clickAction?`: `"embedded-wallet"` \| `"sharing-page"`; `noRewardText?`: `string`; `placement?`: `string`; `preview?`: `string`; `targetInteraction?`: `InteractionTypeKey`; `text?`: `string`; \}
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:7](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L7)
The props type for [ButtonShare](/developers/references/components/functions/buttonshare/).
## Extended by
- [`ButtonShareElement`](/developers/references/components/interfaces/buttonshareelement/)
## Properties
### classname?
> `optional` **classname?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:25](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L25)
Classname to apply to the button
***
### clickAction?
> `optional` **clickAction?**: `"embedded-wallet"` \| `"sharing-page"`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:44](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L44)
Which UI to open on click.
Legacy values (e.g. `"share-modal"`) are accepted at runtime and
gracefully route to the full-page sharing UI — the modal-flow
share path was retired in favour of `displaySharingPage`.
#### Default Value
`"sharing-page"`
***
### noRewardText?
> `optional` **noRewardText?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:30](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L30)
Fallback text when `text` contains the `{REWARD}` placeholder but no
reward is available.
***
### placement?
> `optional` **placement?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L8)
***
### preview?
> `optional` **preview?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:51](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L51)
When set, renders the button in preview mode (e.g. Shopify/WP editor).
Skips the client-ready gating so the button is always enabled visually,
and no-ops the click handler so merchants can see the final layout with
their configured copy even when no Frak client is initialized.
***
### targetInteraction?
> `optional` **targetInteraction?**: `InteractionTypeKey`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:34](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L34)
Target interaction behind this sharing action (will be used to get the right reward to display)
***
### text?
> `optional` **text?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonShare/types.ts:21](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonShare/types.ts#L21)
Text to display on the button.
Including the placeholder `{REWARD}` (e.g. `Share and earn up to \{REWARD\}!`)
opts the button into the live reward flow: the SDK fetches the
estimated reward and substitutes the placeholder. When no reward is
available, `noRewardText` is used as a fallback (or the placeholder is
stripped if no fallback is provided).
When omitted, a built-in localized default is used based on the
resolved language (`"Share and earn!"` / `"Partagez et gagnez !"`).
# ButtonWalletProps
> **ButtonWalletProps** = \{ `classname?`: `string`; `placement?`: `string`; `targetInteraction?`: `InteractionTypeKey`; `useReward?`: `boolean`; \}
Defined in: [vendor/wallet/sdk/components/src/components/ButtonWallet/types.ts:7](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonWallet/types.ts#L7)
The props type for [ButtonWallet](/developers/references/components/functions/buttonwallet/).
## Extended by
- [`ButtonWalletElement`](/developers/references/components/interfaces/buttonwalletelement/)
## Properties
### classname?
> `optional` **classname?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonWallet/types.ts:12](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonWallet/types.ts#L12)
Classname to apply to the button
***
### placement?
> `optional` **placement?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonWallet/types.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonWallet/types.ts#L8)
***
### targetInteraction?
> `optional` **targetInteraction?**: `InteractionTypeKey`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonWallet/types.ts:21](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonWallet/types.ts#L21)
Target interaction behind this sharing action (will be used to get the right reward to display)
***
### useReward?
> `optional` **useReward?**: `boolean`
Defined in: [vendor/wallet/sdk/components/src/components/ButtonWallet/types.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/ButtonWallet/types.ts#L17)
Do we display the reward on the button?
#### Default Value
`false`
# OpenInAppButtonProps
> **OpenInAppButtonProps** = \{ `classname?`: `string`; `placement?`: `string`; `text?`: `string`; \}
Defined in: [vendor/wallet/sdk/components/src/components/OpenInAppButton/types.ts:5](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/OpenInAppButton/types.ts#L5)
The props type for [OpenInAppButton](/developers/references/components/functions/openinappbutton/).
## Extended by
- [`OpenInAppButtonElement`](/developers/references/components/interfaces/openinappbuttonelement/)
## Properties
### classname?
> `optional` **classname?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/OpenInAppButton/types.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/OpenInAppButton/types.ts#L17)
Classname to apply to the button
***
### placement?
> `optional` **placement?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/OpenInAppButton/types.ts:6](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/OpenInAppButton/types.ts#L6)
***
### text?
> `optional` **text?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/OpenInAppButton/types.ts:13](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/OpenInAppButton/types.ts#L13)
Text to display on the button.
When omitted, a built-in localized default is used based on the
resolved language (`"Open in App"` / `"Ouvrir dans l'app"`).
# PostPurchaseProps
> **PostPurchaseProps** = \{ `badgeText?`: `string`; `classname?`: `string`; `ctaText?`: `string`; `customerId?`: `string`; `imageUrl?`: `string`; `merchantId?`: `string`; `orderId?`: `string`; `placement?`: `string`; `preview?`: `string`; `previewVariant?`: `"referrer"` \| `"referee"`; `products?`: `SharingPageProduct`[] \| `string`; `refereeText?`: `string`; `referrerText?`: `string`; `sharingUrl?`: `string`; `token?`: `string`; `variant?`: `"referrer"` \| `"referee"`; \}
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:7](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L7)
Props for the [PostPurchase](/developers/references/components/functions/postpurchase/) component.
## Extended by
- [`PostPurchaseElement`](/developers/references/components/interfaces/postpurchaseelement/)
## Properties
### badgeText?
> `optional` **badgeText?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:47](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L47)
Label for the pill badge displayed above the message.
When omitted (and no placement config provides one), the badge is hidden.
***
### classname?
> `optional` **classname?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:38](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L38)
CSS class names passed through to the root element (Light DOM).
***
### ctaText?
> `optional` **ctaText?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:62](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L62)
Override the CTA button text.
Use `{REWARD}` as placeholder for the reward amount.
***
### customerId?
> `optional` **customerId?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:13](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L13)
Merchant customer ID for purchase tracking fallback.
All three tracking props (`customerId`, `orderId`, `token`) must be
present for tracking to fire.
***
### imageUrl?
> `optional` **imageUrl?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:69](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L69)
Override the image displayed on the left of the post-purchase card.
Accepts an image URL. Falls back to the built-in gift icon when omitted.
The image is constrained to the icon slot via `object-fit: contain`,
so any aspect ratio renders correctly.
***
### merchantId?
> `optional` **merchantId?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:30](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L30)
Override the merchant ID resolved from the SDK config.
***
### orderId?
> `optional` **orderId?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L17)
Merchant order ID for purchase tracking fallback.
***
### placement?
> `optional` **placement?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:34](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L34)
Placement ID for backend-driven CSS customization.
***
### preview?
> `optional` **preview?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:90](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L90)
When set, renders the card in preview mode (e.g. Shopify/WP editor).
Bypasses the client-ready / RPC gates that normally hide the card
until the backend resolves, and no-ops the click handler so merchants
can see the final layout with their configured copy.
***
### previewVariant?
> `optional` **previewVariant?**: `"referrer"` \| `"referee"`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:95](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L95)
Which variant to show when [preview](/developers/references/components/type-aliases/postpurchaseprops/#preview) is set.
Defaults to `"referrer"`.
***
### products?
> `optional` **products?**: `SharingPageProduct`[] \| `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:83](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L83)
Optional product cards forwarded to the sharing page when the user
clicks the CTA. Accepts either a real SharingPageProduct
array (when set imperatively via the JS property,
`el.products = [...]`) or a JSON-stringified array (when set as an
HTML attribute, ``). The HTML
attribute path is required for server-rendered surfaces — e.g.
WooCommerce / Magento plugins — because `preact-custom-element`
delivers attribute values as raw strings.
Empty arrays / unparseable strings are treated as "no products" so
the sharing page renders without the product card section.
***
### refereeText?
> `optional` **refereeText?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:57](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L57)
Override the message shown to referees.
Use `{REWARD}` as placeholder for the reward amount.
***
### referrerText?
> `optional` **referrerText?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:52](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L52)
Override the message shown to referrers.
Use `{REWARD}` as placeholder for the reward amount.
***
### sharingUrl?
> `optional` **sharingUrl?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:26](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L26)
Base URL to share. Falls back to the merchant domain returned by
the backend when omitted.
***
### token?
> `optional` **token?**: `string`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:21](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L21)
Checkout token for purchase tracking fallback.
***
### variant?
> `optional` **variant?**: `"referrer"` \| `"referee"`
Defined in: [vendor/wallet/sdk/components/src/components/PostPurchase/types.ts:42](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/components/src/components/PostPurchase/types.ts#L42)
Force a display variant instead of relying on the backend evaluation.
# displayEmbeddedWallet
> **displayEmbeddedWallet**(`client`, `params`, `placement?`): `Promise`\<[`DisplayEmbeddedWalletResultType`](/developers/references/core-sdk/index/type-aliases/displayembeddedwalletresulttype/)\>
Defined in: [actions/displayEmbeddedWallet.ts:14](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/displayEmbeddedWallet.ts#L14)
Function used to display the Frak embedded wallet popup
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### params
[`DisplayEmbeddedWalletParamsType`](/developers/references/core-sdk/index/type-aliases/displayembeddedwalletparamstype/)
The parameter used to customise the embedded wallet
### placement?
`string`
Optional placement ID to associate with this display request
## Returns
`Promise`\<[`DisplayEmbeddedWalletResultType`](/developers/references/core-sdk/index/type-aliases/displayembeddedwalletresulttype/)\>
The embedded wallet display result
# displayModal
> **displayModal**\<`T`\>(`client`, `args`, `placement?`): `Promise`\<[`ModalRpcStepsResultType`](/developers/references/core-sdk/index/type-aliases/modalrpcstepsresulttype/)\<`T`\>\>
Defined in: [actions/displayModal.ts:111](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/displayModal.ts#L111)
Function used to display a modal
## Type Parameters
### T
`T` *extends* [`ModalStepTypes`](/developers/references/core-sdk/index/type-aliases/modalsteptypes/)[] = [`ModalStepTypes`](/developers/references/core-sdk/index/type-aliases/modalsteptypes/)[]
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### args
[`DisplayModalParamsType`](/developers/references/core-sdk/index/type-aliases/displaymodalparamstype/)\<`T`\>
### placement?
`string`
Optional placement ID to associate with this modal display
## Returns
`Promise`\<[`ModalRpcStepsResultType`](/developers/references/core-sdk/index/type-aliases/modalrpcstepsresulttype/)\<`T`\>\>
The result of each modal steps
## Description
This function will display a modal to the user with the provided steps and metadata.
## Remarks
- The UI of the displayed modal can be configured with the `customCss` property in the `customizations.css` field of the top-level config.
- The `login` step will be automatically skipped if the user is already logged in. It's safe to include this step in all cases to ensure proper user state.
- Steps are automatically reordered in the following sequence:
1. `login` (if needed)
2. All other steps in the order specified
3. `success` (if included, always last)
## Examples
Simple sharing modal with steps:
1. Login (Skipped if already logged in)
2. Display a success message with sharing link option
```ts
const results = await displayModal(frakConfig, {
steps: {
// Simple login with no SSO, nor customization
login: { allowSso: false },
// Success message
final: {
action: { key: "reward" },
// Skip this step, it will be only displayed in the stepper within the modal
autoSkip: true,
},
},
});
console.log("Login step - wallet", results.login.wallet);
```
A full modal example, with a few customization options, with the steps:
1. Login (Skipped if already logged in)
2. Authenticate via SIWE
3. Send a transaction
4. Display a success message with sharing link options
```ts
const results = await displayModal(frakConfig, {
steps: {
// Login step
login: {
allowSso: true,
ssoMetadata: {
logoUrl: "https://my-app.com/logo.png",
homepageLink: "https://my-app.com",
},
},
// Siwe authentication
siweAuthenticate: {
siwe: {
domain: "my-app.com",
uri: "https://my-app.com/",
nonce: generateSiweNonce(),
version: "1",
},
},
// Send batched transaction
sendTransaction: {
tx: [
{ to: "0xdeadbeef", data: "0xdeadbeef" },
{ to: "0xdeadbeef", data: "0xdeadbeef" },
],
},
// Success message with sharing options
final: {
action: {
key: "sharing",
options: {
popupTitle: "Share the app",
text: "Discover my super app website",
link: "https://my-app.com",
},
},
dismissedMetadata: {
title: "Dismiss",
description: "You won't be rewarded for this sharing action",
},
},
},
metadata: {
// Header of desktop modals
header: {
title: "My-App",
icon: "https://my-app.com/logo.png",
},
// Context that will be present in every modal steps
context: "My-app overkill flow",
},
});
```
# displaySharingPage
> **displaySharingPage**(`client`, `params`, `placement?`): `Promise`\<[`DisplaySharingPageResultType`](/developers/references/core-sdk/index/type-aliases/displaysharingpageresulttype/)\>
Defined in: [actions/displaySharingPage.ts:38](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/displaySharingPage.ts#L38)
Function used to display a sharing page
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### params
[`DisplaySharingPageParamsType`](/developers/references/core-sdk/index/type-aliases/displaysharingpageparamstype/)
The parameters to customize the sharing page (products, link override, metadata)
### placement?
`string`
Optional placement ID to associate with this display request
## Returns
`Promise`\<[`DisplaySharingPageResultType`](/developers/references/core-sdk/index/type-aliases/displaysharingpageresulttype/)\>
The result indicating the user's action (shared, copied, or dismissed)
## Description
This function will display a full-page sharing UI to the user,
showing product info, estimated rewards, sharing steps, FAQ, and share/copy buttons.
The sharing link is generated from the user's wallet context + merchant info.
## Remarks
- The promise resolves on the first user action (share or copy) but the page stays visible
- The user can continue to share/copy multiple times after the initial resolution
- Dismissing the page after a share/copy action is a no-op (promise already resolved)
- If the user dismisses without any action, the promise resolves with `{ action: "dismissed" }`
## Example
```ts
const result = await displaySharingPage(frakClient, {
products: [
{
title: "Babies camel cuir velours bout carré",
imageUrl: "https://example.com/product.jpg",
},
],
});
console.log("User action:", result.action); // "shared" | "copied" | "dismissed"
```
# ensureIdentity
> **ensureIdentity**(`interactionToken`): `Promise`\<`void`\>
Defined in: [actions/ensureIdentity.ts:29](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/ensureIdentity.ts#L29)
Ensure the current wallet ↔ clientId link exists on the backend.
Called automatically by [watchWalletStatus](/developers/references/core-sdk/actions/functions/watchwalletstatus/) when a connected wallet
status is received. Acts as a failsafe: if the primary merge (SSO, pairing,
login/register) missed or silently failed, this ensures the link is
eventually established.
The call is:
- **Idempotent** — if already linked, backend returns immediately
- **Deduplicated** — only fires once per browser session per merchant
- **Fire-and-forget** — errors are logged but never thrown
## Parameters
### interactionToken
`string`
The SDK JWT from wallet status (x-wallet-sdk-auth)
## Returns
`Promise`\<`void`\>
## Example
```ts
// Usually called automatically via watchWalletStatus side effect.
// Can also be called manually if needed:
await ensureIdentity("eyJhbGciOi...");
```
# getMerchantInformation
> **getMerchantInformation**(`client`, `options?`): `Promise`\<[`GetMerchantInformationReturnType`](/developers/references/core-sdk/index/type-aliases/getmerchantinformationreturntype/)\>
Defined in: [actions/getMerchantInformation.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/getMerchantInformation.ts#L17)
Fetch the current merchant information (name, rewards, tiers) from the wallet iframe.
Results are cached in memory for 30 seconds by default. Concurrent calls
while a request is in-flight are deduplicated automatically.
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### options?
Optional cache configuration
#### cacheTime?
`number`
Time in ms to cache the result. Default: 30_000 (30s). Set to 0 to disable.
## Returns
`Promise`\<[`GetMerchantInformationReturnType`](/developers/references/core-sdk/index/type-aliases/getmerchantinformationreturntype/)\>
The merchant information including available reward tiers
## See
[\`GetMerchantInformationReturnType\`](/developers/references/core-sdk/index/type-aliases/getmerchantinformationreturntype/) for the return type shape
# getMergeToken
> **getMergeToken**(`client`, `options?`): `Promise`\<`string` \| `null`\>
Defined in: [actions/getMergeToken.ts:19](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/getMergeToken.ts#L19)
Fetch a merge token for the current anonymous identity.
Used by in-app browser redirect flows to preserve identity
when switching from a WebView to the system browser.
The token is appended as `?fmt=` to the redirect URL.
Results are cached in memory for 30 seconds by default. Concurrent calls
while a request is in-flight are deduplicated automatically.
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### options?
Optional cache configuration
#### cacheTime?
`number`
Time in ms to cache the result. Default: 30_000 (30s). Set to 0 to disable.
## Returns
`Promise`\<`string` \| `null`\>
The merge token string, or null if unavailable
# getUserReferralStatus
> **getUserReferralStatus**(`client`, `options?`): `Promise`\<[`UserReferralStatusType`](/developers/references/core-sdk/index/type-aliases/userreferralstatustype/) \| `null`\>
Defined in: [actions/getUserReferralStatus.ts:28](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/getUserReferralStatus.ts#L28)
Fetch the current user's referral status on the current merchant.
The listener resolves the user's identity (via clientId or wallet session)
and checks whether a referral link exists where the user is the referee.
Results are cached in memory for 30 seconds by default. Concurrent calls
while a request is in-flight are deduplicated automatically.
Returns `null` when the user's identity cannot be resolved.
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### options?
Optional cache configuration
#### cacheTime?
`number`
Time in ms to cache the result. Default: 30_000 (30s). Set to 0 to disable.
## Returns
`Promise`\<[`UserReferralStatusType`](/developers/references/core-sdk/index/type-aliases/userreferralstatustype/) \| `null`\>
The user's referral status, or `null` if identity cannot be resolved
## Example
```ts
const status = await getUserReferralStatus(client);
if (status?.isReferred) {
console.log("User was referred to this merchant");
}
```
# modalBuilder
> **modalBuilder**(`client`, `args`): [`ModalBuilder`](/developers/references/core-sdk/actions/type-aliases/modalbuilder/)
Defined in: [actions/wrapper/modalBuilder.ts:98](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/modalBuilder.ts#L98)
Helper to craft Frak modal, and share a base initial config
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### args
#### login?
[`ModalStepMetadata`](/developers/references/core-sdk/index/type-aliases/modalstepmetadata/) & \{ `allowSso`: `true`; `ssoMetadata?`: [`SsoMetadata`](/developers/references/core-sdk/index/type-aliases/ssometadata/); \} \| [`ModalStepMetadata`](/developers/references/core-sdk/index/type-aliases/modalstepmetadata/) & \{ `allowSso?`: `false`; `ssoMetadata?`: `undefined`; \}
Login step parameters
#### metadata?
[`ModalRpcMetadata`](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/)
Common modal metadata (customisation, language etc)
## Returns
[`ModalBuilder`](/developers/references/core-sdk/actions/type-aliases/modalbuilder/)
## Description
This function will create a modal builder with the provided metadata and login parameters.
## Example
Here is an example of how to use the `modalBuilder` to create and display a sharing modal:
```js
// Create the modal builder
const modalBuilder = window.FrakSDK.modalBuilder(frakClient, baseModalConfig);
// Configure the information to be shared via the sharing link
const sharingConfig = {
popupTitle: "Share this with your friends",
text: "Discover our product!",
link: window.location.href,
};
// Display the sharing modal
function modalShare() {
modalBuilder.sharing(sharingConfig).display();
}
```
## See
- [ModalStepTypes](/developers/references/core-sdk/index/type-aliases/modalsteptypes/) for more info about each modal step types and their parameters
- [ModalRpcMetadata](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/) for more info about the metadata that can be passed to the modal
- [ModalRpcStepsResultType](/developers/references/core-sdk/index/type-aliases/modalrpcstepsresulttype/) for more info about the result of each modal steps
- [displayModal](/developers/references/core-sdk/actions/functions/displaymodal/) for more info about how the modal is displayed
# openSso
> **openSso**(`client`, `inputArgs`): `Promise`\<[`OpenSsoReturnType`](/developers/references/core-sdk/index/type-aliases/openssoreturntype/)\>
Defined in: [actions/openSso.ts:68](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/openSso.ts#L68)
Function used to open the SSO
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### inputArgs
[`OpenSsoParamsType`](/developers/references/core-sdk/index/type-aliases/openssoparamstype/)
## Returns
`Promise`\<[`OpenSsoReturnType`](/developers/references/core-sdk/index/type-aliases/openssoreturntype/)\>
## Description
Two SSO flow modes:
**Redirect Mode** (openInSameWindow: true):
- Wallet generates URL and triggers redirect
- Used when redirectUrl is provided
**Popup Mode** (openInSameWindow: false/omitted):
- SDK generates URL client-side (or uses provided ssoPopupUrl)
- Opens popup synchronously (prevents popup blockers)
- Waits for SSO completion via postMessage
## Example
First we build the sso metadata
```ts
// Build the metadata
const metadata: SsoMetadata = {
logoUrl: "https://my-app.com/logo.png",
homepageLink: "https://my-app.com",
};
```
Then, either use it with direct exit (and so user is directly redirected to your website), or a custom redirect URL
```ts title="Popup (default)"
// Opens in popup, SDK generates URL automatically
await openSso(frakConfig, {
directExit: true,
metadata,
});
```
```ts title="Redirect"
// Opens in same window with redirect
await openSso(frakConfig, {
redirectUrl: "https://my-app.com/frak-sso",
metadata,
openInSameWindow: true,
});
```
```ts title="Custom popup URL"
// Advanced: provide custom SSO URL
const { ssoUrl } = await prepareSso(frakConfig, { metadata });
await openSso(frakConfig, {
metadata,
ssoPopupUrl: `${ssoUrl}&custom=param`,
});
```
# prepareSso
> **prepareSso**(`client`, `args`): `Promise`\<[`PrepareSsoReturnType`](/developers/references/core-sdk/index/type-aliases/preparessoreturntype/)\>
Defined in: [actions/prepareSso.ts:38](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/prepareSso.ts#L38)
Generate SSO URL without opening popup
This is a **synchronous**, client-side function that generates the SSO URL
without any RPC calls to the wallet iframe. Use this when you need:
- Custom URL modifications before opening popup
- Pre-generation for advanced popup strategies
- URL inspection/logging before SSO flow
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### args
[`PrepareSsoParamsType`](/developers/references/core-sdk/index/type-aliases/preparessoparamstype/)
The SSO parameters
## Returns
`Promise`\<[`PrepareSsoReturnType`](/developers/references/core-sdk/index/type-aliases/preparessoreturntype/)\>
Object containing the generated ssoUrl
## Example
```ts
// Generate URL for inspection
const { ssoUrl } = prepareSso(client, {
metadata: { logoUrl: "..." },
directExit: true
});
console.log("Opening SSO:", ssoUrl);
// Add custom params
const customUrl = `${ssoUrl}&tracking=abc123`;
await openSso(client, { metadata, ssoPopupUrl: customUrl });
```
## Remarks
For most use cases, just use `openSso()` which handles URL generation automatically.
Only use `prepareSso()` when you need explicit control over the URL.
# processReferral
> **processReferral**(`client`, `args`): `"success"` \| `"idle"` \| `"processing"` \| `"no-referrer"` \| `"self-referral"`
Defined in: [actions/referral/processReferral.ts:149](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/referral/processReferral.ts#L149)
Handle the full referral interaction flow:
1. Check if the user has been referred (if not, early exit)
2. Preflight self-referral check (if yes, early exit)
3. Track the arrival event
4. Replace the current URL with the user's own referral context
5. Return the resulting referral state
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### args
#### frakContext?
`FrakContext` \| `null`
The referral context parsed from the URL
#### options?
[`ProcessReferralOptions`](/developers/references/core-sdk/actions/type-aliases/processreferraloptions/)
Options for URL replacement and merchant context
#### walletStatus?
[`WalletStatusReturnType`](/developers/references/core-sdk/index/type-aliases/walletstatusreturntype/)
The current user wallet status
## Returns
`"success"` \| `"idle"` \| `"processing"` \| `"no-referrer"` \| `"self-referral"`
The referral state
## See
@frak-labs/core-sdk!ModalStepTypes for modal step types
# referralInteraction
> **referralInteraction**(`client`, `args?`): `Promise`\<`"success"` \| `"idle"` \| `"processing"` \| `"no-referrer"` \| `"self-referral"` \| `undefined`\>
Defined in: [actions/referral/referralInteraction.ts:21](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/referral/referralInteraction.ts#L21)
Function used to handle referral interactions
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### args?
#### options?
[`ProcessReferralOptions`](/developers/references/core-sdk/actions/type-aliases/processreferraloptions/)
Some options for the referral interaction
## Returns
`Promise`\<`"success"` \| `"idle"` \| `"processing"` \| `"no-referrer"` \| `"self-referral"` \| `undefined`\>
A promise with the resulting referral state, or undefined in case of an error
## Description
This function will automatically handle the referral interaction process
## See
[processReferral](/developers/references/core-sdk/actions/functions/processreferral/) for more details on the automatic referral handling process
# sendInteraction
> **sendInteraction**(`client`, `params`): `Promise`\<`void`\>
Defined in: [actions/sendInteraction.ts:43](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/sendInteraction.ts#L43)
Send an interaction to the backend via the listener RPC.
Fire-and-forget: errors are caught and logged, not thrown.
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The Frak client instance
### params
[`SendInteractionParamsType`](/developers/references/core-sdk/index/type-aliases/sendinteractionparamstype/)
The interaction parameters
## Returns
`Promise`\<`void`\>
## Description
Sends a user interaction event through the wallet iframe RPC. Supports three interaction types: arrival tracking, sharing events, and custom interactions.
## Examples
Track a user arrival with referral attribution:
```ts
await sendInteraction(client, {
type: "arrival",
referrerWallet: "0x1234...abcd",
landingUrl: window.location.href,
utmSource: "twitter",
utmMedium: "social",
utmCampaign: "launch-2026",
});
```
Track a sharing event:
```ts
await sendInteraction(client, { type: "sharing" });
```
Send a custom interaction:
```ts
await sendInteraction(client, {
type: "custom",
customType: "newsletter_signup",
data: { email: "user@example.com" },
});
```
# sendTransaction
> **sendTransaction**(`client`, `args`): `Promise`\<\{ `hash`: `` `0x${string}` ``; \}\>
Defined in: [actions/wrapper/sendTransaction.ts:47](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/sendTransaction.ts#L47)
Function used to send a user transaction, simple wrapper around the displayModal function to ease the send transaction process
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### args
The parameters
#### metadata?
[`ModalRpcMetadata`](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/)
Custom metadata to be passed to the modal
#### tx
[`SendTransactionTxType`](/developers/references/core-sdk/index/type-aliases/sendtransactiontxtype/) \| [`SendTransactionTxType`](/developers/references/core-sdk/index/type-aliases/sendtransactiontxtype/)[]
The transaction to be sent (either a single tx or multiple ones)
## Returns
`Promise`\<\{ `hash`: `` `0x${string}` ``; \}\>
The hash of the transaction that was sent in a promise
## Description
This function will display a modal to the user with the provided transaction and metadata.
## Example
```ts
const { hash } = await sendTransaction(frakConfig, {
tx: {
to: "0xdeadbeef",
value: toHex(100n),
},
metadata: {
header: {
title: "Sending eth",
},
context: "Send 100wei to 0xdeadbeef",
},
});
console.log("Transaction hash:", hash);
```
# setupReferral
> **setupReferral**(`client`): `Promise`\<`void`\>
Defined in: [actions/referral/setupReferral.ts:22](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/referral/setupReferral.ts#L22)
Process referral context and emit a DOM event on success.
- Calls [referralInteraction](/developers/references/core-sdk/actions/functions/referralinteraction/) to detect and track any referral in the URL
- On `"success"`, dispatches a bare [REFERRAL\_SUCCESS\_EVENT](/developers/references/core-sdk/actions/variables/referral_success_event/) on `window`
- Silently swallows errors (fire-and-forget during SDK init)
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The initialized Frak client
## Returns
`Promise`\<`void`\>
# siweAuthenticate
> **siweAuthenticate**(`client`, `args`): `Promise`\<\{ `message`: `string`; `signature`: `` `0x${string}` ``; \}\>
Defined in: [actions/wrapper/siweAuthenticate.ts:86](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/siweAuthenticate.ts#L86)
Function used to launch a siwe authentication
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### args
The parameters
#### metadata?
[`ModalRpcMetadata`](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/)
Custom metadata to be passed to the modal
#### siwe?
`Partial`\<[`SiweAuthenticationParams`](/developers/references/core-sdk/index/type-aliases/siweauthenticationparams/)\>
Partial SIWE params, since we can rebuild them from the SDK if they are empty
If no parameters provider, some fields will be recomputed from the current configuration and environment.
- `statement` will be set to a default value
- `nonce` will be generated
- `uri` will be set to the current domain
- `version` will be set to "1"
- `domain` will be set to the current window domain
**Default**
```ts
{}
```
## Returns
`Promise`\<\{ `message`: `string`; `signature`: `` `0x${string}` ``; \}\>
The SIWE authentication result (message + signature) in a promise
## Description
This function will display a modal to the user with the provided SIWE parameters and metadata.
## Example
```ts
import { siweAuthenticate } from "@frak-labs/core-sdk/actions";
import { parseSiweMessage } from "viem/siwe";
const { signature, message } = await siweAuthenticate(frakConfig, {
siwe: {
statement: "Sign in to My App",
domain: "my-app.com",
expirationTimeTimestamp: Date.now() + 1000 * 60 * 5,
},
metadata: {
header: {
title: "Sign in",
},
context: "Sign in to My App",
},
});
console.log("Parsed final message:", parseSiweMessage(message));
console.log("Siwe signature:", signature);
```
# trackPurchaseStatus
> **trackPurchaseStatus**(`args`): `Promise`\<`void`\>
Defined in: [actions/trackPurchaseStatus.ts:34](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/trackPurchaseStatus.ts#L34)
Function used to track the status of a purchase
when a purchase is tracked, the `purchaseCompleted` interactions will be automatically send for the user when we receive the purchase confirmation via webhook.
## Parameters
### args
#### customerId
`string` \| `number`
The customer id that made the purchase (on your side)
#### merchantId?
`string`
Optional explicit merchant id to use for the tracking request
#### orderId
`string` \| `number`
The order id of the purchase (on your side)
#### token
`string`
The token of the purchase
## Returns
`Promise`\<`void`\>
## Description
This function will send a request to the backend to listen for the purchase status.
## Example
```ts
async function trackPurchase(checkout) {
const payload = {
customerId: checkout.order.customer.id,
orderId: checkout.order.id,
token: checkout.token,
merchantId: "your-merchant-id",
};
await trackPurchaseStatus(payload);
}
```
## Remarks
- Merchant id is resolved in this order: explicit `args.merchantId`, then `sdkConfigStore.resolveMerchantId()` (config store → sessionStorage → backend fetch).
- This function supports anonymous users and will use the `x-frak-client-id` header when available.
- At least one identity source must exist (`frak-wallet-interaction-token` or `x-frak-client-id`), otherwise the tracking request is skipped.
- This function will print a warning if used in a non-browser environment or if no identity / merchant id can be resolved.
# watchWalletStatus
> **watchWalletStatus**(`client`, `callback?`): `Promise`\<[`WalletStatusReturnType`](/developers/references/core-sdk/index/type-aliases/walletstatusreturntype/)\>
Defined in: [actions/watchWalletStatus.ts:23](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/watchWalletStatus.ts#L23)
Function used to watch the current frak wallet status
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The current Frak Client
### callback?
(`status`) => `void`
The callback that will receive any wallet status change
## Returns
`Promise`\<[`WalletStatusReturnType`](/developers/references/core-sdk/index/type-aliases/walletstatusreturntype/)\>
A promise resolving with the initial wallet status
## Description
This function will return the current wallet status, and will listen to any change in the wallet status.
## Example
```ts
await watchWalletStatus(frakConfig, (status: WalletStatusReturnType) => {
if (status.key === "connected") {
console.log("Wallet connected:", status.wallet);
} else {
console.log("Wallet not connected");
}
});
```
# ModalBuilder
> **ModalBuilder** = [`ModalStepBuilder`](/developers/references/core-sdk/actions/type-aliases/modalstepbuilder/)\<\[[`LoginModalStepType`](/developers/references/core-sdk/index/type-aliases/loginmodalsteptype/)\]\>
Defined in: [actions/wrapper/modalBuilder.ts:62](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/modalBuilder.ts#L62)
Represent the output type of the modal builder
# ModalStepBuilder
> **ModalStepBuilder**\<`Steps`\> = \{ `display`: (`metadataOverride?`, `placement?`) => `Promise`\<[`ModalRpcStepsResultType`](/developers/references/core-sdk/index/type-aliases/modalrpcstepsresulttype/)\<`Steps`\>\>; `params`: [`DisplayModalParamsType`](/developers/references/core-sdk/index/type-aliases/displaymodalparamstype/)\<`Steps`\>; `reward`: (`options?`) => `ModalStepBuilder`\<\[`...Steps`, [`FinalModalStepType`](/developers/references/core-sdk/index/type-aliases/finalmodalsteptype/)\]\>; `sendTx`: (`options`) => `ModalStepBuilder`\<\[`...Steps`, [`SendTransactionModalStepType`](/developers/references/core-sdk/index/type-aliases/sendtransactionmodalsteptype/)\]\>; `sharing`: (`sharingOptions?`, `options?`) => `ModalStepBuilder`\<\[`...Steps`, [`FinalModalStepType`](/developers/references/core-sdk/index/type-aliases/finalmodalsteptype/)\]\>; \}
Defined in: [actions/wrapper/modalBuilder.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/modalBuilder.ts#L17)
Represent the type of the modal step builder
## Type Parameters
### Steps
`Steps` *extends* [`ModalStepTypes`](/developers/references/core-sdk/index/type-aliases/modalsteptypes/)[] = [`ModalStepTypes`](/developers/references/core-sdk/index/type-aliases/modalsteptypes/)[]
## Properties
### display
> **display**: (`metadataOverride?`, `placement?`) => `Promise`\<[`ModalRpcStepsResultType`](/developers/references/core-sdk/index/type-aliases/modalrpcstepsresulttype/)\<`Steps`\>\>
Defined in: [actions/wrapper/modalBuilder.ts:51](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/modalBuilder.ts#L51)
Display the modal
#### Parameters
##### metadataOverride?
(`current?`) => [`ModalRpcMetadata`](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/) \| `undefined`
Function returning optional metadata to override the current modal metadata
##### placement?
`string`
Optional placement ID to associate with this modal display
#### Returns
`Promise`\<[`ModalRpcStepsResultType`](/developers/references/core-sdk/index/type-aliases/modalrpcstepsresulttype/)\<`Steps`\>\>
***
### params
> **params**: [`DisplayModalParamsType`](/developers/references/core-sdk/index/type-aliases/displaymodalparamstype/)\<`Steps`\>
Defined in: [actions/wrapper/modalBuilder.ts:23](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/modalBuilder.ts#L23)
The current modal params
***
### reward
> **reward**: (`options?`) => `ModalStepBuilder`\<\[`...Steps`, [`FinalModalStepType`](/developers/references/core-sdk/index/type-aliases/finalmodalsteptype/)\]\>
Defined in: [actions/wrapper/modalBuilder.ts:33](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/modalBuilder.ts#L33)
Add a final step of type reward to the modal
#### Parameters
##### options?
`Omit`\<[`FinalModalStepType`](/developers/references/core-sdk/index/type-aliases/finalmodalsteptype/)\[`"params"`\], `"action"`\>
#### Returns
`ModalStepBuilder`\<\[`...Steps`, [`FinalModalStepType`](/developers/references/core-sdk/index/type-aliases/finalmodalsteptype/)\]\>
***
### sendTx
> **sendTx**: (`options`) => `ModalStepBuilder`\<\[`...Steps`, [`SendTransactionModalStepType`](/developers/references/core-sdk/index/type-aliases/sendtransactionmodalsteptype/)\]\>
Defined in: [actions/wrapper/modalBuilder.ts:27](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/modalBuilder.ts#L27)
Add a send transaction step to the modal
#### Parameters
##### options
[`SendTransactionModalStepType`](/developers/references/core-sdk/index/type-aliases/sendtransactionmodalsteptype/)\[`"params"`\]
#### Returns
`ModalStepBuilder`\<\[`...Steps`, [`SendTransactionModalStepType`](/developers/references/core-sdk/index/type-aliases/sendtransactionmodalsteptype/)\]\>
***
### sharing
> **sharing**: (`sharingOptions?`, `options?`) => `ModalStepBuilder`\<\[`...Steps`, [`FinalModalStepType`](/developers/references/core-sdk/index/type-aliases/finalmodalsteptype/)\]\>
Defined in: [actions/wrapper/modalBuilder.ts:39](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/modalBuilder.ts#L39)
Add a final step of type sharing to the modal
#### Parameters
##### sharingOptions?
`Extract`\<[`FinalActionType`](/developers/references/core-sdk/index/type-aliases/finalactiontype/), \{ `key`: `"sharing"`; \}\>\[`"options"`\]
##### options?
`Omit`\<[`FinalModalStepType`](/developers/references/core-sdk/index/type-aliases/finalmodalsteptype/)\[`"params"`\], `"action"`\>
#### Returns
`ModalStepBuilder`\<\[`...Steps`, [`FinalModalStepType`](/developers/references/core-sdk/index/type-aliases/finalmodalsteptype/)\]\>
# ProcessReferralOptions
> **ProcessReferralOptions** = \{ `alwaysAppendUrl?`: `boolean`; `merchantId?`: `string`; \}
Defined in: [actions/referral/processReferral.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/referral/processReferral.ts#L17)
Options for the referral auto-interaction process.
## Properties
### alwaysAppendUrl?
> `optional` **alwaysAppendUrl?**: `boolean`
Defined in: [actions/referral/processReferral.ts:23](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/referral/processReferral.ts#L23)
If true, always replace the URL with the current user's referral context
so the next visitor gets referred by this user.
#### Default Value
```ts
false
```
***
### merchantId?
> `optional` **merchantId?**: `string`
Defined in: [actions/referral/processReferral.ts:29](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/referral/processReferral.ts#L29)
Merchant ID for building the current user's referral context.
Required when `alwaysAppendUrl` is true and the incoming context is V1.
For V2 contexts, the merchantId is already embedded in the context.
# SendTransactionParams
> **SendTransactionParams** = \{ `metadata?`: [`ModalRpcMetadata`](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/); `tx`: [`SendTransactionModalStepType`](/developers/references/core-sdk/index/type-aliases/sendtransactionmodalsteptype/)\[`"params"`\]\[`"tx"`\]; \}
Defined in: [actions/wrapper/sendTransaction.ts:13](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/sendTransaction.ts#L13)
Parameters to directly show a modal used to send a transaction
## Properties
### metadata?
> `optional` **metadata?**: [`ModalRpcMetadata`](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/)
Defined in: [actions/wrapper/sendTransaction.ts:21](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/sendTransaction.ts#L21)
Custom metadata to be passed to the modal
***
### tx
> **tx**: [`SendTransactionModalStepType`](/developers/references/core-sdk/index/type-aliases/sendtransactionmodalsteptype/)\[`"params"`\]\[`"tx"`\]
Defined in: [actions/wrapper/sendTransaction.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/sendTransaction.ts#L17)
The transaction to be sent (either a single tx or multiple ones)
# SiweAuthenticateModalParams
> **SiweAuthenticateModalParams** = \{ `metadata?`: [`ModalRpcMetadata`](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/); `siwe?`: `Partial`\<[`SiweAuthenticationParams`](/developers/references/core-sdk/index/type-aliases/siweauthenticationparams/)\>; \}
Defined in: [actions/wrapper/siweAuthenticate.ts:38](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/siweAuthenticate.ts#L38)
Parameter used to directly show a modal used to authenticate with SIWE
## Properties
### metadata?
> `optional` **metadata?**: [`ModalRpcMetadata`](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/)
Defined in: [actions/wrapper/siweAuthenticate.ts:55](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/siweAuthenticate.ts#L55)
Custom metadata to be passed to the modal
***
### siwe?
> `optional` **siwe?**: `Partial`\<[`SiweAuthenticationParams`](/developers/references/core-sdk/index/type-aliases/siweauthenticationparams/)\>
Defined in: [actions/wrapper/siweAuthenticate.ts:51](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/wrapper/siweAuthenticate.ts#L51)
Partial SIWE params, since we can rebuild them from the SDK if they are empty
If no parameters provider, some fields will be recomputed from the current configuration and environment.
- `statement` will be set to a default value
- `nonce` will be generated
- `uri` will be set to the current domain
- `version` will be set to "1"
- `domain` will be set to the current window domain
#### Default
```ts
{}
```
# REFERRAL_SUCCESS_EVENT
> `const` **REFERRAL\_SUCCESS\_EVENT**: `"frak:referral-success"` = `"frak:referral-success"`
Defined in: [actions/referral/setupReferral.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/referral/setupReferral.ts#L11)
Custom event name dispatched on successful referral processing.
Fired once per page load when a valid referral context is found in the URL
and successfully tracked. Consumers (e.g. ``) listen for this
to display a referral success message.
# base64urlDecode
> **base64urlDecode**(`value`): `Uint8Array`
Defined in: [utils/compression/b64.ts:18](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/compression/b64.ts#L18)
Decode a base64url encoded string
## Parameters
### value
`string`
The value to decode
## Returns
`Uint8Array`
The decoded value
# base64urlEncode
> **base64urlEncode**(`buffer`): `string`
Defined in: [utils/compression/b64.ts:6](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/compression/b64.ts#L6)
Encode a buffer to a base64url encoded string
## Parameters
### buffer
`Uint8Array`
The buffer to encode
## Returns
`string`
The encoded string
# clearAllCache
> **clearAllCache**(): `void`
Defined in: [utils/cache/withCache.ts:138](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/cache/withCache.ts#L138)
Clear all cached data (both pending promises and resolved responses).
Called automatically when the client is destroyed.
## Returns
`void`
# createIFrameFrakClient
> **createIFrameFrakClient**(`args`): [`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
Defined in: [clients/createIFrameFrakClient.ts:44](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/clients/createIFrameFrakClient.ts#L44)
Create a new iframe Frak client
## Parameters
### args
#### config
[`FrakWalletSdkConfig`](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/)
The configuration to use for the Frak Wallet SDK.
When `config.domain` is set, it is used to resolve the correct merchant config in tunneled/proxied environments (e.g. Shopify dev with Cloudflare tunnel).
#### iframe
`HTMLIFrameElement`
The iframe to use for the communication
## Returns
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/)
The created Frak Client
## Example
```ts
const frakConfig: FrakWalletSdkConfig = {
metadata: {
name: "My app title",
},
}
const iframe = await createIframe({ config: frakConfig });
const client = createIFrameFrakClient({ config: frakConfig, iframe });
```
# deleteQueryParamCaseInsensitive
> **deleteQueryParamCaseInsensitive**(`searchParams`, `key`): `void`
Defined in: [utils/url/queryParams.ts:46](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/url/queryParams.ts#L46)
Delete every query parameter whose key matches `key` case-insensitively.
Keys are collected before deletion because mutating a `URLSearchParams`
while iterating it skips entries.
## Parameters
### searchParams
`URLSearchParams`
### key
`string`
## Returns
`void`
# findIframeInOpener
> **findIframeInOpener**(`pathname?`): `Window` \| `null`
Defined in: [utils/iframe/iframeHelper.ts:152](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/iframe/iframeHelper.ts#L152)
Find an iframe within window.opener by pathname
When a popup is opened via window.open from an iframe, window.opener points to
the parent window, not the iframe itself. This utility searches through all frames
in window.opener to find an iframe matching the specified pathname.
## Parameters
### pathname?
`string` = `"/listener"`
The pathname to search for (default: "/listener")
## Returns
`Window` \| `null`
The matching iframe window, or null if not found
## Example
```typescript
// Find the default /listener iframe
const listenerIframe = findIframeInOpener();
// Find a custom iframe
const customIframe = findIframeInOpener("/my-custom-iframe");
```
# formatAmount
> **formatAmount**(`amount`, `currency?`): `string`
Defined in: [utils/format/formatAmount.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/format/formatAmount.ts#L11)
Format a numeric amount as a localized currency string
## Parameters
### amount
`number`
The raw numeric amount to format
### currency?
[`Currency`](/developers/references/core-sdk/index/type-aliases/currency/)
Optional currency config; defaults to EUR/fr-FR when omitted
## Returns
`string`
Localized currency string (e.g. "1 500 €", "$1,500")
# generateSsoUrl
> **generateSsoUrl**(`walletUrl`, `params`, `merchantId`, `name`, `clientId`, `css?`): `string`
Defined in: [utils/sso/sso.ts:42](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/sso/sso.ts#L42)
Generate SSO URL with compressed parameters
This mirrors the wallet's getOpenSsoLink() function
## Parameters
### walletUrl
`string`
Base wallet URL (e.g., "https://wallet.frak.id")
### params
[`PrepareSsoParamsType`](/developers/references/core-sdk/index/type-aliases/preparessoparamstype/)
SSO parameters
### merchantId
`string`
Merchant identifier
### name
`string` \| `undefined`
Application name
### clientId
`string`
Client identifier for identity tracking
### css?
`string`
Optional custom CSS
## Returns
`string`
Complete SSO URL ready to open in popup or redirect
## Example
```ts
const ssoUrl = generateSsoUrl(
"https://wallet.frak.id",
{ metadata: { logoUrl: "..." }, directExit: true },
"0x123...",
"My App"
);
// Returns: https://wallet.frak.id/sso?p=
```
# getBackendUrl
> **getBackendUrl**(`walletUrl?`): `string`
Defined in: [config/backendUrl.ts:41](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/config/backendUrl.ts#L41)
Get the backend URL for API calls
Tries to derive from SDK config, falls back to production
## Parameters
### walletUrl?
`string`
Optional wallet URL to derive from (overrides global config)
## Returns
`string`
# getClientId
> **getClientId**(): `string`
Defined in: [config/clientId.ts:28](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/config/clientId.ts#L28)
Get the client ID from localStorage, creating one if it doesn't exist
## Returns
`string`
The client ID (UUID format)
# getCurrencyAmountKey
> **getCurrencyAmountKey**(`currency?`): keyof [`TokenAmountType`](/developers/references/core-sdk/index/type-aliases/tokenamounttype/)
Defined in: [utils/format/getCurrencyAmountKey.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/format/getCurrencyAmountKey.ts#L8)
Get the currency amount key for a given currency
## Parameters
### currency?
[`Currency`](/developers/references/core-sdk/index/type-aliases/currency/)
The currency to use
## Returns
keyof [`TokenAmountType`](/developers/references/core-sdk/index/type-aliases/tokenamounttype/)
The currency amount key
# getQueryParamCaseInsensitive
> **getQueryParamCaseInsensitive**(`searchParams`, `key`): `string` \| `null`
Defined in: [utils/url/queryParams.ts:24](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/url/queryParams.ts#L24)
Read a query parameter, matching its key case-insensitively.
An exact-case match wins when present, so a canonical link is never shadowed
by a mangled duplicate (`?fctx=stale&fCtx=real` resolves to `real`). Only when
the exact key is absent do we scan for a case-folded variant.
## Parameters
### searchParams
`URLSearchParams`
### key
`string`
## Returns
`string` \| `null`
the param value, or `null` when no key matches.
# getSupportedCurrency
> **getSupportedCurrency**(`currency?`): [`Currency`](/developers/references/core-sdk/index/type-aliases/currency/)
Defined in: [utils/format/getSupportedCurrency.ts:9](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/format/getSupportedCurrency.ts#L9)
Get the supported currency for a given currency
## Parameters
### currency?
[`Currency`](/developers/references/core-sdk/index/type-aliases/currency/)
The currency to use
## Returns
[`Currency`](/developers/references/core-sdk/index/type-aliases/currency/)
The supported currency
# isMobile
> **isMobile**(): `boolean`
Defined in: [utils/browser/inAppBrowser.ts:24](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/browser/inAppBrowser.ts#L24)
Check if the current device is a mobile device (iOS, iPadOS, Android,
webOS, BlackBerry, IEMobile, Opera Mini). Reuses [isIOS](/developers/references/core-sdk/index/variables/isios/) so the
iPadOS-13+ Macintosh heuristic stays in one place.
## Returns
`boolean`
# mergeAttribution
> **mergeAttribution**(`__namedParameters`): [`AttributionParams`](/developers/references/core-sdk/index/type-aliases/attributionparams/) \| `undefined`
Defined in: [context/mergeAttribution.ts:44](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/context/mergeAttribution.ts#L44)
Merge the three attribution layers into a single [AttributionParams](/developers/references/core-sdk/index/type-aliases/attributionparams/)
value suitable for `FrakContextManager.update`.
Priority per field:
1. `perCall` (wins)
2. `defaults` (merchant-level, backend > SDK static, already pre-merged)
3. Hardcoded fallbacks resolved later by `FrakContextManager`
Special rules:
- `perCall === null` returns `undefined` (explicit disable: no UTM/ref/via).
- `perCall === undefined` (no opinion) yields at least `{}` so `FrakContextManager`
applies its hardcoded defaults (utm_source=frak, utm_medium=referral,
utm_campaign=, ref=, via=frak).
- `utm_content` never comes from `defaults`; only `productUtmContent` or
`perCall.utmContent` can populate it.
## Parameters
### \_\_namedParameters
[`MergeAttributionInput`](/developers/references/core-sdk/index/type-aliases/mergeattributioninput/)
## Returns
[`AttributionParams`](/developers/references/core-sdk/index/type-aliases/attributionparams/) \| `undefined`
# redirectToExternalBrowser
> **redirectToExternalBrowser**(`targetUrl`): `void`
Defined in: [utils/browser/inAppBrowser.ts:65](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/browser/inAppBrowser.ts#L65)
Redirect to external browser from in-app WebView.
- **iOS**: Uses `x-safari-https://` scheme — server-side 302 redirects
to custom URL schemes are silently swallowed by WKWebView.
Direct `window.location.href` assignment works (confirmed iOS 17+).
- **Android**: Uses backend `/common/social` endpoint which returns a PDF
Content-Type response, forcing the WebView to hand off to the default browser.
## Parameters
### targetUrl
`string`
The URL to open in the external browser
## Returns
`void`
# setupClient
> **setupClient**(`config`): `Promise`\<[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/) \| `undefined`\>
Defined in: [clients/setupClient.ts:20](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/clients/setupClient.ts#L20)
Directly setup the Frak client with an iframe
Return when the FrakClient is ready (setup and communication estbalished with the wallet)
## Parameters
### config
The configuration to use for the Frak Wallet SDK
#### config
[`FrakWalletSdkConfig`](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/)
## Returns
`Promise`\<[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/) \| `undefined`\>
a Promise with the Frak Client
## Example
```ts
const frakConfig: FrakWalletSdkConfig = {
metadata: {
name: "My app title",
},
}
const client = await setupClient({ config: frakConfig });
```
# trackEvent
> **trackEvent**\<`K`\>(`client`, `event`, `properties?`): `void`
Defined in: [utils/analytics/trackEvent.ts:16](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/analytics/trackEvent.ts#L16)
Track an analytics event via the SDK's OpenPanel instance.
Fire-and-forget — silently catches errors so analytics never break a
partner integration.
The client must be passed explicitly because the OpenPanel instance is
scoped to each `FrakClient` (a partner site may hold multiple iframes).
## Type Parameters
### K
`K` *extends* keyof SdkLifecycleEventMap \| keyof SdkComponentEventMap \| keyof SdkReferralEventMap
## Parameters
### client
[`FrakClient`](/developers/references/core-sdk/index/type-aliases/frakclient/) \| `undefined`
The Frak client instance (no-op if undefined)
### event
`K`
Typed event name from the SDK event map
### properties?
[`SdkEventMap`](/developers/references/core-sdk/index/type-aliases/sdkeventmap/)\[`K`\]
Typed properties for the given event
## Returns
`void`
# triggerDeepLinkWithFallback
> **triggerDeepLinkWithFallback**(`deepLink`, `options?`): `void`
Defined in: [utils/browser/deepLinkWithFallback.ts:67](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/browser/deepLinkWithFallback.ts#L67)
Trigger a deep link with visibility-based fallback detection.
Uses the Page Visibility API to detect if the app opened (page goes hidden).
If the page remains visible after the timeout, assumes app is not installed
and invokes the onFallback callback.
On Chromium Android, converts custom scheme to intent:// URL to avoid
the "Continue to app?" confirmation bar.
## Parameters
### deepLink
`string`
The deep link URL to trigger (e.g., "frakwallet://wallet")
### options?
[`DeepLinkFallbackOptions`](/developers/references/core-sdk/index/type-aliases/deeplinkfallbackoptions/)
Optional configuration (timeout, onFallback callback)
## Returns
`void`
# withCache
> **withCache**\<`TData`\>(`fn`, `__namedParameters`): `Promise`\<`TData`\>
Defined in: [utils/cache/withCache.ts:61](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/cache/withCache.ts#L61)
Returns the result of a given promise, and caches the result for
subsequent invocations against a provided cache key.
Also deduplicates concurrent calls — if multiple callers request the same
cache key while the promise is pending, they share the same promise.
## Type Parameters
### TData
`TData`
## Parameters
### fn
() => `Promise`\<`TData`\>
### \_\_namedParameters
`WithCacheOptions`
## Returns
`Promise`\<`TData`\>
## Example
```ts
// First call fetches, subsequent calls return cached data for 30s
const data = await withCache(
() => client.request({ method: "frak_getMerchantInformation" }),
{ cacheKey: "merchantInfo", cacheTime: 30_000 }
);
```
# AppSpecificSsoMetadata
> **AppSpecificSsoMetadata** = [`SsoMetadata`](/developers/references/core-sdk/index/type-aliases/ssometadata/) & \{ `css?`: `string`; `name?`: `string`; \}
Defined in: [utils/sso/sso.ts:5](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/sso/sso.ts#L5)
## Type Declaration
### css?
> `optional` **css?**: `string`
### name?
> `optional` **name?**: `string`
# AttributionDefaults
> **AttributionDefaults** = `Omit`\<[`AttributionParams`](/developers/references/core-sdk/index/type-aliases/attributionparams/), `"utmContent"`\>
Defined in: [types/tracking.ts:45](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L45)
Merchant-level attribution defaults.
Same shape as [AttributionParams](/developers/references/core-sdk/index/type-aliases/attributionparams/) minus `utmContent`, because
`utm_content` describes the specific content/creative being shared and is
inherently per-call or per-product (never a merchant-wide default).
Used as the shape for both:
- `FrakWalletSdkConfig.attribution` (SDK-side compile-time defaults)
- Backend merchant-config attribution (dashboard-driven defaults)
# AttributionParams
> **AttributionParams** = \{ `ref?`: `string`; `utmCampaign?`: `string`; `utmContent?`: `string`; `utmMedium?`: `string`; `utmSource?`: `string`; `utmTerm?`: `string`; `via?`: `string`; \}
Defined in: [types/tracking.ts:24](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L24)
Attribution parameters appended to outbound sharing URLs.
Defaults are derived from the V2 Frak context when available:
- `utmSource`: `"frak"`
- `utmMedium`: `"referral"`
- `utmCampaign`: merchantId (`context.m`)
- `via`: `"frak"`
- `ref`: clientId (`context.c`)
Fields explicitly set here override the defaults. Existing params on the
base URL are preserved (gap-fill policy) to respect merchant-provided UTMs.
## Properties
### ref?
> `optional` **ref?**: `string`
Defined in: [types/tracking.ts:31](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L31)
***
### utmCampaign?
> `optional` **utmCampaign?**: `string`
Defined in: [types/tracking.ts:27](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L27)
***
### utmContent?
> `optional` **utmContent?**: `string`
Defined in: [types/tracking.ts:28](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L28)
***
### utmMedium?
> `optional` **utmMedium?**: `string`
Defined in: [types/tracking.ts:26](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L26)
***
### utmSource?
> `optional` **utmSource?**: `string`
Defined in: [types/tracking.ts:25](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L25)
***
### utmTerm?
> `optional` **utmTerm?**: `string`
Defined in: [types/tracking.ts:29](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L29)
***
### via?
> `optional` **via?**: `string`
Defined in: [types/tracking.ts:30](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L30)
# CompressedSsoData
> **CompressedSsoData** = \{ `cId`: `string`; `d?`: `boolean`; `id?`: `Hex`; `l?`: `"en"` \| `"fr"`; `m`: `string`; `md`: \{ `css?`: `string`; `h?`: `string`; `l?`: `string`; `n?`: `string`; \}; `r?`: `string`; \}
Defined in: [utils/sso/sso.ts:102](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/sso/sso.ts#L102)
Type of compressed the sso data
## Properties
### cId
> **cId**: `string`
Defined in: [utils/sso/sso.ts:106](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/sso/sso.ts#L106)
***
### d?
> `optional` **d?**: `boolean`
Defined in: [utils/sso/sso.ts:110](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/sso/sso.ts#L110)
***
### id?
> `optional` **id?**: `Hex`
Defined in: [utils/sso/sso.ts:104](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/sso/sso.ts#L104)
***
### l?
> `optional` **l?**: `"en"` \| `"fr"`
Defined in: [utils/sso/sso.ts:112](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/sso/sso.ts#L112)
***
### m
> **m**: `string`
Defined in: [utils/sso/sso.ts:114](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/sso/sso.ts#L114)
***
### md
> **md**: \{ `css?`: `string`; `h?`: `string`; `l?`: `string`; `n?`: `string`; \}
Defined in: [utils/sso/sso.ts:116](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/sso/sso.ts#L116)
#### css?
> `optional` **css?**: `string`
#### h?
> `optional` **h?**: `string`
#### l?
> `optional` **l?**: `string`
#### n?
> `optional` **n?**: `string`
***
### r?
> `optional` **r?**: `string`
Defined in: [utils/sso/sso.ts:108](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/sso/sso.ts#L108)
# ConditionGroup
> **ConditionGroup** = \{ `conditions`: ([`RuleCondition`](/developers/references/core-sdk/index/type-aliases/rulecondition/) \| `ConditionGroup`)[]; `logic`: `"all"` \| `"any"` \| `"none"`; \}
Defined in: [types/rpc/merchantInformation.ts:112](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L112)
A recursive group of conditions combined through a boolean `logic`.
## Properties
### conditions
> **conditions**: ([`RuleCondition`](/developers/references/core-sdk/index/type-aliases/rulecondition/) \| `ConditionGroup`)[]
Defined in: [types/rpc/merchantInformation.ts:114](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L114)
***
### logic
> **logic**: `"all"` \| `"any"` \| `"none"`
Defined in: [types/rpc/merchantInformation.ts:113](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L113)
# ConditionOperator
> **ConditionOperator** = `"eq"` \| `"neq"` \| `"gt"` \| `"gte"` \| `"lt"` \| `"lte"` \| `"in"` \| `"not_in"` \| `"contains"` \| `"starts_with"` \| `"ends_with"` \| `"exists"` \| `"not_exists"` \| `"between"`
Defined in: [types/rpc/merchantInformation.ts:59](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L59)
Comparison operators usable in a [RuleCondition](/developers/references/core-sdk/index/type-aliases/rulecondition/).
# Currency
> **Currency** = `"eur"` \| `"usd"` \| `"gbp"`
Defined in: [types/config.ts:7](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L7)
All the currencies available
# DeepLinkFallbackOptions
> **DeepLinkFallbackOptions** = \{ `onFallback?`: () => `void`; `timeout?`: `number`; \}
Defined in: [utils/browser/deepLinkWithFallback.ts:6](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/browser/deepLinkWithFallback.ts#L6)
Options for deep link with fallback
## Properties
### onFallback?
> `optional` **onFallback?**: () => `void`
Defined in: [utils/browser/deepLinkWithFallback.ts:10](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/browser/deepLinkWithFallback.ts#L10)
Callback invoked when fallback is triggered (app not installed)
#### Returns
`void`
***
### timeout?
> `optional` **timeout?**: `number`
Defined in: [utils/browser/deepLinkWithFallback.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/browser/deepLinkWithFallback.ts#L8)
Timeout in ms before triggering fallback (default: 2500ms)
# DisplayEmbeddedWalletParamsType
> **DisplayEmbeddedWalletParamsType** = \{ `loggedIn?`: [`LoggedInEmbeddedView`](/developers/references/core-sdk/index/type-aliases/loggedinembeddedview/); `loggedOut?`: [`LoggedOutEmbeddedView`](/developers/references/core-sdk/index/type-aliases/loggedoutembeddedview/); `metadata?`: \{ `homepageLink?`: `string`; `i18n?`: [`I18nConfig`](/developers/references/core-sdk/index/type-aliases/i18nconfig/); `logo?`: `string`; `position?`: `"left"` \| `"right"`; `targetInteraction?`: [`InteractionTypeKey`](/developers/references/core-sdk/index/type-aliases/interactiontypekey/); \}; \}
Defined in: [types/rpc/embedded/index.ts:23](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/index.ts#L23)
The params used to display the embedded wallet
## Properties
### loggedIn?
> `optional` **loggedIn?**: [`LoggedInEmbeddedView`](/developers/references/core-sdk/index/type-aliases/loggedinembeddedview/)
Defined in: [types/rpc/embedded/index.ts:27](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/index.ts#L27)
The embedded view to display once the user is logged in
***
### loggedOut?
> `optional` **loggedOut?**: [`LoggedOutEmbeddedView`](/developers/references/core-sdk/index/type-aliases/loggedoutembeddedview/)
Defined in: [types/rpc/embedded/index.ts:31](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/index.ts#L31)
The embedded view to display once the user is logged out
***
### metadata?
> `optional` **metadata?**: \{ `homepageLink?`: `string`; `i18n?`: [`I18nConfig`](/developers/references/core-sdk/index/type-aliases/i18nconfig/); `logo?`: `string`; `position?`: `"left"` \| `"right"`; `targetInteraction?`: [`InteractionTypeKey`](/developers/references/core-sdk/index/type-aliases/interactiontypekey/); \}
Defined in: [types/rpc/embedded/index.ts:35](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/index.ts#L35)
Some metadata to customize the embedded view
#### homepageLink?
> `optional` **homepageLink?**: `string`
Link to the homepage of the calling website
If undefined, will default to the domain of the calling website
#### i18n?
> `optional` **i18n?**: [`I18nConfig`](/developers/references/core-sdk/index/type-aliases/i18nconfig/)
Some i18n override for the displayed modal (i.e. update the displayed text only for this modal)
#### logo?
> `optional` **logo?**: `string`
The logo to display on the embedded wallet
If undefined, will default to no logo displayed
#### position?
> `optional` **position?**: `"left"` \| `"right"`
The position of the component
#### targetInteraction?
> `optional` **targetInteraction?**: [`InteractionTypeKey`](/developers/references/core-sdk/index/type-aliases/interactiontypekey/)
The target interaction behind this modal
# DisplayEmbeddedWalletResultType
> **DisplayEmbeddedWalletResultType** = \{ `wallet`: `Address`; \}
Defined in: [types/rpc/embedded/index.ts:66](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/index.ts#L66)
The result of the display embedded wallet rpc request
## Properties
### wallet
> **wallet**: `Address`
Defined in: [types/rpc/embedded/index.ts:67](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/index.ts#L67)
# DisplayModalParamsType
> **DisplayModalParamsType**\<`T`\> = \{ `metadata?`: [`ModalRpcMetadata`](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/); `steps`: [`ModalRpcStepsInput`](/developers/references/core-sdk/index/type-aliases/modalrpcstepsinput/)\<`T`\>; \}
Defined in: [types/rpc/displayModal.ts:79](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displayModal.ts#L79)
Params used to display a modal
## Type Parameters
### T
`T` *extends* [`ModalStepTypes`](/developers/references/core-sdk/index/type-aliases/modalsteptypes/)[]
The list of modal steps we expect to have in the modal
## Properties
### metadata?
> `optional` **metadata?**: [`ModalRpcMetadata`](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/)
Defined in: [types/rpc/displayModal.ts:81](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displayModal.ts#L81)
***
### steps
> **steps**: [`ModalRpcStepsInput`](/developers/references/core-sdk/index/type-aliases/modalrpcstepsinput/)\<`T`\>
Defined in: [types/rpc/displayModal.ts:80](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displayModal.ts#L80)
# DisplaySharingPageParamsType
> **DisplaySharingPageParamsType** = \{ `attribution?`: [`AttributionParams`](/developers/references/core-sdk/index/type-aliases/attributionparams/) \| `null`; `link?`: `string`; `metadata?`: \{ `homepageLink?`: `string`; `i18n?`: [`I18nConfig`](/developers/references/core-sdk/index/type-aliases/i18nconfig/); `logo?`: `string`; `targetInteraction?`: [`InteractionTypeKey`](/developers/references/core-sdk/index/type-aliases/interactiontypekey/); \}; `products?`: [`SharingPageProduct`](/developers/references/core-sdk/index/type-aliases/sharingpageproduct/)[]; \}
Defined in: [types/rpc/displaySharingPage.ts:35](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L35)
Parameters to display the sharing page
## Properties
### attribution?
> `optional` **attribution?**: [`AttributionParams`](/developers/references/core-sdk/index/type-aliases/attributionparams/) \| `null`
Defined in: [types/rpc/displaySharingPage.ts:57](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L57)
Optional attribution overrides for the outbound sharing URL.
When provided (even as an empty object), Frak adds standard affiliation
params (`utm_source=frak`, `utm_medium=referral`, `utm_campaign=`,
`ref=`, `via=frak`) alongside `fCtx`. Existing UTMs on the base
URL are preserved (gap-fill). Set this to `null` to disable attribution
params entirely (only `fCtx` is added).
#### Default
```ts
{} — defaults applied
```
***
### link?
> `optional` **link?**: `string`
Defined in: [types/rpc/displaySharingPage.ts:45](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L45)
Optional link override for sharing
If not provided, the sharing link will be generated from the current page URL + merchant context
***
### metadata?
> `optional` **metadata?**: \{ `homepageLink?`: `string`; `i18n?`: [`I18nConfig`](/developers/references/core-sdk/index/type-aliases/i18nconfig/); `logo?`: `string`; `targetInteraction?`: [`InteractionTypeKey`](/developers/references/core-sdk/index/type-aliases/interactiontypekey/); \}
Defined in: [types/rpc/displaySharingPage.ts:61](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L61)
Optional metadata overrides for the sharing page
#### homepageLink?
> `optional` **homepageLink?**: `string`
Link to the homepage of the calling website
#### i18n?
> `optional` **i18n?**: [`I18nConfig`](/developers/references/core-sdk/index/type-aliases/i18nconfig/)
i18n overrides for the sharing page
#### logo?
> `optional` **logo?**: `string`
Logo override for the sharing page header
#### targetInteraction?
> `optional` **targetInteraction?**: [`InteractionTypeKey`](/developers/references/core-sdk/index/type-aliases/interactiontypekey/)
The target interaction behind this sharing page
***
### products?
> `optional` **products?**: [`SharingPageProduct`](/developers/references/core-sdk/index/type-aliases/sharingpageproduct/)[]
Defined in: [types/rpc/displaySharingPage.ts:40](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L40)
Products to showcase on the sharing page
If provided, they will be displayed in a product card section
# DisplaySharingPageResultType
> **DisplaySharingPageResultType** = \{ `action`: `"shared"` \| `"copied"` \| `"dismissed"`; `installUrl?`: `string`; \}
Defined in: [types/rpc/displaySharingPage.ts:86](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L86)
Result of the sharing page display
## Properties
### action
> **action**: `"shared"` \| `"copied"` \| `"dismissed"`
Defined in: [types/rpc/displaySharingPage.ts:93](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L93)
The action the user took
- "shared": User used the native share dialog
- "copied": User copied the link to clipboard
- "dismissed": User dismissed the sharing page without acting
***
### installUrl?
> `optional` **installUrl?**: `string`
Defined in: [types/rpc/displaySharingPage.ts:99](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L99)
The install URL for the Frak app
Can be used as a fallback to redirect the user to the install page
from the merchant's top-level page (e.g. via `window.location.href`)
# EmbeddedViewActionReferred
> **EmbeddedViewActionReferred** = \{ `key`: `"referred"`; `options?`: `never`; \}
Defined in: [types/rpc/embedded/loggedIn.ts:36](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/loggedIn.ts#L36)
The action to display on the logged out embedded view when the user is referred
## Properties
### key
> **key**: `"referred"`
Defined in: [types/rpc/embedded/loggedIn.ts:37](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/loggedIn.ts#L37)
***
### options?
> `optional` **options?**: `never`
Defined in: [types/rpc/embedded/loggedIn.ts:42](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/loggedIn.ts#L42)
No options for a referred action
# EmbeddedViewActionSharing
> **EmbeddedViewActionSharing** = \{ `key`: `"sharing"`; `options?`: \{ `link?`: `string`; `popupTitle?`: `string`; `text?`: `string`; \}; \}
Defined in: [types/rpc/embedded/loggedIn.ts:6](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/loggedIn.ts#L6)
The different type of action we can have on the embedded view (once the user is logged in)
## Properties
### key
> **key**: `"sharing"`
Defined in: [types/rpc/embedded/loggedIn.ts:7](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/loggedIn.ts#L7)
***
### options?
> `optional` **options?**: \{ `link?`: `string`; `popupTitle?`: `string`; `text?`: `string`; \}
Defined in: [types/rpc/embedded/loggedIn.ts:12](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/loggedIn.ts#L12)
Some sharing options
#### link?
> `optional` **link?**: `string`
The link to be shared (will be suffixed with the Frak sharing context)
#### ~~popupTitle?~~
> `optional` **popupTitle?**: `string`
The title that will be displayed on the system popup once the system sharing window is open
:::caution[Deprecated]
Use the top level `config.metadata.i18n` instead
:::
#### ~~text?~~
> `optional` **text?**: `string`
The text that will be shared alongside the link.
Can contain the variable `{LINK}` to specify where the link is placed, otherwise it will be added at the end
:::caution[Deprecated]
Use the top level `config.metadata.i18n` instead
:::
# EstimatedReward
> **EstimatedReward** = \{ `amount`: [`TokenAmountType`](/developers/references/core-sdk/index/type-aliases/tokenamounttype/); `payoutType`: `"fixed"`; \} \| \{ `maxAmount?`: [`TokenAmountType`](/developers/references/core-sdk/index/type-aliases/tokenamounttype/); `minAmount?`: [`TokenAmountType`](/developers/references/core-sdk/index/type-aliases/tokenamounttype/); `payoutType`: `"percentage"`; `percent`: `number`; `percentOf`: `string`; \} \| \{ `payoutType`: `"tiered"`; `tierField`: `string`; `tiers`: [`RewardTier`](/developers/references/core-sdk/index/type-aliases/rewardtier/)[]; \}
Defined in: [types/rpc/merchantInformation.ts:37](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L37)
Estimated reward amount — discriminated union by payout type
- `fixed`: A known token amount (with fiat equivalents)
- `percentage`: A percent of a purchase field (e.g. 5% of purchase_amount), with optional min/max caps
- `tiered`: Amount depends on a field value matching tier brackets
# FinalActionType
> **FinalActionType** = \{ `key`: `"sharing"`; `options?`: \{ `link?`: `string`; `popupTitle?`: `string`; `text?`: `string`; \}; \} \| \{ `key`: `"reward"`; `options?`: `never`; \}
Defined in: [types/rpc/modal/final.ts:28](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/final.ts#L28)
The different types of final actions we can display in the final step
# FinalModalStepType
> **FinalModalStepType** = `GenericModalStepType`\<`"final"`, \{ `action`: [`FinalActionType`](/developers/references/core-sdk/index/type-aliases/finalactiontype/); `autoSkip?`: `boolean`; `dismissedMetadata?`: [`ModalStepMetadata`](/developers/references/core-sdk/index/type-aliases/modalstepmetadata/)\[`"metadata"`\]; \}, `object`\>
Defined in: [types/rpc/modal/final.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/final.ts#L11)
The final modal step type, could be used to display sharing options or a success reward screen.
**Input**: What type final step to display?
**Output**: None
# FrakClient
> **FrakClient** = \{ `config`: [`FrakWalletSdkConfig`](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/); `openPanel?`: `OpenPanel`; \} & [`IFrameTransport`](/developers/references/core-sdk/index/type-aliases/iframetransport/)
Defined in: [types/client.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/client.ts#L8)
Representing a Frak client, used to interact with the Frak Wallet
## Type Declaration
### config
> **config**: [`FrakWalletSdkConfig`](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/)
### openPanel?
> `optional` **openPanel?**: `OpenPanel`
# FrakLifecycleEvent
> **FrakLifecycleEvent** = `IFrameLifecycleEvent` \| `ClientLifecycleEvent`
Defined in: [types/transport.ts:34](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/transport.ts#L34)
Represent an iframe event
# FrakWalletSdkConfig
> **FrakWalletSdkConfig** = \{ `attribution?`: [`AttributionDefaults`](/developers/references/core-sdk/index/type-aliases/attributiondefaults/); `customizations?`: \{ `css?`: `` `${string}.css` ``; `i18n?`: [`I18nConfig`](/developers/references/core-sdk/index/type-aliases/i18nconfig/); \}; `domain?`: `string`; `metadata`: \{ `currency?`: [`Currency`](/developers/references/core-sdk/index/type-aliases/currency/); `homepageLink?`: `string`; `lang?`: [`Language`](/developers/references/core-sdk/index/type-aliases/language/); `logoUrl?`: `string`; `merchantId?`: `string`; `name?`: `string`; \}; `preload?`: [`ListenerPreloadOption`](/developers/references/core-sdk/index/type-aliases/listenerpreloadoption/)[]; `waitForBackendConfig?`: `boolean`; `walletUrl?`: `string`; \}
Defined in: [types/config.ts:19](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L19)
Configuration for the Frak Wallet SDK
## Properties
### attribution?
> `optional` **attribution?**: [`AttributionDefaults`](/developers/references/core-sdk/index/type-aliases/attributiondefaults/)
Defined in: [types/config.ts:89](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L89)
Default attribution params (UTM / via / ref) appended to outbound
sharing URLs. Per-call `displaySharingPage` overrides win, then backend
config, then this SDK-level default. `utm_content` is intentionally
excluded — it is per-content/per-product, never a merchant-wide default.
***
### customizations?
> `optional` **customizations?**: \{ `css?`: `` `${string}.css` ``; `i18n?`: [`I18nConfig`](/developers/references/core-sdk/index/type-aliases/i18nconfig/); \}
Defined in: [types/config.ts:61](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L61)
Some customization for the modal
#### css?
> `optional` **css?**: `` `${string}.css` ``
Custom CSS styles to apply to the modals and components
#### i18n?
> `optional` **i18n?**: [`I18nConfig`](/developers/references/core-sdk/index/type-aliases/i18nconfig/)
Custom i18n configuration for the modal
***
### domain?
> `optional` **domain?**: `string`
Defined in: [types/config.ts:75](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L75)
The domain name of your application
#### Default Value
```ts
window.location.host
```
***
### metadata
> **metadata**: \{ `currency?`: [`Currency`](/developers/references/core-sdk/index/type-aliases/currency/); `homepageLink?`: `string`; `lang?`: [`Language`](/developers/references/core-sdk/index/type-aliases/language/); `logoUrl?`: `string`; `merchantId?`: `string`; `name?`: `string`; \}
Defined in: [types/config.ts:28](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L28)
Some metadata about your implementation of the Frak SDK
#### currency?
> `optional` **currency?**: [`Currency`](/developers/references/core-sdk/index/type-aliases/currency/)
The currency to display in the modal
##### Default Value
`"eur"`
#### homepageLink?
> `optional` **homepageLink?**: `string`
The homepage link that could be displayed in a few components
#### lang?
> `optional` **lang?**: [`Language`](/developers/references/core-sdk/index/type-aliases/language/)
Language to display in the modal
If undefined, will default to the browser language
#### logoUrl?
> `optional` **logoUrl?**: `string`
The logo URL that will be displayed in a few components
#### merchantId?
> `optional` **merchantId?**: `string`
Your merchant ID from the Frak dashboard (UUID format)
Used for referral tracking and analytics
If not provided, will be auto-fetched from the backend using your domain
#### name?
> `optional` **name?**: `string`
Your application name (will be displayed in a few modals and in SSO)
***
### preload?
> `optional` **preload?**: [`ListenerPreloadOption`](/developers/references/core-sdk/index/type-aliases/listenerpreloadoption/)[]
Defined in: [types/config.ts:94](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L94)
Preload specific UI views inside the listener iframe for better UX.
Default: ["sharing"]
***
### waitForBackendConfig?
> `optional` **waitForBackendConfig?**: `boolean`
Defined in: [types/config.ts:82](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L82)
Wait for backend config before rendering components.
When true (default), components show a spinner until backend config is resolved.
When false, components render immediately with SDK static config / HTML attributes.
#### Default Value
```ts
true
```
***
### walletUrl?
> `optional` **walletUrl?**: `string`
Defined in: [types/config.ts:24](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L24)
The Frak wallet url
#### Default Value
```ts
"https://wallet.frak.id"
```
# FullSsoParams
> **FullSsoParams** = `Omit`\<[`PrepareSsoParamsType`](/developers/references/core-sdk/index/type-aliases/preparessoparamstype/), `"metadata"`\> & \{ `clientId`: `string`; `merchantId`: `string`; `metadata`: [`AppSpecificSsoMetadata`](/developers/references/core-sdk/index/type-aliases/appspecificssometadata/); \}
Defined in: [utils/sso/sso.ts:13](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/sso/sso.ts#L13)
The full SSO params that will be used for compression
## Type Declaration
### clientId
> **clientId**: `string`
### merchantId
> **merchantId**: `string`
### metadata
> **metadata**: [`AppSpecificSsoMetadata`](/developers/references/core-sdk/index/type-aliases/appspecificssometadata/)
# GetMerchantInformationReturnType
> **GetMerchantInformationReturnType** = \{ `id`: `string`; `onChainMetadata`: \{ `domain`: `string`; `name`: `string`; \}; `rewards`: [`MerchantReward`](/developers/references/core-sdk/index/type-aliases/merchantreward/)[]; \}
Defined in: [types/rpc/merchantInformation.ts:165](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L165)
Response of the `frak_getMerchantInformation` RPC method
## Properties
### id
> **id**: `string`
Defined in: [types/rpc/merchantInformation.ts:169](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L169)
Current merchant id
***
### onChainMetadata
> **onChainMetadata**: \{ `domain`: `string`; `name`: `string`; \}
Defined in: [types/rpc/merchantInformation.ts:173](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L173)
Some metadata
#### domain
> **domain**: `string`
Domain of the merchant on-chain
#### name
> **name**: `string`
Name of the merchant on-chain
***
### rewards
> **rewards**: [`MerchantReward`](/developers/references/core-sdk/index/type-aliases/merchantreward/)[]
Defined in: [types/rpc/merchantInformation.ts:183](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L183)
# I18nConfig
> **I18nConfig** = `Record`\<[`Language`](/developers/references/core-sdk/index/type-aliases/language/), [`LocalizedI18nConfig`](/developers/references/core-sdk/index/type-aliases/localizedi18nconfig/)\> \| [`LocalizedI18nConfig`](/developers/references/core-sdk/index/type-aliases/localizedi18nconfig/)
Defined in: [types/config.ts:130](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L130)
Custom i18n configuration for the modal
See [i18next json format](https://www.i18next.com/misc/json-format#i18next-json-v4)
Available variables
- `{{ productName }}` : The name of your website (`metadata.name`)
- `{{ productOrigin }}` : The origin url of your website
- `{{ estimatedReward }}` : The estimated reward for the user (based on the specific `targetInteraction` you can specify, or the max referrer reward if no target interaction is specified)
Context of the translation [see i18n context](https://www.i18next.com/translation-function/context)
- For modal display, the key of the final action (`sharing`, `reward`, or undefined)
- For embedded wallet display, the key of the logged in action (`sharing` or undefined)
## Example
```ts
// Multi language config
const multiI18n = {
fr: {
"sdk.modal.title": "Titre de modal",
"sdk.modal.description": "Description de modal, avec {{ estimatedReward }} de gains possible",
},
en: "https://example.com/en.json"
}
// Single language config
const singleI18n = {
"sdk.modal.title": "Modal title",
"sdk.modal.description": "Modal description, with {{ estimatedReward }} of gains possible",
}
```
# IFrameRpcSchema
> **IFrameRpcSchema** = \[\{ `Method`: `"frak_listenToWalletStatus"`; `Parameters?`: `undefined`; `ReturnType`: [`WalletStatusReturnType`](/developers/references/core-sdk/index/type-aliases/walletstatusreturntype/); \}, \{ `Method`: `"frak_displayModal"`; `Parameters`: \[[`ModalRpcStepsInput`](/developers/references/core-sdk/index/type-aliases/modalrpcstepsinput/), [`ModalRpcMetadata`](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/) \| `undefined`, [`FrakWalletSdkConfig`](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/)\[`"metadata"`\], `string`\]; `ReturnType`: [`ModalRpcStepsResultType`](/developers/references/core-sdk/index/type-aliases/modalrpcstepsresulttype/); \}, \{ `Method`: `"frak_prepareSso"`; `Parameters`: \[[`PrepareSsoParamsType`](/developers/references/core-sdk/index/type-aliases/preparessoparamstype/), `string`, `string`\]; `ReturnType`: [`PrepareSsoReturnType`](/developers/references/core-sdk/index/type-aliases/preparessoreturntype/); \}, \{ `Method`: `"frak_openSso"`; `Parameters`: \[[`OpenSsoParamsType`](/developers/references/core-sdk/index/type-aliases/openssoparamstype/), `string`, `string`\]; `ReturnType`: [`OpenSsoReturnType`](/developers/references/core-sdk/index/type-aliases/openssoreturntype/); \}, \{ `Method`: `"frak_getMerchantInformation"`; `Parameters?`: `undefined`; `ReturnType`: [`GetMerchantInformationReturnType`](/developers/references/core-sdk/index/type-aliases/getmerchantinformationreturntype/); \}, \{ `Method`: `"frak_displayEmbeddedWallet"`; `Parameters`: \[[`DisplayEmbeddedWalletParamsType`](/developers/references/core-sdk/index/type-aliases/displayembeddedwalletparamstype/), [`FrakWalletSdkConfig`](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/)\[`"metadata"`\], `string`\]; `ReturnType`: [`DisplayEmbeddedWalletResultType`](/developers/references/core-sdk/index/type-aliases/displayembeddedwalletresulttype/); \}, \{ `Method`: `"frak_sendInteraction"`; `Parameters`: \[[`SendInteractionParamsType`](/developers/references/core-sdk/index/type-aliases/sendinteractionparamstype/), \{ `clientId?`: `string`; \}\]; `ReturnType`: `undefined`; \}, \{ `Method`: `"frak_getUserReferralStatus"`; `Parameters?`: `undefined`; `ReturnType`: [`UserReferralStatusType`](/developers/references/core-sdk/index/type-aliases/userreferralstatustype/) \| `null`; \}, \{ `Method`: `"frak_displaySharingPage"`; `Parameters`: \[[`DisplaySharingPageParamsType`](/developers/references/core-sdk/index/type-aliases/displaysharingpageparamstype/), [`FrakWalletSdkConfig`](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/)\[`"metadata"`\], `string`\]; `ReturnType`: [`DisplaySharingPageResultType`](/developers/references/core-sdk/index/type-aliases/displaysharingpageresulttype/); \}, \{ `Method`: `"frak_getMergeToken"`; `Parameters?`: `undefined`; `ReturnType`: `string` \| `null`; \}\]
Defined in: [types/rpc.ts:70](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc.ts#L70)
RPC interface that's used for the iframe communication
Define all the methods available within the iFrame RPC client with response type annotations
## Remarks
Each method in the schema now includes a ResponseType field that indicates:
- "promise": One-shot request that resolves once
- "stream": Streaming request that can emit multiple values
### Methods:
#### frak_listenToWalletStatus
- Params: None
- Returns: [WalletStatusReturnType](/developers/references/core-sdk/index/type-aliases/walletstatusreturntype/)
- Response Type: stream (emits updates when wallet status changes)
#### frak_displayModal
- Params: [requests: [ModalRpcStepsInput](/developers/references/core-sdk/index/type-aliases/modalrpcstepsinput/), metadata?: [ModalRpcMetadata](/developers/references/core-sdk/index/type-aliases/modalrpcmetadata/), configMetadata: [FrakWalletSdkConfig](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/)["metadata"], placement?: string]
- Returns: [ModalRpcStepsResultType](/developers/references/core-sdk/index/type-aliases/modalrpcstepsresulttype/)
- Response Type: promise (one-shot)
#### frak_sso
- Params: [params: [OpenSsoParamsType](/developers/references/core-sdk/index/type-aliases/openssoparamstype/), name: string, customCss?: string]
- Returns: [OpenSsoReturnType](/developers/references/core-sdk/index/type-aliases/openssoreturntype/)
- Response Type: promise (one-shot)
#### frak_getMerchantInformation
- Params: None
- Returns: [GetMerchantInformationReturnType](/developers/references/core-sdk/index/type-aliases/getmerchantinformationreturntype/)
- Response Type: promise (one-shot)
#### frak_displayEmbeddedWallet
- Params: [request: [DisplayEmbeddedWalletParamsType](/developers/references/core-sdk/index/type-aliases/displayembeddedwalletparamstype/), metadata: [FrakWalletSdkConfig](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/)["metadata"], placement?: string]
- Returns: [DisplayEmbeddedWalletResultType](/developers/references/core-sdk/index/type-aliases/displayembeddedwalletresulttype/)
- Response Type: promise (one-shot)
#### frak_displaySharingPage
- Params: [request: [DisplaySharingPageParamsType](/developers/references/core-sdk/index/type-aliases/displaysharingpageparamstype/), configMetadata: [FrakWalletSdkConfig](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/)["metadata"], placement?: string]
- Returns: [DisplaySharingPageResultType](/developers/references/core-sdk/index/type-aliases/displaysharingpageresulttype/)
- Response Type: promise (one-shot)
# IFrameTransport
> **IFrameTransport** = \{ `destroy`: () => `Promise`\<`void`\>; `listenerRequest`: `RpcClient`\<[`IFrameRpcSchema`](/developers/references/core-sdk/index/type-aliases/iframerpcschema/), `LifecycleMessage`\>\[`"listen"`\]; `request`: `RpcClient`\<[`IFrameRpcSchema`](/developers/references/core-sdk/index/type-aliases/iframerpcschema/), `LifecycleMessage`\>\[`"request"`\]; `waitForConnection`: `Promise`\<`boolean`\>; `waitForSetup`: `Promise`\<`void`\>; \}
Defined in: [types/transport.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/transport.ts#L8)
IFrame transport interface
## Properties
### destroy
> **destroy**: () => `Promise`\<`void`\>
Defined in: [types/transport.ts:28](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/transport.ts#L28)
Function used to destroy the iframe transport
#### Returns
`Promise`\<`void`\>
***
### listenerRequest
> **listenerRequest**: `RpcClient`\<[`IFrameRpcSchema`](/developers/references/core-sdk/index/type-aliases/iframerpcschema/), `LifecycleMessage`\>\[`"listen"`\]
Defined in: [types/transport.ts:24](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/transport.ts#L24)
Function used to listen to a request response via the iframe transport
***
### request
> **request**: `RpcClient`\<[`IFrameRpcSchema`](/developers/references/core-sdk/index/type-aliases/iframerpcschema/), `LifecycleMessage`\>\[`"request"`\]
Defined in: [types/transport.ts:20](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/transport.ts#L20)
Function used to perform a single request via the iframe transport
***
### waitForConnection
> **waitForConnection**: `Promise`\<`boolean`\>
Defined in: [types/transport.ts:12](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/transport.ts#L12)
Wait for the connection to be established
***
### waitForSetup
> **waitForSetup**: `Promise`\<`void`\>
Defined in: [types/transport.ts:16](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/transport.ts#L16)
Wait for the setup to be done
# InteractionTypeKey
> **InteractionTypeKey** = `"referral"` \| `"create_referral_link"` \| `"purchase"` \| `` `custom.${string}` ``
Defined in: [constants/interactionTypes.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/constants/interactionTypes.ts#L11)
The supported interaction type keys
- `referral` - User arrived via a referral link
- `create_referral_link` - User created/shared a referral link
- `purchase` - User completed a purchase
- `custom.${string}` - Custom interaction type defined per campaign
# Language
> **Language** = `"fr"` \| `"en"`
Defined in: [types/config.ts:13](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L13)
All the languages available
# ListenerPreloadOption
> **ListenerPreloadOption** = `"modal"` \| `"sharing"`
Defined in: [types/config.ts:138](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L138)
Options for preloading the listener UI
# LocalizedI18nConfig
> **LocalizedI18nConfig** = \{\[`key`: `string`\]: `string`; \}
Defined in: [types/config.ts:144](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/config.ts#L144)
A localized i18n config (inline objects only — URL-based i18n removed)
## Index Signature
\[`key`: `string`\]: `string`
# LoggedInEmbeddedView
> **LoggedInEmbeddedView** = \{ `action?`: [`EmbeddedViewActionSharing`](/developers/references/core-sdk/index/type-aliases/embeddedviewactionsharing/) \| [`EmbeddedViewActionReferred`](/developers/references/core-sdk/index/type-aliases/embeddedviewactionreferred/); \}
Defined in: [types/rpc/embedded/loggedIn.ts:50](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/loggedIn.ts#L50)
Some configuration options for the embedded view
## Properties
### action?
> `optional` **action?**: [`EmbeddedViewActionSharing`](/developers/references/core-sdk/index/type-aliases/embeddedviewactionsharing/) \| [`EmbeddedViewActionReferred`](/developers/references/core-sdk/index/type-aliases/embeddedviewactionreferred/)
Defined in: [types/rpc/embedded/loggedIn.ts:54](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/loggedIn.ts#L54)
The main action to display on the logged in embedded view
# LoggedOutEmbeddedView
> **LoggedOutEmbeddedView** = \{ `metadata?`: \{ `buttonText?`: `string`; `text?`: `string`; \}; \}
Defined in: [types/rpc/embedded/loggedOut.ts:5](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/loggedOut.ts#L5)
The view when a user is logged out
## Properties
### metadata?
> `optional` **metadata?**: \{ `buttonText?`: `string`; `text?`: `string`; \}
Defined in: [types/rpc/embedded/loggedOut.ts:9](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/embedded/loggedOut.ts#L9)
Metadata option when displaying the embedded view
#### ~~buttonText?~~
> `optional` **buttonText?**: `string`
The text that will be displayed on the login button
If not set, it will default to a internationalized message
:::caution[Deprecated]
Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
:::
#### ~~text?~~
> `optional` **text?**: `string`
The main CTA for the logged out view
- can include some variable, available ones are:
- `{REWARD}` -> The maximum reward a user can receive when interacting on your website
- can be formatted in markdown
If not set, it will default to a internationalized message
:::caution[Deprecated]
Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
:::
# LoginModalStepType
> **LoginModalStepType** = `GenericModalStepType`\<`"login"`, \{ `allowSso`: `true`; `ssoMetadata?`: [`SsoMetadata`](/developers/references/core-sdk/index/type-aliases/ssometadata/); \} \| \{ `allowSso?`: `false`; `ssoMetadata?`: `undefined`; \}, \{ `wallet`: `Address`; `webauthnProof?`: \{ `authenticatorResponse`: `string`; `challenge`: `Hex`; \}; \}\>
Defined in: [types/rpc/modal/login.ts:26](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/login.ts#L26)
The login step for a Modal
**Input**: Do we allow SSO or not? Is yes then the SSO metadata
**Output**: The logged in wallet address
# MerchantConfigResponse
> **MerchantConfigResponse** = \{ `allowedDomains`: `string`[]; `domain`: `string`; `merchantId`: `string`; `name`: `string`; `sdkConfig?`: [`ResolvedSdkConfig`](/developers/references/core-sdk/index/type-aliases/resolvedsdkconfig/); \}
Defined in: [types/resolvedConfig.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L8)
Response from the merchant resolve endpoint
## Properties
### allowedDomains
> **allowedDomains**: `string`[]
Defined in: [types/resolvedConfig.ts:12](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L12)
***
### domain
> **domain**: `string`
Defined in: [types/resolvedConfig.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L11)
***
### merchantId
> **merchantId**: `string`
Defined in: [types/resolvedConfig.ts:9](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L9)
***
### name
> **name**: `string`
Defined in: [types/resolvedConfig.ts:10](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L10)
***
### sdkConfig?
> `optional` **sdkConfig?**: [`ResolvedSdkConfig`](/developers/references/core-sdk/index/type-aliases/resolvedsdkconfig/)
Defined in: [types/resolvedConfig.ts:13](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L13)
# MerchantReward
> **MerchantReward** = \{ `campaignId`: `string`; `conditions`: [`RuleConditions`](/developers/references/core-sdk/index/type-aliases/ruleconditions/); `defaultLockupSeconds?`: `number`; `expiresAt?`: `string` \| `null`; `interactionTypeKey`: [`InteractionTypeKey`](/developers/references/core-sdk/index/type-aliases/interactiontypekey/); `maxRewardsPerUser?`: `number`; `merchantMaxRewardsPerUser?`: `number`; `name`: `string`; `pendingRewardExpirationDays?`: `number`; `referee?`: [`EstimatedReward`](/developers/references/core-sdk/index/type-aliases/estimatedreward/); `referrer?`: [`EstimatedReward`](/developers/references/core-sdk/index/type-aliases/estimatedreward/); `token?`: `Address`; \}
Defined in: [types/rpc/merchantInformation.ts:134](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L134)
A reward offer exposed by a merchant campaign.
Mirrors the backend `EstimatedRewardItem` one-to-one — a static parity
assertion on the backend keeps its runtime-validated schema in lockstep with
this published contract.
## Properties
### campaignId
> **campaignId**: `string`
Defined in: [types/rpc/merchantInformation.ts:138](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L138)
Identifier of the campaign rule this reward originates from.
***
### conditions
> **conditions**: [`RuleConditions`](/developers/references/core-sdk/index/type-aliases/ruleconditions/)
Defined in: [types/rpc/merchantInformation.ts:148](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L148)
Raw gating rules — inspect to derive start date, minimum purchase, …
***
### defaultLockupSeconds?
> `optional` **defaultLockupSeconds?**: `number`
Defined in: [types/rpc/merchantInformation.ts:150](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L150)
Seconds a reward stays locked before settlement.
***
### expiresAt?
> `optional` **expiresAt?**: `string` \| `null`
Defined in: [types/rpc/merchantInformation.ts:158](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L158)
ISO-8601 campaign end date, or `null` when open-ended.
***
### interactionTypeKey
> **interactionTypeKey**: [`InteractionTypeKey`](/developers/references/core-sdk/index/type-aliases/interactiontypekey/)
Defined in: [types/rpc/merchantInformation.ts:142](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L142)
Interaction that triggers the reward.
***
### maxRewardsPerUser?
> `optional` **maxRewardsPerUser?**: `number`
Defined in: [types/rpc/merchantInformation.ts:154](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L154)
Per-user reward cap for this campaign.
***
### merchantMaxRewardsPerUser?
> `optional` **merchantMaxRewardsPerUser?**: `number`
Defined in: [types/rpc/merchantInformation.ts:156](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L156)
Merchant-wide per-user reward cap across every campaign.
***
### name
> **name**: `string`
Defined in: [types/rpc/merchantInformation.ts:140](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L140)
Campaign display name.
***
### pendingRewardExpirationDays?
> `optional` **pendingRewardExpirationDays?**: `number`
Defined in: [types/rpc/merchantInformation.ts:152](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L152)
Days before a pending reward expires.
***
### referee?
> `optional` **referee?**: [`EstimatedReward`](/developers/references/core-sdk/index/type-aliases/estimatedreward/)
Defined in: [types/rpc/merchantInformation.ts:146](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L146)
Reward paid to the referee, when the campaign defines one.
***
### referrer?
> `optional` **referrer?**: [`EstimatedReward`](/developers/references/core-sdk/index/type-aliases/estimatedreward/)
Defined in: [types/rpc/merchantInformation.ts:144](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L144)
Reward paid to the referrer, when the campaign defines one.
***
### token?
> `optional` **token?**: `Address`
Defined in: [types/rpc/merchantInformation.ts:136](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L136)
Reward token address; falls back to the merchant token when omitted.
# MergeAttributionInput
> **MergeAttributionInput** = \{ `defaults?`: [`AttributionDefaults`](/developers/references/core-sdk/index/type-aliases/attributiondefaults/); `perCall`: [`AttributionParams`](/developers/references/core-sdk/index/type-aliases/attributionparams/) \| `null` \| `undefined`; `productUtmContent?`: `string`; \}
Defined in: [context/mergeAttribution.ts:6](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/context/mergeAttribution.ts#L6)
Inputs for [mergeAttribution](/developers/references/core-sdk/index/functions/mergeattribution/).
## Properties
### defaults?
> `optional` **defaults?**: [`AttributionDefaults`](/developers/references/core-sdk/index/type-aliases/attributiondefaults/)
Defined in: [context/mergeAttribution.ts:19](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/context/mergeAttribution.ts#L19)
Pre-merged merchant-level defaults (backend config > SDK static config).
`utm_content` is intentionally absent from this shape.
***
### perCall
> **perCall**: [`AttributionParams`](/developers/references/core-sdk/index/type-aliases/attributionparams/) \| `null` \| `undefined`
Defined in: [context/mergeAttribution.ts:14](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/context/mergeAttribution.ts#L14)
Per-call attribution override passed to actions like `displaySharingPage`.
- `null` explicitly disables attribution (no UTM/ref/via params are added).
- `undefined` means "no per-call override" — defaults apply if present.
- An object (including `{}`) merges field-by-field with defaults.
***
### productUtmContent?
> `optional` **productUtmContent?**: `string`
Defined in: [context/mergeAttribution.ts:24](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/context/mergeAttribution.ts#L24)
Per-product `utm_content` override (from the currently selected
`SharingPageProduct`). Takes precedence over `perCall.utmContent`.
# ModalRpcMetadata
> **ModalRpcMetadata** = \{ `header?`: \{ `icon?`: `string`; `title?`: `string`; \}; `i18n?`: [`I18nConfig`](/developers/references/core-sdk/index/type-aliases/i18nconfig/); `targetInteraction?`: [`InteractionTypeKey`](/developers/references/core-sdk/index/type-aliases/interactiontypekey/); \} & \{ `dismissActionTxt?`: `string`; `isDismissible`: `true`; \} \| \{ `dismissActionTxt?`: `never`; `isDismissible?`: `false`; \}
Defined in: [types/rpc/displayModal.ts:50](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displayModal.ts#L50)
RPC metadata for the modal, used on top level modal configuration
## Type Declaration
### header?
> `optional` **header?**: \{ `icon?`: `string`; `title?`: `string`; \}
#### header.icon?
> `optional` **icon?**: `string`
#### header.title?
> `optional` **title?**: `string`
### i18n?
> `optional` **i18n?**: [`I18nConfig`](/developers/references/core-sdk/index/type-aliases/i18nconfig/)
Some i18n override for the displayed modal (i.e. update the displayed text only for this modal)
### targetInteraction?
> `optional` **targetInteraction?**: [`InteractionTypeKey`](/developers/references/core-sdk/index/type-aliases/interactiontypekey/)
# ModalRpcStepsInput
> **ModalRpcStepsInput**\<`T`\> = `{ [K in T[number]["key"]]?: Extract["params"] }`
Defined in: [types/rpc/displayModal.ts:40](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displayModal.ts#L40)
Type for the RPC input of a modal
Just the `params` type of each `ModalStepTypes`
## Type Parameters
### T
`T` *extends* [`ModalStepTypes`](/developers/references/core-sdk/index/type-aliases/modalsteptypes/)[] = [`ModalStepTypes`](/developers/references/core-sdk/index/type-aliases/modalsteptypes/)[]
The list of modal steps we expect to have in the modal
# ModalRpcStepsResultType
> **ModalRpcStepsResultType**\<`T`\> = `{ [K in T[number]["key"]]: Extract["returns"] }`
Defined in: [types/rpc/displayModal.ts:27](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displayModal.ts#L27)
Type for the result of a modal request
Just the `returns` type of each `ModalStepTypes`
## Type Parameters
### T
`T` *extends* [`ModalStepTypes`](/developers/references/core-sdk/index/type-aliases/modalsteptypes/)[] = [`ModalStepTypes`](/developers/references/core-sdk/index/type-aliases/modalsteptypes/)[]
The list of modal steps we expect to have in the modal
# ModalStepMetadata
> **ModalStepMetadata** = \{ `metadata?`: \{ `description?`: `string`; `primaryActionText?`: `string`; `secondaryActionText?`: `string`; `title?`: `string`; \}; \}
Defined in: [types/rpc/modal/generic.ts:19](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/generic.ts#L19)
Metadata that can be used to customize a modal step
:::caution[Deprecated]
Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
:::
## Properties
### ~~metadata?~~
> `optional` **metadata?**: \{ `description?`: `string`; `primaryActionText?`: `string`; `secondaryActionText?`: `string`; `title?`: `string`; \}
Defined in: [types/rpc/modal/generic.ts:20](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/generic.ts#L20)
#### ~~description?~~
> `optional` **description?**: `string`
Custom description for the step
If none provided, it will use an internationalized text
:::caution[Deprecated]
Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
:::
#### ~~primaryActionText?~~
> `optional` **primaryActionText?**: `string`
Custom text for the primary action of the step
If none provided, it will use an internationalized text
:::caution[Deprecated]
Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
:::
#### ~~secondaryActionText?~~
> `optional` **secondaryActionText?**: `string`
Custom text for the secondary action of the step
If none provided, it will use an internationalized text
:::caution[Deprecated]
Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
:::
#### ~~title?~~
> `optional` **title?**: `string`
Custom title for the step
If none provided, it will use an internationalized text
:::caution[Deprecated]
Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
:::
# ModalStepTypes
> **ModalStepTypes** = [`LoginModalStepType`](/developers/references/core-sdk/index/type-aliases/loginmodalsteptype/) \| [`SiweAuthenticateModalStepType`](/developers/references/core-sdk/index/type-aliases/siweauthenticatemodalsteptype/) \| [`SendTransactionModalStepType`](/developers/references/core-sdk/index/type-aliases/sendtransactionmodalsteptype/) \| [`FinalModalStepType`](/developers/references/core-sdk/index/type-aliases/finalmodalsteptype/)
Defined in: [types/rpc/displayModal.ts:14](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displayModal.ts#L14)
Generic type of steps we will display in the modal to the end user
# OpenSsoParamsType
> **OpenSsoParamsType** = [`PrepareSsoParamsType`](/developers/references/core-sdk/index/type-aliases/preparessoparamstype/) & \{ `openInSameWindow?`: `boolean`; `ssoPopupUrl?`: `string`; \}
Defined in: [types/rpc/sso.ts:73](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L73)
Params to start a SSO
## Type Declaration
### openInSameWindow?
> `optional` **openInSameWindow?**: `boolean`
Indicate whether we want todo the flow within the same window context, or if we want to do it with an external popup window openned
Note: Default true if redirectUrl is present, otherwise, false
### ssoPopupUrl?
> `optional` **ssoPopupUrl?**: `string`
Custom SSO popup url if user want additionnal customisation
# OpenSsoReturnType
> **OpenSsoReturnType** = \{ `wallet?`: `Hex`; \}
Defined in: [types/rpc/sso.ts:61](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L61)
Response after an SSO has been openned
## Properties
### wallet?
> `optional` **wallet?**: `Hex`
Defined in: [types/rpc/sso.ts:66](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L66)
Optional wallet address, returned when SSO completes via postMessage
Note: Only present when SSO flow completes (not immediately on open)
# PrepareSsoParamsType
> **PrepareSsoParamsType** = \{ `directExit?`: `boolean`; `lang?`: `"en"` \| `"fr"`; `metadata?`: [`SsoMetadata`](/developers/references/core-sdk/index/type-aliases/ssometadata/); `redirectUrl?`: `string`; \}
Defined in: [types/rpc/sso.ts:22](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L22)
Params for preparing SSO (generating URL)
Same as OpenSsoParamsType but without openInSameWindow (popup-only operation)
## Properties
### directExit?
> `optional` **directExit?**: `boolean`
Defined in: [types/rpc/sso.ts:35](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L35)
If the SSO should directly exit (close the popup) after completion.
Defaults to `true` when `redirectUrl` is omitted, `false` otherwise.
The default is applied by [\`openSso()\`](/developers/references/core-sdk/actions/functions/opensso/)
before the SSO URL is generated and by the wallet SSO route as a fallback
for older SDK callers.
***
### lang?
> `optional` **lang?**: `"en"` \| `"fr"`
Defined in: [types/rpc/sso.ts:40](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L40)
Language of the SSO page (optional)
It will default to the current user language (or "en" if unsupported language)
***
### metadata?
> `optional` **metadata?**: [`SsoMetadata`](/developers/references/core-sdk/index/type-aliases/ssometadata/)
Defined in: [types/rpc/sso.ts:44](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L44)
Custom SSO metadata
***
### redirectUrl?
> `optional` **redirectUrl?**: `string`
Defined in: [types/rpc/sso.ts:26](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L26)
Redirect URL after the SSO (optional)
# PrepareSsoReturnType
> **PrepareSsoReturnType** = \{ `ssoUrl`: `string`; \}
Defined in: [types/rpc/sso.ts:51](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L51)
Response after preparing SSO
## Properties
### ssoUrl
> **ssoUrl**: `string`
Defined in: [types/rpc/sso.ts:55](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L55)
The SSO URL that should be opened in a popup
# ResolvedPlacement
> **ResolvedPlacement** = \{ `components?`: \{ `banner?`: \{ `css?`: `string`; `imageUrl?`: `string`; `inappCta?`: `string`; `inappDescription?`: `string`; `inappTitle?`: `string`; `referralCta?`: `string`; `referralDescription?`: `string`; `referralTitle?`: `string`; \}; `buttonShare?`: \{ `clickAction?`: `"embedded-wallet"` \| `"share-modal"` \| `"sharing-page"`; `css?`: `string`; `noRewardText?`: `string`; `text?`: `string`; \}; `buttonWallet?`: \{ `css?`: `string`; `position?`: `"right"` \| `"left"`; \}; `openInApp?`: \{ `css?`: `string`; `text?`: `string`; \}; `postPurchase?`: \{ `badgeText?`: `string`; `css?`: `string`; `ctaNoRewardText?`: `string`; `ctaText?`: `string`; `imageUrl?`: `string`; `refereeNoRewardText?`: `string`; `refereeText?`: `string`; `referrerNoRewardText?`: `string`; `referrerText?`: `string`; \}; \}; `css?`: `string`; `targetInteraction?`: `string`; `translations?`: `Record`\<`string`, `string`\>; \}
Defined in: [types/resolvedConfig.ts:21](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L21)
Resolved placement config from backend
Translations already flattened: default + lang-specific merged into one record
## Properties
### components?
> `optional` **components?**: \{ `banner?`: \{ `css?`: `string`; `imageUrl?`: `string`; `inappCta?`: `string`; `inappDescription?`: `string`; `inappTitle?`: `string`; `referralCta?`: `string`; `referralDescription?`: `string`; `referralTitle?`: `string`; \}; `buttonShare?`: \{ `clickAction?`: `"embedded-wallet"` \| `"share-modal"` \| `"sharing-page"`; `css?`: `string`; `noRewardText?`: `string`; `text?`: `string`; \}; `buttonWallet?`: \{ `css?`: `string`; `position?`: `"right"` \| `"left"`; \}; `openInApp?`: \{ `css?`: `string`; `text?`: `string`; \}; `postPurchase?`: \{ `badgeText?`: `string`; `css?`: `string`; `ctaNoRewardText?`: `string`; `ctaText?`: `string`; `imageUrl?`: `string`; `refereeNoRewardText?`: `string`; `refereeText?`: `string`; `referrerNoRewardText?`: `string`; `referrerText?`: `string`; \}; \}
Defined in: [types/resolvedConfig.ts:23](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L23)
Per-component configuration within this placement
#### banner?
> `optional` **banner?**: \{ `css?`: `string`; `imageUrl?`: `string`; `inappCta?`: `string`; `inappDescription?`: `string`; `inappTitle?`: `string`; `referralCta?`: `string`; `referralDescription?`: `string`; `referralTitle?`: `string`; \}
##### banner.css?
> `optional` **css?**: `string`
##### banner.imageUrl?
> `optional` **imageUrl?**: `string`
Custom illustration URL replacing the built-in gift icon.
##### banner.inappCta?
> `optional` **inappCta?**: `string`
##### banner.inappDescription?
> `optional` **inappDescription?**: `string`
##### banner.inappTitle?
> `optional` **inappTitle?**: `string`
##### banner.referralCta?
> `optional` **referralCta?**: `string`
##### banner.referralDescription?
> `optional` **referralDescription?**: `string`
##### banner.referralTitle?
> `optional` **referralTitle?**: `string`
#### buttonShare?
> `optional` **buttonShare?**: \{ `clickAction?`: `"embedded-wallet"` \| `"share-modal"` \| `"sharing-page"`; `css?`: `string`; `noRewardText?`: `string`; `text?`: `string`; \}
##### buttonShare.clickAction?
> `optional` **clickAction?**: `"embedded-wallet"` \| `"share-modal"` \| `"sharing-page"`
##### buttonShare.css?
> `optional` **css?**: `string`
##### buttonShare.noRewardText?
> `optional` **noRewardText?**: `string`
##### buttonShare.text?
> `optional` **text?**: `string`
#### buttonWallet?
> `optional` **buttonWallet?**: \{ `css?`: `string`; `position?`: `"right"` \| `"left"`; \}
##### buttonWallet.css?
> `optional` **css?**: `string`
##### buttonWallet.position?
> `optional` **position?**: `"right"` \| `"left"`
#### openInApp?
> `optional` **openInApp?**: \{ `css?`: `string`; `text?`: `string`; \}
##### openInApp.css?
> `optional` **css?**: `string`
##### openInApp.text?
> `optional` **text?**: `string`
#### postPurchase?
> `optional` **postPurchase?**: \{ `badgeText?`: `string`; `css?`: `string`; `ctaNoRewardText?`: `string`; `ctaText?`: `string`; `imageUrl?`: `string`; `refereeNoRewardText?`: `string`; `refereeText?`: `string`; `referrerNoRewardText?`: `string`; `referrerText?`: `string`; \}
##### postPurchase.badgeText?
> `optional` **badgeText?**: `string`
##### postPurchase.css?
> `optional` **css?**: `string`
##### postPurchase.ctaNoRewardText?
> `optional` **ctaNoRewardText?**: `string`
##### postPurchase.ctaText?
> `optional` **ctaText?**: `string`
##### postPurchase.imageUrl?
> `optional` **imageUrl?**: `string`
Custom illustration URL replacing the built-in gift icon.
##### postPurchase.refereeNoRewardText?
> `optional` **refereeNoRewardText?**: `string`
##### postPurchase.refereeText?
> `optional` **refereeText?**: `string`
##### postPurchase.referrerNoRewardText?
> `optional` **referrerNoRewardText?**: `string`
##### postPurchase.referrerText?
> `optional` **referrerText?**: `string`
***
### css?
> `optional` **css?**: `string`
Defined in: [types/resolvedConfig.ts:66](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L66)
Global placement CSS (applied to modals/listener)
***
### targetInteraction?
> `optional` **targetInteraction?**: `string`
Defined in: [types/resolvedConfig.ts:62](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L62)
***
### translations?
> `optional` **translations?**: `Record`\<`string`, `string`\>
Defined in: [types/resolvedConfig.ts:64](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L64)
Already flattened: default + lang-specific merged into one record
# ResolvedSdkConfig
> **ResolvedSdkConfig** = \{ `attribution?`: [`AttributionDefaults`](/developers/references/core-sdk/index/type-aliases/attributiondefaults/); `components?`: [`ResolvedPlacement`](/developers/references/core-sdk/index/type-aliases/resolvedplacement/)\[`"components"`\]; `css?`: `string`; `currency?`: [`Currency`](/developers/references/core-sdk/index/type-aliases/currency/); `hidden?`: `boolean`; `homepageLink?`: `string`; `lang?`: [`Language`](/developers/references/core-sdk/index/type-aliases/language/); `logoUrl?`: `string`; `name?`: `string`; `placements?`: `Record`\<`string`, [`ResolvedPlacement`](/developers/references/core-sdk/index/type-aliases/resolvedplacement/)\>; `translations?`: `Record`\<`string`, `string`\>; \}
Defined in: [types/resolvedConfig.ts:74](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L74)
Resolved SDK config from backend `/resolve` endpoint
Language resolution and translation merging already applied
## Properties
### attribution?
> `optional` **attribution?**: [`AttributionDefaults`](/developers/references/core-sdk/index/type-aliases/attributiondefaults/)
Defined in: [types/resolvedConfig.ts:92](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L92)
Default attribution params applied when building outbound sharing URLs.
Per-call overrides win over these backend defaults; `utm_content` is
intentionally excluded (per-content/per-product, never a merchant default).
***
### components?
> `optional` **components?**: [`ResolvedPlacement`](/developers/references/core-sdk/index/type-aliases/resolvedplacement/)\[`"components"`\]
Defined in: [types/resolvedConfig.ts:86](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L86)
Global component defaults (used when no placement override exists)
***
### css?
> `optional` **css?**: `string`
Defined in: [types/resolvedConfig.ts:82](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L82)
***
### currency?
> `optional` **currency?**: [`Currency`](/developers/references/core-sdk/index/type-aliases/currency/)
Defined in: [types/resolvedConfig.ts:78](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L78)
***
### hidden?
> `optional` **hidden?**: `boolean`
Defined in: [types/resolvedConfig.ts:81](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L81)
When true, all SDK components should be hidden
***
### homepageLink?
> `optional` **homepageLink?**: `string`
Defined in: [types/resolvedConfig.ts:77](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L77)
***
### lang?
> `optional` **lang?**: [`Language`](/developers/references/core-sdk/index/type-aliases/language/)
Defined in: [types/resolvedConfig.ts:79](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L79)
***
### logoUrl?
> `optional` **logoUrl?**: `string`
Defined in: [types/resolvedConfig.ts:76](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L76)
***
### name?
> `optional` **name?**: `string`
Defined in: [types/resolvedConfig.ts:75](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L75)
***
### placements?
> `optional` **placements?**: `Record`\<`string`, [`ResolvedPlacement`](/developers/references/core-sdk/index/type-aliases/resolvedplacement/)\>
Defined in: [types/resolvedConfig.ts:84](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L84)
***
### translations?
> `optional` **translations?**: `Record`\<`string`, `string`\>
Defined in: [types/resolvedConfig.ts:83](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L83)
# RewardTier
> **RewardTier** = \{ `amount`: [`TokenAmountType`](/developers/references/core-sdk/index/type-aliases/tokenamounttype/); `maxValue?`: `number`; `minValue`: `number`; \} \| \{ `maxValue?`: `number`; `minValue`: `number`; `percent`: `number`; \}
Defined in: [types/rpc/merchantInformation.ts:18](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L18)
A tier definition for tiered rewards — pays either a flat token amount
or a percent of the tier field value
# RuleCondition
> **RuleCondition** = \{ `field`: [`RuleField`](/developers/references/core-sdk/index/type-aliases/rulefield/); `operator`: [`ConditionOperator`](/developers/references/core-sdk/index/type-aliases/conditionoperator/); `value`: `string` \| `number` \| `boolean` \| `null`; `valueTo?`: `string` \| `number` \| `boolean` \| `null`; \}
Defined in: [types/rpc/merchantInformation.ts:101](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L101)
A single leaf rule condition. Compares the value found at [RuleField](/developers/references/core-sdk/index/type-aliases/rulefield/)
in the evaluation context against `value` (and `valueTo` for `between`).
## Properties
### field
> **field**: [`RuleField`](/developers/references/core-sdk/index/type-aliases/rulefield/)
Defined in: [types/rpc/merchantInformation.ts:102](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L102)
***
### operator
> **operator**: [`ConditionOperator`](/developers/references/core-sdk/index/type-aliases/conditionoperator/)
Defined in: [types/rpc/merchantInformation.ts:103](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L103)
***
### value
> **value**: `string` \| `number` \| `boolean` \| `null`
Defined in: [types/rpc/merchantInformation.ts:104](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L104)
***
### valueTo?
> `optional` **valueTo?**: `string` \| `number` \| `boolean` \| `null`
Defined in: [types/rpc/merchantInformation.ts:105](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L105)
# RuleConditions
> **RuleConditions** = [`RuleCondition`](/developers/references/core-sdk/index/type-aliases/rulecondition/)[] \| [`ConditionGroup`](/developers/references/core-sdk/index/type-aliases/conditiongroup/)
Defined in: [types/rpc/merchantInformation.ts:124](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L124)
Campaign gating rules: a flat list of [RuleCondition](/developers/references/core-sdk/index/type-aliases/rulecondition/) (implicitly
AND-ed) or a nested [ConditionGroup](/developers/references/core-sdk/index/type-aliases/conditiongroup/) tree. Surfaced raw so integrators
can inspect the rules and derive their own display (start date, minimum
purchase, …) instead of relying on pre-computed fields.
# RuleField
> **RuleField** = `"purchase.amount"` \| `"time.timestamp"` \| `"attribution.referrerIdentityGroupId"` \| `` `custom.${string}` `` \| `string` & `Record`\<`never`, `never`\>
Defined in: [types/rpc/merchantInformation.ts:84](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L84)
Dot-path of the rule-evaluation context field a [RuleCondition](/developers/references/core-sdk/index/type-aliases/rulecondition/) targets.
Only the paths the SDK actually reads are listed (for editor autocompletion);
the trailing `string` member keeps the type open to any other path the backend
may emit, so it never lies at runtime. Custom interaction data is addressed
through `custom.${string}`.
# SdkEventMap
> **SdkEventMap** = `SdkLifecycleEventMap` & `SdkComponentEventMap` & `SdkReferralEventMap`
Defined in: [utils/analytics/events/index.ts:18](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/analytics/events/index.ts#L18)
Merged SDK event map. Consumed by the SDK's typed `trackEvent`.
Stays isolated from wallet-shared because the SDK ships in partner
bundles (different OpenPanel client id, no wallet-shared dependency
allowed — see `packages/wallet-shared/AGENTS.md`).
# SdkHandshakeFailureReason
> **SdkHandshakeFailureReason** = `"timeout"` \| `"origin"` \| `"asset_push"` \| `"unknown"`
Defined in: [utils/analytics/events/lifecycle.ts:1](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/analytics/events/lifecycle.ts#L1)
# SdkResolvedConfig
> **SdkResolvedConfig** = \{ `allowedDomains?`: `string`[]; `attribution?`: [`AttributionDefaults`](/developers/references/core-sdk/index/type-aliases/attributiondefaults/); `components?`: [`ResolvedPlacement`](/developers/references/core-sdk/index/type-aliases/resolvedplacement/)\[`"components"`\]; `css?`: `string`; `currency?`: [`Currency`](/developers/references/core-sdk/index/type-aliases/currency/); `domain?`: `string`; `hasRawSdkConfig?`: `boolean`; `hidden?`: `boolean`; `homepageLink?`: `string`; `isResolved`: `boolean`; `lang?`: [`Language`](/developers/references/core-sdk/index/type-aliases/language/); `logoUrl?`: `string`; `merchantId`: `string`; `name?`: `string`; `placements?`: `Record`\<`string`, [`ResolvedPlacement`](/developers/references/core-sdk/index/type-aliases/resolvedplacement/)\>; `translations?`: `Record`\<`string`, `string`\>; \}
Defined in: [types/resolvedConfig.ts:101](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L101)
Internal SDK config store state
Merged config: backend > SDK static > defaults
Components subscribe to this reactively
## Properties
### allowedDomains?
> `optional` **allowedDomains?**: `string`[]
Defined in: [types/resolvedConfig.ts:112](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L112)
Domains allowed for this merchant (used by iframe trust check)
***
### attribution?
> `optional` **attribution?**: [`AttributionDefaults`](/developers/references/core-sdk/index/type-aliases/attributiondefaults/)
Defined in: [types/resolvedConfig.ts:140](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L140)
Merged attribution defaults: backend > SDK static config
***
### components?
> `optional` **components?**: [`ResolvedPlacement`](/developers/references/core-sdk/index/type-aliases/resolvedplacement/)\[`"components"`\]
Defined in: [types/resolvedConfig.ts:137](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L137)
Global component defaults (fallback for placement-level overrides)
***
### css?
> `optional` **css?**: `string`
Defined in: [types/resolvedConfig.ts:128](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L128)
Global CSS from backend config (passed to iframe)
***
### currency?
> `optional` **currency?**: [`Currency`](/developers/references/core-sdk/index/type-aliases/currency/)
Defined in: [types/resolvedConfig.ts:122](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L122)
***
### domain?
> `optional` **domain?**: `string`
Defined in: [types/resolvedConfig.ts:109](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L109)
Domain returned by the resolve endpoint
***
### hasRawSdkConfig?
> `optional` **hasRawSdkConfig?**: `boolean`
Defined in: [types/resolvedConfig.ts:115](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L115)
Whether the resolve returned a backend sdkConfig object
***
### hidden?
> `optional` **hidden?**: `boolean`
Defined in: [types/resolvedConfig.ts:125](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L125)
When true, all SDK components should be hidden
***
### homepageLink?
> `optional` **homepageLink?**: `string`
Defined in: [types/resolvedConfig.ts:120](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L120)
***
### isResolved
> **isResolved**: `boolean`
Defined in: [types/resolvedConfig.ts:103](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L103)
Whether the backend config has been resolved
***
### lang?
> `optional` **lang?**: [`Language`](/developers/references/core-sdk/index/type-aliases/language/)
Defined in: [types/resolvedConfig.ts:121](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L121)
***
### logoUrl?
> `optional` **logoUrl?**: `string`
Defined in: [types/resolvedConfig.ts:119](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L119)
***
### merchantId
> **merchantId**: `string`
Defined in: [types/resolvedConfig.ts:106](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L106)
Merchant ID from resolution
***
### name?
> `optional` **name?**: `string`
Defined in: [types/resolvedConfig.ts:118](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L118)
Merged metadata fields
***
### placements?
> `optional` **placements?**: `Record`\<`string`, [`ResolvedPlacement`](/developers/references/core-sdk/index/type-aliases/resolvedplacement/)\>
Defined in: [types/resolvedConfig.ts:134](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L134)
Named placements (keyed by placement ID)
***
### translations?
> `optional` **translations?**: `Record`\<`string`, `string`\>
Defined in: [types/resolvedConfig.ts:131](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/resolvedConfig.ts#L131)
Global translations (for reference / component fallback)
# SendInteractionParamsType
> **SendInteractionParamsType** = \{ `referralTimestamp?`: `number`; `referrerClientId?`: `string`; `referrerMerchantId?`: `string`; `referrerWallet?`: `Address`; `type`: `"arrival"`; \} \| \{ `purchaseId?`: `string`; `sharingTimestamp?`: `number`; `type`: `"sharing"`; \} \| \{ `customType`: `string`; `data?`: `Record`\<`string`, `unknown`\>; `idempotencyKey?`: `string`; `type`: `"custom"`; \}
Defined in: [types/rpc/interaction.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/interaction.ts#L11)
Parameters for sending interactions via RPC
Note: merchantId and clientId come from WalletRpcContext
and are NOT included in the params - they are resolved by the listener
## Union Members
### Type Literal
\{ `referralTimestamp?`: `number`; `referrerClientId?`: `string`; `referrerMerchantId?`: `string`; `referrerWallet?`: `Address`; `type`: `"arrival"`; \}
#### referralTimestamp?
> `optional` **referralTimestamp?**: `number`
Epoch seconds timestamp from the referral link creation
#### referrerClientId?
> `optional` **referrerClientId?**: `string`
#### referrerMerchantId?
> `optional` **referrerMerchantId?**: `string`
#### referrerWallet?
> `optional` **referrerWallet?**: `Address`
Sharer wallet address. Accepted in both wallet-only legacy contexts and merchant-context (V2) contexts.
#### type
> **type**: `"arrival"`
***
### Type Literal
\{ `purchaseId?`: `string`; `sharingTimestamp?`: `number`; `type`: `"sharing"`; \}
#### purchaseId?
> `optional` **purchaseId?**: `string`
Merchant order ID linking this sharing event to a purchase (stays server-side, never in URL)
#### sharingTimestamp?
> `optional` **sharingTimestamp?**: `number`
Epoch seconds timestamp matching the V2 context `t` field embedded in the referral link URL, used for backend correlation
#### type
> **type**: `"sharing"`
***
### Type Literal
\{ `customType`: `string`; `data?`: `Record`\<`string`, `unknown`\>; `idempotencyKey?`: `string`; `type`: `"custom"`; \}
# SendTransactionModalStepType
> **SendTransactionModalStepType** = `GenericModalStepType`\<`"sendTransaction"`, \{ `tx`: [`SendTransactionTxType`](/developers/references/core-sdk/index/type-aliases/sendtransactiontxtype/) \| [`SendTransactionTxType`](/developers/references/core-sdk/index/type-aliases/sendtransactiontxtype/)[]; \}, \{ `hash`: `` `0x${string}` ``; \}\>
Defined in: [types/rpc/modal/transaction.ts:29](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/transaction.ts#L29)
The send transaction step for a Modal
**Input**: Either a single tx or an array of tx to be sent
**Output**: The hash of the tx(s) hash (in case of multiple tx, still returns a single hash because it's bundled on the wallet level)
# SendTransactionReturnType
> **SendTransactionReturnType** = \{ `hash`: `Hex`; \}
Defined in: [types/rpc/modal/transaction.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/transaction.ts#L17)
Return type of the send transaction rpc request
## Properties
### hash
> **hash**: `Hex`
Defined in: [types/rpc/modal/transaction.ts:18](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/transaction.ts#L18)
# SendTransactionTxType
> **SendTransactionTxType** = \{ `data?`: `Hex`; `to`: `Address`; `value?`: `Hex`; \}
Defined in: [types/rpc/modal/transaction.ts:7](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/transaction.ts#L7)
Generic format representing a tx to be sent
## Properties
### data?
> `optional` **data?**: `Hex`
Defined in: [types/rpc/modal/transaction.ts:9](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/transaction.ts#L9)
***
### to
> **to**: `Address`
Defined in: [types/rpc/modal/transaction.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/transaction.ts#L8)
***
### value?
> `optional` **value?**: `Hex`
Defined in: [types/rpc/modal/transaction.ts:10](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/transaction.ts#L10)
# SharingPageProduct
> **SharingPageProduct** = \{ `imageUrl?`: `string`; `link?`: `string`; `title`: `string`; `utmContent?`: `string`; \}
Defined in: [types/rpc/displaySharingPage.ts:9](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L9)
Product information to display on the sharing page
## Properties
### imageUrl?
> `optional` **imageUrl?**: `string`
Defined in: [types/rpc/displaySharingPage.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L17)
Optional product image URL
***
### link?
> `optional` **link?**: `string`
Defined in: [types/rpc/displaySharingPage.ts:22](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L22)
Optional product-specific sharing link
When provided and the product is selected, this link is used instead of the default sharing link
***
### title
> **title**: `string`
Defined in: [types/rpc/displaySharingPage.ts:13](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L13)
The product title / name
***
### utmContent?
> `optional` **utmContent?**: `string`
Defined in: [types/rpc/displaySharingPage.ts:27](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/displaySharingPage.ts#L27)
Optional `utm_content` value to apply when this product is selected.
Falls back to the page-level `attribution.utmContent` when omitted.
# SiweAuthenticateModalStepType
> **SiweAuthenticateModalStepType** = `GenericModalStepType`\<`"siweAuthenticate"`, \{ `siwe`: [`SiweAuthenticationParams`](/developers/references/core-sdk/index/type-aliases/siweauthenticationparams/); \}, \{ `message`: `string`; `signature`: `` `0x${string}` ``; \}\>
Defined in: [types/rpc/modal/siweAuthenticate.ts:33](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/siweAuthenticate.ts#L33)
The SIWE authentication step for a Modal
**Input**: SIWE message parameters
**Output**: SIWE result (message signed and wallet signature)
# SiweAuthenticateReturnType
> **SiweAuthenticateReturnType** = \{ `message`: `string`; `signature`: `Hex`; \}
Defined in: [types/rpc/modal/siweAuthenticate.ts:20](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/siweAuthenticate.ts#L20)
Return type of the Siwe transaction rpc request
## Properties
### message
> **message**: `string`
Defined in: [types/rpc/modal/siweAuthenticate.ts:22](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/siweAuthenticate.ts#L22)
***
### signature
> **signature**: `Hex`
Defined in: [types/rpc/modal/siweAuthenticate.ts:21](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/siweAuthenticate.ts#L21)
# SiweAuthenticationParams
> **SiweAuthenticationParams** = `Omit`\<`SiweMessage`, `"address"` \| `"chainId"` \| `"expirationTime"` \| `"issuedAt"` \| `"notBefore"`\> & \{ `expirationTimeTimestamp?`: `number`; `notBeforeTimestamp?`: `number`; \}
Defined in: [types/rpc/modal/siweAuthenticate.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/modal/siweAuthenticate.ts#L8)
Parameters used send a SIWE rpc request
## Type Declaration
### expirationTimeTimestamp?
> `optional` **expirationTimeTimestamp?**: `number`
### notBeforeTimestamp?
> `optional` **notBeforeTimestamp?**: `number`
# SsoMetadata
> **SsoMetadata** = \{ `homepageLink?`: `string`; `logoUrl?`: `string`; \}
Defined in: [types/rpc/sso.ts:6](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L6)
SSO Metadata
## Properties
### homepageLink?
> `optional` **homepageLink?**: `string`
Defined in: [types/rpc/sso.ts:14](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L14)
Link to your homepage, if referenced your app name will contain a link on the sso page
***
### logoUrl?
> `optional` **logoUrl?**: `string`
Defined in: [types/rpc/sso.ts:10](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/sso.ts#L10)
URL to your client, if provided will be displayed in the SSO header
# TokenAmountType
> **TokenAmountType** = \{ `amount`: `number`; `eurAmount`: `number`; `gbpAmount`: `number`; `usdAmount`: `number`; \}
Defined in: [types/rpc/merchantInformation.ts:7](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L7)
The type for the amount of tokens
## Properties
### amount
> **amount**: `number`
Defined in: [types/rpc/merchantInformation.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L8)
***
### eurAmount
> **eurAmount**: `number`
Defined in: [types/rpc/merchantInformation.ts:9](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L9)
***
### gbpAmount
> **gbpAmount**: `number`
Defined in: [types/rpc/merchantInformation.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L11)
***
### usdAmount
> **usdAmount**: `number`
Defined in: [types/rpc/merchantInformation.ts:10](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/merchantInformation.ts#L10)
# TrackArrivalParams
> **TrackArrivalParams** = \{ `referralTimestamp?`: `number`; `referrerClientId?`: `string`; `referrerMerchantId?`: `string`; `referrerWallet?`: `Address`; \}
Defined in: [types/tracking.ts:47](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L47)
## Properties
### referralTimestamp?
> `optional` **referralTimestamp?**: `number`
Defined in: [types/tracking.ts:53](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L53)
Epoch seconds timestamp from the referral link creation
***
### referrerClientId?
> `optional` **referrerClientId?**: `string`
Defined in: [types/tracking.ts:50](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L50)
***
### referrerMerchantId?
> `optional` **referrerMerchantId?**: `string`
Defined in: [types/tracking.ts:51](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L51)
***
### referrerWallet?
> `optional` **referrerWallet?**: `Address`
Defined in: [types/tracking.ts:49](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L49)
Sharer wallet address. Accepted in both V1 (legacy) and V2 (authenticated sharer) contexts.
# TrackArrivalResult
> **TrackArrivalResult** = \{ `error?`: `string`; `identityGroupId?`: `string`; `referralLinkId?`: `string`; `success`: `boolean`; \}
Defined in: [types/tracking.ts:56](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L56)
## Properties
### error?
> `optional` **error?**: `string`
Defined in: [types/tracking.ts:60](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L60)
***
### identityGroupId?
> `optional` **identityGroupId?**: `string`
Defined in: [types/tracking.ts:58](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L58)
***
### referralLinkId?
> `optional` **referralLinkId?**: `string`
Defined in: [types/tracking.ts:59](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L59)
***
### success
> **success**: `boolean`
Defined in: [types/tracking.ts:57](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L57)
# UserReferralStatusType
> **UserReferralStatusType** = \{ `isReferred`: `boolean`; \}
Defined in: [types/rpc/userReferralStatus.ts:13](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/userReferralStatus.ts#L13)
User referral status returned by `frak_getUserReferralStatus`.
Generic referral context for the current user on a merchant.
Used by components like `` and ``
to adapt their display based on the user's referral relationship.
Returns `null` when the user's identity cannot be resolved
(e.g. no clientId and no wallet session).
## Properties
### isReferred
> **isReferred**: `boolean`
Defined in: [types/rpc/userReferralStatus.ts:19](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/userReferralStatus.ts#L19)
Whether the user was referred to this merchant by someone else.
`true` means a referral link exists where this user is the referee.
# UtmParams
> **UtmParams** = \{ `campaign?`: `string`; `content?`: `string`; `medium?`: `string`; `source?`: `string`; `term?`: `string`; \}
Defined in: [types/tracking.ts:3](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L3)
## Properties
### campaign?
> `optional` **campaign?**: `string`
Defined in: [types/tracking.ts:6](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L6)
***
### content?
> `optional` **content?**: `string`
Defined in: [types/tracking.ts:8](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L8)
***
### medium?
> `optional` **medium?**: `string`
Defined in: [types/tracking.ts:5](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L5)
***
### source?
> `optional` **source?**: `string`
Defined in: [types/tracking.ts:4](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L4)
***
### term?
> `optional` **term?**: `string`
Defined in: [types/tracking.ts:7](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/tracking.ts#L7)
# WalletStatusReturnType
> **WalletStatusReturnType** = \{ `interactionToken?`: `string`; `key`: `"connected"`; `wallet`: `` `0x${string}` ``; \} \| \{ `interactionToken?`: `undefined`; `key`: `"not-connected"`; `wallet?`: `undefined`; \}
Defined in: [types/rpc/walletStatus.ts:7](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/types/rpc/walletStatus.ts#L7)
RPC Response for the method `frak_listenToWalletStatus`
# DEEP_LINK_SCHEME
> `const` **DEEP\_LINK\_SCHEME**: `string`
Defined in: [constants.ts:14](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/constants.ts#L14)
Deep link scheme for Frak Wallet mobile app.
Replaced at build time via tsdown/Vite `define`. Defaults to the prod scheme;
in-monorepo dev builds (listener at wallet-dev.frak.id) override this with
`frakwallet-dev://` so deep links open the dev wallet variant (id.frak.wallet.dev).
External integrators consuming the published NPM/CDN bundle always see the prod scheme.
# FrakContextManager
> `const` **FrakContextManager**: \{ `compress`: (`context?`) => `string` \| `undefined`; `decompress`: (`context?`) => `FrakContext` \| `undefined`; `parse`: (`args`) => `FrakContext` \| `null` \| `undefined`; `remove`: (`url`) => `string`; `replaceUrl`: (`args`) => `void`; `update`: (`args`) => `string` \| `null`; \}
Defined in: [context/frakContext.ts:238](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/context/frakContext.ts#L238)
Manager for Frak referral context in URLs.
Handles compression, decompression, URL parsing, and browser history updates
for both V1 (wallet address) and V2 (anonymous clientId) referral contexts.
## Type Declaration
### compress
> **compress**: (`context?`) => `string` \| `undefined`
Compress a Frak context into a URL-safe string.
- V2 contexts are encoded using a compact binary layout (see
encodeFrakContextV2) then base64url-encoded.
- V1 contexts encode the wallet address as raw bytes (base64url).
#### Parameters
##### context?
`FrakContextV1` \| `FrakContextV2`
The context to compress (V1 or V2)
#### Returns
`string` \| `undefined`
A compressed base64url string, or undefined on failure
### decompress
> **decompress**: (`context?`) => `FrakContext` \| `undefined`
Decompress a base64url string back into a Frak context.
V1 (exactly 20 bytes) and V2 (37, 41, or 57 bytes) are distinguished by
their decoded byte length, so there is no ambiguity.
#### Parameters
##### context?
`string`
The compressed context string
#### Returns
`FrakContext` \| `undefined`
The decompressed FrakContext, or undefined on failure
### parse
> **parse**: (`args`) => `FrakContext` \| `null` \| `undefined`
Parse a URL to extract the Frak referral context from the `fCtx` query parameter.
The key is matched case-insensitively: some link channels (emails, messaging
apps) lowercase query-param keys in transit, so `fCtx` can arrive as `fctx`.
#### Parameters
##### args
###### url
`string`
The URL to parse
#### Returns
`FrakContext` \| `null` \| `undefined`
The parsed FrakContext, or null if absent
### remove
> **remove**: (`url`) => `string`
Remove the `fCtx` query parameter from a URL.
#### Parameters
##### url
`string`
The URL to strip the context from
#### Returns
`string`
The cleaned URL string
### replaceUrl
> **replaceUrl**: (`args`) => `void`
Replace the current browser URL with an updated Frak context.
- If `context` is non-null, embeds it via update.
- If `context` is null, strips the context via remove.
#### Parameters
##### args
###### context
`FrakContextV1` \| `FrakContextV2` \| `null`
Context to set, or null to remove
###### url?
`string`
Base URL (defaults to `window.location.href`)
#### Returns
`void`
### update
> **update**: (`args`) => `string` \| `null`
Add or replace the `fCtx` query parameter in a URL with the given context.
Standard affiliation params (`utm_source`, `utm_medium`, `utm_campaign`,
`ref`, `via`, ...) are always appended using gap-fill semantics: pre-existing
params on the URL are preserved, defaults are derived from the context when
applicable, and `attribution` overrides take precedence when provided.
#### Parameters
##### args
###### attribution?
[`AttributionParams`](/developers/references/core-sdk/index/type-aliases/attributionparams/)
Optional attribution overrides. Defaults are applied even when omitted.
###### context
`FrakContextV1` \| `FrakContextV2`
The context to embed (V1 or V2)
###### url?
`string`
The URL to update
#### Returns
`string` \| `null`
The updated URL string, or null on failure
# isInAppBrowser
> `const` **isInAppBrowser**: `boolean`
Defined in: [utils/browser/inAppBrowser.ts:51](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/browser/inAppBrowser.ts#L51)
Whether the current browser is a social media in-app browser
(Instagram, Facebook).
# isIOS
> `const` **isIOS**: `boolean`
Defined in: [utils/browser/inAppBrowser.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/utils/browser/inAppBrowser.ts#L17)
Whether the current device runs iOS (including iPadOS 13+).
# sdkConfigStore
> `const` **sdkConfigStore**: \{ `getConfig`: () => [`SdkResolvedConfig`](/developers/references/core-sdk/index/type-aliases/sdkresolvedconfig/); get `isCacheFresh`(): `boolean`; get `isResolved`(): `boolean`; `clearCache`: `void`; `getMerchantId`: `string` \| `undefined`; `reset`: `void`; `resolve`: `Promise`\<[`MerchantConfigResponse`](/developers/references/core-sdk/index/type-aliases/merchantconfigresponse/) \| `undefined`\>; `resolveMerchantId`: `Promise`\<`string` \| `undefined`\>; `setCacheScope`: `void`; `setConfig`: `void`; \}
Defined in: [config/sdkConfigStore.ts:167](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/config/sdkConfigStore.ts#L167)
## Type Declaration
### getConfig
> **getConfig**: () => [`SdkResolvedConfig`](/developers/references/core-sdk/index/type-aliases/sdkresolvedconfig/)
#### Returns
[`SdkResolvedConfig`](/developers/references/core-sdk/index/type-aliases/sdkresolvedconfig/)
### isCacheFresh
#### Get Signature
> **get** **isCacheFresh**(): `boolean`
##### Returns
`boolean`
### isResolved
#### Get Signature
> **get** **isResolved**(): `boolean`
##### Returns
`boolean`
### clearCache()
> **clearCache**(): `void`
#### Returns
`void`
### getMerchantId()
> **getMerchantId**(): `string` \| `undefined`
#### Returns
`string` \| `undefined`
### reset()
> **reset**(): `void`
#### Returns
`void`
### resolve()
> **resolve**(`domain?`, `walletUrl?`, `lang?`): `Promise`\<[`MerchantConfigResponse`](/developers/references/core-sdk/index/type-aliases/merchantconfigresponse/) \| `undefined`\>
#### Parameters
##### domain?
`string`
##### walletUrl?
`string`
##### lang?
[`Language`](/developers/references/core-sdk/index/type-aliases/language/)
#### Returns
`Promise`\<[`MerchantConfigResponse`](/developers/references/core-sdk/index/type-aliases/merchantconfigresponse/) \| `undefined`\>
### resolveMerchantId()
> **resolveMerchantId**(`domain?`, `walletUrl?`): `Promise`\<`string` \| `undefined`\>
#### Parameters
##### domain?
`string`
##### walletUrl?
`string`
#### Returns
`Promise`\<`string` \| `undefined`\>
### setCacheScope()
> **setCacheScope**(`domain`, `lang?`): `void`
#### Parameters
##### domain
`string`
##### lang?
`string`
#### Returns
`void`
### setConfig()
> **setConfig**(`config`): `void`
#### Parameters
##### config
[`SdkResolvedConfig`](/developers/references/core-sdk/index/type-aliases/sdkresolvedconfig/)
#### Returns
`void`
# ssoPopupFeatures
> `const` **ssoPopupFeatures**: `"menubar=no,status=no,scrollbars=no,fullscreen=no,width=500, height=800"` = `"menubar=no,status=no,scrollbars=no,fullscreen=no,width=500, height=800"`
Defined in: [actions/openSso.ts:11](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/openSso.ts#L11)
# ssoPopupName
> `const` **ssoPopupName**: `"frak-sso"` = `"frak-sso"`
Defined in: [actions/openSso.ts:13](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/core/src/actions/openSso.ts#L13)
# FrakConfigProvider
> **FrakConfigProvider**(`parameters`): `FunctionComponentElement`\<`ProviderProps`\<`FrakWalletSdkConfig` \| `undefined`\>\>
Defined in: [react/src/provider/FrakConfigProvider.ts:34](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/provider/FrakConfigProvider.ts#L34)
Simple config provider for the Frak Wallet SDK
Should be wrapped within a @tanstack/react-query!QueryClientProvider \| \`QueryClientProvider\`
## Parameters
### parameters
`PropsWithChildren`\<[`FrakConfigProviderProps`](/developers/references/react-sdk/type-aliases/frakconfigproviderprops/)\>
## Returns
`FunctionComponentElement`\<`ProviderProps`\<`FrakWalletSdkConfig` \| `undefined`\>\>
# FrakIFrameClientProvider
> **FrakIFrameClientProvider**(`args`): `FunctionComponentElement`\<`FragmentProps`\>
Defined in: [react/src/provider/FrakIFrameClientProvider.ts:47](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/provider/FrakIFrameClientProvider.ts#L47)
IFrame client provider for the Frak Wallet SDK
It will automatically create the frak wallet iFrame (required for the wallet to communicate with the SDK securely), and provide it in the context
## Parameters
### args
#### children?
`ReactNode`
Descedant components that will have access to the Frak Client
#### style?
`CSSProperties`
Some custom styles to apply to the iFrame
## Returns
`FunctionComponentElement`\<`FragmentProps`\>
## Remarks
This provider must be wrapped within a [FrakConfigProvider](/developers/references/react-sdk/functions/frakconfigprovider/) to work properly
# useDisplayModal
> **useDisplayModal**\<`T`\>(`args?`): `UseMutationResult`\<`ModalRpcStepsResultType`\<`T`\>, `FrakRpcError`\<`undefined`\>, `DisplayModalParamsType`\<`T`\> & \{ `placement?`: `string`; \}, `unknown`\>
Defined in: [react/src/hook/useDisplayModal.ts:51](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/useDisplayModal.ts#L51)
Hook that return a mutation helping to display a modal to the user
It's a @tanstack/react-query!home \| \`tanstack\` wrapper around the [\`displayModal()\`](/developers/references/core-sdk/actions/functions/displaymodal/) action
## Type Parameters
### T
`T` *extends* `ModalStepTypes`[] = `ModalStepTypes`[]
The modal steps types to display (the result will correspond to the steps types asked in params)
An array of [\`ModalStepTypes\`](/developers/references/core-sdk/index/type-aliases/modalsteptypes/)
If not provided, it will default to a generic array of `ModalStepTypes`
## Parameters
### args?
Optional config object with `mutations` for customizing the underlying @tanstack/react-query!useMutation \| \`useMutation()\`
#### mutations?
`MutationOptions`\<`T`\>
Optional mutation options, see @tanstack/react-query!useMutation \| \`useMutation()\` for more infos
## Returns
`UseMutationResult`\<`ModalRpcStepsResultType`\<`T`\>, `FrakRpcError`\<`undefined`\>, `DisplayModalParamsType`\<`T`\> & \{ `placement?`: `string`; \}, `unknown`\>
The mutation hook wrapping the `displayModal()` action
The `mutate` and `mutateAsync` argument is of type [\`DisplayModalParamsType\\`](/developers/references/core-sdk/index/type-aliases/displaymodalparamstype/), with type params `T` being the modal steps types to display
The `data` result is a [\`ModalRpcStepsResultType\`](/developers/references/core-sdk/index/type-aliases/modalrpcstepsresulttype/)
## See
- [\`displayModal()\`](/developers/references/core-sdk/actions/functions/displaymodal/) for more info about the underlying action
- @tanstack/react-query!useMutation \| \`useMutation()\` for more info about the mutation options and response
# useDisplaySharingPage
> **useDisplaySharingPage**(`args?`): `UseMutationResult`\<`DisplaySharingPageResultType`, `FrakRpcError`\<`undefined`\>, `DisplaySharingPageParamsType` & \{ `placement?`: `string`; \}, `unknown`\>
Defined in: [react/src/hook/useDisplaySharingPage.ts:45](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/useDisplaySharingPage.ts#L45)
Hook that return a mutation helping to display a sharing page to the user
It's a @tanstack/react-query!home \| \`tanstack\` wrapper around the [\`displaySharingPage()\`](/developers/references/core-sdk/actions/functions/displaysharingpage/) action
## Parameters
### args?
Optional config object with `mutations` for customizing the underlying @tanstack/react-query!useMutation \| \`useMutation()\`
#### mutations?
`MutationOptions`
Optional mutation options, see @tanstack/react-query!useMutation \| \`useMutation()\` for more infos
## Returns
`UseMutationResult`\<`DisplaySharingPageResultType`, `FrakRpcError`\<`undefined`\>, `DisplaySharingPageParamsType` & \{ `placement?`: `string`; \}, `unknown`\>
The mutation hook wrapping the `displaySharingPage()` action
The `mutate` and `mutateAsync` argument is of type [\`DisplaySharingPageParamsType\`](/developers/references/core-sdk/index/type-aliases/displaysharingpageparamstype/) with optional `placement`
The `data` result is a [\`DisplaySharingPageResultType\`](/developers/references/core-sdk/index/type-aliases/displaysharingpageresulttype/)
## See
- [\`displaySharingPage()\`](/developers/references/core-sdk/actions/functions/displaysharingpage/) for more info about the underlying action
- @tanstack/react-query!useMutation \| \`useMutation()\` for more info about the mutation options and response
# useFrakClient
> **useFrakClient**(): `FrakClient` \| `undefined`
Defined in: [react/src/hook/useFrakClient.ts:9](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/useFrakClient.ts#L9)
Get the current Frak client
## Returns
`FrakClient` \| `undefined`
# useFrakConfig
> **useFrakConfig**(): `FrakWalletSdkConfig`
Defined in: [react/src/hook/useFrakConfig.ts:13](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/useFrakConfig.ts#L13)
Get the current Frak config
## Returns
`FrakWalletSdkConfig`
## Throws
if the config is not found (only if this hooks is used outside a FrakConfigProvider)
## See
- [FrakConfigProvider](/developers/references/react-sdk/functions/frakconfigprovider/) for the config provider
- [FrakWalletSdkConfig](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/) for the config type
# useGetMerchantInformation
> **useGetMerchantInformation**(`args?`): `UseQueryResult`\<`GetMerchantInformationReturnType`, `FrakRpcError`\<`undefined`\>\>
Defined in: [react/src/hook/useGetMerchantInformation.ts:45](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/useGetMerchantInformation.ts#L45)
Hook that return a query helping to get the current merchant information
It's a @tanstack/react-query!home \| \`tanstack\` wrapper around the [\`getMerchantInformation()\`](/developers/references/core-sdk/actions/functions/getmerchantinformation/) action
## Parameters
### args?
Optional config object with `query` for customizing the underlying @tanstack/react-query!useQuery \| \`useQuery()\`
#### cacheTime?
`number`
Time in ms to cache the result at the core SDK level. Default: 30_000 (30s). Set to 0 to disable.
#### query?
`QueryOptions`
Optional query options, see @tanstack/react-query!useQuery \| \`useQuery()\` for more infos
## Returns
`UseQueryResult`\<`GetMerchantInformationReturnType`, `FrakRpcError`\<`undefined`\>\>
The query hook wrapping the `getMerchantInformation()` action
The `data` result is a [\`GetMerchantInformationReturnType\`](/developers/references/core-sdk/index/type-aliases/getmerchantinformationreturntype/)
## See
- [\`getMerchantInformation()\`](/developers/references/core-sdk/actions/functions/getmerchantinformation/) for more info about the underlying action
- @tanstack/react-query!useQuery \| \`useQuery()\` for more info about the useQuery options and response
# useGetMergeToken
> **useGetMergeToken**(`args?`): `UseQueryResult`\<`string` \| `null`, `FrakRpcError`\<`undefined`\>\>
Defined in: [react/src/hook/useGetMergeToken.ts:43](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/useGetMergeToken.ts#L43)
Hook that return a query to fetch a merge token for the current anonymous identity
Used by in-app browser redirect flows to preserve identity
when switching from a WebView to the system browser.
It's a @tanstack/react-query!home \| \`tanstack\` wrapper around the [\`getMergeToken()\`](/developers/references/core-sdk/actions/functions/getmergetoken/) action
## Parameters
### args?
Optional config object with `query` for customizing the underlying @tanstack/react-query!useQuery \| \`useQuery()\`
#### cacheTime?
`number`
Time in ms to cache the result at the core SDK level. Default: 30_000 (30s). Set to 0 to disable.
#### query?
`QueryOptions`
Optional query options, see @tanstack/react-query!useQuery \| \`useQuery()\` for more infos
## Returns
`UseQueryResult`\<`string` \| `null`, `FrakRpcError`\<`undefined`\>\>
The query hook wrapping the `getMergeToken()` action
The `data` result is a `string | null`
## See
- [\`getMergeToken()\`](/developers/references/core-sdk/actions/functions/getmergetoken/) for more info about the underlying action
- @tanstack/react-query!useQuery \| \`useQuery()\` for more info about the useQuery options and response
# useGetUserReferralStatus
> **useGetUserReferralStatus**(`args?`): `UseQueryResult`\<`UserReferralStatusType` \| `null`, `FrakRpcError`\<`undefined`\>\>
Defined in: [react/src/hook/useGetUserReferralStatus.ts:47](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/useGetUserReferralStatus.ts#L47)
Hook that return a query to fetch the current user's referral status on the current merchant
Returns `null` when the user's identity cannot be resolved.
It's a @tanstack/react-query!home \| \`tanstack\` wrapper around the [\`getUserReferralStatus()\`](/developers/references/core-sdk/actions/functions/getuserreferralstatus/) action
## Parameters
### args?
Optional config object with `query` for customizing the underlying @tanstack/react-query!useQuery \| \`useQuery()\`
#### cacheTime?
`number`
Time in ms to cache the result at the core SDK level. Default: 30_000 (30s). Set to 0 to disable.
#### query?
`QueryOptions`
Optional query options, see @tanstack/react-query!useQuery \| \`useQuery()\` for more infos
## Returns
`UseQueryResult`\<`UserReferralStatusType` \| `null`, `FrakRpcError`\<`undefined`\>\>
The query hook wrapping the `getUserReferralStatus()` action
The `data` result is a [\`UserReferralStatusType\`](/developers/references/core-sdk/index/type-aliases/userreferralstatustype/) or `null`
## See
- [\`getUserReferralStatus()\`](/developers/references/core-sdk/actions/functions/getuserreferralstatus/) for more info about the underlying action
- @tanstack/react-query!useQuery \| \`useQuery()\` for more info about the useQuery options and response
# useOpenSso
> **useOpenSso**(`args?`): `UseMutationResult`\<`OpenSsoReturnType`, `FrakRpcError`\<`undefined`\>, `OpenSsoParamsType`, `unknown`\>
Defined in: [react/src/hook/useOpenSso.ts:38](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/useOpenSso.ts#L38)
Hook that return a mutation helping to open the SSO page
It's a @tanstack/react-query!home \| \`tanstack\` wrapper around the [\`openSso()\`](/developers/references/core-sdk/actions/functions/opensso/) action
## Parameters
### args?
Optional config object with `mutations` for customizing the underlying @tanstack/react-query!useMutation \| \`useMutation()\`
#### mutations?
`MutationOptions`
Optional mutation options, see @tanstack/react-query!useMutation \| \`useMutation()\` for more infos
## Returns
`UseMutationResult`\<`OpenSsoReturnType`, `FrakRpcError`\<`undefined`\>, `OpenSsoParamsType`, `unknown`\>
The mutation hook wrapping the `openSso()` action
The `mutate` and `mutateAsync` argument is of type [\`OpenSsoParamsType\`](/developers/references/core-sdk/index/type-aliases/openssoparamstype/)
The mutation doesn't output any value
## See
- [\`openSso()\`](/developers/references/core-sdk/actions/functions/opensso/) for more info about the underlying action
- @tanstack/react-query!useMutation \| \`useMutation()\` for more info about the mutation options and response
# usePrepareSso
> **usePrepareSso**(`params`): `UseQueryResult`\<`PrepareSsoReturnType`, `Error`\>
Defined in: [react/src/hook/usePrepareSso.ts:43](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/usePrepareSso.ts#L43)
Hook that generates SSO URL for popup flow
This is a **synchronous** hook (no async calls) that generates the SSO URL
client-side without communicating with the wallet iframe.
## Parameters
### params
`PrepareSsoParamsType`
SSO parameters for URL generation
## Returns
`UseQueryResult`\<`PrepareSsoReturnType`, `Error`\>
Object containing:
- `ssoUrl`: Generated SSO URL (or undefined if client not ready)
- `isReady`: Boolean indicating if URL is available
## Example
```tsx
function MyComponent() {
const { data } = usePrepareSso({
metadata: { logoUrl: "..." },
directExit: true
});
const handleClick = () => {
if (ssoUrl) {
window.open(data?.ssoUrl, "_blank");
}
};
return Login ;
}
```
## See
- [\`prepareSso()\`](/developers/references/core-sdk/actions/functions/preparesso/) for the underlying action
- [\`openSso()\`](/developers/references/core-sdk/actions/functions/opensso/) for the recommended high-level API
# useReferralInteraction
> **useReferralInteraction**(`args?`): `Error` \| `"idle"` \| `"processing"` \| `"success"` \| `"no-referrer"` \| `"self-referral"`
Defined in: [react/src/hook/helper/useReferralInteraction.ts:26](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/helper/useReferralInteraction.ts#L26)
Helper hook to automatically submit a referral interaction when detected
Runs once when the Frak client becomes available.
## Parameters
### args?
#### options?
`ProcessReferralOptions`
Some options for the referral interaction
## Returns
`Error` \| `"idle"` \| `"processing"` \| `"success"` \| `"no-referrer"` \| `"self-referral"`
The resulting referral state, or a potential error
## Description
This function will automatically handle the referral interaction process
## See
[\`referralInteraction()\`](/developers/references/core-sdk/actions/functions/referralinteraction/) for more details on the automatic referral handling process
# useSendTransactionAction
> **useSendTransactionAction**(`args?`): `UseMutationResult`\<\{ `hash`: `` `0x${string}` ``; \}, `FrakRpcError`\<`undefined`\>, \{ `metadata?`: `ModalRpcMetadata`; `tx`: `SendTransactionTxType` \| `SendTransactionTxType`[]; \}, `unknown`\>
Defined in: [react/src/hook/useSendTransaction.ts:45](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/useSendTransaction.ts#L45)
Hook that return a mutation helping to send a transaction
It's a @tanstack/react-query!home \| \`tanstack\` wrapper around the [\`sendTransaction()\`](/developers/references/core-sdk/actions/functions/sendtransaction/) action
## Parameters
### args?
Optional config object with `mutations` for customizing the underlying @tanstack/react-query!useMutation \| \`useMutation()\`
#### mutations?
`MutationOptions`
Optional mutation options, see @tanstack/react-query!useMutation \| \`useMutation()\` for more infos
## Returns
`UseMutationResult`\<\{ `hash`: `` `0x${string}` ``; \}, `FrakRpcError`\<`undefined`\>, \{ `metadata?`: `ModalRpcMetadata`; `tx`: `SendTransactionTxType` \| `SendTransactionTxType`[]; \}, `unknown`\>
The mutation hook wrapping the `sendTransaction()` action
The `mutate` and `mutateAsync` argument is of type [\`SendTransactionParams\`](/developers/references/core-sdk/actions/type-aliases/sendtransactionparams/)
The `data` result is a [\`SendTransactionReturnType\`](/developers/references/core-sdk/index/type-aliases/sendtransactionreturntype/)
## See
- [\`sendTransaction()\`](/developers/references/core-sdk/actions/functions/sendtransaction/) for more info about the underlying action
- @tanstack/react-query!useMutation \| \`useMutation()\` for more info about the mutation options and response
# useSetupReferral
> **useSetupReferral**(): `UseQueryResult`\<`null`, `Error`\>
Defined in: [react/src/hook/useSetupReferral.ts:20](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/useSetupReferral.ts#L20)
Hook that automatically processes referral context and emits a DOM event on success
Runs once when the Frak client becomes available. Fire-and-forget — the referral
result is tracked via a `"frak:referral-success"` DOM event on `window`, not via
the returned query data.
## Returns
`UseQueryResult`\<`null`, `Error`\>
The query handle (data is not meaningful — listen for `REFERRAL_SUCCESS_EVENT` on `window` instead)
## See
- [\`setupReferral()\`](/developers/references/core-sdk/actions/functions/setupreferral/) for more info about the underlying action
- [\`REFERRAL\_SUCCESS\_EVENT\`](/developers/references/core-sdk/actions/variables/referral_success_event/) for the event name constant
# useSiweAuthenticate
> **useSiweAuthenticate**(`args?`): `UseMutationResult`\<\{ `message`: `string`; `signature`: `` `0x${string}` ``; \}, `FrakRpcError`\<`undefined`\>, \{ `metadata?`: `ModalRpcMetadata`; `siwe?`: `Partial`\<`SiweAuthenticationParams`\>; \}, `unknown`\>
Defined in: [react/src/hook/useSiweAuthenticate.ts:45](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/useSiweAuthenticate.ts#L45)
Hook that return a mutation helping to send perform a SIWE authentication
It's a @tanstack/react-query!home \| \`tanstack\` wrapper around the [\`siweAuthenticate()\`](/developers/references/core-sdk/actions/functions/siweauthenticate/) action
## Parameters
### args?
`UseSiweAuthenticateParams` = `{}`
Optional config object with `mutations` for customizing the underlying @tanstack/react-query!useMutation \| \`useMutation()\`
## Returns
`UseMutationResult`\<\{ `message`: `string`; `signature`: `` `0x${string}` ``; \}, `FrakRpcError`\<`undefined`\>, \{ `metadata?`: `ModalRpcMetadata`; `siwe?`: `Partial`\<`SiweAuthenticationParams`\>; \}, `unknown`\>
The mutation hook wrapping the `siweAuthenticate()` action
The `mutate` and `mutateAsync` argument is of type [\`SiweAuthenticateModalParams\`](/developers/references/core-sdk/actions/type-aliases/siweauthenticatemodalparams/)
The `data` result is a [\`SiweAuthenticateReturnType\`](/developers/references/core-sdk/index/type-aliases/siweauthenticatereturntype/)
## See
- [\`siweAuthenticate()\`](/developers/references/core-sdk/actions/functions/siweauthenticate/) for more info about the underlying action
- @tanstack/react-query!useMutation \| \`useMutation()\` for more info about the mutation options and response
# useWalletStatus
> **useWalletStatus**(): `UseQueryResult`\<`WalletStatusReturnType`, `Error`\>
Defined in: [react/src/hook/useWalletStatus.ts:22](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/hook/useWalletStatus.ts#L22)
Hook that return a query helping to get the current wallet status.
It's a @tanstack/react-query!home \| \`tanstack\` wrapper around the [\`watchWalletStatus()\`](/developers/references/core-sdk/actions/functions/watchwalletstatus/) action
## Returns
`UseQueryResult`\<`WalletStatusReturnType`, `Error`\>
The query hook wrapping the `watchWalletStatus()` action
The `data` result is a [\`WalletStatusReturnType\`](/developers/references/core-sdk/index/type-aliases/walletstatusreturntype/)
## See
- [\`watchWalletStatus()\`](/developers/references/core-sdk/actions/functions/watchwalletstatus/) for more info about the underlying action
- @tanstack/react-query!useQuery \| \`useQuery()\` for more info about the useQuery response
# FrakConfigProviderProps
> **FrakConfigProviderProps** = \{ `config`: `FrakWalletSdkConfig`; \}
Defined in: [react/src/provider/FrakConfigProvider.ts:17](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/provider/FrakConfigProvider.ts#L17)
Props to instantiate the Frak Wallet SDK configuration provider
## Properties
### config
> **config**: `FrakWalletSdkConfig`
Defined in: [react/src/provider/FrakConfigProvider.ts:22](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/provider/FrakConfigProvider.ts#L22)
The wanted Frak configuration
#### See
[FrakWalletSdkConfig](/developers/references/core-sdk/index/type-aliases/frakwalletsdkconfig/)
# FrakIFrameClientProps
> **FrakIFrameClientProps** = \{ `config`: `FrakWalletSdkConfig`; \}
Defined in: [react/src/provider/FrakIFrameClientProvider.ts:30](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/provider/FrakIFrameClientProvider.ts#L30)
Props to instantiate the Frak Wallet SDK configuration provider
## Properties
### config
> **config**: `FrakWalletSdkConfig`
Defined in: [react/src/provider/FrakIFrameClientProvider.ts:31](https://github.com/frak-id/wallet/blob/da58e5f874a69966502537d9611590646b89891e/sdk/react/src/provider/FrakIFrameClientProvider.ts#L31)
# Documentation
## Packages
- @frak-labs/components
- @frak-labs/core-sdk
- @frak-labs/react-sdk
# How does it work?
> How the frak wallet work under the hood?
# How does it work?
In this section, we will go through the different technologies and smart contracts used by the Frak Wallet, and how they are working together.
## Knowledge base
Before deep diving into the Frak Wallet, it is important to understand a few blockchain technologies.
### Account Abstraction
The frak wallet is using the [ERC-4337](https://eips.ethereum.org/EIPS/eip-4337) standard, which is a standard for account abstraction on EVM blockchain.
If you are not familiar with this standard, here is a few great resources to get started:
- [Awesome account abstraction](https://github.com/4337Mafia/awesome-account-abstraction)
- [Stackup intro to account abstraction](https://docs.stackup.sh/docs/account-abstraction)
- The EIP itself: [EIP-4337](https://eips.ethereum.org/EIPS/eip-4337)
A few key takeaways from the account abstraction standard:
- It permit to execute transaction without having to pay for the gas fees directly
- It can be used with any type of validation (password, biometric, etc.)
### WebAuthN
Then, the Frak wallet is using the [WebAuthN](https://w3c.github.io/webauthn/) standard for the authentication and the signing of the transactions.
If you are not familiar with this standard, here is a few great resources to get started:
- [Awesome WebAuthN](https://github.com/herrjemand/awesome-webauthn)
- [Detailed WebAuthN demo by Auth0](https://webauthn.me/)
- [WebAuthN demo by Matthew Miller](https://webauthn.io/)
- [WebAuthN official documentation](https://w3c.github.io/webauthn/)
- [WebAuthN on MDN](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API)
A few key takeaways from the WebAuthN standard:
- It's a standard for **passwordless** authentication
- It's a standard for **secure message signing**
- The authentication is bounded to a **specific domain**.
### P-256 Signature
WebAuthN rely on the [secp256r1](https://neuromancer.sk/std/secg/secp256r1) signature algorithm (or in short *P-256*) to sign the transaction.
This signature curve isn't supported on EVM chains by default.
The [RIP-7212](https://github.com/ethereum/RIPs/blob/master/RIPS/rip-7212.md) provides native support of this curve on rollup chains and is now live on several L2s including Base, Optimism, Arbitrum, and others.
For chains that don't yet support this precompile, we fall back to the [FreshCryptoLib](https://github.com/rdubois-crypto/FreshCryptoLib) to verify the signature in Solidity.
## SmartWallet side
In this section we will go through the smart contract related to the Smart wallet side of the Frak Wallet.
We are using the [Kernel Smart Wallet](https://github.com/zerodevapp/kernel) by the [ZeroDev](https://zerodev.app/) team for core logic of the Smart Wallet.
It's audited, battle tested, and has a lot of features that we can leverage (for example the [ERC-7579](https://erc7579.com/) support)
Since kernel wallet support modular validation, we are mainly using two type of validator for the Frak Wallet:
1. The main one being the [FCL WebAuthN validator](https://github.com/zerodevapp/kernel/blob/dev/src/validator/webauthn/WebAuthnFclValidator.sol), a custom validator developed by us, using the [FreshCryptoLib](https://github.com/rdubois-crypto/FreshCryptoLib) to verify P-256 signatures on chains that don't yet support the RIP-7212 precompile (and using the native precompile where available).
2. The second one being the [ECDSAValidator](https://github.com/zerodevapp/kernel/blob/dev/src/validator/ECDSAValidator.sol), for users that set up recovery options. They can set up an EOA as a recovery wallet, enabling an ECDSAValidator. This permits them to execute transactions via either the WebAuthN validator or the ECDSA one.
On the infrastructure side, we are using the [Pimlico bundler](https://www.pimlico.io/) to manage the smart wallet transactions and data fetching.
Transaction gas fees are sponsored by Frak for standard SDK interactions. The paymaster handles gas sponsorship automatically through the Pimlico infrastructure.
## Communication side
Since the WebAuthN standard is bounded to a specific domain, we use two principal ways of communication:
1. An **iFrame**, for bidirectional communication between the Frak Wallet and the implementing website. This is the primary communication channel used for all SDK actions (modals, embedded wallet, interactions, wallet status, etc.).
2. **URL-based redirection**, used specifically for SSO flows where the user needs to authenticate on the Frak Wallet domain.
Working this way, with a **client first** approach, provides us a few key benefits:
- We are not relying on third-party cookies
- We don't rely on a centralised server to manage the communication, so you don't have to trust us with up-time, server provisioning, db going down or anything.
- Your app can communicate with the client storage, even if the client is offline (so you can still fetch wallet address, transaction history etc. even if the client is offline)
- All the frak related storage is stored on the client storage, in a secure way, and is only accessible by the frak wallet and allowed dApps.
:::note
On the centralisation side, yeah you are not relying on a centralised server, but you are relying on the frak website, **how is that different?**
Firstly, the website hosting the Frak wallet is a PWA, meaning that user can install it on their devices (if compatible), and enjoy it everytime (even if our website come down for whatever reason).
Secondly, it's all open source, meaning that you can easily redeploy it on your own infrastructure if you want to.
:::
### iFrame communication
The iFrame communication side isn't that complex really. We are basically using an iFrame with a two-way communication (using regular `window.addEventListener('message', handler)`).
The init flow is as follows:
1. The dApp create an iFrame with the right URL (can be built using an SDK helper or react component directly)
2. When the iFrame is loaded, it should be loaded on the **Frak query listener** page: no UI, just handling incoming message requests.
3. Once the frak query listener is loaded, and have warmed up a few key storage slots, it will send a `ready` message to the dApp.
4. Once the dApp receive the `ready` message, it can start sending message to the Frak Wallet, and receive message from it.
On top of the classical postMessage communication, we added some abstraction around all of that, helping to have:
- a `createIFrameFrakClient` method, that will build a `transport` (similar to [Viem transports](https://viem.sh/docs/clients/intro.html)) used for the communication
- The `IFrameTransport` can handle every data types specified in the `IFrameRpcSchema`,
- To query data via that transport directly, you can either:
- Use the `request` method, returning a Promise of the expected `ReturnType` of the given request
- Use the `listenerRequest` method, and passing a `callback` args, that will be invoked with the expected `ReturnType` of the given request, and every time the `ReturnType` change.
Under the hood, both `request` and `listenerRequest` are using a small abstraction around `postMessage`, building a notification system, and a request/response system, on both sides.
### SSO redirect flow
For SSO (Single Sign-On) authentication, the SDK uses a redirect-based flow:
1. The SDK builds a URL with compressed SSO parameters using `prepareSso` / `openSso`
2. The user is redirected to the Frak Wallet SSO page
3. The Frak Wallet handles authentication and creates the session
4. The user is redirected back to the dApp, and the SDK picks up the compressed SSO result from the URL
### Embedded wallet
The embedded wallet (`displayEmbeddedWallet`) provides a persistent wallet UI that lives within the host page via the iFrame transport. It supports logged-in views (sharing, referred state) and logged-out views, all rendered within the Frak iFrame without any page redirects.
Cross-origin WebAuthN via iFrame is an evolving w3c standard (see [this discussion](https://github.com/w3c/webauthn/issues/1656) for background). Browser support is tracked at:
- [Chromium](https://issues.chromium.org/issues/40258856)
- [Mozilla](https://github.com/mozilla/standards-positions/issues/964)
- [WebKit](https://github.com/WebKit/standards-positions/issues/304)
### Communication security
Since sensitive data can be shared between the dApp and the Frak Wallet, we built a secured communication layer.
For data exchanged via URL (SSO params, referral context), the SDK uses:
1. JSON serialization of the message payload
2. A **sha256** validation hash of the primordial message keys (varies by message type)
3. Base64url encoding of the data + validation hash for URL-safe transport
4. On the receiving side, the data is decoded and the validation hash is verified against the payload
For iFrame communication, the `postMessage` transport includes origin checks to ensure messages are only accepted from the expected Frak Wallet domain.
:::note
The hash validation mechanism is used for both iFrame communication and URL-based data exchange.
:::
## Transaction side
Now, how does the transaction process work exactly?
We won't enter in depth with the account abstraction way of working, since it's a bit out of the scope of this documentation, and samewise for the WebAuthN signing standard.
Here is the flow when a user want to execute a transaction:
1. Build the transaction data
2. Prepare a `userOperation` bundle
3. Sign the `userOperation.hash` via the current webAuthN validator
4. Send the `userOperation` to the pimlico bundler, and receive the `userOpHash`
5. Wait for the `userOpHash` to be bundled in a transaction, and then wait for the `txHash` to be executed
# Welcome to Frak
> Turn your customers into advocates. Set up Frak on your store in about 5 minutes. No technical skills required for most platforms.
import { LinkCard, Steps } from '@astrojs/starlight/components';
# Welcome to Frak
Frak rewards your customers for sharing your store with friends, and rewards their friends for buying. It's word-of-mouth marketing that runs itself, and you only pay out when a real sale happens.
Getting started takes about **5 minutes**. Pick the path that matches your store:
1. **Connect your store.** Link your shop to Frak so we can recognize your customers and the friends they refer.
2. **Add a share button.** Let customers share your products, and earn when their friends buy.
3. **Fund your rewards.** Add a budget by card. Rewards leave your balance only on real, confirmed purchases.
## You're in good hands
- **No code for most stores.** Shopify, WordPress, and PrestaShop all have ready-made apps.
- **You only pay for results.** Rewards are paid out only when a sale is confirmed.
- **You stay in control.** Adjust your budget, rewards, and where buttons appear at any time.
New to some of the words we use? The [glossary](/guides/glossary/) explains them in a minute.
# Best practices
> Simple ways to get more shares and more sales from Frak. Where to place prompts, how to set rewards, and how to keep momentum.
import { Aside, CardGrid, LinkCard } from '@astrojs/starlight/components';
# Best practices
Frak works best when customers are nudged to share at the right moment, with a reward worth talking about. None of this is complicated. Here's what makes the biggest difference.
## Ask at the moment of excitement
The single best place to ask for a share is **right after checkout**, when your customer is happiest. Lead with the post-purchase card, then add the others:
- **Post-purchase card**: shown straight after an order. This converts best, so set it up first.
- **Share button on product pages**: lets customers share something specific they love.
- **Welcome banner**: greets visitors who arrive from a friend's link, so they feel recognized.
The strongest results come from using **more than one** of these together. Each touchpoint catches customers in a different mood.
## Bring in your existing customers
Your email list is full of people who already like you. Drop your **newsletter sharing link** into a campaign email: one click opens your store with the sharing window ready and your rewards pre-filled. It's the fastest way to kick off a campaign on day one.
## Set rewards worth sharing
- **Reward both sides.** A little reward for the friend who buys makes the link far more clickable. Frak suggests an **80/20 split** in the ambassador's favor, one tap to apply.
- **Make it meaningful.** A reward big enough to mention ("get €6") travels further than a token amount.
- **Match the reward to the goal.** Reward purchases for sales, sign-ups for leads. Pick the one goal that matters most for this campaign.
## Keep the momentum going
- **Stay funded.** Campaigns pause when the budget runs dry. Keep a buffer so sharing never stops mid-stream. [Add funds](/guides/dashboard/configure/funds/).
- **Re-engage your members.** Send an occasional [push notification](/guides/campaigns/push/) to announce a new campaign or product. The customers who already shared are your best ambassadors.
- **Get discovered.** List your brand in the **Frak Explorer** so app users can find and share you. [Customize your listing](/guides/dashboard/configure/explorer/).
## Watch what works
Open [Track performance](/guides/campaigns/performance/) to see which campaigns and placements drive the most shares and sales, then double down on the winners.
# Create a campaign
> Set up a Frak campaign in a short guided wizard. Choose your goal, budget, and rewards, then publish and go live.
import { Steps, Aside, CardGrid, LinkCard } from '@astrojs/starlight/components';
# Create a campaign
A campaign decides what your customers earn for sharing your store, and what action pays out. Setup is a short guided wizard, and you can **Save as draft** at any point and come back later.
Make sure your store is [registered](/guides/dashboard/register/) and your [reward budget is funded](/guides/dashboard/configure/funds/). A campaign can only pay out once there's money in the budget.
## The wizard, step by step
1. **Campaign basics.** Give the campaign a title (only you see it) and pick the **merchant** it belongs to. You can keep your store's default reward currency, which is recommended, or choose another.
2. **Goal.** Pick the one action that triggers rewards:
- **Sales**: reward purchases. The most popular choice for shops.
- **Traffic**: reward visits to your site or app.
- **Registration**: reward sign-ups and qualified leads.
3. **Territory & categories.** Choose the countries where your campaign runs. (Special advertising categories like credit or housing aren't supported yet, so you can move on.)
4. **Budget & schedule.** Set how much to spend and when. Pick a budget **period** (one global pot, or daily, weekly, monthly) and a **cap**. Then choose to start immediately, on a date, or over a fixed window. With no end date, the campaign simply runs until the budget is used up.
5. **Reward setup.** Decide how much customers earn and how it's calculated:
- **Fixed amount**: the same reward per sale.
- **% of basket**: the reward scales with order value.
- **Tiered**: bigger baskets earn bigger rewards.
You split the reward between the **ambassador** (your customer who shares) and the **referee** (the friend who buys). Frak suggests an 80/20 split in the ambassador's favor, one tap with **Apply reco**.
6. **Review & publish.** The last screen shows everything read-only so you can check it over. When it looks right, click **Publish**.
Frak takes a **20% commission** on the campaign budget. The other 80% goes straight to your customers as rewards. You only ever pay out on real, confirmed actions.
## You published, what happens next
Your campaign goes live right away, and the Frak ambassador community gets a notification that you've launched, so sharing can start immediately. For the best results, give people somewhere to share from:
Once it's running, [track its performance](/guides/campaigns/performance/) to see shares, sales, and your real cost per result.
# Track performance
> See how your campaigns are doing in plain numbers: shares, sales, your real cost per result, and how it compares to paid ads.
import { Aside, LinkCard } from '@astrojs/starlight/components';
# Track performance
Once a campaign is live, the **Campaigns** area shows exactly how it's doing: who's sharing, what's selling, and what each result actually costs you. No spreadsheets, it updates on its own.
**Data overview** gives you the big picture across all campaigns. The **List** lets you open any single campaign for the full detail.
## The big picture
The **Data overview** opens with the numbers that matter most:
- **Ambassadors**: customers who shared your store.
- **Shares**: how many times your store was shared.
- **Generated revenue**: sales that came from those shares.
- **Sharing rate**: how many people who saw the prompt actually shared.
- **Avg. CPA**: your average cost per result.
Below that you'll find a **sharing funnel** (from "share prompt seen" all the way to "converted"), **purchases generated** over time, a **projected revenue** trend, where shares come from (site vs the Frak app, mobile vs desktop), and your **top campaigns**.
## Your campaign list
The **List** shows every campaign with its **status** (Active, Paused, Draft, Ended, or Archived) and key figures side by side: sharing rate, rewards paid, click-through rate, revenue, and budget spent.
From the menu on each row you can **open performance**, **view parameters**, **edit**, **pause**, **resume**, **archive**, or **delete**. You can also select several at once to pause or archive them together.
## Inside a single campaign
Open a campaign for the full story, organized in three tabs:
- **Funnel & ROI**: the conversion funnel plus your return on investment.
- **Ambassadors**: who's driving results, with a **top ambassadors** leaderboard (shares, sales, revenue, and what they earned).
- **Configuration**: the campaign's settings, read-only.
You'll also see a **cost breakdown** (how each reward splits between the ambassador, the referee, and Frak) and headline stats like the share of active ambassadors and how many referred friends converted.
Each campaign shows an **economic value** panel that compares your spend to the equivalent cost on Meta, so you can see how much cheaper word-of-mouth is, alongside the revenue and average basket value it brought in.
## Export your data
Need the raw numbers for your own reports? Use **Export** to download them.
Open **Members** and click **Send Push Notification**, or go to **Push → Create**. You can filter your members first to send to a specific group.
## Write and send
1. **Name it.** Give the notification an internal name (like "Summer reactivation"). Only you see this, your members never do.
2. **Write your message.** Add a **title** and a **message**. You can include an optional **image** and a **launch URL**, the page that opens when someone taps the notification. A live **preview** shows how it'll look.
3. **Choose your audience.** Pick which members should receive it. The dashboard shows how many people you'll reach as you adjust the selection.
4. **Pick when to send.** Choose **Send immediately**. (Scheduling for later is coming soon.)
5. **Review and send.** Check the audience and timing on the review screen, then **Send notification**.
You need at least one member to send a notification. Members join automatically as customers share your store and earn rewards, so your audience grows as your campaigns run.
Keep it useful and occasional. A relevant, well-timed message brings people back. Too many, and they tune out.
# What your customers see
> A look at the customer side of Frak. How someone shares your store, how their friend buys, and how both get rewarded.
import { Steps, Aside, CardGrid, LinkCard } from '@astrojs/starlight/components';
# What your customers see
Here's the experience you're giving your customers, from the first share to money in the bank. Frak is word-of-mouth: your happy customers share your store with friends, the friends buy, and both sides earn a reward. No coupons to manage, no crypto knowledge needed on either side.
There are two people in every story:
- The **ambassador**: your customer, the one who shares.
- Their **friend** (the referee): the one who clicks and buys.
## The journey, start to finish
Say your campaign pays **€10 per sale**, split **€6 to the ambassador, €2 to the friend** (Frak keeps €2).
1. **Sarah buys from your store.** Right after checkout she sees a friendly card: "Share with a friend and you both earn." She taps it.
2. **Sarah shares her link.** Frak creates a personal link for her and she sends it to Tom on WhatsApp.
3. **Tom clicks and buys.** He lands on your store, sees he'll get a little reward too, and places a €50 order.
4. **You confirm the sale, both get paid.** Once the order is confirmed, **Sarah earns €6** and **Tom earns €2**, straight into their Frak wallet.
5. **Sarah gets a notification and comes back.** "You earned €6." So she shares again with the next friend.
6. **Tom collects his €2, and joins in.** He installs the Frak app, watches his reward land, and sees how simple it was. Now he shares your store with his own friends, and the loop starts over with him.
Every friend who buys can become the next person sharing. That flywheel, share, buy, reward, repeat, is the whole point, and you only ever pay when a real sale happens.
## The free wallet, in plain terms
Rewards land in a **Frak wallet**, which lives in the **Frak app**. Your customers don't need to know anything about crypto, and there's nothing scary here:
- **Created in about 10 seconds.** No forms, no paperwork.
- **Secured by Face ID or fingerprint.** No password to remember.
- **Email is only used to recover the account.** Never for spam.
- **Available on the App Store and Google Play.** A quick install means customers can reach and withdraw their money fast.
Signing up is this light on purpose: the friend who clicks can go from "never heard of Frak" to "earning a reward" in a couple of taps.
## How they get their money
Customers always see exactly where a reward stands:
- **Awaiting validation**: the reward is reserved while the order is being confirmed.
- **To collect**: the sale is confirmed and the money is theirs.
- **Cancelled**: if the order is refunded or cancelled, the reward is voided too, so you never pay for a sale that didn't stick.
Once a reward is theirs, it lands **right in their Frak app**. From there they can **withdraw it straight to their bank account**, with no extra steps and nothing for you to handle.
You stay protected. Rewards are only released on confirmed sales, and a refund automatically cancels the matching reward.
## Where customers discover you
Most sharing happens right on your store, through the buttons and cards you place. Customers can also find you in the **Frak Explorer**, a directory inside the Frak app where people browse brands worth sharing. Listing there is optional and free.
## Make it happen on your store
# The business dashboard
> Your home for everything Frak outside Shopify. Register your site, fund rewards, launch campaigns, and track results.
import { Aside, CardGrid, LinkCard } from '@astrojs/starlight/components';
# The business dashboard
The [business dashboard](https://business.frak.id/) is where you set up and run Frak. You register your site, fund your rewards, launch campaigns, and watch how they perform, all in one place.
Each store you add is a **merchant**. You can manage several from the same account and switch between them at any time.
## What you can do
## Finding your way around
Once you open a merchant, the dashboard is organized into a few simple areas:
- **My Merchants**: all your stores. Pick one to manage it, or add a new one.
- **Campaigns**: create campaigns and follow their results, including a **Data overview** of everything at a glance.
- **Members**: the customers who joined by sharing your store. Filter them and reach out.
- **Push**: send a push notification to your members.
- **Wallet**: your reward budget and payouts.
- **Settings**: your account preferences, like language and currency.
Terms like **ambassador**, **referee**, and **reward budget** are explained in the [glossary](/guides/glossary/).
## A typical first run
# Merchant settings
> Update your store's name and currency, allow extra domains, grab your newsletter sharing link, and check purchase tracking.
import { Aside, LinkCard } from '@astrojs/starlight/components';
# Merchant settings
Everything about your store lives under **Edit** for your merchant: its name and currency, the domains allowed to use it, a ready-made link for your newsletter, and the status of purchase tracking.
## Store details
Update your **merchant name** and **default reward currency** any time. Your domain is shown here too. Click **Edit**, make your change, then **Save**.
The currency here is the default for new campaigns. You can still pick a different currency on any individual campaign.
## Allowed domains
If your store runs on more than one address, add the extras under **Allowed domains** so Frak recognizes them all. A common case is a Shopify store that also uses its `myshopify.com` address.
Type the domain (like `mystore.myshopify.com`), click **Add domain**, and save. Remove one any time with **Remove**.
Your main registered domain already works. You only need this for additional domains or subdomains.
## Newsletter sharing link
Want to invite your existing customers to share? Copy your **newsletter sharing link** and drop it into any marketing email. When a customer clicks it, your storefront opens with the Frak sharing window ready, pre-filled with your current rewards, so they can share and earn in one tap.
## Purchase tracking
The **Purchase tracker** shows whether Frak is receiving orders from your store, which is what lets campaigns reward real sales. You'll see the connection status, the platform in use, and when the last purchase came in.
For most stores this is set up automatically by your platform app:
If you built your store yourself, you can register the webhook manually here. The full setup is in the [purchase webhook reference](/developers/api/webhook/).
# Customize appearance
> Match Frak to your brand. Set your name, logo, and wording, and choose how your store appears in the Frak Explorer.
import { Aside, LinkCard } from '@astrojs/starlight/components';
# Customize appearance
Everything customers see from Frak can match your brand: the name and logo on the share button, the wording on each component, and how your store shows up in the Frak Explorer. You'll find it all under **Customize** for your merchant.
Changes show a live preview as you edit, so you always see what your customers will see. Click **Save** when you're happy.
## Your brand identity
These defaults apply everywhere Frak appears on your store:
- **Name**: your brand name, shown to visitors.
- **Logo**: displayed next to your name.
- **Homepage link**: where visitors go when they click your name.
- **Currency**: how reward amounts are shown. Leave on **Auto** to match the visitor.
- **Language**: the language of Frak's text. **Auto** detects it from the visitor's browser.
There's also a **Frak SDK displayed** switch. Turn it off to hide Frak from your storefront completely, without uninstalling anything.
## Wording for each component
You can tailor the text on each Frak component to your voice:
- **Share button**: the button label, with a version for when no reward applies.
- **Banner**: the welcome message for referred visitors.
- **Post-purchase card**: the prompt shown right after checkout.
Pick the wording that fits your brand, preview it, and save.
Advanced options like multiple **placements** (different wording or styles on different pages) and custom CSS are available too. For the full list of settings, see the [components reference](/developers/components/).
## Appear in the Frak Explorer
The **Frak Explorer** is where app users discover stores worth sharing. Listing your brand there is optional and free.
- **Listed in Explorer**: turn your listing on or off.
- **Hero image**: the main banner on your Explorer page (you can add a few more as a slider).
- **Logo** and **Description**: a short, compelling pitch for why people should share you.
Turning the Explorer listing off doesn't affect your running campaigns. Customers who already have your sharing links keep earning. Your brand simply won't appear in the Explorer directory.
Open your merchant and go to **Manage Budget** (also shown as **Wallet**). Everything below lives there.
## Set up your budget
The first time, click **Set Up Budget**. This creates the budget your campaigns draw from. You only do it once per merchant.
## Add funds
1. Click **Add funds**.
2. Enter the amount and pay by card. **Stripe** handles the payment securely, so Frak never sees your card details.
3. Your new balance appears under **Reward Budget** once the payment clears.
Top-ups take **1 to 5 business days** to clear. Like any payment, they go through standard security and anti-money-laundering checks before the funds land in your balance.
## Turn payouts on or off
A **Distributing Rewards** toggle controls whether active campaigns can pay out:
- **On**: rewards are sent automatically as customers refer and buy.
- **Off**: payouts pause. Your campaigns and balance stay exactly as they are, nothing is lost.
If your budget runs empty, active campaigns can't reward customers until you add funds. The dashboard shows a clear banner when that happens.
## Get money back
Need to pull unused funds back? Turn **Distributing Rewards** off, then use **Withdraw funds**. Your available balance returns to your wallet. Rewards already promised to customers stay reserved, so you only ever withdraw what's truly free.
Funded and ready? [Create a campaign](/guides/campaigns/create/) to decide what customers earn.
# Team & roles
> Invite teammates to help manage your store on Frak, and remove them when needed. All by Frak wallet address.
import { Aside, Steps } from '@astrojs/starlight/components';
# Team & roles
You can invite teammates to help run your store on Frak. Everyone is added by their Frak wallet address, and changes are confirmed with your fingerprint or face unlock, so only you can edit the team.
Open your merchant and go to **Team** (also reachable from **Manage your team** in the merchant settings).
## The two roles
- **Owner**: the account that registered the store. Full control, including the team and budget.
- **Admin**: a trusted teammate who can manage the day-to-day, such as campaigns, funds, and appearance.
That's the whole model. There's nothing complicated to assign.
## Add a teammate
1. Click **Add Team Member**.
2. Paste their **Frak wallet address** (it starts with `0x`). They can find it on their [Frak wallet settings page](https://wallet.frak.id/settings).
3. Click **Add member**, then **Save all changes** and confirm with your fingerprint or face unlock.
Ask your teammate to create their free Frak account first, then share their wallet address with you. That address is all you need to add them.
## Remove a teammate
Click **Remove member** next to their name, then **Save all changes** and confirm. Changed your mind before saving? Use **Undo remove**.
With your team in place, fine-tune your [merchant settings](/guides/dashboard/configure/edit/).
# Register your site
> Add your site to Frak in a short two-step form. Enter your details, verify your domain with one DNS record, and confirm.
import { Tabs, TabItem, Aside, CardGrid, LinkCard } from '@astrojs/starlight/components';
# Register your site
Adding your site to Frak is a short, two-step form. You enter a few details, prove the site is yours with one DNS record, and confirm. It takes a few minutes, and you only do it once.
Be signed in to the [business dashboard](https://business.frak.id/), and have access to your domain's DNS settings (usually where you bought your domain or host your site).
## Add your details
In the [business dashboard](https://business.frak.id/), start a new site. On the **Add merchant details** screen, fill in:
- **Merchant Name**: your store or brand name. This is what customers see.
- **Currency**: the currency your rewards are paid in. Most merchants keep the default (**EURe**).
- **Domain Name**: your website address, like `example.com`.
- **Setup Code**: optional. Leave it blank unless Frak gave you one.
**EURe** (by Monerium) is easiest if you'd like funding by bank transfer (IBAN). **USDC** (by Circle) is a good fit if you or your customers already use crypto. You can keep the default and move on.
## Verify your domain
This proves the site is yours, so no one else can claim it. As soon as you enter your domain, Frak shows a **DNS TXT record**. Copy it, add it at your domain provider, and you're verified.
Pick your provider for the exact clicks:
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your domain.
2. In the sidebar, open **DNS → Records**.
3. Click **Add record**.
4. Set **Type** to **TXT**, **Name** to `@`, and paste the record into **Content**.
5. Leave **TTL** on **Auto** and click **Save**. Cloudflare usually applies TXT records within minutes.
1. Log in to the [OVHcloud Control Panel](https://www.ovh.com/manager/) and open **Web Cloud → Domain names**.
2. Select your domain, then open the **DNS zone** tab.
3. Click **Add an entry** and choose **TXT**.
4. Leave **Sub-domain** empty (for your root domain) and paste the record into the **Value** field.
5. Click **Next**, then **Confirm**. OVHcloud publishes the record after a short delay.
1. Log in to the [Infomaniak Manager](https://manager.infomaniak.com) and open **Domain names**.
2. Select your domain and open the **DNS zone**.
3. Click **Add a record** and choose **TXT**.
4. Leave the **Source** empty or set it to `@`, then paste the record into the **Target** field.
5. Click **Save** to apply your changes.
1. Sign in to GoDaddy and open **My Products**.
2. Next to your domain, select **DNS** (or **Manage DNS**).
3. In the **Records** section, click **Add** and choose **TXT**.
4. Set **Name** to `@` and paste the record into **Value**; leave **TTL** on the default.
5. Click **Save**.
1. Sign in to Namecheap and open **Domain List**, then **Manage** next to your domain.
2. Open the **Advanced DNS** tab.
3. Click **Add New Record** and choose **TXT Record**.
4. Set **Host** to `@` and paste the record into **Value**; leave **TTL** on **Automatic**.
5. Click the green check to save the record.
1. Sign in to your domain provider, usually where you bought the domain or host your site.
2. Find the DNS area. It may be called **DNS management**, **DNS zone**, **Advanced DNS**, or **Name server management**.
3. Add a new record with **Type** set to **TXT**.
4. Put `@` (or the host shown by Frak) in the **Name / Host** field, and paste the record into the **Value** field.
5. Save your changes. If you can't find the DNS settings, contact your provider's support.
- The **Name** field may also be called **Host**, **Hostname**, or **Alias**. Most providers accept **@** for your root domain.
- The **Value** field may also be called **Content**, **Data**, or **Target**: paste the record there.
When the record is in, click **Continue**. Frak checks it for you.
DNS changes can take a few minutes to show up (sometimes up to an hour). If Frak can't find the record yet, wait a little and click **Continue** again. The record is public, which is normal and safe.
## Confirm and register
On the **Merchant registration** screen, review the **Summary** (your name, domain, and currency). When it looks right, click **Complete Registration** and approve with your fingerprint or face unlock. No password to remember.
That's it, usually in under a minute. Your site is registered and ready.
## You're registered, what's next
## If something looks off
- **"A merchant already exists for this domain."** Your site is already registered, possibly under another account. Reach out from the [business dashboard](https://business.frak.id/) if that's unexpected.
- **"The DNS TXT record is not set."** The record isn't visible yet. Double-check you pasted the exact value at your provider, then wait a few minutes and click **Continue** again.
# Common questions
> Quick answers to the questions merchants ask most about Frak. Crypto, costs, refunds, control, and privacy.
import { Aside, LinkCard } from '@astrojs/starlight/components';
# Common questions
Short, straight answers to what merchants ask most before going live.
## Your customers
**Do my customers need crypto, or a wallet, to take part?**
No. They create a free Frak wallet in about 10 seconds with Face ID or a fingerprint, no crypto knowledge, no jargon, no money up front. See [what your customers see](/guides/customer-journey/).
**Is this really my customers, or strangers?**
It's your real customers and the friends they personally invite. That's warm, trusted word-of-mouth, not cold ads.
**Can customers actually cash out their rewards?**
Yes. They can transfer their earnings to their bank account from the wallet whenever they like.
## Costs and payments
**How much does Frak cost?**
Frak takes a **20% commission** on your campaign budget. The other 80% goes to your customers as rewards. You only pay on real, confirmed sales.
**When are rewards actually paid?**
Only when a sale is confirmed. Until then the reward is held as "awaiting validation", so nothing leaves your budget for an order that isn't final.
**What happens if an order is refunded?**
The matching reward is cancelled automatically. You never pay for a sale that didn't stick.
**Can I control my spending?**
Yes. Set a budget cap (overall, or daily, weekly, monthly), pause a campaign any time, or switch reward payouts off entirely. [Add funds](/guides/dashboard/configure/funds/).
**Which currencies can I use?**
EUR, USD, or GBP via Monerium, or USDC via Circle. Most merchants keep the default (EURe).
## Setup and privacy
**Do I need to write code?**
Not for Shopify, WordPress, or PrestaShop, they all have ready-made apps. A fully custom site needs a little setup. [Pick your platform](/guides/).
**How long does setup take?**
About 5 minutes for most stores: install, connect, fund, and launch.
**Is my customers' data safe?**
Yes. A customer's email is only ever used to recover their wallet, never for unsolicited messages.
Still stuck? Every platform guide has its own troubleshooting section, and the [glossary](/guides/glossary/) explains any unfamiliar terms.
Steps 1 and 3 happen in the business dashboard. Step 2 is a quick plugin install on your own site.
## The three steps
1. **Register your site.** Sign in to the [business dashboard](https://business.frak.id/) and add your website. To prove the site is yours, you'll add a small verification record at your domain provider, a one-time check that takes a couple of minutes. See [Register your site](/guides/dashboard/register/).
2. **Install Frak on your site.** Pick your platform below and follow the matching guide.
3. **Set up your rewards.** Back in the business dashboard, [add a budget](/guides/dashboard/configure/funds/) and [create your first campaign](/guides/campaigns/create/). This is where you fund rewards and decide how much customers earn.
## Step 2: install Frak on your site
## What you'll manage in the dashboard
If your shop runs on a subdomain (like `shop.your-store.com`) that differs from the domain you registered, add it under **Allowed Domains** in the dashboard before installing, otherwise tracking won't connect.
# Add Frak to a custom website
> Add Frak to any custom-built site with a few lines of code, then confirm real orders with a signed webhook from your backend.
import { Tabs, TabItem, Steps, Aside, LinkCard, CardGrid } from '@astrojs/starlight/components';
# Add Frak to a custom website
For a custom-built site, adding Frak takes two parts:
1. **Add the Frak components to your site.** Load Frak, set one config object, and drop in the share button, the welcome banner, and the post-purchase card. Pick the setup that matches your stack below.
2. **Validate purchases from your backend.** Confirm real orders with a signed webhook, so rewards only go out on genuine sales.
Register your site and add your domain in the [business dashboard](https://business.frak.id/) first. Your merchant ID is then resolved automatically from your domain, so the config below stays short. See [Register your site](/guides/dashboard/register/).
## The components
All three components are framework-agnostic [web components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components), so they work the same whether you write plain HTML, use a bundler, or build with React.
| Component | Where it goes | What it does |
| --- | --- | --- |
| `` | Product page, homepage | Lets customers share your store and earn rewards |
| `` | Top of the page | Welcomes referred visitors |
| `` | Order confirmation page | Prompts a share right after checkout, and tracks the order |
In HTML and JSX, multi-word attributes must be written with dashes, not camelCase: use `customer-id`, not `customerId`. Browsers lowercase attribute names, so a camelCase attribute is silently ignored.
## 1. Add Frak to your site
### Load and configure Frak
Add this to the `` of your pages. The config object is read by Frak when it loads, so set it **before** the script tag.
```html title="index.html"
```
### Add the components
Place the banner near the top of your ``, and the share button wherever you want customers to share:
```html
### Install
```bash
npm install @frak-labs/components @frak-labs/core-sdk
```
### Configure Frak
Set the config in its own module so it runs first:
```ts title="frak-setup.ts"
import type { FrakWalletSdkConfig } from "@frak-labs/core-sdk";
declare global {
interface Window {
FrakSetup: { config?: FrakWalletSdkConfig };
}
}
window.FrakSetup = {
config: {
metadata: {
name: "Your Store",
currency: "eur",
},
},
};
```
### Register the components
Import your config module first, then import each component you use. Importing a component registers its custom element and boots the SDK from `window.FrakSetup.config`:
```ts title="main.ts"
import "./frak-setup";
import "@frak-labs/components/banner";
import "@frak-labs/components/buttonShare";
import "@frak-labs/components/postPurchase";
```
Then drop the elements into your markup, exactly like the HTML tab:
```html
The visual components are the same web components, used inside JSX. Install them and (optionally) `@frak-labs/core-sdk` for direct action calls:
```bash
npm install @frak-labs/components @frak-labs/core-sdk
```
### Configure and register
Set the config in its own module, then import it (and the components) before you render your app:
```ts title="frak-setup.ts"
import type { FrakWalletSdkConfig } from "@frak-labs/core-sdk";
declare global {
interface Window {
FrakSetup: { config?: FrakWalletSdkConfig };
}
}
window.FrakSetup = {
config: {
metadata: {
name: "Your Store",
currency: "eur",
},
},
};
```
```tsx title="main.tsx"
import "./frak-setup";
import "@frak-labs/components/banner";
import "@frak-labs/components/buttonShare";
import "@frak-labs/components/postPurchase";
import { createRoot } from "react-dom/client";
import { App } from "./App";
createRoot(document.getElementById("root")!).render(
TypeScript may not recognize the `` tags in JSX. Add a small declaration so it does:
```ts title="frak.d.ts"
import type { HTMLAttributes } from "react";
declare global {
namespace JSX {
interface IntrinsicElements {
"frak-banner": HTMLAttributes;
"frak-button-share": HTMLAttributes & { classname?: string; text?: string };
"frak-post-purchase": HTMLAttributes & {
"customer-id"?: string;
"order-id"?: string;
token?: string;
};
}
}
}
```
On React 19, declare the same `namespace JSX` inside `declare module "react"` instead of `declare global`.
For custom flows (wallet status, referral hooks, opening the modal yourself), `@frak-labs/react-sdk` exposes React hooks and providers. See the [React integration guide](/developers/integration/react/).
The full attribute list for each component lives in the developer reference: [share button](/developers/components/share-button/), [banner](/developers/components/banner/), [post-purchase](/developers/components/post-purchase/), and the [`FrakSetup` config](/developers/components/frak-setup/).
## 2. Validate purchases from your backend
Tracking on the page tells Frak an order *might* be coming. Rewards only fire once your backend confirms the order is real with a signed webhook. This keeps rewards tied to genuine, paid sales.
1. **The page registers the order.** The post-purchase card (or `trackPurchaseStatus`) sends `customerId`, `orderId`, and `token` so Frak starts listening for that order.
2. **Your backend confirms it.** When the order is paid (or refunded, cancelled), your server sends a webhook to Frak with the same identifiers and an HMAC signature.
3. **Frak triggers the reward.** Once the signature checks out and the status is `confirmed`, Frak sends the `PurchaseCompleted` interaction, which can pay out rewards based on your active campaigns.
Your webhook URL and signing secret are in the [business dashboard](https://business.frak.id/), under the **Purchase Tracker** section of your merchant. Sign the entire request body with HMAC SHA-256 and send it in the `x-hmac-sha256` header.
```ts
import crypto from "node:crypto";
async function sendPurchaseWebhook(order: {
id: string;
customerId: string;
status: "pending" | "confirmed" | "cancelled" | "refunded";
token: string;
currency?: string;
totalPrice?: string;
}) {
const body = JSON.stringify(order);
const hmac = crypto
.createHmac("sha256", process.env.FRAK_WEBHOOK_SECRET)
.update(body)
.digest("hex");
await fetch(process.env.FRAK_WEBHOOK_URL, {
method: "POST",
headers: {
"Content-Type": "application/json",
"x-hmac-sha256": hmac,
// Use "true" while testing, "false" in production
"x-test": "false",
},
body,
});
}
await sendPurchaseWebhook({
id: "order_456",
customerId: "cust_123",
status: "confirmed",
token: "a-unique-order-token",
currency: "EUR",
totalPrice: "99.99",
});
```
```php
function sendPurchaseWebhook(array $order): void {
$url = getenv('FRAK_WEBHOOK_URL');
$secret = getenv('FRAK_WEBHOOK_SECRET');
$body = json_encode($order);
$hmac = hash_hmac('sha256', $body, $secret);
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $body,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'x-hmac-sha256: ' . $hmac,
'x-test: false', // "true" while testing
],
]);
curl_exec($ch);
curl_close($ch);
}
sendPurchaseWebhook([
'id' => 'order_456',
'customerId' => 'cust_123',
'status' => 'confirmed',
'token' => 'a-unique-order-token',
'currency' => 'EUR',
'totalPrice' => '99.99',
]);
```
The webhook's `id` is the same value as the `order-id` on the page, and `customerId` and `token` must match the values you sent when tracking. If they differ, Frak cannot link the confirmation to the order and no reward fires.
See the [Purchase webhook reference](/developers/api/webhook/) for the full payload (including line items) and the [track purchase endpoint](/developers/api/track-purchase/) for the page-side call.
## Next steps
# Install Frak on PrestaShop
> Add Frak to your PrestaShop store in three simple steps. Install the module, paste one key, and start rewarding customers for sharing.
import { Steps, Aside, LinkCard, CardGrid } from '@astrojs/starlight/components';
# Install Frak on PrestaShop
Adding Frak to PrestaShop takes about five minutes. You install a module, paste one key from your dashboard, and Frak starts tracking referrals and rewards. The buttons even appear on the right pages on their own.
You'll need admin access to your PrestaShop back office and a free [Frak account](https://business.frak.id/) with [your site registered](/guides/dashboard/register/). That only takes a couple of minutes, and you do it once.
## Install the module
1. Download the latest **Frak module** from the [releases page](https://github.com/frak-id/wallet/releases?q=PrestaShop+Module&expanded=true). It's the `frakintegration-.zip` file.
2. In your back office, go to **Modules → Module Manager → Upload a module** and drop the zip in.
3. Click **Configure** on the **Frak** module to open its settings.
## Connect your store
This is the only key you'll ever copy. It links your store to your Frak account.
1. In the [business dashboard](https://business.frak.id/), open your store and go to **Purchase Tracker**. Select **PrestaShop**, click **Register**, and copy the key it shows you.
2. On the Frak settings page, scroll to **Purchase Tracking → Webhook Secret** and paste the key.
3. Check that the **Merchant** line shows a green **Connected** badge, then click **Save Settings**.
If the badge stays red, make sure your store's domain is registered in the dashboard, then open the **Maintenance** panel and click **Refresh Merchant**. More in [Settings & tracking](/guides/platforms/prestashop/details/).
That's it. Your store is connected, and Frak starts tracking orders right away.
## You're live, now make it shine
The share button, banner, and post-purchase card appear automatically on the right pages. From here you can fine-tune where they show, fund your rewards, and launch a campaign.
Brand settings, order tracking, the retry queue, and troubleshooting live in [Settings & tracking](/guides/platforms/prestashop/details/).
# Choose where Frak buttons appear on PrestaShop
> Turn each Frak component on or off and adjust where it shows on your PrestaShop storefront.
import { Aside, LinkCard } from '@astrojs/starlight/components';
# Choose where Frak buttons appear on PrestaShop
Once Frak is [installed and connected](/guides/platforms/prestashop/), the three components already show on the right pages. You can turn any of them off or fine-tune them from the **Component Placements** panel on the Frak settings page.
| Component | Where it shows | On by default | Options |
| --- | --- | --- | --- |
| **Share button** | Product pages | Yes | Button style: Primary, Secondary, or None |
| **Banner** | Top of the storefront | Yes | Custom CSS class |
| **Post-purchase card** | Order confirmation page | Yes | None |
| **Post-purchase card** | Customer order details | Yes | None |
Each placement is a simple checkbox. Uncheck the ones you don't want, then **Save** to apply.
The post-purchase card shows on both the thank-you page and the order details page, so customers who open their order straight from the confirmation email are still counted. Frak won't reward the same order twice.
## Put a component somewhere else
Need Frak on a page the checkboxes don't cover, like a CMS page or a custom block in your theme? Use the bundled Smarty tags in any `.tpl` file:
```smarty
{frak_banner placement="hero" referral_title="Welcome back!"}
{frak_share_button text="Share & earn up to {REWARD}" no_reward_text="Share & earn" placement="sidebar"}
{frak_post_purchase variant="referrer" cta_text="Earn rewards"}
```
The post-purchase tag needs the order context to track a sale. It's filled in automatically on the order pages, so only use `{frak_post_purchase}` elsewhere if you know how to pass that context yourself.
## Buttons not showing?
Confirm the placement is checked in **Component Placements**, then clear your cache (**Advanced Parameters → Performance → Clear cache**). Some themes remove the product or header hooks Frak uses, so if a checked placement still shows nothing, check that theme template. Full steps are in [Settings & tracking](/guides/platforms/prestashop/details/).
## Next
The full list of settings for each component lives in the [developer components reference](/developers/components/).
# PrestaShop settings & tracking
> Requirements, brand fields, order tracking, the retry queue, and troubleshooting for the Frak PrestaShop module.
import { Aside, Tabs, TabItem, LinkCard } from '@astrojs/starlight/components';
# PrestaShop settings & tracking
The reference for everything beyond the [basic setup](/guides/platforms/prestashop/): requirements, brand fields, how order tracking keeps itself reliable, and what to do when something looks off.
## Requirements
- **PrestaShop 8.1+** with **PHP 8.1+**.
- The module ships everything it needs inside the zip. There's nothing to install on a command line.
If your store runs on a subdomain (like `shop.your-store.com`) that's different from the domain you registered, open **Allowed Domains** in the dashboard and add it before installing. Otherwise tracking won't connect.
## Brand fields
The **Website Information** panel sets what customers see in the Frak window:
- **Shop Name**: defaults to your PrestaShop shop name. Used as the title.
- **Logo**: paste a public **Logo URL**, or use **Or upload a file** (JPG, PNG, GIF, or SVG up to 2 MB). The preview on the right updates as you type.
The rest of the wording and translations are managed from the [business dashboard](https://business.frak.id/). Click **Save Settings** when done.
If your logo doesn't load in the Frak window, upload the file instead of linking to it. Uploaded logos avoid third-party caching and CORS issues.
## How order tracking stays reliable
When an order's status changes, the module tells Frak so rewards go out on real sales. If a message can't get through, it's saved and retried automatically (up to 5 times, spaced further apart each time). To make sure those retries actually run, set up one of the two options below.
Install the official **ps_cronjobs** module from the Module Manager. Frak registers itself automatically, and the **Retry Cron** line on the settings page turns green. Nothing else to do.
The **Retry Cron** line shows a ready-made URL. Add it to a cron that runs every 5 minutes, for example with `crontab -e`:
```cron
*/5 * * * * curl -fs 'https://your-shop.example/index.php?fc=module&module=frakintegration&controller=cron&token='
```
The URL includes a private token from your settings page, so keep it to yourself.
You can also run a retry on demand: open **Maintenance → Webhook queue** and click **Drain queue now**.
## Keep an eye on the queue
The **Maintenance → Webhook queue** panel shows the health of order tracking at a glance:
- **Pending**: waiting for the next attempt.
- **Delivered**: sent successfully.
- **Parked (failed)**: gave up after retrying. A red badge appears if this isn't zero.
- **Last error**: the most recent problem, with a timestamp.
### Which order statuses count
Orders that reach **Awaiting payment validation**, **Payment accepted**, **Delivered**, or **Awaiting payment (out of stock)** are tracked as confirmed sales. **Cancelled** and **Payment error** mark the sale as cancelled, and any refund (including partial refunds and returns) marks it as refunded. **Preparation in progress** and **Shipping** are ignored on purpose, so they don't clutter your results.
## Troubleshooting
- **Merchant says "Not resolved for this domain".** Confirm your store's domain is registered on the [dashboard](https://business.frak.id/), then open **Maintenance** and click **Refresh Merchant**. (Your main domain works automatically; only subdomains need adding.)
- **Deliveries failing right after setup.** Re-copy the key from **Purchase Tracker → PrestaShop** in the dashboard, paste it back into **Webhook Secret**, and click **Save Settings**.
- **Parked count keeps growing.** Open **Advanced Parameters → Logs** and filter on `FrakIntegration`. The **Last error** line on the queue panel usually points straight at the cause.
- **Buttons missing on the storefront.** Confirm the placement is enabled in [Component Placements](/guides/platforms/prestashop/components/) and clear your cache (**Advanced Parameters → Performance → Clear cache**).
## For developers
The Frak PrestaShop module is open source, inside the [Frak wallet monorepo](https://github.com/frak-id/wallet) under `plugins/prestashop`. Open an issue or a pull request any time.
You'll need admin access to your WordPress site and a free [Frak account](https://business.frak.id/) with [your site registered](/guides/dashboard/register/). That only takes a couple of minutes, and you do it once.
## Install the plugin
1. Download the latest **Frak plugin** from the [releases page](https://github.com/frak-id/wallet/releases?q=wordpress+plugin&expanded=true). It's the `frak-integration.zip` file.
2. In your WordPress admin, go to **Plugins → Add New Plugin → Upload Plugin**.
3. Pick the zip file, click **Install Now**, then **Activate**.
Turn on **auto-updates** next to Frak in **Plugins → Installed Plugins** so you always have the latest version.
## Connect your store
This is the only key you'll ever copy. It links your store to your Frak account.
1. In the [business dashboard](https://business.frak.id/), open your store and go to **Purchase Tracker**. Select **WooCommerce**, click **Register**, and copy the key it shows you.
2. In WordPress, go to **Settings → Frak** and paste the key into **Webhook Secret**.
3. Check that the **Merchant** line shows a green **Connected** badge, then click **Save Settings**.
After saving, scroll to **WooCommerce Webhook** and click **Set up webhook**. Frak now tracks orders for you, so rewards only go out on real sales. The plugin handles everything else. See [Settings & webhooks](/guides/platforms/wordpress/details/) if you'd like the details.
That's it. Your store is connected.
## You're live, now make it shine
Brand settings, webhook setup, delivery logs, and troubleshooting live in [Settings & webhooks](/guides/platforms/wordpress/details/).
# Add Frak buttons on WordPress
> Place the Frak share button, banner, and post-purchase card on your WordPress pages with a block, shortcode, widget, or Elementor widget.
import { Tabs, TabItem, Aside, LinkCard } from '@astrojs/starlight/components';
# Add Frak buttons on WordPress
Once Frak is [installed and connected](/guides/platforms/wordpress/), you choose where your customers see it. There are three Frak components, and you can add each one the way that fits your theme: a block, a shortcode, a widget, or an Elementor widget.
| Component | What it does |
| --- | --- |
| **Share button** | Lets customers share your store and earn rewards. |
| **Banner** | Welcomes referred visitors at the top of the page. |
| **Post-purchase card** | Invites customers to share right after they buy. |
Add the **post-purchase card** to your order confirmation page first. Showing the share prompt right after checkout converts best.
## Add a component
Pick the method that matches how you edit your site.
1. Open the post, page, or template part in the editor (for block themes: **Appearance → Editor**).
2. Click the **+** where you want the component and search for **Frak**.
3. Choose **Frak Share Button**, **Frak Banner**, or **Frak Post-Purchase**.
4. Adjust the options in the sidebar, then save.
Paste the matching shortcode into any page, post, or builder that accepts shortcodes:
```text
[frak_share_button text="Share and earn!"]
[frak_banner]
[frak_post_purchase variant="referrer"]
```
From a theme template you can also call it in PHP:
```php
echo do_shortcode( '[frak_share_button text="Share & earn"]' );
```
Go to **Appearance → Widgets**, pick the sidebar or footer area, and add **Frak Share Button**, **Frak Banner**, or **Frak Post-Purchase**. Each one has a simple form with the same options as the block.
If your site uses **Elementor**, the plugin adds a **Frak** category in the editor. Drag **Frak Share Button**, **Frak Banner**, or **Frak Post-Purchase** onto the canvas and tune the controls on the right.
The share button picks up your theme's button styling automatically, so it matches the rest of your site out of the box.
## Block, shortcode, and widget names
If you need the exact identifiers (for a page builder search or a template), here they are:
| Component | Block | Shortcode | Widget |
| --- | --- | --- | --- |
| Share button | `frak/share-button` | `[frak_share_button]` | Frak Share Button |
| Banner | `frak/banner` | `[frak_banner]` | Frak Banner |
| Post-purchase card | `frak/post-purchase` | `[frak_post_purchase]` | Frak Post-Purchase |
## Next
The full list of settings for each component lives in the [developer components reference](/developers/components/).
# WordPress settings & webhooks
> Requirements, brand fields, WooCommerce order tracking, delivery logs, and troubleshooting for the Frak WordPress plugin.
import { Aside, LinkCard } from '@astrojs/starlight/components';
# WordPress settings & webhooks
The reference for everything beyond the [basic setup](/guides/platforms/wordpress/): requirements, brand fields, order tracking, and what to do when something looks off.
## Requirements
- **WordPress 6.4+** and **PHP 8.0+**.
- **WooCommerce** is optional. You only need it for purchase tracking, and the plugin is HPOS-compatible.
If your store runs on a subdomain (like `shop.your-store.com`) that's different from the domain you registered, open **Allowed Domains** in the dashboard and add it before installing. Otherwise tracking won't connect.
## Brand fields
In **Settings → Frak**, under **Website Information**, you can set what customers see in the Frak window:
- **App Name**: defaults to your site name. Click **Use Site Name** to fill it.
- **Logo URL**: defaults to your site icon. Click **Use Site Icon**, or upload your own.
The rest of the wording and translations are managed from the [business dashboard](https://business.frak.id/), so the WordPress page only covers these two fields. Click **Save Settings** when done.
## Order tracking with WooCommerce
After you paste your key and save, the **WooCommerce Webhook** section lets Frak know when an order is placed, so rewards go out on real sales.
1. Click **Set up webhook**. (It stays disabled until your merchant is connected and the key is saved.)
2. Look for the green banner: **WooCommerce webhook active**. The **Secret in WooCommerce** line should read **matches the secret saved above**.
That's the whole setup. WooCommerce handles retries and delivery on its own, so you don't have to maintain anything.
- The webhook itself: **WooCommerce → Settings → Advanced → Webhooks**.
- Delivery logs: **WooCommerce → Status → Logs**, source `webhooks-delivery`.
If the banner is yellow instead of green, the message tells you exactly what's off and which button to click (**Re-enable webhook**, **Sync webhook**, and so on).
## Troubleshooting
- **Merchant says "Not resolved for this domain".** Add your site's domain under **Allowed Domains** on the [dashboard](https://business.frak.id/), then click **Refresh Merchant** on the plugin settings page. (Your main domain works automatically; only subdomains need adding.)
- **Tracking stopped after a domain change.** Same fix: add the new domain, then click **Refresh Merchant**. The webhook re-points itself automatically.
- **"Secret does not match".** Re-copy the key from **Purchase Tracker → WooCommerce** in the dashboard, paste it back in **Settings → Frak**, save, then click **Sync webhook**.
- **"Vendor folder missing" notice.** You unzipped a developer copy instead of the packaged release. Download `frak-integration.zip` from the [releases page](https://github.com/frak-id/wallet/releases?q=wordpress+plugin&expanded=true).
## For developers
The Frak app does the technical work for you. Most steps are a single click. You just confirm.
## Before you start
- An active Shopify store you can sign in to as an admin.
- A few minutes to follow the in-app setup.
You don't need a crypto wallet beforehand. You'll create your free Frak account during setup.
## Set it up
1. **Install the Frak app.** Open the [Frak app on the Shopify App Store](https://apps.shopify.com/frak) and click **Add app**. Shopify adds it to your store and opens the Frak setup screen.
{/* screenshot: /img/guides/shopify/getting-started/01-install-app.png */}
2. **Connect your Frak account.** The first screen asks you to connect with a Frak wallet. This is your free Frak account.
- **New to Frak?** Choose **Create an account** and follow the secure sign-up. It uses your device's fingerprint or face unlock, with no password to remember.
- **Already have an account?** Choose **I already have an account** and sign in.
Both options take you through the Frak sign-in screen, then back into the app.
{/* screenshot: /img/guides/shopify/getting-started/02-connect-wallet.png */}
3. **Run the guided setup.** The app walks through five quick checks and confirms each one for you. The first four happen automatically; the last opens your theme editor, where you toggle Frak **on** and click **Save**.
{/* screenshot: /img/guides/shopify/getting-started/03-guided-setup.png */}
That's it. Your store is connected and ready.
### What the guided setup does
You don't need to understand the details, but here's what's happening behind each check:
| Setup check | What it does for you |
| --- | --- |
| **Connect your store** | Creates your store on Frak so rewards can be tracked. |
| **Turn on tracking** | Recognizes customers who arrive from a friend's link. |
| **Send purchases to Frak** | Lets Frak know when an order is placed. |
| **Secure your purchases** | Confirms orders are genuine, so rewards only go out on real sales. |
| **Activate Frak in your theme** | Switches Frak on across your storefront. |
The app handles tracking, webhooks, and security keys for you. You never copy snippets or edit code.
## You're live, now make it shine
Your store is connected. Next, add the buttons your customers will use and fund your rewards:
Start with the **post-purchase card**: showing the share prompt right after checkout converts best.
## Need a hand?
- Each setup step shows its own status and hints inside the app.
- For deeper analytics and settings, open the [business dashboard](https://business.frak.id/) with the same account.
- The Frak Shopify app is [open source](https://github.com/frak-id/wallet). Report an issue or contribute any time.
# Customize appearance (Shopify)
> Adjust your brand name, logo, and the wording shown to customers.
import { Aside } from '@astrojs/starlight/components';
# Customize appearance
A full walkthrough with screenshots is on its way. Here's the short version.
Make Frak feel like part of your brand. Open the **Appearance** tab in the Frak app, where everything is organized into a few sub-tabs:
- **Text Customizations**: your **logo** and the **wording** shown in share prompts and reward messages.
- **Share Button** and **Banner**: turn each placement on and configure where it appears on your storefront.
- **Checkout Extension**: the post-purchase card shown on the checkout thank-you and order status pages.
- **Explorer**: how your store appears in the **Frak Explorer**, where customers discover brands.
{/* screenshot: /img/guides/shopify/appearance/01-appearance-tab.png */}
Coming soon: detailed steps and screenshots.
# Add sharing buttons (Shopify)
> Add the share button and post-purchase card to your Shopify storefront.
import { Aside } from '@astrojs/starlight/components';
# Add sharing buttons
A full step-by-step with screenshots is on its way. Here's the short version.
Once your store is connected, add the buttons customers use to share and earn. From your Shopify theme editor you can add:
- **Share button** on your product pages, so customers can share and earn referral rewards.
- **Post-purchase card** on the order status / thank-you page, shown right after checkout. **We recommend this one** because it converts best.
- **Banner** to promote active rewards across your storefront.
Each is a Shopify theme block, and the Frak app deep-links you to the right spot, so there's no code to copy.
{/* screenshot: /img/guides/shopify/buttons/01-theme-blocks.png */}
Coming soon: detailed steps and screenshots for each placement.
# Create a campaign (Shopify)
> Decide how much customers earn for referrals and purchases.
import { Aside } from '@astrojs/starlight/components';
# Create a campaign
A full walkthrough with screenshots is on its way. Here's the short version.
A campaign sets the rules for rewards: how much a customer earns when a friend clicks, signs up, or buys. You can create one from the **Campaigns** tab in the Frak app, or in the [business dashboard](https://business.frak.id/) for more options.
{/* screenshot: /img/guides/shopify/campaigns/01-campaign-tab.png */}
The full walkthrough lives in [Create a campaign](/guides/campaigns/create/).
Coming soon: a Shopify-specific walkthrough with screenshots.
# Add funds (Shopify)
> Top up your Frak reward balance, billed directly through Shopify.
import { Aside } from '@astrojs/starlight/components';
# Add funds
A full walkthrough with screenshots is on its way. Here's the short version.
Rewards are paid from your Frak balance. On Shopify you top it up straight from the app. The charge goes through your usual **Shopify billing**, so there's no separate checkout or invoice to manage.
Open the **Funding** tab in the Frak app, choose an amount, and confirm. Your balance updates once the payment clears.
Top-ups take **1 to 5 business days** to clear. Like any payment, they go through standard security and anti-money-laundering checks before the funds land in your balance.
{/* screenshot: /img/guides/shopify/funds/01-financing-tab.png */}
You only spend what customers actually earn: rewards leave your balance only when a purchase is confirmed.
Coming soon: detailed steps and screenshots.