alpha

LabeledValue

A LabeledValue displays a non-editable value with a label. It formats numbers, dates, times, and lists according to the user's locale.

install	`yarn add @react-spectrum/labeledvalue`
version	3.0.0-alpha.1
usage	`import {LabeledValue} from '@react-spectrum/labeledvalue'`

View repository

GitHub

View package

NPM

Example#

<LabeledValue label="File name" value="Budget.xls" />

<LabeledValue label="File name" value="Budget.xls" />

<LabeledValue
  label="File name"
  value="Budget.xls"
/>

Value#

In addition to a string as shown above, a LabeledValue accepts numbers, dates, times, and lists of strings in the value prop.

Numbers#

When the value prop is set to a number, LabeledValue formats it according to the user's locale.

<LabeledValue label="Number of cookies" value={1024} />

<LabeledValue label="Number of cookies" value={1024} />

<LabeledValue
  label="Number of cookies"
  value={1024}
/>

Custom formatOptions can also be provided to format the value as a percentage, unit, currency, etc. This prop is compatible with the option parameter of Intl.NumberFormat.

<LabeledValue
  label="File size"
  value={1.2}
  formatOptions={{ style: 'unit', unit: 'megabyte' }}
/>

<LabeledValue
  label="File size"
  value={1.2}
  formatOptions={{ style: 'unit', unit: 'megabyte' }}
/>

<LabeledValue
  label="File size"
  value={1.2}
  formatOptions={{
    style: 'unit',
    unit: 'megabyte'
  }}
/>

An object with start and end properties may also be provided to format a numeric range.

<LabeledValue
  label="Price range"
  value={{ start: 150, end: 400 }}
  formatOptions={{
    style: 'currency',
    currency: 'USD',
    minimumFractionDigits: 0
  }}
/>

<LabeledValue
  label="Price range"
  value={{ start: 150, end: 400 }}
  formatOptions={{
    style: 'currency',
    currency: 'USD',
    minimumFractionDigits: 0
  }}
/>

<LabeledValue
  label="Price range"
  value={{
    start: 150,
    end: 400
  }}
  formatOptions={{
    style: 'currency',
    currency: 'USD',
    minimumFractionDigits:
      0
  }}
/>

Dates and times#

The value prop may be set to a JavaScript Date object, or one of the types from @internationalized/date to display a date or time, which is formatted according to the user's locale.

import {getLocalTimeZone, today} from '@internationalized/date';

<LabeledValue
  label="Date modified"
  value={today(getLocalTimeZone()).subtract({ weeks: 1 })}
/>

import {
  getLocalTimeZone,
  today
} from '@internationalized/date';

<LabeledValue
  label="Date modified"
  value={today(getLocalTimeZone()).subtract({ weeks: 1 })}
/>

import {
  getLocalTimeZone,
  today
} from '@internationalized/date';

<LabeledValue
  label="Date modified"
  value={today(
    getLocalTimeZone()
  ).subtract({
    weeks: 1
  })}
/>

By default, the formatting depends on the type of value provided. Above, a CalendarDate is provided, so only the date is displayed. To display a time, pass a Time object. You can also provide a CalendarDateTime or ZonedDateTime to display a date with a time.

import {now} from '@internationalized/date';

<LabeledValue label="Page load time" value={now()} />

import {now} from '@internationalized/date';

<LabeledValue label="Page load time" value={now()} />

import {now} from '@internationalized/date';

<LabeledValue
  label="Page load time"
  value={now()}
/>

An object with start and end properties may also be provided to format a date or time range.

import {Time} from '@internationalized/date';

<LabeledValue
  label="Business hours"
  value={{ start: new Time(8, 30), end: new Time(18) }}
/>

import {Time} from '@internationalized/date';

<LabeledValue
  label="Business hours"
  value={{ start: new Time(8, 30), end: new Time(18) }}
/>

import {Time} from '@internationalized/date';

<LabeledValue
  label="Business hours"
  value={{
    start: new Time(
      8,
      30
    ),
    end: new Time(18)
  }}
/>

Custom formatOptions can also be provided control the exact date format. This prop is compatible with the option parameter of Intl.DateTimeFormat.

<LabeledValue
  label="Appointment date"
  value={new Date(2022, 6, 5)}
  formatOptions={{ dateStyle: 'short' }}
