Skip to content

Commit 20083b3

Browse files
committed
Add documentation to ChoiceSet
1 parent 264e4a7 commit 20083b3

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

lib/js/src/manager/screen/choiceset/ChoiceSet.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ import { VrHelpItem } from '../../../rpc/structs/VrHelpItem.js';
3636
class ChoiceSet {
3737
/**
3838
* Create a new instance of ChoiceSet
39+
* Initialize with a title, choices, and listener. It will use the default timeout and layout, all other properties (such as prompts) will be null.
40+
* WARNING: If you display multiple cells with the same title with the only uniquing property between cells being different `vrCommands` or a feature
41+
* that is not displayed on the head unit (e.g. if the head unit doesn't display `secondaryArtwork` and that's the only uniquing property between two cells)
42+
* then the cells may appear to be the same to the user in `Manual` mode. This only applies to RPC connections >= 7.1.0.
43+
* WARNING: On < 7.1.0 connections, the title cell will be automatically modified among cells that have the same title when they are preloaded, so they will
44+
* always appear differently on-screen when they are displayed. Unique text will be created by appending " (2)", " (3)", etc.
3945
* @class
4046
* @param {String} title - The choice set's title
4147
* @param {ChoiceCell[]} choices - The choices to be displayed to the user for interaction

0 commit comments

Comments
 (0)