Skip to content

Ansible UI Framework

Martin Hradil edited this page Jun 28, 2023 · 16 revisions

A framework for building applications using PatternFly.

While PatternFly provides the building blocks and guidance on building applications, PatternFly does not tie together those building blocks and manage the needed state for the developer. This framework adds state management and abstractions for common patterns of application development.

This framework:

  • does not use any state libraries other than the built in react context state management.
  • does not assume any specific translation libraries, but does provide a hook for internal translations.
  • does not assume any specific navigation libraries, but does provide a hook for internal navigation.

There is an Ansible UI Framework Demo repo showing an example of using the framework.

Getting Started

Install the NPM package

npm install @ansible/ansible-ui-framework

Using the framework

  1. Use PageFramework in your application.
  2. Use PageLayout to control the layout in your pages.
  3. Use PageHeader to add consistent headers to your pages.
  4. Use framework components in your page

Overview, structure, guides

See Overview, structure

Clone this wiki locally