processing/p5.js

[p5.js 2.0 Bug Report]: width/height/options overloads inconsistent/incorrect for typography methods

Open

#7820 opened on May 15, 2025

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (20,784 stars) (3,178 forks)batch import
Area:TypographyDocumentationHelp Wantedp5.js 2.0+

Description

Most appropriate sub-area of p5.js?

  • Accessibility
  • Color
  • Core/Environment/Rendering
  • Data
  • DOM
  • Events
  • Image
  • IO
  • Math
  • Typography
  • Utilities
  • WebGL
  • Build process
  • Unit testing
  • Internationalization
  • Friendly errors
  • Other (specify if possible)

p5.js version

2.0.2

Web browser and version

N/A

Operating system

N/A

Steps to reproduce this

textToModel has these overloads:

textToModel(str, x, y, width, height, [options], [options.extrude], [options.sampleFactor])

textToContours has these overloads:

textToContours(str, x, y, [options])

textToPoints has these:

textToPoints(str, x, y, [options])

A few issues to fix:

  • All of these optionally support width and height. The overloads should maybe be:

    something(str, x, y, [options])
something(str, x, y, width, height, [options])

  • All should have the same base options. These include sampleFactor and simplifyThreshold (see the 1.x docs for descriptions of these.) textToModel additionally has extrude.

Contributor guide

Tech stack
javascript
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic JavaScriptFamiliarity with p5.jsUnderstanding of function overloading
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the current implementation of textToModel, textToContours, and textToPoints in the p5.js source (likely in src/typography/). Update the overloads to support optional width and height consistently, and ensure base options like sampleFactor and simplifyThreshold are uniform across all methods. Refer to the 1.x documentation for the correct option names.