/>

<LabeledValue
  label="Appointment date"
  value={new Date(2022, 6, 5)}
  formatOptions={{ dateStyle: 'short' }}
/>

<LabeledValue
  label="Appointment date"
  value={new Date(
    2022,
    6,
    5
  )}
  formatOptions={{
    dateStyle: 'short'
  }}
/>

Lists#

When the value prop is set to an array of strings, they are rendered as a comma-separated list according to the user's locale.

<LabeledValue
  label="Pizza toppings"
  value={['Pepperoni', 'Pineapple', 'Mushroom', 'Garlic']}
/>

<LabeledValue
  label="Pizza toppings"
  value={['Pepperoni', 'Pineapple', 'Mushroom', 'Garlic']}
/>

<LabeledValue
  label="Pizza toppings"
  value={[
    'Pepperoni',
    'Pineapple',
    'Mushroom',
    'Garlic'
  ]}
/>

By default, the list is displayed as a conjunction (an "and"-based grouping of items). This may be changed to a disjunction (an "or"-based grouping), or a pure comma-separated list using the formatOptions prop. This is compatible with the option parameter of Intl.ListFormat.

<LabeledValue
  label="Interests"
  value={['Travel', 'Hiking', 'Snorkeling', 'Camping']}
  formatOptions={{ type: 'unit' }}
/>

<LabeledValue
  label="Interests"
  value={['Travel', 'Hiking', 'Snorkeling', 'Camping']}
  formatOptions={{ type: 'unit' }}
/>

<LabeledValue
  label="Interests"
  value={[
    'Travel',
    'Hiking',
    'Snorkeling',
    'Camping'
  ]}
  formatOptions={{
    type: 'unit'
  }}
/>

Labeling#

A visual label must be provided to the LabeledValue using the label prop.

Internationalization#

In order to internationalize a LabeledValue, a localized string should be passed to the label prop.

LabeledValue automatically formats numbers, dates, times, and lists according to the user's locale, as defined by the Provider component. String values provided to a LabeledValue should be translated accordingly.

Props#

Name	Type	Default	Description
`value`	`string \| string[] \| number \| RangeValue<number> \| DateTime \| RangeValue<DateTime>`	—	The value to display.
`label`	`ReactNode`	—	The content to display as the label.
`formatOptions`	`Intl.NumberFormatOptions \| Intl.DateTimeFormatOptions \| Intl.ListFormatOptions`	—	Formatting options for the value. The available options depend on the type passed to the `value` prop.
`labelPosition`	`LabelPosition`	`'top'`	The label's overall position relative to the element it is labeling.
`labelAlign`	`Alignment`	`'start'`	The label's horizontal alignment relative to the element it is labeling.
`contextualHelp`	`ReactNode`	—	A ContextualHelp element to place next to the label.

Layout

Name	Type	Default	Description
`flex`	`Responsive<string \| number \| boolean>`	—	When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
`flexGrow`	`Responsive<number>`	—	When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
`flexShrink`	`Responsive<number>`	—	When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
`flexBasis`	`Responsive<number \| string>`	—	When used in a flex layout, specifies the initial main size of the element. See MDN.
`alignSelf`	`Responsive<'auto' \| 'normal' \| 'start' \| 'end' \| 'center' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'stretch'>`	—	Overrides the `alignItems` property of a flex or grid container. See MDN.
`justifySelf`	`Responsive<'auto' \| 'normal' \| 'start' \| 'end' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'center' \| 'left' \| 'right' \| 'stretch'>`	—	Specifies how the element is justified inside a flex or grid container. See MDN.
`order`	`Responsive<number>`	—	The layout order for the element within a flex or grid container. See MDN.
`gridArea`	`Responsive<string>`	—	When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
`gridColumn`	`Responsive<string>`	—	When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
`gridRow`	`Responsive<string>`	—	When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
`gridColumnStart`	`Responsive<string>`	—	When used in a grid layout, specifies the starting column to span within the grid. See MDN.
`gridColumnEnd`	`Responsive<string>`	—	When used in a grid layout, specifies the ending column to span within the grid. See MDN.
`gridRowStart`	`Responsive<string>`	—	When used in a grid layout, specifies the starting row to span within the grid. See MDN.
`gridRowEnd`	`Responsive<string>`	—	When used in a grid layout, specifies the ending row to span within the grid. See MDN.

