npm.io
0.8.12 • Published 2 months ago

@snack-uikit/counter

Licence
Apache-2.0
Version
0.8.12
Deps
2
Size
49 kB
Vulns
0
Weekly
0
Stars
23

Counter

Installation

npm i @snack-uikit/counter

Changelog

Description

  • Пакет @snack-uikit/counter предоставляет компонент Counter для отображения числовых индикаторов (счётчиков уведомлений, количеств элементов, метрик и т.п.) в компактном виде.
  • Компонент поддерживает несколько вариантов отображения значения: обычный счётчик (count), формат с плюсом при превышении порога (count-plus) и укороченную запись в тысячах (count-k), управляемую пропами variant и plusLimit.
  • Размер (size) и внешний вид (appearance, color) позволяют адаптировать счётчик под разные сценарии — от базовых меток до критических состояний.
  • Форматированное значение отображается в едином контейнере без дополнительных иконок или кнопок, за счёт чего компонент хорошо подходит для использования внутри других UI-элементов (кнопок, тегов, пунктов меню).
  • Figma: Snack UI Kit — Counter.

Example

import { Counter } from '@snack-uikit/counter';

function Example() {
  return (
    <>
      <Counter value={9} />

      <Counter
        value={10}
        variant='count-plus'
        plusLimit={9}
        appearance='red'
        size='m'
      />

      <Counter
        value={8500}
        variant='count-k'
        color='decor'
      />
    </>
  );
}

Counter

Компонент счетчик

Props
name type default value description
value* number - Значение
appearance enum Appearance: "primary", "neutral", "red" primary Внешний вид
variant enum Variant: "count", "count-plus", "count-k" count Вариант
size enum Size: "s", "m" s Размер
plusLimit number 10 Порог сокращения значения в формат v+. Например 1500 -> 999+ для 1000
className string - CSS-класс
color enum Color: "accent", "decor" accent Семантический цвет