Package io.jmix.flowui.kit.meta

Annotation Interface StudioUiKit

@Documented @Retention(CLASS) @Target(TYPE) public @interface StudioUiKit
Annotation marks which interfaces (classes) should be scanned in the Studio.

  • Element Details

    • studioClassloaderDependencies

      String[] studioClassloaderDependencies
      Describes dependencies from module that should be loaded into Studio classloader. It may be required to display a component in the Designer Preview that uses a custom return type in its meta description. The dependency should look like group:name
      Default:
      {}

    • requiredDependencies

      String[] requiredDependencies
      Describes the required dependencies. Optional. If empty the ui kit will be used in Studio. The dependency should look like group:name
      Default:
      {}

    • requiredDependenciesStrategy

      RequiredDependenciesStrategy requiredDependenciesStrategy
      Describes the required dependencies strategy.

      If strategy is RequiredDependenciesStrategy.AND (default value) then all dependencies are required to use the ui kit in the Studio, otherwise any of the dependencies is enough.
      Default:
      AND