Skip to content

Delta

The move beside a figure against its last value, as an arrow and percent, better or worse.

<div class="cap-specimen-row" id="d-moves">
  <p>Recovered this month: $4,210 <span class="cap-delta" data-kind="moved" data-tone="good" data-direction="up"><span class="cap-delta-arrow" aria-hidden="true">▲</span><span class="cap-sr-only">up </span>12%</span></p>
  <p>Failed payments: 38 <span class="cap-delta" data-kind="moved" data-tone="bad" data-direction="up"><span class="cap-delta-arrow" aria-hidden="true">▲</span><span class="cap-sr-only">up </span>9%</span></p>
  <p>Failed payments: 31 <span class="cap-delta" data-kind="moved" data-tone="good" data-direction="down"><span class="cap-delta-arrow" aria-hidden="true">▼</span><span class="cap-sr-only">down </span>18%</span></p>
  <p>Open disputes: 4 <span class="cap-delta" data-kind="unchanged">no change</span></p>
</div>

Installation

// package.json: "capsomer": "github:DrDustinEdwards/capsomer#v0.152.2"
import "capsomer/tokens.css";
import "capsomer/base.css";
import "capsomer/delta.css";
import { compareFigures, deltaText } from "capsomer/behavior/delta";

Usage

import { Delta } from "capsomer/react/delta";
import "capsomer/delta.css";
<Delta current={4210} previous={3760} higherIsBetter />
<span class="cap-delta" data-kind="moved" data-tone="good" data-direction="up"><span class="cap-delta-arrow" aria-hidden="true">▲</span><span class="cap-sr-only">up </span>12%</span>

API reference

Delta

Functions

FunctionSignatureDoes
compareFigures(current: number | null | undefined, previous: number | null | undefined, { higherIsBetter, unchangedBelowPct }: CompareOptions): DeltaNull on either side is "none": a figure that was not read has no change to draw. A move from zero is measured against the new figure, so it is 100%, never infinite.
deltaText(d: Delta): stringThe words a screen reader and a plain-text copy say: "up 12%", "no change".

Parts and data attributes

ClassIs
.cap-deltathe root
.cap-delta-arrowa part
AttributeValues
data-kindunchanged
data-tonebad good

Accessibility

Nothing to operate.

  • The arrow is hidden; "up" or "down" is read before the percent.
  • Both tones reach 4.5:1 on the surface in both themes.