> Markdown version of [Portlet Support](https://vaadin.com/docs/v23/integrations/portlet). Section index: [llms.txt](https://vaadin.com/docs/v23/integrations/llms.txt)

# Portlet Support

> **Note: Commercial feature**
>
> A commercial Vaadin subscription is required to use Portlet Support in your project.
>
> - [Start Free Trial](https://vaadin.com/trial)
>
> - [See Pricing](https://vaadin.com/pricing)

Vaadin Portlet Support for Vaadin 23 is built on top of the [Portlet 3.0 Specification](https://download.oracle.com/otndocs/jcp/portlet-3-final-spec/). The Vaadin Portlet add-on was developed and tested with Liferay 7, but can be run in other portals supporting Portlet 3.0 and JDK 11+.

## <a id="topics"></a>Topics

- [Creating Vaadin Portlets](https://vaadin.com/docs/v23/integrations/portlet/creating-vaadin-portlets.md): Describes how to build your own Vaadin Portlets and run them.
- [Handling Portlet Phases](https://vaadin.com/docs/v23/integrations/portlet/handling-portlet-phases.md): Introduces the API to use to interact with the Portlet phases and Portlet requests
- [Inter-Portlet Communication](https://vaadin.com/docs/v23/integrations/portlet/inter-portlet-communication.md): Describes how to enable Portlets to communicate with other Portlets (Vaadin or non-Vaadin) on the Portal page
- [Creating Multi-Module Portlet Project](https://vaadin.com/docs/v23/integrations/portlet/creating-multi-module-portlet-project.md): Shows how to create a multi-module Vaadin Portlet Maven project, in which each portlet is in its own module, and frontend assets are in one module
- [Adding a Vaadin Portlet Module to an Existing Multi-Module Project](https://vaadin.com/docs/v23/integrations/portlet/adding-portlet-module.md): Shows how to add a new Vaadin Portlet Module to an existing Vaadin or non-Vaadin multi-module project
- [Appendix A - Address Book Example Project Demonstration](https://vaadin.com/docs/v23/integrations/portlet/demo-address-book.md): Describes how to build two Vaadin Portlets that communicate with each other as a multi-module project

## <a id="limitations-and-known-issues"></a>Limitations and Known Issues

<!-- vale Vaadin.Abbr = NO -->

- Vaadin Portlet doesn’t support integration with `OSGi`, which comes with Liferay 7. Vote for [OSGi support for Vaadin Portlet](https://github.com/vaadin/flow/issues/10939/) if you need it in your project and leave a comment about your use cases.

- The `Vaadin Push` feature is [not supported](https://github.com/vaadin/portlet/issues/200/) at the moment. Vaadin client-to-server polling can be used as a replacement.

- The `SPA` feature isn’t supported and needs to be disabled for Liferay; see the [SPA issue](https://help.liferay.com/hc/en-us/articles/360030752391-Disabling-SPA/).

- The Vaadin Portlet API for changing Portlet’s mode and state doesn’t work with Liferay; see [this issue](https://github.com/vaadin/portlet/issues/214).

- The `@PWA` annotation and all PWA features aren’t supported.

- Vaadin Portlets aren’t compatible with [Multiplatform Runtime](https://vaadin.com/docs/v23/tools/mpr.md).

<!-- vale Vaadin.Abbr = YES -->

## <a id="repositories"></a>Repositories

- [Vaadin Portlet GitHub Repository](https://github.com/vaadin/portlet)\
  Vaadin Portlet source codes.

- [Vaadin Portlet Base Starter Project](https://github.com/vaadin/base-starter-flow-portlet)\
  Simple project to get started with building Vaadin Portlets.

- [Vaadin Portlet Address Book Example Project](https://github.com/vaadin/addressbook-portlet)\
  Address book build as multi-module project with inter-portlet communication.
