searchspring / snap

Snap is Searchspring's latest front end integration SDK
https://searchspring.github.io/snap/
MIT License
8 stars 0 forks source link

Documentation on `result.display` #1098

Open korgon opened 1 week ago

korgon commented 1 week ago

The SearchResultStore recently had a release with the variants that included a new property display. Together with the mask property display is used as a way to "overlay" various data points without altering the store altogether. This functionality is used in order to allow for selection of variants to alter result data (eg. mappings.core.price) displayed by components.

Documentation needs to be added to the Snap docs to describe how this works and when and where it should be utilized.

Additionally, it seems we are missing some documentation on the result.variants.update function and any other methods that need to be utilized to update variant pricing or other details.