Specifies an alias, or array of aliases, which can be used instead of the actual option name.
This can be useful to modify an option name without introducing a breaking change.
Specifies a different markup name to use for an option, rather than the standard name (i.e.,
data- followed by
the hyphened name of the option).
This should only be used for backward compatibility reasons.
Specifies a function that should return the value the option must take when no other value is explicitly specified.
Specifies the value the option must take when no other value is explicitly specified.
Specifies the name of a boolean component option which must be
true in order for this option to function
Specifies a message that labels the option as deprecated. This message appears in the console upon initialization if the deprecated option is used in the page. Consequently, this message should explain as clearly as possible why the option is deprecated, and what now replaces it.
Specifies whether it is necessary to explicitly specify a value for the option in order for the component to function properly.
fieldoption of the
Facetcomponent is required, since a facet cannot function properly without a field.
Specifies a function that should indicate whether the option value is valid.
IComponentOptionsFieldsOptionArgsinterface describes the available parameters when building a fields option.