Skip to content

GroupItemOptions

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/sun/blob/main/js/GroupItemOptions.ts for the most up-to-date information.

Overview

For groups like radio button groups or checkbox groups, where we need to flow the tandem through to the items.

@author Sam Reid (PhET Interactive Simulations)

Type GroupItemOptions

import type { GroupItemOptions } from 'scenerystack/sun';
  • createNode: ( contentTandem: Tandem ) => T
  • tandemName?: string
    If PhET-iO instrumented, tandemName must be supplied to supply the instrumentation. Optional to support uninstrumented sims and demos.

NOTE!!!: This is not necessarily the contentTandem passed to createNode. It depends on the implementation. There is sometimes a swap, where this tandemName will go to an AlignBox/Checkbox parent, etc. instead of the content.

Source Code

See the source for GroupItemOptions.ts in the sun repository.