Number

This field is used to display a number formatted according to the browser locale, right aligned. and uses Intl to display date format.

Good to know:

You can swizzle this component to customize it with the Refine CLI

Usage

<NumberField> uses Intl.NumberFormat() if available, passing the locales and options props as arguments. This allows a perfect display of decimals, currencies, percentages, etc. See the Intl.NumberFormat documentation for the options prop syntax.

If Intl is not available, <NumberField> outputs numbers as is (and ignores the locales and options props).

localhost:3000

import {
  List,
  NumberField,
  useTable,
} from "@refinedev/antd";
import { Table } from "antd";

const PostList: React.FC = () => {
  const { tableProps } = useTable<IPost>();

  return (
    <List>
      <Table {...tableProps} rowKey="id">
        <Table.Column dataIndex="id" title="ID" />
        <Table.Column dataIndex="title" title="Title" width="50%" />
        <Table.Column<IPost>
          key="hit"
          title="Hit"
          dataIndex="hit"
          render={(value) => (
            <NumberField
              value={value}
              options={{
                notation: "compact",
              }}
            />
          )}
          width="50%"
        />
      </Table>
    </List>
  );
};

interface IPost {
  id: number;
  title: string;
  hit: number;
}

API Reference

Properties

Property	Type	Description
value ﹡	`ReactChild`	Number value
locale	`string \| string[]`	Override the browser locale in the date formatting. Passed as first argument to `Intl.NumberFormat()`
options	`NumberFormatOptions`	Number formatting options. Passed as second argument to `Intl.NumberFormat()`

External Props:

This field also accepts all props of Ant Design's Text component.

Usage​

API Reference​

Properties​

Usage

API Reference

Properties