> For the complete documentation index, see [llms.txt](https://klassdocs.gitbook.io/klassapp-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://klassdocs.gitbook.io/klassapp-documentation/.design-sync/docs/kpicard.md).

# KpiCard

Dashboard metric tile. Blade equivalent: `<x-ds-kpi-card>` in `resources/views/components/ds-kpi-card.blade.php`.

```jsx
<KpiCard icon="users" value="1,284" label="Total Students" color="blue"
         link="/reception/students" />
```

Renders a `<div>`, or an `<a>` when `link` is set. Laid out in an `auto-fit` grid across the top of the role dashboards.

## Props

* `icon` — see the glyph table below; anything unrecognised renders an info-circle fallback
* `value` — the headline figure; defaults to an em dash
* `label` — caption underneath
* `color`: `blue` (default) · `green` · `amber` · `red` · `purple` — tints the icon chip only
* `link` — makes the whole tile an anchor

## Icon keys

Several keys share one glyph:

| Glyph           | Keys                  |
| --------------- | --------------------- |
| people          | `users`               |
| building        | `classes`, `door`     |
| calendar        | `exam`, `calendar`    |
| chat            | `whatsapp`, `message` |
| book            | `book`, `library`     |
| bell            | `bell`, `notice`      |
| currency        | `dollar`, `money`     |
| clipboard-check | `check`, `tasks`      |
| info (fallback) | anything else         |

The icon chip's background and foreground are inline styles from the Blade `$colorMap`, not CSS classes — `color` is the only way to change them.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://klassdocs.gitbook.io/klassapp-documentation/.design-sync/docs/kpicard.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.