Luigi Documentation

If you are new to Luigi, read the Getting started guide to learn more about its structure and key features.

Luigi Core

Luigi Core enables you to create web applications with an easily configurable and consistent user interface.

Installation shows you the first steps to prepare your application for development.

Configuration

TIP: Luigi Fiddle allows you to configure a very simple application and get a feel for the process.

To configure your Luigi application, simply edit the files in the luigi-config folder of your project. Luigi configuration is divided into several sections, which are outlined in the guides below:

  • Navigation (basic) - configure basic top and side navigation, links, and categories.
  • Navigation (advanced) - create a dynamic path, reuse micro frontends with the same origin, and configure additional navigation elements. 
  • Full parameter reference - find all the parameters which you can use to configure Luigi navigation in one place.
  • Authorization - configure login and security features for your application.
  • Authorization events - define event configuration used to react to Luigi authorization events.
  • General settings - fully customize a micro frontend, define a header, make your application responsive, and more.
  • Lifecycle hooks - execute custom logic on any of the Luigi lifecycle steps.

The following guides outline Luigi Core API features and additional UI options that exist outside the configuration files:

  • Core API - API features that help you enrich and use Luigi Core.
  • Luigi UI features - customization options for some of the Luigi UI components.

Luigi Client

Luigi Client enables you to connect micro frontends to an already existing Luigi Core application.

Installation shows you how to install the Luigi Client.

Read the Luigi Client API documentation to learn more about the functions and parameters you can use to communicate with the core application:

  • Lifecycle - manage the lifecycle of listeners, navigation nodes, and event data.
  • Link Manager - navigate to a specific route.
  • UX Manager - manage appearance options such as the behavior of backdrop or loading indicators.

Advanced

Communication describes how to send custom messages between Luigi Core and Client.

Examples

Check the Luigi application examples for an in-depth look at Luigi capabilities.

Development

Read the development and code formatting guidelines if you are interested in contributing.

Copyright © The Linux Foundation Europe. For web site terms of use, trademark policy and other project policies please see https://linuxfoundation.eu/en/policies.