Skip to main content

90 docs tagged with "web"

View All Tags

Angular: example application

We have provided an extensive example application that showcases how to integrate Angular with Genesis Foundation-UI.

Core concepts and set-up

Before diving into the core concepts, let's start with how to set up the Genesis HTTP Client in your project.

Criteria matching

This page looks at how you can apply criteria matching when you connect to Data Server and Request Server resources.

Customisation (general)

Our design systems and components are highly configurable. Let's have a look at how you can take advantage.

Data grid

A more light-weight grid for scenarios where you don't need the full power of Grid Pro.

Design systems - introduction

A design system is a collection of resources for interactive media that promotes brand alignment. Typically, it consists of the following:

Different ways of making requests

The Genesis HTTP Client offers many approaches to making HTTP requests, catering for different use cases and preferences. This section covers the three main approaches:

Entity Management

The entity-management micro front-end gives you a grid and a form that you can add to your pages and configure.

Foundation Reporting

The Reporting micro front-end enables your users to create report specifications, run them, or save them for later use.

Foundation UI - integration

Our FoundationUI libraries can be used on their own to build web sites and applications, but they are also designed to be used in combination with a wide variety of existing technologies. This section of our documentation is dedicated to helping you get FoundationUI working with your existing or preferred stack.

Genesis HTTP Client and external API Integration

The Genesis HTTP Client is designed to simplify integration with external REST services in the Genesis Platform. It provides an intuitive DSL for making HTTP requests, so that you can integrate Request Servers and Event Handlers with external applications.

Genesis UI Generator

The Genesis UI Generator is a Visual Studio Code extension designed to enhance the development experience on the Genesis Platform.

Grid Pro - Cell

This is a slotted component that allows a "visual approach" when configuring cell renderers. Each grid-pro-cell takes an ICellRendererFunc typed function.

Grid Pro - Column

This is a slotted component that allows a more visual approach to defining columns. Each ` takes a ColDef typed object. To check all the available fields for the variable type coldef`, look here.

Grid Pro - Connected data

The connected data use case is when you have a Data Server or Request Server available and ready to use, and don't want to worry about handling data transformations, updates, deletes and cell renderers in the grid. For cell renders, it's flexible; you can use the components provided by default, or you can use any component you want.

Grid Pro - Renderers

The grid-pro-renderers enable you to render data in a way that is meaningful to the user. You can render each column differently and individually.

Grid Pro - Simple data

The examples below use JSX syntax. Real-world scenarios might be different, depending on the client application tooling and structure.

Integrations - Vue

FoundationUI works well with Vue. Let's take a look at how you can set up a Vue project, starting from scratch.

Login

You can find detailed information on this micro front-end in the API documentation.

Practical examples and use cases

This section demonstrates practical examples of using the Genesis HTTP Client in various Genesis components and common use cases.

React: example application

We have provided an extensive example application showing how you can integrate React with Genesis Foundation-UI.

Web

Welcome to the reference documentation on operating Genesis applications. Here, you will find details of a wide range of operating concerns, including specs of the complete Genesis command set and the use of Genesis Console.

Web - Http Polling Mode

If the target environment does not support websockets the client can be configured to operate in http polling mode.

Web basics - front end

To view or use your Genesis application, you need to create one or more web pages. On each of these pages, you need to have components that display information or enable the user to interact with the application. For example:

Web Components - Accordion

An accordion is a vertically stacked set of interactive headings representing a section of content. The headings function as controls that enable users to reveal or hide their associated sections of content. Accordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.

Web Components - Anchored region

An anchored region is a container component that enables you to create layouts where the contents of the anchored region can be positioned relative to another "anchor" element. Additionally, the anchored region can react to the available space between the anchor and a parent "viewport" element such that the region is placed on the side of the anchor with the most available space, or even resize itself based on that space.

Web Components - Button

Button component enables users to trigger actions, such as submitting a form or opening a dialog.

Web Components - Card

The card component is a visual container without semantics, which takes children. Cards are snapshots of content that are typically used in a group to present collections of related information.

Web Components - Charts

A chart component is a graphical representation of a set of data. A range of different chart types can be used. Genesis charts are based on g2plot.

Web Components - Dialog

A dialog component presents content to the user. Unlike modal it doesn't prevent the user from interacting with other content on the page.

Web Components - Disclosure

A disclosure component is the implementation of native details and summary controls, which toggles the visibility of the extra content. Visually, it would look like a button or hyperlink beneath extra content. As defined by the W3C:

Web Components - Flipper

The flipper component is most often used to page through blocks of content or collections of UI elements. As flippers are often a supplemental form of navigation, the flippers are hidden by default to avoid duplicate keyboard interaction. Passing an attribute of aria-hidden="false" will expose the flippers to assistive technology.

Web Components - Listbox

An implementation of a listbox. While any DOM content is permissible as a child of the listbox, only alpha-option elements, option elements, and slotted items with role="option" will be treated as options and receive keyboard support.

Web Components - Modal

A modal is a type of dialog that prevents the user from interacting with other content on the page. Usually, when an active modal is displayed, all other content on the screen is dimmed. The user is unable to move focus to other windows or dialogs. This forces the user to deal with the modal before moving to other work on the application.

Web components - overview

Our easy-to-use Genesis components (also known as custom elements) are web-component-based, so they work with or without your favourite framework.

Web Components - Radio

For information about creating forms and using our web components, see our pages on Forms.

Web Components - Skeleton

The skeleton component is used as a visual placeholder for an element while it is in a loading state. It usually presents itself as a simplified wireframe-like version of the UI it is representing.

Web Components - Tab

Tabs are displayed as a set of layered sections of content, where one selected panel of content is displayed above all the other sections. Each tab panel has an associated tab element that, when activated, displays the panel. The list of tab elements is arranged along one edge of the currently displayed panel.

Web Components - Tooltip

The alpha-tooltip component is used to provide extra information about another element when the user hovers over it.

Web deployment - automated

Ideally, an automated pipeline such as a github workflow should be put in place to build, test and deploy the front end every time the master or develop branches are updated.

Webpack

FoundationUI works well with TypeScript and Webpack, using a fairly standard set-up. Let's take a look at how you can set up such a project, starting from scratch.