Skip to main content
👀 Interested in the latest enterprise backend features of refine? 👉 Join now and get early access!
Documentation
Version: 4.xx.xx
Swizzle Ready

Edit

<EditButton> uses Chakra UI's <Button> component. It uses the edit method from useNavigation under the hood. It can be useful when redirecting the app to the edit page with the record id route of resource.

Swizzle

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

Usage​

localhost:3000
import {
    List,

    EditButton,
} from "@refinedev/chakra-ui";
import {
    TableContainer,
    Table,
    Thead,
    Tr,
    Th,
    Tbody,
    Td,
} from "@chakra-ui/react";
import { useTable } from "@refinedev/react-table";
import { ColumnDef, flexRender } from "@tanstack/react-table";

const PostList: React.FC = () => {
    const columns = React.useMemo<ColumnDef<IPost>[]>(
        () => [
            {
                id: "id",
                header: "ID",
                accessorKey: "id",
            },
            {
                id: "title",
                header: "Title",
                accessorKey: "title",
            },
            {
                id: "actions",
                header: "Actions",
                accessorKey: "id",
                cell: function render({ getValue }) {
                    return (
                        <EditButton recordItemId={getValue() as number} />
                    );
                },
            },
        ],
        [],
    );

    const {
        getHeaderGroups,
        getRowModel,
        refineCore: { setCurrent, pageCount, current },
    } = 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 IPost {
    id: number;
    title: string;
}

Properties​

recordItemId​

recordItemId is used to append the record id to the end of the route path.

localhost:3000
import { EditButton } from "@refinedev/chakra-ui";

const MyEditComponent = () => {
    return <EditButton colorScheme="black" recordItemId="123" />;
};

resource​

Redirection endpoint is defined by the resource property and its edit action path. By default, <EditButton> uses the inferred resource from the route.

localhost:3000
import { EditButton } from "@refinedev/chakra-ui";

const MyEditComponent = () => {
    return (
        <EditButton
            colorScheme="black"
            resource="categories"
            recordItemId="2"
        />
    );
};

Clicking the button will trigger the edit method of useNavigation and then redirect the app to the edit action path of the resource, filling the necessary parameters in the route.

If you have multiple resources with the same name, you can pass the identifier instead of the name of the resource. It will only be used as the main matching key for the resource, data provider methods will still work with the name of the resource defined in the <Refine/> component.

For more information, refer to the identifier of the <Refine/> component documentation →

meta​

It is used to pass additional parameters to the edit method of useNavigation. By default, existing parameters in the route are used by the edit method. You can pass additional parameters or override the existing ones using the meta prop.

If the edit action route is defined by the pattern: /posts/:authorId/edit/:id, the meta prop can be used as follows:

const MyComponent = () => {
    return <EditButton meta={{ authorId: "10" }} />;
};

hideText​

It is used to show and not show the text of the button. When true, only the button icon is visible.

localhost:3000
import { EditButton } from "@refinedev/chakra-ui";

const MyEditComponent = () => {
    return <EditButton colorScheme="black" recordItemId="123" hideText />;
};

accessControl​

This prop can be used to skip access control check with its enabled property or to hide the button when the user does not have the permission to access the resource with hideIfUnauthorized property. This is relevant only when an accessControlProvider is provided to <Refine/>

import { EditButton } from "@refinedev/chakra-ui";

export const MyListComponent = () => {
    return (
        <EditButton
            accessControl={{ enabled: true, hideIfUnauthorized: true }}
        />
    );
};

resourceNameOrRouteName
deprecated
​

resourceNameOrRouteName prop is deprecated. Use resource prop instead.

Redirection endpoint(resourceNameOrRouteName/edit) is defined by resourceNameOrRouteName property. By default, <EditButton> uses name property of the resource object as an endpoint to redirect after clicking.

localhost:3000
import { EditButton } from "@refinedev/chakra-ui";

const MyEditComponent = () => {
    return (
        <EditButton
            colorScheme="black"
            resourceNameOrRouteName="categories"
            recordItemId="2"
        />
    );
};

Clicking the button will trigger the edit method of useNavigation and then redirect the app to /categories/edit/2.

API Reference​

Properties​

Last updated on Jul 19, 2023 by Yıldıray Ünlü
Previous
Delete
Next
Export