Spacing

Name	Type	Default	Description
`margin`	`Responsive<DimensionValue>`	—	The margin for all four sides of the element. See MDN.
`marginTop`	`Responsive<DimensionValue>`	—	The margin for the top side of the element. See MDN.
`marginBottom`	`Responsive<DimensionValue>`	—	The margin for the bottom side of the element. See MDN.
`marginStart`	`Responsive<DimensionValue>`	—	The margin for the logical start side of the element, depending on layout direction. See MDN.
`marginEnd`	`Responsive<DimensionValue>`	—	The margin for the logical end side of an element, depending on layout direction. See MDN.
`marginX`	`Responsive<DimensionValue>`	—	The margin for both the left and right sides of the element. See MDN.
`marginY`	`Responsive<DimensionValue>`	—	The margin for both the top and bottom sides of the element. See MDN.

Sizing

Name	Type	Default	Description
`width`	`Responsive<DimensionValue>`	—	The width of the element. See MDN.
`minWidth`	`Responsive<DimensionValue>`	—	The minimum width of the element. See MDN.
`maxWidth`	`Responsive<DimensionValue>`	—	The maximum width of the element. See MDN.
`height`	`Responsive<DimensionValue>`	—	The height of the element. See MDN.
`minHeight`	`Responsive<DimensionValue>`	—	The minimum height of the element. See MDN.
`maxHeight`	`Responsive<DimensionValue>`	—	The maximum height of the element. See MDN.

Positioning

Name	Type	Default	Description
`position`	`Responsive<'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky'>`	—	Specifies how the element is positioned. See MDN.
`top`	`Responsive<DimensionValue>`	—	The top position for the element. See MDN.
`bottom`	`Responsive<DimensionValue>`	—	The bottom position for the element. See MDN.
`left`	`Responsive<DimensionValue>`	—	The left position for the element. See MDN. Consider using `start` instead for RTL support.
`right`	`Responsive<DimensionValue>`	—	The right position for the element. See MDN. Consider using `start` instead for RTL support.
`start`	`Responsive<DimensionValue>`	—	The logical start position for the element, depending on layout direction. See MDN.
`end`	`Responsive<DimensionValue>`	—	The logical end position for the element, depending on layout direction. See MDN.
`zIndex`	`Responsive<number>`	—	The stacking order for the element. See MDN.
`isHidden`	`Responsive<boolean>`	—	Hides the element.

Accessibility

Name	Type	Default	Description
`id`	`string`	—	The element's unique identifier. See MDN.

Advanced

Name	Type	Default	Description
`UNSAFE_className`	`string`	—	Sets the CSS className for the element. Only use as a last resort. Use style props instead.
`UNSAFE_style`	`CSSProperties`	—	Sets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#

Label alignment and position#

View guidelines

By default, the label is positioned above the LabeledValue. The labelPosition prop can be used to position the label to the side. The labelAlign prop can be used to align the label as "start" or "end". For left-to-right (LTR) languages, "start" refers to the left most edge of the LabeledValue and "end" refers to the right-most edge. For right-to-left (RTL) languages, this is flipped.

<LabeledValue
  label="File name"
  value="Onboarding.pdf"
  labelPosition="side"
  labelAlign="end"
/>

<LabeledValue
  label="File name"
  value="Onboarding.pdf"
  labelPosition="side"
  labelAlign="end"
/>

<LabeledValue
  label="File name"
  value="Onboarding.pdf"
  labelPosition="side"
  labelAlign="end"
/>

Name	Type	Description
`start`	`T`	The start value of the range.
`end`	`T`	The end value of the range.

Date
  | CalendarDate
  | CalendarDateTime
  | ZonedDateTime
  | Time

A CalendarDate represents a date without any time components in a specific calendar system.

Properties

Name	Type	Description
`calendar`	`Calendar`	The calendar system associated with this date, e.g. Gregorian.
`era`	`string`	The calendar era for this date, e.g. "BC" or "AD".
`year`	`number`	The year of this date within the era.
`month`	`number`	The month number within the year. Note that some calendar systems such as Hebrew may have a variable number of months per year. Therefore, month numbers may not always correspond to the same month names in different years.
`day`	`number`	The day number within the month.

Methods

