Quickstart

Create a new Space every time Flatfile is opened.

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!

For synchronous data import/exchange completed in one session, create a new Space each time Flatfile is opened. This suits situations where a clean slate for every interaction is preferred.

Before you begin

Get your keys

To complete this tutorial, you'll need to retrieve your Publishable key from your development environment.

Note: The Publishable Key is safe to be used in client-side applications as it has limited access to the Flatfile API.

Prepare your project

Follow prompts from the new command.

ng new create-flatfile-angular-embed

cd create-flatfile-angular-embed

npm i @flatfile/angular-sdk @flatfile/plugin-record-hook @flatfile/listener

Build your importer

1. Initialize Flatfile

In your app.component.ts you’ll need to pass in a minimum of the publishableKey.

2. Build a Workbook

Now, let’s build a Workbook inside the Space for next time.

1. Create a file src/app/blueprint.ts with this simple Blueprint.
2. Update app.component to import the Workbook.

Next time you open Flatfile, you’ll see a Workbook called “Contacts” that has one Sheet with three fields. Your Workbook will also have a Submit action. We will configure this action in the next step.

4. Set the destination

Finally, let’s get the data out of our system and to your destination with onSubmit.

Once you add this code, when the submit button is clicked, this will be the place you can egress your data. Learn more about Egress Out

app/app.component.ts

spaceProps = {
  name: "My space!",
  publishableKey: "pk_1234",
  closeSpace: {
    operation: "simpleSubmitAction",
    onClose: this.closeSpace.bind(this),
  },
  displayAsModal: true,
  spaceBody: {
    namespace: "portal",
  },
  sheet: blueprint,
  onSubmit: async ({ sheet }) => {
    const data = await sheet.allData();
    console.log("onSubmit", data);
  },
};

5. Transform Data

Next, we’ll listen for data changes and respond onRecordHook,

Once you add this code, when a change occurs, we’ll log the entered first name and update the last name to “Rock.” You’ll immediately see this begin to work when you add or update any records. Learn more about Handling Data

app/app.component.ts

spaceProps = {
  name: "My space!",
  publishableKey: "pk_1234",
  closeSpace: {
    operation: "simpleSubmitAction",
    onClose: this.closeSpace.bind(this),
  },
  displayAsModal: true,
  spaceBody: {
    namespace: "portal",
  },
  sheet: blueprint,
  onSubmit: async ({ sheet }) => {
    const data = await sheet.allData();
    console.log("onSubmit", data);
  },
  onRecordHook: (record) => {
    const firstName = record.get("firstName");
    console.log({ firstName });
    record.set("lastName", "Rock");
    return record;
  },
};

6. Match your brand

By attaching a themeConfig, we will now override colors in your Space to match your brand. See all of the options here in the Theming Reference.

app/app.component.ts

spaceProps = {
  name: "My space!",
  publishableKey: "pk_1234",
  closeSpace: {
    operation: "simpleSubmitAction",
    onClose: this.closeSpace.bind(this),
  },
  displayAsModal: true,
  spaceBody: {
    namespace: "portal",
  },
  sheet: blueprint,
  onSubmit: async ({ sheet }) => {
    const data = await sheet.allData();
    console.log("onSubmit", data);
  },
  onRecordHook: (record) => {
    const firstName = record.get("firstName");
    console.log({ firstName });
    record.set("lastName", "Rock");
    return record;
  },
  themeConfig: {
    root: {
      primaryColor: "red",
      textColor: "white",
      logo: "https://images.ctfassets.net/hjneo4qi4goj/gL6Blz3kTPdZXWknuIDVx/7bb7c73d93b111ed542d2ed426b42fd5/flatfile.svg",
    },
  },
};

7. Customize

You can stop here or you can view our full reference to see all the ways you can customize your importer.

Example Project

Find this Angular example project in the Flatfile GitHub repository.

create-flatfile-angular

Clone the Flatfile Angular tutorial here.