> For the complete documentation index, see [llms.txt](https://docs.dotpassport.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dotpassport.io/widgets/overview.md).

# Overview

Framework-agnostic embeddable widgets for displaying reputation data.

## Features

* **Framework-Agnostic** - Works with any framework or vanilla JS
* **Lightweight** - \~7KB gzipped per widget
* **Customizable** - Full theme and style support
* **Zero Dependencies** - Self-contained with inline styles

## Available Widgets

### Reputation Widget (Default)

Displays total reputation score with category breakdown.

[Learn more →](https://github.com/dotpassport/dotpassport-sdk/blob/main/docs/widgets/reputation.md)

### Badge Widget

Shows badges earned by the user.

[Learn more →](https://github.com/dotpassport/dotpassport-sdk/blob/main/docs/widgets/badge.md)

### Profile Widget

User profile card with social links.

[Learn more →](https://github.com/dotpassport/dotpassport-sdk/blob/main/docs/widgets/profile.md)

### Category Widget

Detailed breakdown of a specific category.

[Learn more →](https://github.com/dotpassport/dotpassport-sdk/blob/main/docs/widgets/category.md)

## Quick Start

```html
<div id="reputation-widget"></div>

<script type="module">
  import { createWidget } from '@dotpassport/sdk';

  createWidget({
    apiKey: 'your-api-key',
    address: 'polkadot-address'
  }).mount('#reputation-widget');
</script>
```

## Common Configuration

All widgets accept these options:

```typescript
{
  apiKey: string;              // Required
  address: string;             // Required
  theme?: 'light' | 'dark' | 'auto';
  className?: string;
  onError?: (error: Error) => void;
  onLoad?: () => void;
}
```

## Next Steps

* [Reputation Widget](https://github.com/dotpassport/dotpassport-sdk/blob/main/docs/widgets/reputation.md)
* [Badge Widget](https://github.com/dotpassport/dotpassport-sdk/blob/main/docs/widgets/badge.md)
* [Lifecycle Methods](https://github.com/dotpassport/dotpassport-sdk/blob/main/docs/widgets/lifecycle.md)
* [Theming](https://github.com/dotpassport/dotpassport-sdk/blob/main/docs/widgets/theming.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.dotpassport.io/widgets/overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.