Method	Description
`constructor( (...args: any[] )): void`
`copy(): CalendarDate`	Returns a copy of this date.
`add( (duration: DateDuration )): CalendarDate`	Returns a new `CalendarDate` with the given duration added to it.
`subtract( (duration: DateDuration )): CalendarDate`	Returns a new `CalendarDate` with the given duration subtracted from it.
`set( (fields: DateFields )): CalendarDate`	Returns a new `CalendarDate` with the given fields set to the provided values. Other fields will be constrained accordingly.
`cycle( field: DateField, amount: number, options?: CycleOptions ): CalendarDate`	Returns a new `CalendarDate` with the given field adjusted by a specified amount. When the resulting value reaches the limits of the field, it wraps around.
`toDate( (timeZone: string )): Date`	Converts the date to a native JavaScript Date object, with the time set to midnight in the given time zone.
`toString(): string`	Converts the date to an ISO 8601 formatted string.
`compare( (b: AnyCalendarDate )): number`	Compares this date with another. A negative result indicates that this date is before the given one, and a positive date indicates that it is after.

A CalendarDateTime represents a date and time without a time zone, in a specific calendar system.

Properties

Name	Type	Description
`calendar`	`Calendar`	The calendar system associated with this date, e.g. Gregorian.
`era`	`string`	The calendar era for this date, e.g. "BC" or "AD".
`year`	`number`	The year of this date within the era.
`month`	`number`	The month number within the year. Note that some calendar systems such as Hebrew may have a variable number of months per year. Therefore, month numbers may not always correspond to the same month names in different years.
`day`	`number`	The day number within the month.
`hour`	`number`	The hour in the day, numbered from 0 to 23.
`minute`	`number`	The minute in the hour.
`second`	`number`	The second in the minute.
`millisecond`	`number`	The millisecond in the second.

Methods

Method	Description
`constructor( (...args: any[] )): void`
`copy(): CalendarDateTime`	Returns a copy of this date.
`add( (duration: DateTimeDuration )): CalendarDateTime`	Returns a new `CalendarDateTime` with the given duration added to it.
`subtract( (duration: DateTimeDuration )): CalendarDateTime`	Returns a new `CalendarDateTime` with the given duration subtracted from it.
`set( (fields: DateFields & & TimeFields )): CalendarDateTime`	Returns a new `CalendarDateTime` with the given fields set to the provided values. Other fields will be constrained accordingly.
`cycle( field: DateField \| \| TimeField, amount: number, options?: CycleTimeOptions ): CalendarDateTime`	Returns a new `CalendarDateTime` with the given field adjusted by a specified amount. When the resulting value reaches the limits of the field, it wraps around.
`toDate( (timeZone: string, , disambiguation?: Disambiguation )): Date`	Converts the date to a native JavaScript Date object in the given time zone.
`toString(): string`	Converts the date to an ISO 8601 formatted string.
`compare( (b: CalendarDate \| CalendarDateTime \| ZonedDateTime )): number`	Compares this date with another. A negative result indicates that this date is before the given one, and a positive date indicates that it is after.

A ZonedDateTime represents a date and time in a specific time zone and calendar system.

Properties

Name	Type	Description
`calendar`	`Calendar`	The calendar system associated with this date, e.g. Gregorian.
`era`	`string`	The calendar era for this date, e.g. "BC" or "AD".
`year`	`number`	The year of this date within the era.
`month`	`number`	The month number within the year. Note that some calendar systems such as Hebrew may have a variable number of months per year. Therefore, month numbers may not always correspond to the same month names in different years.
`day`	`number`	The day number within the month.
`hour`	`number`	The hour in the day, numbered from 0 to 23.
`minute`	`number`	The minute in the hour.
`second`	`number`	The second in the minute.
`millisecond`	`number`	The millisecond in the second.
`timeZone`	`string`	The IANA time zone identifier that this date and time is represented in.
`offset`	`number`	The UTC offset for this time, in seconds.

Methods

Method	Description
`constructor( (...args: any[] )): void`
`copy(): ZonedDateTime`	Returns a copy of this date.
`add( (duration: DateTimeDuration )): void`	Returns a new `ZonedDateTime` with the given duration added to it.
`subtract( (duration: DateTimeDuration )): void`	Returns a new `ZonedDateTime` with the given duration subtracted from it.
`set( (fields: DateFields & & TimeFields, , disambiguation?: Disambiguation )): void`	Returns a new `ZonedDateTime` with the given fields set to the provided values. Other fields will be constrained accordingly.
`cycle( field: DateField \| \| TimeField, amount: number, options?: CycleTimeOptions ): void`	Returns a new `ZonedDateTime` with the given field adjusted by a specified amount. When the resulting value reaches the limits of the field, it wraps around.
`toDate(): void`	Converts the date to a native JavaScript Date object.
`toString(): void`	Converts the date to an ISO 8601 formatted string, including the UTC offset and time zone identifier.
`toAbsoluteString(): void`	Converts the date to an ISO 8601 formatted string in UTC.
`compare( (b: CalendarDate \| CalendarDateTime \| ZonedDateTime )): void`	Compares this date with another. A negative result indicates that this date is before the given one, and a positive date indicates that it is after.

A Time represents a clock time without any date components.

Properties

Name	Type	Description
`hour`	`number`	The hour, numbered from 0 to 23.
`minute`	`number`	The minute in the hour.
`second`	`number`	The second in the minute.
`millisecond`	`number`	The millisecond in the second.

Methods

Method	Description
`constructor( hour: number, minute: number, second: number, millisecond: number ): void`
`copy(): Time`	Returns a copy of this time.
`add( (duration: TimeDuration )): void`	Returns a new `Time` with the given duration added to it.
`subtract( (duration: TimeDuration )): void`	Returns a new `Time` with the given duration subtracted from it.
`set( (fields: TimeFields )): void`	Returns a new `Time` with the given fields set to the provided values. Other fields will be constrained accordingly.
`cycle( field: TimeField, amount: number, options?: CycleTimeOptions ): void`	Returns a new `Time` with the given field adjusted by a specified amount. When the resulting value reaches the limits of the field, it wraps around.
`toString(): void`	Converts the time to an ISO 8601 formatted string.
`compare( (b: AnyTime )): void`	Compares this time with another. A negative result indicates that this time is before the given one, and a positive time indicates that it is after.

'top' | 'side'

'start' | 'end'

T | ResponsiveProp<T>

{base?: T,
S?: T,
M?: T,
L?: T,
[custom: string]: T | undefined
}

See the Styling docs for a visualization of these values.

'size-0'
  | 'size-10'
  | 'size-25'
  | 'size-40'
  | 'size-50'
  | 'size-65'
  | 'size-75'
  | 'size-85'
  | 'size-100'
  | 'size-115'
  | 'size-125'
  | 'size-130'
  | 'size-150'
  | 'size-160'
  | 'size-175'
  | 'size-200'
  | 'size-225'
  | 'size-250'
  | 'size-300'
  | 'size-350'
  | 'size-400'
  | 'size-450'
  | 'size-500'
  | 'size-550'
  | 'size-600'
  | 'size-675'
  | 'size-700'
  | 'size-800'
  | 'size-900'
  | 'size-1000'
  | 'size-1200'
  | 'size-1250'
  | 'size-1600'
  | 'size-1700'
  | 'size-2000'
  | 'size-2400'
  | 'size-3000'
  | 'size-3400'
  | 'size-3600'
  | 'size-4600'
  | 'size-5000'
  | 'size-6000'
  | 'static-size-0'
  | 'static-size-10'
  | 'static-size-25'
  | 'static-size-50'
  | 'static-size-40'
  | 'static-size-65'
  | 'static-size-100'
  | 'static-size-115'
  | 'static-size-125'
  | 'static-size-130'
  | 'static-size-150'
  | 'static-size-160'
  | 'static-size-175'
  | 'static-size-200'
  | 'static-size-225'
  | 'static-size-250'
  | 'static-size-300'
  | 'static-size-400'
  | 'static-size-450'
  | 'static-size-500'
  | 'static-size-550'
  | 'static-size-600'
  | 'static-size-700'
  | 'static-size-800'
  | 'static-size-900'
  | 'static-size-1000'
  | 'static-size-1200'
  | 'static-size-1700'
  | 'static-size-2400'
  | 'static-size-2600'
  | 'static-size-3400'
  | 'static-size-3600'
  | 'static-size-4600'
  | 'static-size-5000'
  | 'static-size-6000'
  | 'single-line-height'
  | 'single-line-width'
  | string
    &  & {}
  | number