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

Add data about each component #6

Open
samreid opened this issue May 14, 2018 · 7 comments
Open

Add data about each component #6

samreid opened this issue May 14, 2018 · 7 comments

Comments

@samreid
Copy link
Member

samreid commented May 14, 2018

Related to #5, the style guide show this information which is not presented in the binder view at the moment:

Here is additional information from the Style Guide that we should add to the document:

  • Number of published sims with component: [number]
  • Sims with component (not necessarily published): [list of all sim repos]
  • Published sims with component: [list of sim links]
  • Published sims with element a11y enabled: [list of sim links]

@zepumph can you work on that part? You should be able to leverage the existing data for the first two bullets, and I think you referred to some metadata service that would help with the latter two.

@zepumph
Copy link
Member

zepumph commented May 16, 2018

In a meeting today, it was decided to let @mbarlow12 take over this repo, here seems to be the next step in terms of content generation. Let me know if there is anything else I can do.

@zepumph zepumph assigned mbarlow12 and unassigned zepumph May 16, 2018
@terracoda
Copy link

Also discussed at the meeting was the list of generated content. It looks very similar to what @samreid posted above, with a couple of additions. I have checked off the ones that I think are already working in the prototype that @samreid created.

Name: ComboBox

  • Repo: sun/js/ComboBox.js
  • Number of published sims with component: [number]
  • Sims with component (not necessarily published): [list of all sim repos]
  • Published sims with component: [list of sim links]
  • Published sims with element a11y enabled: [list of sim links]
  • Snapshots of all uses on Master: [Link to Sam’s magical snapshot document at the relevant anchor]
  • Instructions on how to find options in a js file.

mbarlow12 added a commit that referenced this issue May 24, 2018
@mbarlow12
Copy link
Contributor

mbarlow12 commented May 31, 2018

In Tuesday a11y meeting, it was noted that having issues that correspond to each of the common components might be useful. Each of the items below will need to present the info outlined in #6 (comment).

Some of these components will not make it into the style guide, and we're free to remove them from this issue as that becomes apparent.

General

  • ABSwitch - registered
  • AccordionBox - registered
  • AquaRadioButton - registered
  • BooleanToggleNode
  • Carousel
  • Checkbox - registered
  • ComboBox - registered
  • Dialog
  • ExpandCollapseBar
  • ExpandCollapseButton - registered
  • FontAwesomeNode
  • HSeparator
  • HSlider - registered
  • HSliderThumb
  • HSliderTrack
  • MenuItem
  • NumberSpinner
  • OnOffSwitch
  • PageControl
  • Panel
  • ToggleNode
  • UIComponent
  • VerticalAquaRadioButtonGroup
  • VerticalCheckboxGroup

Buttons

  • CarouselButton
  • HTMLPushButton
  • NodesPushButton
  • RadioButtonGroup - registered
  • RadioButtonGroupMember
  • RectangularButtonView
  • RectangularMomentaryButton
  • RectangularPushButton
  • RectangularStickyToggleButton
  • RectangularToggleButton
  • RoundButtonView
  • RoundMomentaryButton
  • RoundPushButton
  • RoundStickyToggleButton
  • RoundToggleButton
  • TextPushButton

Accessibility

  • AccessibleNumberTweaker
  • AccessibleSlider

@mbarlow12
Copy link
Contributor

Further notes:

  • when a View type is present, do we include both the button and its associated view or select one or the other?
  • if the info presented is more inclusive than just accessibility, should we include the nodes in scenery/js/nodes?

@terracoda
Copy link

@mbarlow12, re #6 (comment), @zepumph had made a much shorter (perhaps more realistic list).

Also, md files are in sun, so I thought the issues for MD files would be created there. Perhaps this list is for other purposes?

There are 2 issues related to Radio Button Group (phetsims/sun#364 and phetsims/sun#361)

Should these issues be noted in the list?

@mbarlow12
Copy link
Contributor

mbarlow12 commented May 31, 2018

@terracoda I wanted to make an exhaustive list, and I noted in my comment

Some of these components will not make it into the style guide, and we're free to remove them from this issue as that becomes apparent.

So I do not anticipate the list to remain this length (I already removed several since this AM).

We can always link issues in commits and comments, and I agree that the issues associated with specific files/components should live in their respective directories. My hope was to have a central location to quickly track progress...and checklists are SOOO satisfying :)

@terracoda
Copy link

Ok, sounds great.

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

4 participants