Sparkline component for Stripe Apps

A type of line chart to display data succinctly as a simple line.

SDK version

To add the Sparkline component to your app:

import {Sparkline} from '@stripe/ui-extension-sdk/ui';

The following shows a preview of the Sparkline UI component:

Loading example...

const sales = [
  {
    date: 'Jan',
    sold: 1,
  },
  {
    date: 'Feb',
    sold: 4,
  },
  {
    date: 'Mar',
    sold: 2,
  },
  {
    date: 'Apr',
    sold: 3,
  },
];

return (
  <Box css={{width: 'fill'}}>
    <Sparkline data={sales} x="date" y="sold" />
  </Box>
)

Sparkline props

Property	Type
`data`	Required `{ [x: string]: any; }[]` The data used to generate the chart.
`x`	Required `string \| number \| Channel` The property or accessor for the point on the x axis. Related types: Channel.
`y`	Required `string \| number \| Channel` The property or accessor for the point on the y axis. Related types: Channel.
`color`	Optional `(string \| number \| ColorChannel) \| undefined` Groups data by color based on a property or accessor. Related types: ColorChannel.
`tooltip`	Optional `boolean \| undefined` Determines whether to render a tooltip when hovering over the chart.
`z`	Optional `(string \| number \| Channel) \| undefined` Groups data based on a property or accessor. Related types: Channel.

Channel

Property	Type
`domain`	Optional `any[] \| undefined`
`format`	Optional `((Currency \| UnitIdentifier) \| ("capitalize" \| { [x: string]: string; })) \| undefined` Related types: Currency, UnitIdentifier.
`label`	Optional `string \| undefined`
`range`	Optional `any[] \| undefined`
`value`	Optional `(string \| number) \| undefined`

Currency

Property Type

Property	Type
`currency`	Required 'AED' \| 'AFN' \| 'ALL' \| 'AMD' \| 'ANG' \| 'AOA' \| 'ARS' \| 'AUD' \| 'AWG' \| 'AZN' \| 'BAM' \| 'BBD' \| 'BDT' \| 'BGN' \| 'BHD' \| 'BIF' \| 'BMD' \| 'BND' \| 'BOB' \| 'BRL' \| 'BSD' \| 'BTN' \| 'BWP' \| 'BYN' \| 'BZD' \| 'CAD' \| 'CDF' \| 'CHF' \| 'CLP' \| 'CNY' \| 'COP' \| 'CRC' \| 'CUC' \| 'CUP' \| 'CVE' \| 'CZK' \| 'DJF' \| 'DKK' \| 'DOP' \| 'DZD' \| 'EGP' \| 'ERN' \| 'ETB' \| 'EUR' \| 'FJD' \| 'FKP' \| 'GBP' \| 'GEL' \| 'GHS' \| 'GIP' \| 'GMD' \| 'GNF' \| 'GTQ' \| 'GYD' \| 'HKD' \| 'HNL' \| 'HRK' \| 'HTG' \| 'HUF' \| 'IDR' \| 'ILS' \| 'INR' \| 'IQD' \| 'IRR' \| 'ISK' \| 'JMD' \| 'JOD' \| 'JPY' \| 'KES' \| 'KGS' \| 'KHR' \| 'KMF' \| 'KPW' \| 'KRW' \| 'KWD' \| 'KYD' \| 'KZT' \| 'LAK' \| 'LBP' \| 'LKR' \| 'LRD' \| 'LSL' \| 'LYD' \| 'MAD' \| 'MDL' \| 'MGA' \| 'MKD' \| 'MMK' \| 'MNT' \| 'MOP' \| 'MRU' \| 'MUR' \| 'MVR' \| 'MWK' \| 'MXN' \| 'MYR' \| 'MZN' \| 'NAD' \| 'NGN' \| 'NIO' \| 'NOK' \| 'NPR' \| 'NZD' \| 'OMR' \| 'PAB' \| 'PEN' \| 'PGK' \| 'PHP' \| 'PKR' \| 'PLN' \| 'PYG' \| 'QAR' \| 'RON' \| 'RSD' \| 'RUB' \| 'RWF' \| 'SAR' \| 'SBD' \| 'SCR' \| 'SDG' \| 'SEK' \| 'SGD' \| 'SHP' \| 'SLL' \| 'SOS' \| 'SRD' \| 'SSP' \| 'STN' \| 'SYP' \| 'SZL' \| 'THB' \| 'TJS' \| 'TMT' \| 'TND' \| 'TOP' \| 'TRY' \| 'TTD' \| 'TWD' \| 'TZS' \| 'UAH' \| 'UGX' \| 'USD' \| 'UYU' \| 'UZS' \| 'VES' \| 'VND' \| 'VUV' \| 'WST' \| 'XAF' \| 'XCD' \| 'XOF' \| 'XPF' \| 'YER' \| 'ZAR' \| 'ZMW'

currency

Required

'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW'

UnitIdentifier

Property Type

