Skip to main content
Version: 3.xx.xxSwizzle Ready

Email

This field is used to display email values. It uses the <Link> component of Chakra UI.

Swizzle

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

Usage​

Let's see how we can use <EmailField> with the example in the user list.

http://localhost:3000/users
import {
List,
TableContainer,
Table,
Thead,
Tr,
Th,
Tbody,
Td,
EmailField,
} from "@pankod/refine-chakra-ui";
import { useTable, ColumnDef, flexRender } from "@pankod/refine-react-table";

const UserList: React.FC = () => {
const columns = React.useMemo<ColumnDef<IUser>[]>(
() => [
{
id: "id",
header: "ID",
accessorKey: "id",
},
{
id: "firstName",
header: "First Name",
accessorKey: "firstName",
},
{
id: "lastName",
header: "Last Name",
accessorKey: "lastName",
},
{
id: "email",
header: "Email",
accessorKey: "email",
cell: function render({ getValue }) {
return (
<EmailField value={getValue()} />
);
},
},
],
[],
);

const { getHeaderGroups, getRowModel } = useTable({
columns,
});

return (
<List>
<TableContainer>
<Table variant="simple" whiteSpace="pre-line">
<Thead>
{getHeaderGroups().map((headerGroup) => (
<Tr key={headerGroup.id}>
{headerGroup.headers.map((header) => {
return (
<Th key={header.id}>
{!header.isPlaceholder &&
flexRender(
header.column.columnDef
.header,
header.getContext(),
)}
</Th>
);
})}
</Tr>
))}
</Thead>
<Tbody>
{getRowModel().rows.map((row) => {
return (
<Tr key={row.id}>
{row.getVisibleCells().map((cell) => {
return (
<Td key={cell.id}>
{flexRender(
cell.column.columnDef.cell,
cell.getContext(),
)}
</Td>
);
})}
</Tr>
);
})}
</Tbody>
</Table>
</TableContainer>
</List>
);
};

interface IUser {
id: number;
firstName: string;
lastName: string;
email: string;
}
tip

<EmailField> uses "mailto:" in the href prop of the <Link> component. For this reason, clicking <EmailField> opens your device's default mail application.

API Reference​

Properties​

Refer to the documentation for the rest of Anchor properties. β†’