# XWUIGameCompanionFrame

A compact unit frame for a companion, mount, or pet, showing a circular `portrait` (image URL or emoji) with a type-colored border, the companion `name`, an HP bar with `hp`/`maxHp` numeric text, and a row of `statusEffects` icons. The `type` field (`companion`, `mount`, `pet`) sets the badge and border color. Toggle `showPortrait`, `showHp`, and `showStatus` to slim it down; call `updateData()` to push HP and status changes without rebuilding the frame.

## Basic Usage

A companion unit frame with portrait, HP bar, type badge, and status effect icons.

```example
file: examples/BasicUsage.ts
html: examples/BasicUsage.html
title: Basic Usage
description: A companion unit frame with portrait, HP bar, type badge, and status effect icons.
```

## Mount Frame

A mount frame with its own type badge and border color, status row hidden for a slim look.

```example
file: examples/MountFrame.ts
html: examples/MountFrame.html
title: Mount Frame
description: A mount frame with its own type badge and border color, status row hidden for a slim look.
```

## Pet Takes Damage

A pet frame whose HP bar drains via updateData() as it soaks incoming hits.

```example
file: examples/PetTakesDamage.ts
html: examples/PetTakesDamage.html
title: Pet Takes Damage
description: A pet frame whose HP bar drains via updateData() as it soaks incoming hits.
```

## Slim Pet

A compact pet nameplate with the HP bar and status icons switched off, leaving just the portrait, name, and type badge.

```example
file: examples/SlimPet.ts
html: examples/SlimPet.html
title: Slim Pet
description: A minimal pet frame showing only portrait and name with the HP bar and status row hidden.
```

## Wounded Mount

A large mount frame at critical HP with a bleed effect, then healed in place through `updateData()`.

```example
file: examples/WoundedMount.ts
html: examples/WoundedMount.html
title: Wounded Mount
description: A near-downed mount frame with a bleed status that is patched back up live via updateData().
```

```api
```