TaxonomyPicker initialValues prop requires too many props.

Category

[x] Enhancement

[ ] Bug

[x] Question

Version

Please specify what version of the library you are using: [ 1.7 ]

Expected / Desired Behavior / Question

The initialValues TaxonomyPicker property expects
key: The ID of the term
name: The name of the term
path: The path of the term
termSet: The Id of the parent TermSet of the term

As far as I understand, only the key is required so why are all these properties expected?

Since the component does not check for the validity of the values, you could pass anything to the path (and why wouldn't you, the documentation does not mention whether the path is absolute or relative, what the delimiter is, what format the values are and which api can be used to retrieve this data). This could become a problem if someone passing in the (unbeknown to them) incorrect information, has their component break in a future update where the TaxonomyPicker starts validating the input.

Maybe it is better if a completely different interface was created for the initialValues prop which only expects and requires the termId. The termId must be the only value this component relies on as end users can rename or move terms. If there was such an interface, a developer would be assured that the component won't, at some indeterminate point in time, start using the path to retrieve the term (I'm sure that won't happen but I think it is better to be explicit).

Observed Behavior

Once I supply the correct key, I could put in a bogus path and name. The "incorrect" name will be displayed as the default value in the text box (but not in the taxonomy tree if you click on the tag, where the ticked label will be displayed correctly).

Start by locating the TaxonomyPicker implementation and the public type definition for its initialValues prop. Compare the current required fields with the requested termId-only contract and verify that the displayed value and taxonomy tree use the term ID rather than caller-supplied path, name, or termSet data.