Components
Component types, attributes, and example entry points.
Available components
LinkFox currently provides five component types:
linkfox-widgetlinkfox-navbarlinkfox-listlinkfox-gridlinkfox-inline
If you want live previews and copy-ready snippets, open the interactive examples page at /component.
Common attributes
Use api-key only in trusted environments. For private data on external sites, prefer server-side rendering with @linkfox/core.
| Attribute | Required | Type | Description |
|---|---|---|---|
slug | Yes | string | The source site slug used as the root context |
api-key | No | string | Your LinkFox API key. Omit it to read public site networks only |
group | No | string | Filter returned sites by group slug |
title | No | string | Header text for widget, list, and grid |
theme | No | light | sand | mint | Built-in visual theme |
max-items | No | number | Maximum number of sites to render |
show-description | No | boolean | Toggle link descriptions |
open-in-new-tab | No | boolean | Open links in a new tab |
utm-key | No | string | Query parameter key appended to links |
utm-value | No | string | Query parameter value appended to links |
empty-message | No | string | Text shown when no related sites are returned |
Example
<linkfox-inline
slug="game-father"
group="game"
max-items="5"
utm-key="ref"
utm-value="docs"
></linkfox-inline>