subarist / waterhole-user-card

v1.0.0 2026-11-11 10:06 UTC

Requires

• waterhole/core: ^0.7.0 || ^0.8.0

MIT

Published on Packagist.org on 2026-11-11 10:12 UTC

README

A compact hover user card extension for Waterhole.

Preview

Features

• Compact user cards on name hover.
• Lightweight JSON endpoint.
• Avatar, name, headline, biography, groups and profile information.
• Optional Waterhole User Cover integration.
• Desktop hover and touch-device tap interactions.
• Response caching and stale-request protection.

Requirements

• Waterhole ^0.7.0 || ^0.8.0
• PHP version supported by your installed Waterhole version.

Installation

After this package has been published and is available through Composer:

composer require subarist/waterhole-user-card

Then enable User Card in the Waterhole extension manager.

Optional User Cover Integration

User Card can display a cover image when Waterhole User Cover is installed and its database migration has been run.

User Cover is optional and is not a Composer dependency.

API

GET /users/{user}/card

Returns JSON data used by the frontend user card.

Response fields include:

• name
• headline
• bio
• avatar
• color
• cover
• groups
• info

The endpoint uses private, non-cacheable response headers.

Private group information is only included when the viewer has the required permission.

License

MIT. See LICENSE.