# Frameworks

> For the complete documentation index, see [llms.txt](https://plugins.jetbrains.com/docs/intellij/llms.txt).

The following tutorial shows how to support a custom framework type for a project and make this framework type embedded in a [project wizard](new-project-wizard.html) as a UI component. The examples in this tutorial rely heavily on the [framework_basics](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/framework_basics) code sample.

> **Warning:**
> Note that this feature requires a [dependency](plugin-dependencies.html) on the [Java Plugin](idea.html#java-plugin).

## Creating a New Framework

In order to make a custom framework available and configurable for a project, [FrameworkTypeEx](https://github.com/JetBrains/intellij-community/tree/idea/263.7307.200/java/idea-ui/src/com/intellij/framework/FrameworkTypeEx.java) needs to be extended, in this example to make [DemoFramework](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/framework_basics/src/main/java/org/intellij/sdk/framework/DemoFramework.java).

```JAVA
final class DemoFramework extends FrameworkTypeEx {
}
```

## Registering Framework

The newly created framework class should be registered in [com.intellij.framework.type](https://jb.gg/ipe?extensions=com.intellij.framework.type) extension point  in [plugin.xml](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/framework_basics/src/main/resources/META-INF/plugin.xml) configuration file:

```XML
<extensions defaultExtensionNs="com.intellij">
  <framework.type
      implementation="org.intellij.sdk.framework.DemoFramework"/>
</extensions>
```

## Setting up Mandatory Attributes

The framework component should have a unique name passed as a string literal to the constructor. It is best if this is the FQN name of the class:

```JAVA
final class DemoFramework extends FrameworkTypeEx {

  public static final String FRAMEWORK_ID =
      "org.intellij.sdk.framework.DemoFramework";

  DemoFramework() {
    super(FRAMEWORK_ID);
  }
}
```

The Presentable name and icon define the appearance of visual components related to the framework:

```JAVA
final class DemoFramework extends FrameworkTypeEx {
  @NotNull
  @Override
  public String getPresentableName() {
    return "SDK Demo Framework";
  }

  @NotNull
  @Override
  public Icon getIcon() {
    return SdkIcons.Sdk_default_icon;
  }
}
```

## Creating Provider for Enabling Framework Support

To make the framework set up available while executing the steps to create a project, the `DemoFramework.createProvider()` method must be implemented to return an object of type [FrameworkSupportInModuleConfigurable](https://github.com/JetBrains/intellij-community/tree/idea/263.7307.200/java/idea-ui/src/com/intellij/framework/addSupport/FrameworkSupportInModuleConfigurable.java), which adds the framework to a module. In this example the framework is added to any [ModuleType](https://github.com/JetBrains/intellij-community/tree/idea/263.7307.200/platform/lang-core/src/com/intellij/openapi/module/ModuleType.java) without checking, which is usually not the case.

```JAVA
@NotNull
@Override
public FrameworkSupportInModuleProvider createProvider() {
  return new FrameworkSupportInModuleProvider() {
    @NotNull
    @Override
    public FrameworkTypeEx getFrameworkType() {
      return DemoFramework.this;
    }

    @NotNull
    @Override
    public FrameworkSupportInModuleConfigurable createConfigurable(
        @NotNull FrameworkSupportModel model) {
      return new FrameworkSupportInModuleConfigurable() {

        @Override
        public JComponent createComponent() {
          return new JCheckBox("SDK Extra Option");
        }

        @Override
        public void addSupport(@NotNull Module module,
                               @NotNull ModifiableRootModel model,
                               @NotNull ModifiableModelsProvider provider) {
          // This is the place to set up a library, generate a specific file,
          // and actually add framework support to a module.
        }
      };
    }

    @Override
    public boolean isEnabledForModuleType(@NotNull ModuleType type) {
      return true;
    }
  };
}
```

## Compile and Run the Plugin

See [Code Samples](code-samples.html) on how to set up and run the plugin.

An extra option for configuring the newly created Demo custom framework should be available in the Project Wizard:

![Custom Framework Support](images/custom_framework.png)

