@gitlab/ui/dist/components/charts/single_stat/single_stat.documentation.js

GitLab UI Components

import examples from './examples';

var description = "### Single Stat\n\nThe single stat component is a card used to show a single value. The color of the background & text is determined by the **variant** prop, which can be one of \"success\", \"warning\", \"error\", \"info\", or \"neutral\" (default).\n\nTo display an icon to the left of the text, you can use the **icon** slot. This can be an SVG icon or a text character. If using an SVG icon, ensure that the fill/stroke values use `currentColor` so the icon color matches the text of the single stat.\n\nAn example of using an icon:\n\n```html\n<gl-single-stat variant=\"success\" title=\"Ecstatic\" value=\"1000%\">\n  <gl-icon slot=\"icon\" name=\"arrow-up\" />\n</gl-single-stat>\n```\n";

var single_stat_documentation = {
  examples: examples,
  description: description
};

export default single_stat_documentation;