Editing Guide

If your tables need full CRUD functionality, you can enable editing features in Shadcn Table.

There are five visually distinct editing modes to choose from, whether you want to let users edit data in a modal, inline one row at a time, one cell at a time, or just always have editing enabled for every cell, or a completely custom editing UI.

Relevant Table OptionsCopy Anchor Link

Relevant Column OptionsCopy Anchor Link

Relevant State OptionsCopy Anchor Link

Enable EditingCopy Anchor Link

To enable editing, you first need to set the enableEditing table option to true.

const table = useShadcnTable({
  columns,
  data,
  enableEditing: true,
});

However, this is just the first step. You will need to hook up logic and event listeners, but it depends on which editDisplayMode you want to use.

Disable EditingCopy Anchor Link

Editing can be turned off on a per-column basis with the enableEditing column option.

const columns = [
  {
    accessorKey: 'age',
    header: 'Age',
    enableEditing: false,
  },
];

In the modal editing mode, a disabled text field will still be rendered for columns with editing disabled, but in the row, cell, and table editing modes, normal cell values will be rendered instead of text fields.

If you want to completely remove an editing textfield from the editing modal or render the normal cell value instead, you can use the Edit column option to override the editing UI for that column.

const columns = [
  {
    accessorKey: 'age',
    header: 'Age',
    enableEditing: false,
    Edit: () => null, //don't render anything in the editing modal for this column
    //or Edit: ({ cell, renderedCellValue }) => <>{renderedCellValue}</>, //render the normal cell value instead of a text field
  },
];

Edit Display ModesCopy Anchor Link

There are five different editDisplayModes to choose from. The default is "modal", but you can also choose "row", "cell", "table", or "custom".

Modal Edit Display ModeCopy Anchor Link

When using the default "modal" editDisplayMode, the user will be presented with a modal dialog where they can edit the data for one row at a time. No data is saved until the user clicks the save button. Clicking the cancel button clears out any changes that were made on that row.

An onEditingRowSave callback function prop must be provided where you will get access to the updated row data so that changes can be processed and saved. It is up to you how you handle the data. This function has a exitEditingMode parameter that must be called in order to exit editing mode upon save. The reason for this is so that you can perform validation checks before letting the modal close.

By default, Shadcn Table will render all of the cells in the row as text fields in a vertical stack. You can customize or override this behavior with the stEditRowDialogProps table option, or the renderEditRowDialogContent table option.

const table = useShadcnTable({
  columns,
  data,
  enableEditing: true,
  editDisplayMode: 'modal', //default
  onEditingRowSave: ({ table, values }) => {
    //validate data
    //save data to api
    table.setEditingRow(null); //exit editing mode
  },
  onEditingRowCancel: () => {
    //clear any validation errors
  },
  stEditRowDialogProps: {
    //optionally customize the dialog
  },
  renderEditRowDialogContent: ({ internalEditComponents, row, table }) => {
    //optionally, completely override the render of the dialog content
    //use `internalEditComponents` to render the generated text fields, or completely render your own form and inputs
  },
});

Row Edit Display ModeCopy Anchor Link

The "row" editDisplayMode works just like the default "modal" editDisplayMode, except that the editing components will render inline in the table instead of in a modal dialog. Only one row is made editable at a time.

By default, you will probably not want to save any data until the user clicks the save button, though you could wire up onChange or onBlur events to save data as the user inputs data.

const table = useShadcnTable({
  columns,
  data,
  enableEditing: true,
  editDisplayMode: 'row',
  onEditingRowSave: ({ table, values }) => {
    //validate data
    //save data to api
    table.setEditingRow(null); //exit editing mode
  },
  onEditingRowCancel: () => {
    //clear any validation errors
  },
});

Cell Edit Display ModeCopy Anchor Link

The "cell" editDisplayMode is a bit simpler visually. By default, a user can double-click a cell to activate editing mode, but only for that cell.

Then there is a bit of work for you to do to wire up either the onBlur, onChange, etc., events yourself in order to save the table data. This can be done in the stEditTextFieldProps table option or column definition option.

const columns = [
  {
    accessor: 'age',
    header: 'Age',
    stEditTextFieldProps: ({ cell, row, table }) => ({
      onBlur: (event) => {
        //validate data
        //save data to api and/or rerender table
        // table.setEditingCell(null) is called automatically onBlur internally
      },
    }),
  },
];

const table = useShadcnTable({
  columns,
  data,
  enableEditing: true,
  editDisplayMode: 'cell',
  //optionally, use single-click to activate editing mode instead of default double-click
  stTableBodyCellProps: ({ cell, column, table }) => ({
    onClick: () => {
      table.setEditingCell(cell); //set editing cell
      //optionally, focus the text field
      queueMicrotask(() => {
        const textField = table.refs.editInputRefs.current?.[column.id];
        if (textField) {
          textField.focus();
          textField.select?.();
        }
      });
    },
  }),
});

Table Edit Display ModeCopy Anchor Link

