Add a way to limit the ParallelDOM API to just accessibleName and helpText

[jessegreenberg]

Many components will should only allow setting accessibleName and helpText of ParallelDOM options. Lets use TypeScript to make this clear. I am imagining a type that will basically omit all ParallelDOMOptions except for these two.

[jessegreenberg]

I added a parametric type called TrimmedParallelDOMOptions. It omits all but accessibleName and helpText. It can be used like this:

export type ABSwitchOptions = TrimmedParallelDOMOptions<SelfOptions & HBoxOptions>;

@pixelzoom can you please review this, what are your thoughts about using this in common code to constrain the API?

[pixelzoom]

Re TrimmedParallelDOMOptions... @jessegreenberg and I discussed.

I pointed out that Node handles this a bit differently. It exports subsets of options, like NodeTranslationOptions and NodeTransformOptions, and composes those to form NodeOptions. Clients can then use those subsets. But I don't know if that's a viable approach for things that inherit from ParallelDOM.

I'm unsure whether 1 subset of high-level options (currently 'accessibleName' | 'helpText' | 'focusable' | 'pdomVisible') will be appropriate in all cases, or whether (more likely) it will vary by UI component.

I'm unsure if TrimmedParallelDOMOptions is the best name, but I can't think of anything better. I did mention that other utility types tend to be named with verbs (Pick, Omit,...) so TrimParallelDOMOptions might be better.

[jessegreenberg]

Thanks for the thoughts here @pixelzoom, I considered these a bit more.

I pointed out that Node handles this a bit differently

Doing it this way will be difficult because NodeOptions extends ParallelDOMOptions. I still want to be able to use all ParallelDOMOptions with Node. And so I can't think of a pattern that will support that without omit.

I'm unsure whether 1 subset of high-level options

Yes, we will probably need others, but I think this is the right starting set for UI components as we scale out accessible names and help text. Variations can include or omit things as they need and if a pattern forms we can create a new subset.

m unsure if TrimmedParallelDOMOptions is the best name,

Good point, Ill rename it to TrimParallelDOMOptions.

[jessegreenberg]

The rename is done. Closing.