processing / processing/p5.js-web-editor

Interactive Function Reference Tooltip

Open
#3,498 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature Request Needs Design
Dominant language
JavaScript
Stars
1.7k
Forks
1.7k
Avg merge
3d 4h
Merged PRs (30d)
8

Description

Increasing Access

This feature increases access to the p5.js Web Editor by making it easier for beginners and educators to learn and use p5.js functions without leaving the editor. By providing instant tooltips with function descriptions, syntax, and example snippets, it serves as a quick reference, especially since parameters for functions like ellipse() or rect() are often hard to remember. This reduces the learning curve for new coders, particularly in classroom or workshop settings, and supports diverse learners (e.g., students, artists) with immediate, context-aware help. A toggle to disable tooltips ensures experienced users can opt out, maintaining accessibility for all skill levels.

Feature request details

I propose adding an Interactive Function Reference tooltip to the p5.js Web Editor. When a user hovers over a p5.js function (e.g. circle()), a tooltip appears with:

  • A brief description of the function.

  • Its syntax and parameters (e.g. circle(50, 50, 25)).

  • A “Try Example” button to insert a working code snippet (e.g., ellipse(50, 50, 80, 80);). This acts as a quick reference for users, especially beginners, who struggle to recall parameters for each function (e.g., the order of x, y, w, h in rect()). It helps users learn and experiment without needing external documentation. This would be especially useful for new coders in workshops, self-paced learners, or anyone needing a quick reminder of function parameters.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name files, tests, or an entry point. First map the Web Editor's editor UI and its existing p5.js reference or documentation integration, then define how function detection, tooltip content, example insertion, and the opt-out toggle should work before implementing and testing the complete interaction.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
accessibility, frontend, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.