Theme your Space - flatfile.com

The DevXP engineering team hosts office hours every Thursday at 11 a.m. Pacific Time where we answer your questions live and help you get up and running with Flatfile. Join us!

Flatfile supports modifying most UI elements including colors, fonts, borders, padding, and more via the endpoint.

Start by simply updating theme.root.primaryColor and theme.sidebar.logo when calling spaces.update().
If needed, you can customize the theme further with additional css variables.

Building a theme

Learn how to create a Space with a theme, and update a theme from an Event listener.

import api from "@flatfile/api";

export default function flatfileEventListener(listener) {
  //listen for space:configure job and build out space
  listener.filter({ job: "space:configure" }, (configure) => {});

  //theme during creation or update your space after it is created
  listener.on("space:created", async ({ context: { spaceId } }) => {
    const updateSpace = await api.spaces.update(spaceId, {
      metadata: {
        theme: {
          root: {
            primaryColor: "red",
          },
          sidebar: {
            logo: "https://image.png",
          },
          // See reference for all possible variables
        },
      },
    });
  });
}

// See full code example (https://github.com/FlatFilers/flatfile-docs-kitchen-sink/blob/main/javascript/theming/index.js)

import { FlatfileListener, FlatfileEvent } from "@flatfile/listener";
import api from "@flatfile/api";

export default function flatfileEventListener(listener: FlatfileListener) {
  //configure space initially
  listener.on(
    "job:ready",
    { job: "space:configure" },
    async ({ context: { spaceId, jobId } }: FlatfileEvent) => {
      await api.jobs.ack(jobId, {
        info: "Gettin started.",
        progress: 10,
      });

      await api.workbooks.create({
        spaceId,
        name: "All Data",
        labels: ["pinned"],
        sheets: [
          {
            name: "Contacts",
            slug: "contacts",
            fields: [
              {
                key: "firstName",
                type: "string",
                label: "First Name",
              },
              {
                key: "lastName",
                type: "string",
                label: "Last Name",
              },
              {
                key: "email",
                type: "string",
                label: "Email",
              },
            ],
            actions: [
              {
                operation: "duplicate",
                mode: "background",
                label: "Duplicate Sheet",
                type: "string",
                description: "Duplicate this Sheet and lock down the original.",
                primary: true,
              },
            ],
          },
        ],
        actions: [
          {
            operation: "submitActionFg",
            mode: "foreground",
            label: "Submit foreground",
            type: "string",
            description: "Submit data to webhook.site",
            primary: true,
          },
        ],
      });

      await api.jobs.complete(jobId, {
        outcome: {
          message: "This job is now complete.",
        },
      });
    }
  );

  //update space after created
  //you can also do this during configuration
  listener.on(
    "space:created",
    async ({ context: { spaceId } }: FlatfileEvent) => {
      //const updateSpace = await flatfile.spaces.update(spaceId, {});

      const updateSpace = await api.spaces.update(spaceId, {
        metadata: {
          theme: {
            root: {
              primaryColor: "red",
            },
            sidebar: {
              logo: "https://image.png",
            },
            // See reference for all possible variables
          },
        },
      });
    }
  );
}

// See full code example (https://github.com/FlatFilers/flatfile-docs-kitchen-sink/blob/main/theming/index.ts)

See full code example in our flatfile-docs-kitchen-sink Github repo

Theme reference

`theme.root`

The sidebar, table and document will automatically inherit theming from your root variables!

Font

string

The font family used throughout the application. Only system fonts are supported at the moment

Colors

string

The primary color used throughout the application.

string

The color used for error messages.

string

The color used for warning messages.

string

The color used for borders throughout the application.

You can override the default colors of the sidebar below. If these are not set they will inherit from your root colors.

string

The img path for the logo displayed in the sidebar.

string

The color of the text in the sidebar.

string

The color of the title in the sidebar.

string

The background color of the active navigation link. The hover state will use the same color with 30% opacity applied.

string

The text color of the active/focused navigation link.

string

The background color of the sidebar.

`theme.table`

You can override the default colors and values for different elements in the table below. If these are not set they will inherit from your root values.

Font

string

The font family used throughout the table. Only system fonts are supported at the moment

Active cell

`theme.table.cell`

string

The width of the border around the active cell.

string

The box shadow around the active cell.

string

The font family for number cells.

Column header

`theme.table.column`

string

The background color of the column headers in the table.

string

The text color of the column headers in the table.

Index column

`theme.table.indexColumn`

string

The background color of the first column in the table.

string

The text color of the first column in the table.

string

The background color of the first column in the table when selected.

Checkboxes

`theme.table.inputs`

string

The color of the checkboxes in the table.

string

The color of the border for the checkboxes in the table.

Filters

`theme.table.filters`

string

The border radius of the table filters

string

The border radius for the individual filters

string

The border of the table filters. By default there is no border.

When nested objects share the same border radius, small gaps may appear. To resolve this, adjust the inner and outer border radius on the filters to seamlessly fill any gaps.

Buttons

`theme.table.buttons`

string

The color of the icon buttons in the toolbar and table

string

The color of the pill buttons in the toolbar

`theme.email`

You can theme the guest invite emails as well as guest email verification emails via the properties below. These are sent to a guest when they are invited to a Space via the guest management page in your Space.

Email theming is only available on the pro and enterprise plans.

string

The URL of the image displayed at the top of the email

string

The color of the text in the email

string

The color of the title in the email

string

The background color of the button

string

The text color of the button

string

The text color of the footer text

string

The background color of the email

`theme.email.dark`

If your default email theme (as set above) is light, we suggest adding a dark mode email theme. Different email providers handle dark and light mode differently. While Apple Mail and some other clients will respect dark mode variables, some email providers do not support dark mode and will display your default theme. We suggest you test your themes across various email clients before going to production to ensure consistent appearance.

string

The URL of the image displayed at the top of the email in dark mode

string

The color of the text in the email in dark mode

string

The color of the title in the email in dark mode

string

The background color of the button in dark mode

string

The text color of the button in dark mode

string

The text color of the footer text in dark mode

string

The background color of the email in dark mode

Deprecation Notice

Flatfile’s new design system released in Q1 2025 supports a more streamlined experience when configuring theme. The new system accepts a more limited set of properties, but ensures those supplied properties are cohesively applied across the application.As a result, many of the original theme.root properties which applied to specific UI elements have been deprecated. We have taken steps to ensure some level of backwards compatibility for these properties in the new system - however we recommend any usage of these properties be updated to the new system as soon as possible.