Product Range/net.ikea.skapa.ui.components/PriceModule

PriceModule

@Composable
fun PriceModule(productName: String, productDescription: String, currentPriceParams: PriceParams, modifier: Modifier = Modifier, variant: PriceModuleVariant = PriceModuleVariant.Regular( size = PriceModuleSizeRegular.Medium, placeholder = false ), energy: @Composable () -> Unit? = null, priceOfferType: PriceOfferType = PriceOfferType.Regular, priceAddons: List<String>? = null, secondCurrencyPriceParams: SecondCurrencyPriceParams? = null, offerMessage: OfferMessageItem? = null)

Price Module communicates product information and price for different scenarios. Note: This is the new implementation of this Price module. In this version there are a couple of significant changes compared to the old PriceModule (Legacy) component.

  • Variant are consolidated into 2, previously 4.

  • Different sizing options for the new variants.

  • Notes and Rating is no longer part of PriceModule. Users are expected to handle these within their own code.

  • Energy label placement to the PriceModuleVariant.List has been moved to be directly under the price and not below the price add-ons.

PriceModuleVariant.Regular (Default) is great for displaying multiple products side by side. Our prices are displayed boldly, and it’s easy to get key product information at a glance.

PriceModuleVariant.List is best suited for vertical lists. While the price is smaller in this variant, it’s still easy to see at a glance. This variant could be a good fit when users are managing a group of products.

Example of usage:

Parameters

productName

Product name, should be capitalised, may include localized product name.

productDescription

A short product description, or product type.

currentPriceParams

Parameters for Current Price.

modifier

Modifier to be applied to the PriceModule.

variant
energy

Composable for Energy class.

priceOfferType
priceAddons

List of strings for PriceAddons.

secondCurrencyPriceParams

Parameters Second price. This can be used if there is a need for providing a secondary currency.

offerMessage

Custom field to use for presenting an offer message for the product.

See also

Samples

net.ikea.skapa.ui.samples.PriceModuleSample