Installation

This reference describes the configuration requirements to setup DevLink in a React project for component imports.

Setup requirements

Webflow CLI

Install the Webflow CLI and the necessary dependencies to import React components into Webflow:

$
npm i --save-dev @webflow/webflow-cli @webflow/data-types @webflow/react

What you get:

• @webflow/webflow-cli - CLI used to publish components to Webflow
• @webflow/data-types - TypeScript definitions for Webflow props
• @webflow/react - React utilities for code components

See the CLI reference for publishing commands.

webflow.json

The webflow.json file is used to configure DevLink for component imports. Use this file to define the name of your library and the components that should be included in the library. Additionally, you can specify a custom webpack configuration file to use for bundling your components.

Create or update webflow.json in the root of your project with the following configuration:

1
{
2
    "library": {
3
        "name": "<Your Library Name>",
4
        "components": ["./src/**/*.webflow.@(js|jsx|mjs|ts|tsx)"],
5
        "bundleConfig": "./webpack.webflow.js",
6
        "globals": "./src/globals.webflow.ts"
7
    }
8
}

Authentication

When importing your component library to Webflow using the webflow devlink import command, the Webflow CLI prompts you to authenticate with Webflow. Once authenticated, DevLink will save the token to your .env file.

Manual authentication

To authenticate manually with Webflow, run the webflow devlink import command with the --api-token option and include a Workspace API token in the command. Authenticating in this way is useful when sharing your component library to a different workspace.

$
webflow devlink import --api-token <your-api-token>

Workspace API token

DevLink publishes your component library to a Webflow workspace. To publish to the correct workspace, you must provide a workspace API token for authentication.

To get your workspace API token:

1. Open your workspace and navigate to Apps & Integrations.
2. In the left sidebar. Click Manage
3. Scroll to the bottom section labeled Workspace API Access
4. Click Generate API Token and copy the token.
5. Add the token to your .env file.

Next steps

After configuration, you can:

• Define a code component
• Publish your library

Related topics

• Webflow CLI reference
• Workspace API token