list_counter 0.0.1

A utility for counting in a variety of languages and styles. Made for lists.

A Counter class that follows the specification outlined at https://www.w3.org/TR/css-lists-3/#auto-numbering.

The CounterStyle class represents styles that can be used to generate a text representation of the given counter's value (such as a 'iv' for 4, or 'β' for 2).

See https://www.w3.org/TR/css-counter-styles-3/#counter-styles for more details.

Features

Getting started

Getting started is simple:

dependencies:
  ordered_list: ^0.0.1

Usage

void main() {
  final counter = Counter('named_counter'); //You can also start a counter at a specific integer value with Counter('name', VALUE);
  final listStyle = PredefinedCounterStyles.upperRoman;
  
  counter.increment(); // Adds 1 to the counter
  print(listStyle.generateMarkerContent(counter.value));
  // Prints "I. "
 
  counter.increment(2021); // Now the counter is at 2022
  print(listStyle.generateMarkerContent(conter.value));
  // Prints "MMXXII. "
 
  // Optionally, you can just print the result of the algorithm without any suffixes:
  print(listStyle.generateCounterContent(counter.value));
  // Prints "MMXXII"
}

Predefined List Styles

A lengthy list of predefined counter styles is included!

Some of the most basic include: PredefinedCounterStyles.decimal (A simple ordered list) PredefinedCounterStyles.disc (A simple bulleted/unordered list) PredefinedCounterStyles.circle (A bulleted list with open circles) PredefinedCounterStyles.square (A bulleted list with square bullets) PredefinedCounterStyles.lowerAlpha (e.g., a, b, c, ..., z, aa, ab)

As well as dozens of language-specific number systems, such as: PredefinedCounterStyles.cjkDecimal (i.e. 〇 一 二 三 四 五 六 七 八 九 ...) PredefinedCounterStyles.cambodian (i.e. ០ ១ ២ ៣ ៤ ៥ ៦ ៧ ៨ ៩ ...) PredefinedCounterStyles.katakana (i.e. ア イ ウ エ オ カ キ ク ...)

See https://www.w3.org/TR/css-counter-styles-3/#predefined-counters for the full list.

Or, you can define your own style:

// Sample additive style taken from https://www.w3.org/TR/css-counter-styles-3/#additive-system
final diceStyle = CounterStyle.define(
  name: 'dice-style',
  system: system.additive,
  additiveSymbols: {6: '⚅', 5: '⚄', 4: '⚃', 3: '⚂', 2: '⚁', 1: '⚀'},
  suffix: " ",
);

diceStyle will then produce lists that look like:

⚀  One
⚁  Two
⚂  Three
...
⚅⚄  Eleven
⚅⚅  Twelve
⚅⚅⚀  Thirteen