Customisation (general)
Our design systems and components are highly configurable. Let's have a look at how you can take advantage.
Our design systems and components are highly configurable. Let's have a look at how you can take advantage.
A more light-weight grid for scenarios where you don't need the full power of Grid Pro.
Genesis design systems implement an adaptive colour system that provides some unique advantages:
You can adjust any of the defaults in the src/_config/values folder of your design system. This covers a number of tokens and options.
You can adjust any of the defaults in the src/_config/values file of your design system.
You can adjust any of the defaults in the src/_config/values folder of your design system.
When performing design system customisations, you can control the scope as follows:
A design system is a collection of resources for interactive media that promotes brand alignment. Typically, it consists of the following:
Introduction
Foundation Entity Management
Our API documentation is separate. Click on the link if you want to view it.
Our API documentation is separate. Click on the link if you want to view it.
The Reporting micro front-end enables your application's users to create report specifications, run them, or save them for later use.
Genesis Foundation UI libraries can be used on their own to build modern 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 Genesis Foundation UI working with your existing or preferred stack.
Creating a new component
This is a slotted component that allows a "visual approach" when configuring cell renderers. Each grid-pro-cell takes an ICellRendererFunc typed function.
This is a slotted component that allows a more "visual approach" when defining columns. Each grid-pro-column takes a ColDef typed object.
Set-up
Used in Connected Data scenarios, this will fetch data from a Genesis server (or any other server that implements the Genesis protocol). Available attributes and props may change in the future and are open for feedback but are reflecting the DATA_LOGON message options](/creating-applications/defining-your-application/integrations/rest-endpoints/#data_logon)
Use cases
When dealing with data, you usually have to render the data in a way that is meaningful to the user. This is the purpose of the grid-pro-renderers. The rendering can vary from one column to another, from boolean typed columns that need to be rendered as a checkbox to a column that needs to be rendered as a percentage.
The examples below use JSX syntax. Real-world scenarions might be different, depending on the client application tooling and structure.
Genesis Foundation integrates nicely with Angular. Let's take a look at how you can set up an Angular project, starting from scratch.
Genesis Foundation can be used in React applications. Let's take a look at how you can set up a project, starting from scratch.
Genesis Foundation works great with Vue. Let's take a look at how you can set up a Vue project, starting from scratch.
Micro-front-end architecture is a design approach in which a front-end app is decomposed into individual,
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.
If the target environment does not support websockets the client can be configured to operate in http polling mode.
Broadly speaking, the process can be summarised as follows:
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:
Previously, we showed you how to create a new page. Now we shall add a data grid.
The package.json file is auto-generated for you by the CLI, based on your answers to the prompts.
What you need to know to start
This page looks at the npm commands for building a project.
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.
An anchor is a piece of text that marks the beginning and/or the end of a hypertext link.
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.
The avatar component is used to graphically represent a user or an object.
The badge component is used to highlight an item or flag its status.
As defined by the W3C:
Button component enables users to trigger actions, such as submitting a form or opening a dialog.
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.
An implementation of a checkbox as a form-connected Web Component.
A combobox is an input with an associated pop-up that enables users to select a value from a collection of possible values (auto-complete).
A dialog component presents content to the user. Unlike modal it doesn't prevent the user from interacting with other content on the page.
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:
A Web Component implementation of a horizontal rule.
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.
An implementation of a content scroller as a Web Component.
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.
As defined by the W3C:
A modal component will prevent the user from interacting with other content on the page. An alternative is the dialog component.
A text field for numeric entry.
An implementation of an option.
Web Components are at the very heart of our strategy - which is based on native browsers and a standards-based component model.
A selection input with support for selection of multiple options.
The Progress and Progress Ring components are used to display
The Progress and Progress Ring components are used to display one of the following:
A selection input with support for selection of multiple options.
As defined by the W3C:
An implementation of an HTML select element as a form-connected Web Component.
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.
An implementation of a range slider as a form-connected Web Component.
An implementation of a switch as a form-connected Web Component.
Tabs are a set of layered sections of content that display one panel of content at a time. 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.
An implementation of an HTML textarea element as a form-connected Web Component. The alpha-text-area supports two visual appearances: outline and filled, with the control defaulting to the outline appearance.
An implementation of a text field as a form-connected Web Component. The alpha-text-field supports two visual appearances: outline and filled, with the control defaulting to the outline appearance.
As defined by the W3C:
The alpha-tooltip component is used to provide extra information about another element when the user hovers over it.
As defined by the W3C:
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.
Default web-server set-up
To perform a manual deployment, you will have to:
Genesis Foundation works great 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.