Skip to content

Reference page click-to-reveal class methods #1011

Open
@JetStarBlues

Description

@JetStarBlues

Actual Behaviour

Currently, the only way to find out about the existence of class methods from the Reference page is by clicking on the class article. For example, the only way to become aware of the setUniform method is by clicking on the p5.Shader article.

This works fine if you are already familiar with what a class does. However, it is not so great for discovering functionality you are unaware of.

Expected Behaviour

In addition to the current style (of nesting method links in class articles), I think modifying the way these classes are listed on the Reference page would go a long way in discover-ability.
Specifically, I propose using a click-to-reveal interface on the class entries. On click, the entry would expand to show nested methods. On next click, the entry would collapse. And so on. In this way, the Reference page is not cluttered, but now class methods are immediately visible (without clicking through to the associated class article).

For example:

default state

  • p5.Image

toggled state

  • p5.Image
    • loadPixels()
    • updatePixels()
    • get()
    • ...

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions