Skip to main content

Import Custom React Components

Windmill already provides over sixty components for its users, accessible with a simple drag-and-drop. For more control and standardization with your existing stack, you might want to import your own components in React.

React & Windmill

If you're looking for a way to:

Importing Custom React Components is a Cloud and Self-Hosted-Enterprise-Only feature

Once imported to Windmill, custom React components will be able to interact with the rest of the app.

There are 3 main benefits of using your own components:

  1. Reusing react components you've already written in other codebases.
  2. Controlling fully the component including theming, inputs and outputs allowing for more complex components and interactions.
  3. Embedding very complex components such as a code editor.

If that's not sufficient you can even build your own app in React.

How to import react components to App Editor‚Äč

  1. Clone the template project.
  2. Install the dependencies:
npm install
  1. Start the development server:
npm run dev
  1. Open your browser to see the live result.

  2. Start editing the src/Component.tsx file to start building your component.

  3. Edit COMPONENT_NAME in vite.config.ts to match your component name. It will be useful later.

  4. Build the IIFE using:

npm run build
  1. Upload the dist/cc.iife.js to Windmill and name the component as it has been named in vite.config.ts.

Custom component example