Skip to content
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.

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

Wishlist of common components to add to lookup #27

Open
46 of 48 tasks
arouinfar opened this issue Jul 12, 2019 · 10 comments
Open
46 of 48 tasks

Wishlist of common components to add to lookup #27

arouinfar opened this issue Jul 12, 2019 · 10 comments
Assignees

Comments

@arouinfar
Copy link

arouinfar commented Jul 12, 2019

In reviewing #25 I realized that there are many common UI components which are missing from the components-by-sim and sim-by-components lists in binder. Currently, it looks like the only components included are the ones which have associated .md files in the style guide.

image

I took a look around sun and scenery-phet and I've come up with a preliminary wishlist.

  • sun/Carousel
  • sun/Dialog
  • sun/NumberSpinner
  • sun/VSlider
  • sun/HSlider
  • remove sun/Slider
  • scenery-phet/ArrowNode
  • scenery-phet/BicyclePumpNode
  • scenery-phet/BracketNode
  • scenery-phet/ConductivityTesterNode
  • scenery-phet/Drawer
  • scenery-phet/ElectronChargeNode
  • scenery-phet/EraserButton
  • scenery-phet/EyeDropperNode
  • scenery-phet/EyeToggleButton
  • scenery-phet/FaceNode
  • scenery-phet/FaucetNode
  • scenery-phet/FineCoarseSpinner
  • scenery-phet/GaugeNode
  • scenery-phet/HandleNode
  • scenery-phet/HeaterCoolerNode
  • scenery-phet/InfoButton
  • scenery-phet/LaserPointerNode
  • scenery-phet/LeftRightSpinner
  • scenery-phet/LightBulbNode
  • scenery-phet/LineArrowNode
  • scenery-phet/MeasuringTapeNode
  • scenery-phet/MoveToTrashButton
  • scenery-phet/NumberControl
  • scenery-phet/NumberKeypad
  • scenery-phet/NumberPicker
  • scenery-phet/ParametricSpringNode
  • scenery-phet/PlayPauseButton
  • scenery-phet/ProbeNode
  • scenery-phet/RecordStopButton
  • scenery-phet/RefreshButton
  • scenery-phet/ResetButton
  • scenery-phet/RewindButton
  • scenery-phet/RulerNode
  • scenery-phet/ScientificNotationNode
  • scenery-phet/SegmentedBarGraphNode
  • scenery-phet/SoundToggleButton
  • scenery-phet/SpectrumSlider
  • scenery-phet/StepButton
  • scenery-phet/ThermometerNode
  • scenery-phet/TimerNode
  • scenery-phet/UpDownSpinner
  • scenery-phet/ZoomButton

A few caveats:

  • We have SO MANY BUTTONS, and I don't think it would be useful to have an entry for every possible kind of button in sun. That said, buttons in scenery-phet tend to have specific purposes (e.g. PlayPauseButton) and I think it would be useful to be able to look up these sorts of buttons.
  • Inheritance is tricky, so there may be some redundancies in the list, though I've tried to avoid this as much as possible.
  • I'm very open to developer suggestions/pushback on this list, so please don't take it as the gospel @zepumph.
@zepumph
Copy link
Member

zepumph commented Jul 18, 2019

Review comments and questions here:

  • Slider: Do you want to know the difference between V/HSlider? Right now there is one entry for Slider, which covers both.
  • Dialog: All sims will have about About/OptionsDialog. These are created lazily (only when the menu option clicked). Likely other dialogs are created the same way, and so this won't be a very "confident" list of dialogs.

@arouinfar
Copy link
Author

@zepumph I'm not sure that a general Slider is the most helpful, since it's a fairly ubiquitous UI component. I think it's probably more helpful to distinguish between HSlider and VSlider, because a designer is likely looking for a more specific example.

@arouinfar arouinfar removed their assignment Jul 18, 2019
@zepumph
Copy link
Member

zepumph commented Jul 18, 2019

@zepumph I'm not sure that a general Slider is the most helpful, since it's a fairly ubiquitous UI component. I think it's probably more helpful to distinguish between HSlider and VSlider, because a designer is likely looking for a more specific example.

what about the use of Slider in NumberControl? Right now there is no way that would be differentiated.

@arouinfar
Copy link
Author

what about the use of Slider in NumberControl? Right now there is no way that would be differentiated.

My wishlist included an entry for scenery-phet/NumberControl and scenery-phet/SpectrumSlider, so I don't think we'd be leaving any slider-like things out in the cold. I wouldn't oppose having a catch-all Slider entry, but it doesn't seem like the most useful component filter by.

@zepumph
Copy link
Member

zepumph commented Jul 19, 2019

All of the above have been added, and Slider was removed. Perhaps Slider should actually be readed since there is a Slider.md

No matter, here is the updated binder doc: http://phettest.colorado.edu/binder/doc/

What do you think?

@terracoda
Copy link

terracoda commented Jul 7, 2020

We have an A11y implementation pattern for Time Control now (see MAL). Should we have time to document this pattern, what repo would it go in? Should it go in scenery-phet?

Adding there are nice shortcuts for toggling between Pause & Play and for Stepping Forward when Paused.

@terracoda
Copy link

We also have a new A11y Design pattern for the On/Off switch for MAL that would benefit from some documentation. Would an issue for the On/Off switch go in the sun repo?

@zepumph
Copy link
Member

zepumph commented Jul 7, 2020

The On off switch for MAL is a BooleanRoundStickyToggleButton. That lives in sun. Likely the a11y of design pattern relates to other toggle-like components (ABSwitch/ToggleSwitch?). Note I also see ToggleButtons.md in sun/doc. This seems to just be blank scaffolding the MB made when creating binder. ToggleButtons.md is already rendered in the binder doc.

TimeControlNode lives in scenery-phet, If you write a md file for it and want it to be added to the binder doc, let me know. I will add it to the lists of components now so that we can see what sims use the component.

zepumph added a commit to phetsims/scenery-phet that referenced this issue Jul 7, 2020
zepumph added a commit to phetsims/ratio-and-proportion that referenced this issue Jul 7, 2020
@zepumph
Copy link
Member

zepumph commented Jul 7, 2020

Please ignore phetsims/ratio-and-proportion@f88aabb, it was an incorrect git commit message.

@arouinfar
Copy link
Author

Binder is not currently a priority, so unassigning myself.

@arouinfar arouinfar removed their assignment Feb 27, 2023
zepumph added a commit to phetsims/phet-core that referenced this issue Apr 1, 2024
…binder#27

Signed-off-by: Michael Kauzmann <michael.kauzmann@colorado.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants