API groups
ApiGroups shows the endpoint groups of your API reference as cards.
<ApiGroups> draws your API reference's endpoint groups as cards, each with its first endpoints — a way into the reference from a home page.
Doc engine v2 only (presets). A v1 site doesn't draw <ApiGroups>: used empty it shows nothing, and any content inside it shows as plain text.
Used empty
With no children, it draws one card per endpoint group of your API reference, listing its first endpoints.
Used empty, it fills itself from your site. Give it content of its own and it shows only that. With no content and nothing on the site to fill it, it draws nothing and the build log says so:
With your own content
Each <Card title href> is a group: its text is the description and its link list the endpoints.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
title | string | "Browse by product" | Heading of the block, where the preset draws one |
limit | number | 9 | Most groups shown |
In each preset
It's drawn in your preset's home style — or in the layout named by appearance.layout.home while that setting still works. Atlas draws its product cards. The other presets draw their section cards, with the endpoint count. On a page with the normal frame it sits in the content column; on a layout: wide page it runs across the page.
Example
This site's own, from <ApiGroups limit={3} />: