FormatRelativeTime

Data Display

상대 시간을 로케일에 맞춰 표시하는 Format 컴포넌트.

Usage

현재를 기준으로 “2시간 전”, “다음 주” 같은 상대 시간을 표시할 때 사용한다.

import

import { FormatRelativeTime } from '@mildang/design-system/Format';

API Reference

FormatRelativeTime Props

Prop

Type

Default

value

필수

number

지정 안 함

locale

string

지정 안 함

options

RelativeTimeFormatOptions

지정 안 함

unit

지정 안 함

같은 패밀리

@mildang/design-system/Format 에서 같이 내보내는 컴포넌트다.

FormatDateTime

날짜·숫자·기간을 로케일에 맞춰 표시하는 대표 포맷터.

FormatDateTimeRange

시작·종료 일시를 로케일에 맞춰 표시하는 Format 컴포넌트.

FormatDayOfWeek

날짜의 요일을 로케일에 맞춰 표시하는 Format 컴포넌트.

FormatDuration

ISO-8601 duration을 로케일에 맞춰 표시하는 Format 컴포넌트.

FormatFileSize

바이트 수를 로케일에 맞춰 파일 크기로 표시하는 Format 컴포넌트.

FormatNumber

숫자를 로케일에 맞춰 표시하는 Format 컴포넌트.

FormatPhoneNumber

전화번호를 국가별 형식에 맞춰 표시하는 Format 컴포넌트.

FormatRelativeTimeFromDate

두 날짜의 차이를 로케일에 맞춰 상대 시간으로 표시하는 Format 컴포넌트.

예제

Default

코드

Open in Playground

import type { ComponentProps } from 'react';
import { FormatRelativeTime } from '@mildang/design-system/Format';

const STORY_DEFAULT_ARGS = { ...({}), ...({
    value: -2,
    unit: 'hour',
  }) } as ComponentProps<typeof FormatRelativeTime>;

const FormatRelativeTimeDefaultExampleRender = (args: ComponentProps<typeof FormatRelativeTime>) => <FormatRelativeTime {...args} />;

export default function FormatRelativeTimeDefaultExample(props: Partial<ComponentProps<typeof FormatRelativeTime>>) {
  const mergedProps = { ...STORY_DEFAULT_ARGS, ...props } as ComponentProps<typeof FormatRelativeTime>;
  return FormatRelativeTimeDefaultExampleRender(mergedProps);
}

PastTime

코드

Open in Playground

import type { ComponentProps } from 'react';
import { FormatRelativeTime } from '@mildang/design-system/Format';

const STORY_DEFAULT_ARGS = { ...({}), ...({
    value: -5,
    unit: 'minute',
  }) } as ComponentProps<typeof FormatRelativeTime>;

const FormatRelativeTimePastTimeExampleRender = (args: ComponentProps<typeof FormatRelativeTime>) => <FormatRelativeTime {...args} />;

export default function FormatRelativeTimePastTimeExample(props: Partial<ComponentProps<typeof FormatRelativeTime>>) {
  const mergedProps = { ...STORY_DEFAULT_ARGS, ...props } as ComponentProps<typeof FormatRelativeTime>;
  return FormatRelativeTimePastTimeExampleRender(mergedProps);
}

FutureTime

코드

Open in Playground

import type { ComponentProps } from 'react';
import { FormatRelativeTime } from '@mildang/design-system/Format';

const STORY_DEFAULT_ARGS = { ...({}), ...({
    value: 2,
    unit: 'day',
  }) } as ComponentProps<typeof FormatRelativeTime>;

const FormatRelativeTimeFutureTimeExampleRender = (args: ComponentProps<typeof FormatRelativeTime>) => <FormatRelativeTime {...args} />;

export default function FormatRelativeTimeFutureTimeExample(props: Partial<ComponentProps<typeof FormatRelativeTime>>) {
  const mergedProps = { ...STORY_DEFAULT_ARGS, ...props } as ComponentProps<typeof FormatRelativeTime>;
  return FormatRelativeTimeFutureTimeExampleRender(mergedProps);
}

NumericFormat

코드

Open in Playground

import type { ComponentProps } from 'react';
import { FormatRelativeTime } from '@mildang/design-system/Format';

const STORY_DEFAULT_ARGS = { ...({}), ...({
    value: -1,
    unit: 'day',
    options: { numeric: 'always' },
  }) } as ComponentProps<typeof FormatRelativeTime>;

const FormatRelativeTimeNumericFormatExampleRender = (args: ComponentProps<typeof FormatRelativeTime>) => <FormatRelativeTime {...args} />;

export default function FormatRelativeTimeNumericFormatExample(props: Partial<ComponentProps<typeof FormatRelativeTime>>) {
  const mergedProps = { ...STORY_DEFAULT_ARGS, ...props } as ComponentProps<typeof FormatRelativeTime>;
  return FormatRelativeTimeNumericFormatExampleRender(mergedProps);
}