How to Contribute Components?

warning

This page may contain outdated information. It will be updated as soon as possible.

New components are added as objects of the CustomComponent class and any dependencies are added to the pyproject.toml file.

Add an example component

You have a new document loader called MyCustomDocumentLoader and it would look awesome in Langflow.

1. Write your loader as an object of the CustomComponent class. You'll create a new class, MyCustomDocumentLoader, that will inherit from CustomComponent and override the base class's methods.
2. Define optional attributes like display_name, description, and documentation to provide information about your custom component.
3. Implement the build_config method to define the configuration options for your custom component.
4. Implement the build method to define the logic for taking input parameters specified in the build_config method and returning the desired output.
5. Add the code to the /components/documentloaders folder.
6. Add the dependency to /documentloaders/__init__.py as from .MyCustomDocumentLoader import MyCustomDocumentLoader.
7. Add any new dependencies to the outer pyproject.toml file.
8. Submit documentation for your component. For this example, you'd submit documentation to the loaders page.
9. Submit your changes as a pull request. The Langflow team will have a look, suggest changes, and add your component to Langflow.

User Sharing

You might want to share and test your custom component with others, but don't need it merged into the main source code.

If so, you can share your component on the Langflow store.

1. Register at the Langflow store.
2. Undergo pre-validation before receiving an API key.
3. To deploy your amazing component directly to the Langflow store, without it being merged into the main source code, navigate to your flow, and then click Share. The share window appears:

5. Choose whether you want to flow to be public or private. You can also Export your flow as a JSON file from this window. When you're ready to share the flow, click Share Flow. You should see a Flow shared successfully popup.
6. To confirm, navigate to the Langflow Store and filter results by Created By Me. You should see your new flow on the Langflow Store.