Skip to content

Add roman numerals to list types #1642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add roman numerals to list types #1642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76107ea
Add roman numerals to listType
BenAldebert Aug 19, 2025
a16277a
Add unit tests for roman numeral lists
BenAldebert Aug 19, 2025
c1c8ca2
Add documentation for listType option
BenAldebert Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/text.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ Lists use the following additional options:
* `bulletRadius`
* `textIndent`
* `bulletIndent`
* `listType` - `bullet`, `numbered`, `roman`, `roman-lower`, `lettered` (`bullet` by default)

## Rich Text

Expand Down
17 changes: 17 additions & 0 deletions lib/mixins/text.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,10 +289,25 @@ export default {

flatten(list);

const toRoman = function (n, lowerCase = false) {
var lookup = {M:1000,CM:900,D:500,CD:400,C:100,XC:90,L:50,XL:40,X:10,IX:9,V:5,IV:4,I:1},roman = '',i;
for (i in lookup) {
while (n >= lookup[i]) {
roman += i;
n -= lookup[i];
}
}
return lowerCase ? roman.toLowerCase() : roman;
};

const label = function (n) {
switch (listType) {
case 'numbered':
return `${n}.`;
case 'roman':
return `${toRoman(n)}.`;
case 'roman-lower':
return `${toRoman(n, true)}.`;
case 'lettered':
var letter = String.fromCharCode(((n - 1) % 26) + 65);
var times = Math.floor((n - 1) / 26 + 1);
Expand Down Expand Up @@ -344,6 +359,8 @@ export default {
this.fill();
break;
case 'numbered':
case 'roman':
case 'roman-lower':
case 'lettered':
var text = label(numbers[i - 1]);
this._fragment(text, this.x - indent, this.y, options);
Expand Down
18 changes: 18 additions & 0 deletions tests/visual/text.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,24 @@ describe('text', function () {
});
});

test('list (roman numerals)', function () {
return runDocTest(function (doc) {
doc.font('tests/fonts/Roboto-Regular.ttf');
doc
.fillColor('#000')
.list(['One', 'Two', 'Three'], 100, 150, { listType: 'roman' });
});
});

test('list (roman numerals lowercase)', function () {
return runDocTest(function (doc) {
doc.font('tests/fonts/Roboto-Regular.ttf');
doc
.fillColor('#000')
.list(['One', 'Two', 'Three'], 100, 150, { listType: 'roman-lower' });
});
});

test('list (lettered)', function () {
return runDocTest(function (doc) {
doc.font('tests/fonts/Roboto-Regular.ttf');
Expand Down