FormatNumber

Data Display

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

Usage

숫자·통화·백분율을 직접 포맷하지 않고 현재 로케일로 표시할 때 사용한다.

import

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

API Reference

FormatNumber Props

Prop

Type

Default

value

필수

number

지정 안 함

locale

string

지정 안 함

options

NumberFormatOptions

지정 안 함

같은 패밀리

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

FormatDateTime

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

FormatDateTimeRange

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

FormatDayOfWeek

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

FormatDuration

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

FormatFileSize

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

FormatPhoneNumber

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

FormatRelativeTime

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

FormatRelativeTimeFromDate

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

예제

Default

코드

Open in Playground

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

const STORY_DEFAULT_ARGS = { ...({}), ...({
    value: 123456.789,
  }) } as ComponentProps<typeof FormatNumber>;

const FormatNumberDefaultExampleRender = (args: ComponentProps<typeof FormatNumber>) => <FormatNumber {...args} />;

export default function FormatNumberDefaultExample(props: Partial<ComponentProps<typeof FormatNumber>>) {
  const mergedProps = { ...STORY_DEFAULT_ARGS, ...props } as ComponentProps<typeof FormatNumber>;
  return FormatNumberDefaultExampleRender(mergedProps);
}

Currency

코드

Open in Playground

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

const STORY_DEFAULT_ARGS = { ...({}), ...({
    value: 123456.789,
    options: { style: 'currency', currency: 'KRW' },
  }) } as ComponentProps<typeof FormatNumber>;

const FormatNumberCurrencyExampleRender = (args: ComponentProps<typeof FormatNumber>) => <FormatNumber {...args} />;

export default function FormatNumberCurrencyExample(props: Partial<ComponentProps<typeof FormatNumber>>) {
  const mergedProps = { ...STORY_DEFAULT_ARGS, ...props } as ComponentProps<typeof FormatNumber>;
  return FormatNumberCurrencyExampleRender(mergedProps);
}

Percentage

코드

Open in Playground

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

const STORY_DEFAULT_ARGS = { ...({}), ...({
    value: 0.1234,
    options: { style: 'percent' },
  }) } as ComponentProps<typeof FormatNumber>;

const FormatNumberPercentageExampleRender = (args: ComponentProps<typeof FormatNumber>) => <FormatNumber {...args} />;

export default function FormatNumberPercentageExample(props: Partial<ComponentProps<typeof FormatNumber>>) {
  const mergedProps = { ...STORY_DEFAULT_ARGS, ...props } as ComponentProps<typeof FormatNumber>;
  return FormatNumberPercentageExampleRender(mergedProps);
}

Compact

코드

Open in Playground

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

const STORY_DEFAULT_ARGS = { ...({}), ...({
    value: 1234567890,
    options: { notation: 'compact' },
  }) } as ComponentProps<typeof FormatNumber>;

const FormatNumberCompactExampleRender = (args: ComponentProps<typeof FormatNumber>) => <FormatNumber {...args} />;

export default function FormatNumberCompactExample(props: Partial<ComponentProps<typeof FormatNumber>>) {
  const mergedProps = { ...STORY_DEFAULT_ARGS, ...props } as ComponentProps<typeof FormatNumber>;
  return FormatNumberCompactExampleRender(mergedProps);
}