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

Price

@Composable
fun Price(integerValue: String, decimalValue: String? = null, currency: String, decimalSign: DecimalSign = DecimalSign.Comma, size: PriceSize = PriceSize.Medium, variant: PriceVariant = PriceVariant.Regular(), currencyPosition: CurrencyPosition = CurrencyPosition.Leading, priceSizeStyle: PriceSizeStyle = MixedSize, subscriptLabel: String? = null, modifier: Modifier = Modifier, decimalVerticalAlignment: AffixVerticalAlignment = AffixVerticalAlignment.Top, currencyVerticalAlignment: AffixVerticalAlignment = AffixVerticalAlignment.Top, captionPrefix: String? = null, captionSuffix: String? = null, currencySpacing: CurrencySpacing = CurrencySpacing.None)

Price displays a currency in the IKEA price presentation brand format. This is the leading price display used for most price presentations at IKEA.

PriceVariant.Regular is the leading price used for most price presentations at IKEA. This price displayed can be combined

PriceVariant.Comparison are used alongside an instance of a leading price. They are typically smaller than the leading price and can compare things like non-member prices (Normal price) or a movement from a previous price (Price strikeout). The default behavior of PriceVariant.Comparison displays the Price strikeout style. To display the Normal price variation, you must provide PriceVariant.strikeout and PriceVariant.regularFontWeight as false.

The PriceVariant.BTI (Breath Taking Item) price display styling highlights the price in a BTI box. This styling can only be applied to the leading price variation.

Example of usage:

Parameters

integerValue

Integer value for Price, will render as provided.

decimalValue

Decimal value for Price.

currency

String used for currency.

decimalSign

Decimal sign for Price.

size

PriceSize to define the Price size.PriceSize.Small enforces a PriceSizeStyle.SingleSize for the price.

variant

PriceVariant defines the Price style. The default value is PriceVariant.Regular.

currencyPosition

CurrencyPosition indicates where currency will be displayed.

priceSizeStyle

The price size style variations to be displayed. The default value is PriceSizeStyle.MixedSize.

subscriptLabel

Subscript label defined after decimals and currency.

modifier

Modifier to be applied to the Price.

decimalVerticalAlignment

AffixVerticalAlignment allow you to place decimals value aligned Top or Bottom (same baseline as price)

currencyVerticalAlignment

AffixVerticalAlignment allow you to place currency value aligned Top or Bottom (same baseline as price)

captionPrefix

String to be used as a prefix for screen readers (Talkback) to describe the price.

captionSuffix

String to be used as a suffix for screen readers (Talkback) to describe the price.

currencySpacing

Optional space added between the currency and price digits.

See also

Samples

net.ikea.skapa.ui.samples.PriceSample