Property	Type
`unit`	Required 'acre' \| 'bit' \| 'byte' \| 'celsius' \| 'centimeter' \| 'day' \| 'degree' \| 'fahrenheit' \| 'fluid-ounce' \| 'foot' \| 'gallon' \| 'gigabit' \| 'gigabyte' \| 'gram' \| 'hectare' \| 'hour' \| 'inch' \| 'kilobit' \| 'kilobyte' \| 'kilogram' \| 'kilometer' \| 'liter' \| 'megabit' \| 'megabyte' \| 'meter' \| 'mile' \| 'mile-scandinavian' \| 'milliliter' \| 'millimeter' \| 'millisecond' \| 'minute' \| 'month' \| 'ounce' \| 'percent' \| 'petabyte' \| 'pound' \| 'second' \| 'stone' \| 'terabit' \| 'terabyte' \| 'week' \| 'yard' \| 'year' \| `${'acre' \| 'bit' \| 'byte' \| 'celsius' \| 'centimeter' \| 'day' \| 'degree' \| 'fahrenheit' \| 'fluid-ounce' \| 'foot' \| 'gallon' \| 'gigabit' \| 'gigabyte' \| 'gram' \| 'hectare' \| 'hour' \| 'inch' \| 'kilobit' \| 'kilobyte' \| 'kilogram' \| 'kilometer' \| 'liter' \| 'megabit' \| 'megabyte' \| 'meter' \| 'mile' \| 'mile-scandinavian' \| 'milliliter' \| 'millimeter' \| 'millisecond' \| 'minute' \| 'month' \| 'ounce' \| 'percent' \| 'petabyte' \| 'pound' \| 'second' \| 'stone' \| 'terabit' \| 'terabyte' \| 'week' \| 'yard' \| 'year'}-per-${'acre' \| 'bit' \| 'byte' \| 'celsius' \| 'centimeter' \| 'day' \| 'degree' \| 'fahrenheit' \| 'fluid-ounce' \| 'foot' \| 'gallon' \| 'gigabit' \| 'gigabyte' \| 'gram' \| 'hectare' \| 'hour' \| 'inch' \| 'kilobit' \| 'kilobyte' \| 'kilogram' \| 'kilometer' \| 'liter' \| 'megabit' \| 'megabyte' \| 'meter' \| 'mile' \| 'mile-scandinavian' \| 'milliliter' \| 'millimeter' \| 'millisecond' \| 'minute' \| 'month' \| 'ounce' \| 'percent' \| 'petabyte' \| 'pound' \| 'second' \| 'stone' \| 'terabit' \| 'terabyte' \| 'week' \| 'yard' \| 'year'}`

unit

Required

'acre' | 'bit' | 'byte' | 'celsius' | 'centimeter' | 'day' | 'degree' | 'fahrenheit' | 'fluid-ounce' | 'foot' | 'gallon' | 'gigabit' | 'gigabyte' | 'gram' | 'hectare' | 'hour' | 'inch' | 'kilobit' | 'kilobyte' | 'kilogram' | 'kilometer' | 'liter' | 'megabit' | 'megabyte' | 'meter' | 'mile' | 'mile-scandinavian' | 'milliliter' | 'millimeter' | 'millisecond' | 'minute' | 'month' | 'ounce' | 'percent' | 'petabyte' | 'pound' | 'second' | 'stone' | 'terabit' | 'terabyte' | 'week' | 'yard' | 'year' | `${'acre' | 'bit' | 'byte' | 'celsius' | 'centimeter' | 'day' | 'degree' | 'fahrenheit' | 'fluid-ounce' | 'foot' | 'gallon' | 'gigabit' | 'gigabyte' | 'gram' | 'hectare' | 'hour' | 'inch' | 'kilobit' | 'kilobyte' | 'kilogram' | 'kilometer' | 'liter' | 'megabit' | 'megabyte' | 'meter' | 'mile' | 'mile-scandinavian' | 'milliliter' | 'millimeter' | 'millisecond' | 'minute' | 'month' | 'ounce' | 'percent' | 'petabyte' | 'pound' | 'second' | 'stone' | 'terabit' | 'terabyte' | 'week' | 'yard' | 'year'}-per-${'acre' | 'bit' | 'byte' | 'celsius' | 'centimeter' | 'day' | 'degree' | 'fahrenheit' | 'fluid-ounce' | 'foot' | 'gallon' | 'gigabit' | 'gigabyte' | 'gram' | 'hectare' | 'hour' | 'inch' | 'kilobit' | 'kilobyte' | 'kilogram' | 'kilometer' | 'liter' | 'megabit' | 'megabyte' | 'meter' | 'mile' | 'mile-scandinavian' | 'milliliter' | 'millimeter' | 'millisecond' | 'minute' | 'month' | 'ounce' | 'percent' | 'petabyte' | 'pound' | 'second' | 'stone' | 'terabit' | 'terabyte' | 'week' | 'yard' | 'year'}`

ColorChannel

Property	Type
`domain`	Optional `any[] \| undefined`
`format`	Optional `((Currency \| UnitIdentifier) \| ("capitalize" \| { [x: string]: string; })) \| undefined` Related types: Currency, UnitIdentifier.
`label`	Optional `string \| undefined`
`value`	Optional `(string \| number) \| undefined`

Using color

The color channel groups data:

Loading example...

const sales = [
  {
    date: 'Jan',
    sold: 1,
    product: 'tables',
  },
  {
    date: 'Jan',
    sold: 2,
    product: 'chairs',
  },
  {
    date: 'Feb',
    sold: 4,
    product: 'tables',
  },
  {
    date: 'Feb',
    sold: 6,
    product: 'chairs',
  },
  {
    date: 'Mar',
    sold: 2,
    product: 'tables',
  },
  {
    date: 'Mar',
    sold: 4,
    product: 'chairs',
  },
  {
    date: 'Apr',
    sold: 7,
    product: 'tables',
  },
  {
    date: 'Apr',
    sold: 9,
    product: 'chairs',
  },
];

return (
  <Box css={{width: 'fill'}}>
    <Sparkline data={sales} x="date" y="sold" color="product" />
  </Box>
)

Sparkline component for Stripe Apps

A type of line chart to display data succinctly as a simple line.

Sparkline props

Channel

Currency

UnitIdentifier

ColorChannel

Using color

See also