Skip to main content

FAQ

v3.17.0+

Is there an example available?​

Yes, there is an example available to get started.

How can I style my components?​

Tailwind and sccs are supported by default. For Sccs, you can create a component.scss file in the component folder.

How can I reuse some logic between components?​

Use the folder shared to develop reusable code

How can I test my custom components?​

You can add the test framework of you choice, however we recommend vitest

Can I use storybook to develop my components?​

Yes, you can add it to the project following the storybook documentation

What are the minimum requisites?​

  • React 18 or higher

  • React developer tools extension installed

  • Flowable version 3.17 or higher

  • Node version 18 or higher

Is there any prerequisite for on-premise solutions?​

Remember to have the custom components feature enabled, this can be done by setting the following property:

flowable.design.form-component-development.enabled=true

How can I migrate between environments?​

We are working on having a component definition migration, however it is not supported yet. To migrate a component you can run flowable components migrate and then follow the same process of uploading and installing the library.

How can I migrate an old custom component project?​

  • Run flowable components migrate-legacy to register a new component
  • Move the code to the new {component-name}.tsx file that was created.
  • Migrate the palette definition

Can I also create custom components with a version older than 3.17?​

Yes, also older versions of Flowable support the creation of custom components. However, there are more manual steps required and additional things need to be done. Please check-out the how-to create a custom form component for further details.

The tokens menu is missing in the user menu?​

When you are using the on-premise Flowable Design, then you need to provide a signing secret to enable the token menu. Therefore, set the following property:

flowable.design.security.access-token.signing-secret=<your-secret>

The <your-secret> needs to be a 32 character string.

In case you are using a customization project, you also need to add the following dependencies to your pom.xml in case they are not included yet:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-oauth2-resource-server</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.security</groupId>
    <artifactId>spring-security-rsa</artifactId>
</dependency>