Ranked names and scores, highest first, with the reader's own entry marked.
<ol class="cap-leaderboard" aria-label="Leaderboard" id="lb-board">
<li class="cap-leaderboard-row"><span class="cap-leaderboard-name">Alex</span><span class="cap-leaderboard-score">1,204</span></li>
<li class="cap-leaderboard-row" aria-current="true"><span class="cap-leaderboard-name">Sam</span><span class="cap-leaderboard-score">980</span></li>
<li class="cap-leaderboard-row"><span class="cap-leaderboard-name">Jordan_with_a_very_long_name</span><span class="cap-leaderboard-score">731</span></li>
<li class="cap-leaderboard-row"><span class="cap-leaderboard-name">anon</span><span class="cap-leaderboard-score">88</span></li>
</ol>
Installation
// package.json: "capsomer": "github:DrDustinEdwards/capsomer#v0.152.2"
import "capsomer/tokens.css";
import "capsomer/base.css";
import "capsomer/leaderboard.css";
import "capsomer/tokens.css";
import "capsomer/leaderboard.css";
import { Leaderboard } from "capsomer/react/leaderboard";
Usage
<ol class="cap-leaderboard" aria-label="Leaderboard">
<li class="cap-leaderboard-row"><span class="cap-leaderboard-name">Alex</span><span class="cap-leaderboard-score">1,204</span></li>
<li class="cap-leaderboard-row" aria-current="true">...</li>
</ol>
<p class="cap-leaderboard-empty">No scores yet.</p> <!-- no entries -->
Examples
Empty
<p class="cap-leaderboard-empty" id="lb-empty">No scores yet. Be the first.</p>
API reference
Leaderboard
| Prop | Type | Required | Does |
|---|
entries | LeaderboardEntry[] | Yes | Highest first, as the server ranked them. |
|---|
label | string | | |
|---|
empty | ReactNode | | |
|---|
format | (score: number) => string | | How a score reads ("1,204"); the locale's grouping by default. |
|---|
CSS variables
| Variable | Default |
|---|
--cap-leaderboard-name-face | inherit |
|---|
Parts and data attributes
| Class | Is |
|---|
.cap-leaderboard | the root |
|---|
.cap-leaderboard-empty | a part |
|---|
.cap-leaderboard-name | a part |
|---|
.cap-leaderboard-row | a part |
|---|
.cap-leaderboard-score | a part |
|---|
| State | Read from |
|---|
[aria-current="true"] | an attribute |
|---|
Accessibility
Nothing to operate.
- The reader's entry is marked by
aria-current, a tint and bold, not color alone; a forced-colors outline.