From 14e4b80595256809ef1cdf7d6c923ea3a7c12807 Mon Sep 17 00:00:00 2001 From: Aleksandra Simeonova Date: Tue, 7 Jul 2020 10:26:28 +0200 Subject: [PATCH 1/3] faq changes --- docs/faq.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 93bce0880f..d78c45346b 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -35,6 +35,14 @@ This video which explains the basics of micro frontend architecture and how it c No, Luigi itself does not deliver any micro frontends. It is a framework that helps you develop micro frontends and connect them to web applications. +### I don't want to use the default Fiori Fundamentals style. How can I style Luigi differently? How can I change the look of Luigi's UI? + +There are a few options to do that at the moment: +- Use the Fundamental Styles theming capabilities which already allow you to achieve a lot by customizing the CSS variables. Find more info [here](https://github.com/SAP/theming-base-content). +- Manually overwrite the styles where needed. The documentation page you are on right now can be used as an example, as it was developed with Luigi! +- Turn off Luigi view components completely via the [hideNavigation](general-settings.md) parameter in the `settings:` section of your Luigi configuration. Then you can implement your own view components for header and navigation and use the [Luigi Core API](luigi-core-api.md) to set them up with Luigi. +- Configure [theming](general-settings.md) directly in Luigi to change the look of the UI. + ### Is Luigi only useful in the context of SAP or very large corporate applications? No, Luigi can be used independently of SAP for a variety of purposes. You can find one example in [this article](https://medium.com/swlh/luigi-micro-fronteds-orchestrator-8c0eca710151) which describes how to create a small hobby project using Luigi. @@ -43,6 +51,14 @@ No, Luigi can be used independently of SAP for a variety of purposes. You can fi The Luigi project can be found on [GitHub](https://github.com/SAP/luigi). Depending on the UI framework you use, there are different setups for Luigi. You can find more information here: [application setup](application-setup.md). +### Does Luigi provide micro frontend to micro frontend communication? + +Yes. The simplest way to configure this type of communication is unidirectional via [linkmanager.navigate](luigi-client-api.md#linkmanager) where you can send additional data to the target micro frontend via [withParams](luigi-client-api.md#withparams). + +Another possibility is to call [linkmanager.navigate](luigi-client-api.md#linkmanager) with the [preserveView](luigi-client-api.md#navigate) option set to `true`. This allows you to get a "return value" from the target micro frontend if it uses the [goBack](luigi-client-api.md#goback) function. Lastly, you can use custom events to model your own communication functionality. + +Of course, Luigi also allows you to communicate between the core application (Luigi Core) and the micro frontend (Luigi Client). See [custom messages](communication.md) for more info. + ### The distributed development possibilities seem like a big advantage; is that just an additional benefit from using Luigi, or was that a main factor behind it? Development scalability was one of the main goals right from the beginning. There is a nice article on [martinfowler.com](https://martinfowler.com/articles/micro-frontends.html) explaining the benefits of a micro frontend architecture in general. All the disadvantages of the iframe approach mentioned in the article are solved with Luigi. @@ -51,13 +67,6 @@ Development scalability was one of the main goals right from the beginning. Ther It is crucial that all micro frontends in a solution follow the same design guidelines. Luigi's default UI styling is based on [Fundamentals](https://sap.github.io/fundamental-styles/) but it can be customised. If you don’t want to use Fundamentals, but Bootstrap, Material, or something else instead, you need to re-style the Luigi view components according to your design guidelines or replace them with your own components completely. -### I don't want to use the default Fiori Fundamentals style. How can I style Luigi differently? - -There are a few options to do that at the moment: -- Use the Fundamental Styles theming capabilities which already allow you to achieve a lot by customizing the CSS variables. Find more info [here](https://github.com/SAP/theming-base-content). -- Manually overwrite the styles where needed. The documentation page you are on right now can be used as an example, as it was developed with Luigi! -- Turn off Luigi view components completely via the [hideNavigation](general-settings.md) parameter in the `settings:` section of your Luigi configuration. Then you can implement your own view components for header and navigation and use the [Luigi Core API](luigi-core-api.md) to set them up with Luigi. - ### Luigi claims to be ‘technology agnostic’. Are you referring to the UI framework that can be used, or to some other technology? The main point is that you can choose any base frontend technology you prefer, such as UI5, Angular, React, or Vue. You can even mix them in one solution. One micro frontend can use UI5, while another is written in Angular and Fundamentals. The only thing that matters is that HTML/JavaScript/CSS resources are provided and served via HTTPS in the end. The fact that a micro frontend is its own web application also means that you have full freedom regarding your development toolchain and CI/CD solutions, and the web server you want to use (such as Nginx, Apache, Tomcat, or Github Pages). From 8ed3a4f2a5fd3d02718f66d4cef3d9de8b3e050f Mon Sep 17 00:00:00 2001 From: Aleksandra Simeonova Date: Tue, 7 Jul 2020 13:26:45 +0200 Subject: [PATCH 2/3] remove text because theming is not released yet --- docs/faq.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/faq.md b/docs/faq.md index d78c45346b..697526d252 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -41,7 +41,6 @@ There are a few options to do that at the moment: - Use the Fundamental Styles theming capabilities which already allow you to achieve a lot by customizing the CSS variables. Find more info [here](https://github.com/SAP/theming-base-content). - Manually overwrite the styles where needed. The documentation page you are on right now can be used as an example, as it was developed with Luigi! - Turn off Luigi view components completely via the [hideNavigation](general-settings.md) parameter in the `settings:` section of your Luigi configuration. Then you can implement your own view components for header and navigation and use the [Luigi Core API](luigi-core-api.md) to set them up with Luigi. -- Configure [theming](general-settings.md) directly in Luigi to change the look of the UI. ### Is Luigi only useful in the context of SAP or very large corporate applications? From c1896e349655d585a44e437bb7e4c351ac0a2a1d Mon Sep 17 00:00:00 2001 From: Aleksandra Simeonova Date: Fri, 10 Jul 2020 13:11:15 +0200 Subject: [PATCH 3/3] change based on suggestion --- docs/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq.md b/docs/faq.md index 697526d252..0aeb37204b 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -39,7 +39,7 @@ No, Luigi itself does not deliver any micro frontends. It is a framework that he There are a few options to do that at the moment: - Use the Fundamental Styles theming capabilities which already allow you to achieve a lot by customizing the CSS variables. Find more info [here](https://github.com/SAP/theming-base-content). -- Manually overwrite the styles where needed. The documentation page you are on right now can be used as an example, as it was developed with Luigi! +- Manually overwrite the styles where needed. The documentation page you are on right now can be used as an example, as it was developed with Luigi. - Turn off Luigi view components completely via the [hideNavigation](general-settings.md) parameter in the `settings:` section of your Luigi configuration. Then you can implement your own view components for header and navigation and use the [Luigi Core API](luigi-core-api.md) to set them up with Luigi. ### Is Luigi only useful in the context of SAP or very large corporate applications?