Import Code Components

Installation

Learn how to configure your React project for code components.

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:

webflow.json
1{
2    "library": {
3        "name": "<Your Library Name>",
4        "components": ["./src/**/*.webflow.@(js|jsx|mjs|ts|tsx)"],
5        "bundleConfig": "./webpack.webflow.js"
6    }
7}
8
FieldDescriptionRequired
library.nameThe name of your component library as it appears in WebflowYes
library.componentsGlob pattern matching your component filesYes
library.bundleConfigPath to a custom webpack configuration fileNo

Authentication

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

Manual authentication

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

$npx webflow library share --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.

Workspace admin required

You must be a Workspace Admin to create a Workspace token.

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.
Security best practices

Never commit your .env file to version control. Be sure to add .env to your .gitignore file.

Next steps

After configuration, you can: