/gravitee-ui-particles

🪐 Set of UI components and UX rules used in Gravitee.io's consoles.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Gravitee UI Particles

CircleCI Storybook

Overview

Gravitee UI Particles centralizes the design system applied to all Gravitee consoles. Based on Angular library.

It currently contains the following packages:

  • @gravitee/ui-particles-angular: Disign system for Gravitee.io Console (APIM, AM, Cockpit)
  • @gravitee/ui-particles-analytic: Contain analytics tools (Pendo)
  • @gravitee/ui-policy-studio-angular: Contain the Policy Studio to share between APIM versions
  • @gravitee/ui-schematics: Contain Angular schematics to generate components, services, etc.

Live Demo

You can see components in action on Storybook.

Usage

To use it in your project just run:

npm install @gravitee/ui-particles-angular
# or
yarn add @gravitee/ui-particles-angular

or any other package you want to use.

Contributing

You think Gravitee.io is awesome and want to contribute to the project?

  • Ensure your dependencies are up-to-date by running yarn install
  • Start Storybook locally with yarn storybook, it will serve it on http://localhost:9008
  • Edit or create a component and Storybook will be updated automatically
  • Do not forget to write documentation for each component
  • Have a look on guidelines that should help you get started.

Copyright

Copyright (C) 2015 The Gravitee team (http://gravitee.io) Licensed under the Apache License, Version 2.0 (the "License");

See the LICENSE file for details.

Changelog

Refer to the CHANGELOG for a complete list of changes.