The "table" editDisplayMode is similar to the "cell" editDisplayMode, but it simply has all of the data cells in the table become editable all at once. You will most likely wire up all of the logic the same way as the "cell" editDisplayMode.

Custom Edit Display ModeCopy Anchor Link

There is another option if you don't like any of the built-in editDisplayModes UI. If you want to completely handle your own editing UI, you can use the "custom" editDisplayMode. This will give you access to the editingCell, editingRow, and creatingRow state options, but ST will not render any editing UI for you. This is common for rendering a form in a sidebar or similar.

Enable CreatingCopy Anchor Link

Shadcn Table offers new functionality to make creating news rows of data easier. It works just like the editing features, but with separate state options and callbacks. A Blank row is added to the table or modal for the user to fill out and submit.

Create Display ModesCopy Anchor Link

There are just three different createDisplayModes to choose from. The default is "modal", but you can also choose "row" or "custom". They work exactly the same as their editDisplayMode counterparts.

Position Creating RowCopy Anchor Link

By default, the creating row will be added to the top of the table. You can change this behavior with the positionCreatingRow table option.

const table = useShadcnTable({
  columns,
  data,
  enableEditing: true,
  createDisplayMode: 'modal',
  positionCreatingRow: 'bottom', //default is 'top'
});

In advanced use cases, such as editing nested expanding sub-rows, you could even pass in a number to the positionCreatingRow table option to specify the index of the row to insert the creating row before.

Trigger Create ModeCopy Anchor Link

To trigger a new blank row to be added to the table, we just need to just populate the creatingRow state option with a new blank row. This can be done with the table.setCreatingRow table instance API. You can either pass in true as an argument, or pass in row object with default values.

const table = useShadcnTable({
  columns,
  data,
  enableEditing: true,
  editDisplayMode: 'modal',
  createDisplayMode: 'modal',
  onCreatingRowSave: ({ table, values }) => {
    //validate data
    //save data to api
    table.setCreatingRow(null); //exit creating mode
  },
  onCreatingRowCancel: () => {
    //clear any validation errors
  },
  renderTopToolbarCustomActions: ({ table }) => (
    <Button
      onClick={() => {
        table.setCreatingRow(true); //simplest way to open the create row modal with no default values
        //or you can pass in a row object to set default values with the `createRow` helper function
        // table.setCreatingRow(
        //   createRow(table, {
        //     //optionally pass in default values for the new row, useful for nested data or other complex scenarios
        //   }),
        // );
      }}
    >
      Create New User
    </Button>
  ),
});

CRUD ExamplesCopy Anchor Link

Customizing Editing ComponentsCopy Anchor Link

You can pass any shadcn/ui TextField Props with the stEditTextFieldProps table option.

const columns = [
  {
    accessor: 'age',
    header: 'Age',
    stEditTextFieldProps: {
      required: true,
      type: 'number',
      variant: 'outlined',
    },
  },
];

Add Validation to Editing ComponentsCopy Anchor Link

You can add validation to the editing components by using the stEditTextFieldProps events. You can write your validation logic and hook it up to the onBlur, onChange, etc., events, then set the error and helperText props accordingly.

If you are implementing validation, you may also need to use the onEditingRowCancel table option to clear the validation error state.

const [validationErrors, setValidationErrors] = useState({});

const columns = [
  {
    accessor: 'age',
    header: 'Age',
    stEditTextFieldProps: {
      error: !!validationErrors.age, //highlight the input red
      helperText: validationErrors.age, //show error message in helper text.
      required: true,
      type: 'number',
      onChange: (event) => {
        const value = event.target.value;
        //validation logic
        if (!value) {
          setValidationErrors((prev) => ({ ...prev, age: 'Age is required' }));
        } else if (value < 18) {
          setValidationErrors({
            ...validationErrors,
            age: 'Age must be 18 or older',
          });
        } else {
          delete validationErrors.age;
          setValidationErrors({ ...validationErrors });
        }
      },
    },
  },
];

Use Custom Editing ComponentsCopy Anchor Link

If you need to use a much more complicated Editing component than the built-in textfield, you can specify a custom editing component with the Edit column definition option.

const columns = [
  {
    accessorKey: 'email',
    header: 'Email',
    Edit: ({ cell, column, row, table }) => {
      const onBlur = (event) => {
        row._valuesCache[column.id] = event.target.value;
        if (isCreating) {
          setCreatingRow(row);
        } else if (isEditing) {
          setEditingRow(row);
        }
      };

      return <CustomInput onBlur={onBlur} />;
    },
  },
];

Customize Actions/Edit ColumnCopy Anchor Link

You can customize the actions column in a few different ways in the displayColumnDefOptions prop's 'st-row-actions' section.

const table = useShadcnTable({
  columns,
  data,
  displayColumnDefOptions: {
    'st-row-actions': {
      header: 'Edit', //change "Actions" to "Edit"
      size: 120,
      //use a text button instead of a icon button
      Cell: ({ row, table }) => (
        <Button onClick={() => table.setEditingRow(row)}>Edit Customer</Button>
      ),
    },
  },
});