diff --git a/docs/001_develop/03_client-capabilities/022_framework-integration/002_integration-angular.mdx b/docs/001_develop/03_client-capabilities/022_framework-integration/002_integration-angular.mdx new file mode 100644 index 0000000000..e1917fa584 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/022_framework-integration/002_integration-angular.mdx @@ -0,0 +1,387 @@ +--- +title: 'Framework integration - Angular' +sidebar_label: 'Angular' +id: client-framework-integration-angular +keywords: [web, integrations, angular] +tags: +- web +- integrations +- angular +sidebar_position: 22 +--- + + +It is easy to set up a new project where your front end uses the Angular framework. + +On this page, we shall show you how to set up an empty project that you can use as a blank canvas for adding Angular and Genesis components. + +These simple steps create an app you log run and log into, and an empty home page. You are then ready to go into the code and add some components. + +We shall also look briefly at: + +- the folder structure of the project +- the principles of routing and styling an application + +:::tip +You can find out more by looking into our [**example application**](https://github.com/genesiscommunitysuccess/howto-ui-integrations-angular/tree/main), where you can look at the code and check the results against the running application. +::: + +## Setting up the Angular project + +:::info prerequisites +Before you start, ensure that you have [Node.js](https://nodejs.org/) and [Genx](../../../development-environment/genx/) installed on your system. +::: + +1. Create a new Angular project. You could use Genesis Create if you prefer. The example below creates a project called **myApp** using Genx with `--framework Angular`: + + +```shell +npx -y @genesislcap/genx@latest init myApp -s blank-app-seed --framework Angular -x +``` + +2. Navigate to your new project's **client** directory: + +```shell +cd ./client +``` + +## Install the dependencies and run the app + +1. Run the following command from your project folder: + +```shell +npm run bootstrap +``` + +2. Start the app in development mode: + +```shell +npm run dev +``` + +The development server launches your project and makes it available on localhost: + +:::note +The project is currently based on Angular 18. +::: + +## Project folder structure and main elements + +### src/main.ts +This is the main entry point for the application. It bootstraps the app by rendering the **app.module.ts** module into the DOM. The file also registers [PBCs](../../../business-components/) using `registerPBCs` + +--- + +### src/pbc +This folder contains components that are responsible for enabling the insertion of slots within the application. + +These slots act as placeholders where content, provided by the registered Project Building Components ([PBCs](../../../business-components/)), is rendered dynamically. The [PBCs](../../../business-components/) are registered in the application through **main.ts**, ensuring that specific components can be inserted into the designated slots at runtime. + +--- + +### src/app/share +The **share** folder holds shared resources and components that are used across the entire application. + +Key files are: + +- **genesis-components.ts**. This registers Genesis framework components, including forms, layouts, and charts. +- **foundation-login.ts**. This configures the foundation-login micro front-end component that handles authorisation and integrates it with the routing system. + +--- + +### src/app/pages +This folder contains the main pages of the application. Each page represents a different route or view, such as the **auth-login.component.ts**, which handles authentication-related flows. + +--- + +### src/app/components +This folder contains reusable UI components that are utilized throughout the app. Components in this folder are not tied to specific pages but are used as building blocks across multiple sections of the application. + +## Routing + +In Angular, routing is essential for creating single-page applications with navigation capabilities. + +The routing configuration in **app/service/route.service.ts** manages and provides routes throughout the application. This file defines a `RouteService` service that combines routes from the main application and additional routes from PBC (Pluggable Business Components). + +The `pbcRoutes` are generated dynamically by mapping over the routes provided by the PBC, extracting essential properties, and wrapping them in a `PBCContainer` component. These routes are then combined with the main application's routes into a single `allRoutes` array. + +The `RoutesProvider` uses Angular's dependency injection to make these routes available to the rest of the application by providing them through the `RoutesService`. + +Additionally, the `RoutesService` is provided to access the routes within Angular components. This ensures seamless integration and accessibility of both main application routes and PBC routes throughout the application. + +## Setting attributes + +Attributes are part of the HTML markup of an element and are reflected in the dom. + +Attributes can be either hard coded or set using the Angular property bindings. Note, Angular automatically maps hyphenated attribute names to camelCase property names so a property called `max-rows` becomes `maxRows`. + +### Text + +To set a text attribute on a component, you can either hard code it in the template or use Angular square bracket template bindings. + +```ts +import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; + +@Component({ + selector: 'my-root', + template: ` + + + + `, + standalone: true, + schemas: [CUSTOM_ELEMENTS_SCHEMA], +}) +export class AppComponent { + resourceName = 'EVENT_INSERT_USER'; +} +``` + +### Boolean + +To set a boolean attribute on a component you can either hard code it in the template or use Angular template bindings `[]`. + +```ts +import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; + +@Component({ + selector: 'my-root', + template: ` + + Disabled button + + + + Disabled button + + `, + standalone: true, + schemas: [CUSTOM_ELEMENTS_SCHEMA], +}) +export class AppComponent { + isDisabled = true; +} +``` + +### Number + +To set a text attribute on a component, you can either hard code it in the template or use Angular template bindings `[]`. + +```ts +import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; + +@Component({ + selector: 'my-root', + template: ` + + + + + + + + `, + standalone: true, + schemas: [CUSTOM_ELEMENTS_SCHEMA], +}) +export class AppComponent { + maxRows = 100; +} +``` + +## Setting properties + +Properties are part of the Javascript object representation of the DOM element. They are used for dynamic interaction and setting complex non-primitive data types such as objects and arrays. + +You can set these using Angular template bindings `[]`. + +```ts +import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; + +@Component({ + selector: 'my-root', + template: ` + + `, + standalone: true, + schemas: [CUSTOM_ELEMENTS_SCHEMA], +}) +export class AppComponent { + jsonSchema = { + type: 'object', + properties: { + QUANTITY: { + type: 'number', + description: 'kotlin.Double', + }, + SIDE: { + type: 'string', + description: 'kotlin.String', + }, + }, + }; +} +``` + +## Handling events + +You can handle events from Foundation UI components using Angular's event binding `()`. + +```ts +import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; + +@Component({ + selector: 'my-root', + template: ` + + `, + standalone: true, + schemas: [CUSTOM_ELEMENTS_SCHEMA], +}) +export class AppComponent { + handleEvent(e): void { + console.log('form submitted', e); + } +} +``` + +## Styling the application + +### Global styles +You can add global styles by modifying the main stylesheet located at **src/styles/styles.css**. This file contains styles that apply to the entire application. + +--- + +## Slots + +Many components in FoundationUI have slots which act as placeholders to allow you to fill components with your own markup. + +This is equivalent to [content projection](https://angular.dev/guide/components/content-projection) in Angular. + +This example shows how you can use the slots in the Modal component + +```typescript +import { AfterViewInit, Component, CUSTOM_ELEMENTS_SCHEMA, ElementRef, ViewChild } from '@angular/core'; + +@Component({ +selector: 'modal-example', +template: ` + Show modal + +

Top slot

+ Main content in the modal +
+ Slotted content in the bottom +
+
+ `, + standalone: true, + schemas: [CUSTOM_ELEMENTS_SCHEMA], +}) +export class ModalExampleComponent implements AfterViewInit { + @ViewChild('modal') modalRef!: ElementRef; + + showModal() { + if (this.modalRef.nativeElement) { + this.modalRef.nativeElement.show() + } + } + +} +``` + +## Dependency Injection + +Foundation UI has a suite of services that can be added to your application via dependency injection. + +For example, if you want to use the Connect service, the best approach is to create an injection token and register it in your app module. + +:::info +You can follow this same procedure for any other service from the framework that works via dependency injection. +::: + +**connect-service.ts** + +```ts +import { Connect, getConnect } from '@genesislcap/foundation-comms'; +import { InjectionToken } from '@angular/core'; + +export const connectService = getConnect(); +export const CONNECT_TOKEN = new InjectionToken('Logger'); +``` + +**app.module.ts** +```ts +@NgModule({ + ... + providers: [ + { provide: CONNECT_TOKEN, useValue: connectService }, + ... + ], + ... +}) +``` + +**your-angular-component.ts** + +After adding the connect service to your module providers using an injection token, you can add it to any class using Angular DI. + +This component will use the Connect `snapshot` method to retrieve data from a dataserver query `ALL_TRADES` and render it in a list. + +```typescript +import { OnInit, Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; +import { NgForOf } from '@angular/common'; +import { Connect } from '@genesislcap/foundation-comms'; +import { CONNECT_TOKEN } from 'path/to/connect.service'; + +@Component({ +selector: 'di-example', + template: ` + `, + standalone: true, + schemas: [CUSTOM_ELEMENTS_SCHEMA], + imports: [ NgForOf ], + +}) +export class DIExampleComponent implements OnInit { + constructor(@Inject(CONNECT_TOKEN) private connect: Connect) {} + + async ngOnInit() { + const response = await this.connect.snapshot('ALL_TRADES') + + if (response.ROW?.length) { + this.data = response.ROW; + } + } +} +``` + +### Design tokens + +Design tokens are declared in the **src/styles/design-tokens.json** file. They offer an effective way to manage and apply styles in your application in a consistent and maintainable manner. + +The design tokens enable you to define and manage values such as colours, fonts, and spacing across the whole application. You can modify these tokens to propagate changes wherever they are used in the application. + +:::note +See more details in our page on [Design systems](../../../design-systems/introduction/) +::: diff --git a/docs/001_develop/03_client-capabilities/022_framework-integration/003_integration-react.mdx b/docs/001_develop/03_client-capabilities/022_framework-integration/003_integration-react.mdx new file mode 100644 index 0000000000..cb8b423e30 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/022_framework-integration/003_integration-react.mdx @@ -0,0 +1,357 @@ +--- +title: 'Framework integration - React' +sidebar_label: 'React' +id: client-framework-integration-react +keywords: [web, integrations, react] +tags: +- web +- integrations +- react +sidebar_position: 22 +--- + +It is easy to set up a new project where your front end uses the React framework. + +On this page, we shall show you how to set up an empty project that you can use as a blank canvas for adding React and Genesis components. + +These simple steps create an app you log run and log into, and an empty home page. You are then ready to go into the code and add some components. + +We shall also look briefly at: + +- the folder structure of the project +- the principles of routing and styling an application + +:::tip +You can find out more by looking into our [**example application**](https://github.com/genesiscommunitysuccess/howto-ui-integrations-react/tree/main), where you can look at the code and check the results against the running application. +::: + +## Setting up the React project + +:::info prerequisites +Before you start, ensure that you have [Node.js](https://nodejs.org/) and [Genx](../../../development-environment/genx/) installed on your system. +::: + +1. reate a new React project. The example below creates a project called **myApp** using Genx with `--framework React`: + +```shell +npx -y @genesislcap/genx@latest init myApp -s blank-app-seed --framework React -x +``` + +2. Navigate to your new project's **client** directory: + +```shell +cd ./client +``` + +## Install the dependencies and start the app + +1. Run the following command from your project folder: + +```shell +npm run bootstrap +``` + +2. Start the app in development mode: + +```shell +npm run dev +``` + +The development server launches your project and makes it available on localhost: + +:::note +The project is currently based on React 19, which is in the Release Candidate (RC) stage. This version provides improved support for integration with Web Components, making it easier to share data and manage state between React components and Web Components. +::: + +## Project folder structure and main elements + +### src/main.tsx +This is the main entry point for the application. It bootstraps the app by rendering the **App.tsx** component into the DOM. The file also registers [PBCs](../../../business-components/) using `registerPBCs`. + +--- + +### src/pbc +This folder contains components that are responsible for enabling the insertion of slots within the application. These slots act as placeholders where content, provided by the registered Project Building Components ([PBCs](../../../business-components/)), is dynamically rendered. The [PBCs](../../../business-components/) are registered in the application through **main.tsx**, ensuring that specific components can be inserted into the designated slots at runtime. + +--- + +### src/share +The **share** folder holds shared resources and components that are used across the entire application. It includes components like **genesis-components.ts**, which registers Genesis framework components, and **foundation-login.ts**, which sets up the login function for the app. + +Key files are: + +- **genesis-components.ts**. This registers Genesis framework components, including forms, layouts, and charts. +- **foundation-login.ts**. This configures the foundation-login micro front-end component that handles authorisation and integrates it with the routing system. + +--- + +### src/pages +This folder contains the main pages of the application. Each page represents a different route or view, such as the **AuthPage**, which handles authentication-related flows. + +--- + +### src/components +This folder contains UI components that are used throughout the app. Components in this folder are not tied to specific pages, but are used as building blocks across multiple sections of the application. + +## Routing + +In React, routing is essential for creating single-page applications with navigation capabilities. + +The routing configuration in **store/RoutesContext.tsx** manages and provides routes throughout the application. This file defines a `RoutesProvider` component that combines routes from the main application and additional routes from PBC (Pluggable Business Components). + +The `pbcRoutes` are generated dynamically by mapping over the routes provided by the PBC, extracting essential properties, and wrapping them in a `PBCContainer` component. These routes are then combined with the main application's routes into a single `allRoutes` array. + +The `RoutesProvider` uses the React Context API to make these routes available to the rest of the application by wrapping its children with the `RoutesContext.Provider`. + +Additionally, the `useRoutesContext` hook is provided to access the routes context within functional components. This ensures seamless integration and accessibility of both main application routes and PBC routes throughout the application. + +## Setting attributes + +Attributes are part of the HTML markup of an element and are reflected in the dom. + +Attributes can be either hard coded or set using React's property event bindings. + +### Text + +To set a text attribute on a component, you can either hard code it in the template or set using the `{}` React bindings. React converts them when rendering in the DOM. + +```ts +export default function Example({}) { + + const resourceName = 'EVENT_INSERT_USER'; + return ( + + + + ); +} +``` + +### Boolean + +To set a boolean attribute on a component you can either hard code it in the template or use React template bindings `{}`. + +```ts +export default function Example({}) { + const isDisabled = true; + return ( + + Disabled button + + + + Disabled button + + ); +} +``` + +### Number + +To set a text attribute on a component, you can either hard code it in the template or use React template bindings `{}`. + +```ts +export default function Example({}) { + + const maxRows = 100; + return ( + + + + + + + + ); +} +``` + +## Setting properties + +Properties are part of the Javascript object representation of the DOM element. They are used for dynamic interaction and setting complex non-primitive data types such as objects and arrays. + +You can set these using React template bindings `{}`. + +```ts +export default function Example({}) { + + const jsonSchema = { + type: 'object', + properties: { + QUANTITY: { + type: 'number', + description: 'kotlin.Double', + }, + SIDE: { + type: 'string', + description: 'kotlin.String', + }, + }, + }; + return ( + + ); +} +``` + +## Handling events + +You can handle events from Foundation UI components using React's event binding `()`. Note, React prefixes events with `on` + +```ts +export default function Example() { + const handleSubmit = (event) => { + console.log(event.target); + } +} +return ( + +) +``` + +## Styling the application + +### Global styles +You can add global styles by modifying the main stylesheet located at **src/styles/styles.css**. This file contains styles that apply to the entire application. + +--- + +### Styling specific components or pages +For more granular control, you can add styles to a specific page or component. + +For example, if you want to have styling for the page that is displayed when a requested page cannot be found, create a stylesheet called **src/pages/NotFoundPage/NotFoundPage.css** with styles that only apply to that page. + +--- + +## Slots + +Many components in FoundationUI have slots which act as placeholders to allow you to fill components with your own markup. + +This example shows how you can use the slots in the Modal component. + +```typescript +export function MyComponent() { + const modalRef = useRef(null); + + const handleClick = (ref) => { + if (modalRef.current) { + modalRef.current.show(); + } + }; + + return ( + handleClick()}>Open Modal + +

Top slot

+ Main content in the modal +
+ Slotted content in the bottom +
+
+ ); +} +``` + +## Dependency Injection + +Foundation UI has a suite of services that can be added to your application via dependency injection. + +If you want to use the Connect service, the best approach is to create a class to resolve the dependency injection boilerplate and export it. + +:::info +You can follow this same procedure for any other service from the framework that works via dependency injection. +::: + +**connect-service.ts** +```ts +import { DI } from '@microsoft/fast-foundation'; +import { Connect } from '@genesislcap/foundation-comms'; +import { API_DATA } from '../config'; + +class ConnectService { + private container = DI.getOrCreateDOMContainer(); + private connect: Connect = this.container.get(Connect); + + getContainer() { + return this.container; + } + + getConnect() { + return this.connect; + } + + isConnected() { + return this.connect.isConnected; + } + + init() { + return this.connect.connect(API_DATA.URL); + } +} + +export const connectService = new ConnectService(); +``` + +**your-react-component.ts** + +This component will use the Connect `snapshot` method to retrieve data from a dataserver query `ALL_TRADES` and render it in a list. + +```ts +import React, { useState, useEffect } from 'react'; +import { connectService } from './connect.service'; // your file location + +export function YourReactComponent { + + const [data, setData] = useState([]); + + useEffect(() => { + const getData = async () => { + const response = await connectService.getConnect().snapshot('ALL_TRADES') + + if (response.ROW?.length) { + setData(response.ROW); + } + } + + getData(); + }, []); + + return ( + + ); +} +``` + +### Design tokens + +Design tokens are declared in the **src/styles/design-tokens.json** file. They offer an effective way to manage and apply styles in your application in a consistent and maintainable manner. + +The design tokens enable you to define and manage values such as colours, fonts, and spacing across the whole application. You can modify these tokens to propagate changes wherever they are used in the application. + +:::note +See more details in our page on [Design systems](../../../design-systems/introduction/) +::: diff --git a/docs/001_develop/03_client-capabilities/022_framework-integration/index.mdx b/docs/001_develop/03_client-capabilities/022_framework-integration/index.mdx index 7ae1e6ab70..051fe2518f 100644 --- a/docs/001_develop/03_client-capabilities/022_framework-integration/index.mdx +++ b/docs/001_develop/03_client-capabilities/022_framework-integration/index.mdx @@ -11,7 +11,104 @@ tags: sidebar_position: 22 --- -Coming soon... +# Framework integration + +Foundation UI is web components based library. This means it can work alongside front end Frameworks such as React and Angular. + +This section of our documentation will guide you in how to get Foundation UI working with your existing or preferred stack. + +We recommend using our Genesis Create tool to create an Angular or React starter web application to see how the framework is integrated. If you have an existing application you can use the generated create application as a guide to integrating Foundation UI. + +## Registering components + +As Foundation UI is based on web components, the first step is registering the components in the dom. To do this you to import the required modules and components and register the design system (which applies the styles). + +First thing you need to add the Foundation UI npm packages you require. Update your package.json to include the following (note this is not an exhaustive list of all the Foundation UI packages). + +**package.json** + +```json +{ + ... + "depependencies": { + "@genesislcap/foundation-comms": "latest", + "@genesislcap/foundation-login": "latest", + "@genesislcap/foundation-entity-management": "latest", + "@genesislcap/foundation-header": "latest", + "@genesislcap/foundation-ui": "latest", + "@genesislcap/rapid-design-system": "latest", + "@genesislcap/foundation-fdc3": "latest", + "@genesislcap/rapid-grid-pro": "latest", + "@genesislcap/foundation-layout": "latest", + "@genesislcap/g2plot-chart": "latest" + }, + ... +} +``` + +Next, you need to create a file that imports and registers the Foundation UI framework, and the Foundation UI header if you want to use it. + +**genesis-components.ts** + +```ts +import { configure as configureHeader }from '@genesislcap/foundation-header/config'; +import { foundationLayoutComponents } from '@genesislcap/foundation-layout'; +import { EntityManagement } from '@genesislcap/foundation-entity-management'; +import { g2plotChartsComponents } from '@genesislcap/g2plot-chart'; +import * as rapidDesignSystem from '@genesislcap/rapid-design-system'; +import { rapidGridComponents } from '@genesislcap/rapid-grid-pro'; +import { configureFoundationLogin } from './foundation-login'; + +EntityManagement; + +configureHeader({ + templateOptions: { + provider: 'template', + icon: 'rapid-icon', + button: 'rapid-button', + connectionIndicator: 'rapid-connection-indicator', + select: 'rapid-select', + option: 'rapid-option', + flyout: 'rapid-flyout', + }, +}); + +configureFoundationLogin(); + +rapidDesignSystem + .provideDesignSystem() + .register( + rapidDesignSystem.baseComponents, + rapidGridComponents, + g2plotChartsComponents, + foundationLayoutComponents, + ); + +``` + +To use the auth login component create a file to configure the auth micro frontend. + +``` +import {configure, define} from '@genesislcap/foundation-login'; +import { AUTH_PATH } from '../config'; +import { DI } from '@microsoft/fast-foundation'; +import { history } from '../utils/history'; + +/** + * Configure the micro frontend + */ +export const configureFoundationLogin = () => { + configure(DI.getOrCreateDOMContainer(), { + showConnectionIndicator: true, + hostPath: AUTH_PATH, + redirectHandler: () => { + history.push('/home'); + }, + }); + + return define({ + name: `client-app-login`, + }); +}; +``` -- react -- angular \ No newline at end of file