phetsims / a11y-research

a repository to track PhETs research into accessibility, or "a11y" for short
MIT License
3 stars 0 forks source link

bundle options under options.a11y #100

Closed pixelzoom closed 3 years ago

pixelzoom commented 6 years ago

From https://github.com/phetsims/area-model-common/issues/139#issuecomment-387182176...

Instead of relying on developers to manually group a11y-related options, consider bundling (nesting) them under options.a11y, e.g.:

options = _.extends( {

  fill: ‘white’,
  stroke: ‘black’,
  …

  phetio: {
    tandem: tandem
    ...
  }
  …

  a11y: { 
    tagName: 'p',
    descriptionContent: 'blah blah blah',
    …
  }

}, options );
samreid commented 6 years ago

I recommend we conclude discussion in https://github.com/phetsims/area-model-common/issues/139 before proceeding here.

zepumph commented 3 years ago

We have decided to go with code comments instead of nested options. CLosing