IssueTracker

Description:

When using PreviewParameterProviders the names of the generated previews is [PreviewName] ([ParameterName] [Index]) it would be useful if the PreviewParamters could define names for the previews generated from it

Use Case:

A UI can have different states depending on the data given. With Preview Parameters it's very easy to give or even generate the data to show all of the possible UI states (e.g. empty, one entry, multiple entries, error in a List). Giving descriptive names to the previews would make it obvious if something is wrong with the UI. (e.g a preview called "favourite-list Error" State would obviously be wrong if no error is shown in the preview)

Workaround:

It is possible to give the preview parameter a separate property with a name and then render that text into the preview. But that changes the preview itself and is not possible if the preview is screen level and is required to fill the entire screen

Implementation Ideas:

Two ideas on how this could be implemented:

Special Class that wraps a PreviewName and PreviewValue. This can be passed to the PreviewParameter Interface and be reacted to accordingly

secondary method in the PreviewParameter class that get passed the current index, parameter name, preview name and value. The default implementation returns the known $previewName ($parameterName $index) but can be overridden to return other strings. Or just allow the part in parenthesis to be customized so the format would be $previewName (${format(value, index, parameterName)})