https://github.com/wso2/oxygen-ui

The Design System powering WSO2 products.
https://github.com/wso2/oxygen-ui

Last synced: 20 days ago
JSON representation

The Design System powering WSO2 products.

• Host: GitHub
• URL: https://github.com/wso2/oxygen-ui
• Owner: wso2
• License: apache-2.0
• Created: 2023-01-25T05:35:18.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-23T08:20:57.000Z (6 months ago)
• Last Synced: 2024-10-25T01:48:28.097Z (6 months ago)
• Language: TypeScript
• Homepage: https://wso2.github.io/oxygen-ui
• Size: 7.03 MB
• Stars: 43
• Watchers: 160
• Forks: 24
• Open Issues: 44
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - wso2/oxygen-ui - The Design System powering WSO2 products. (TypeScript)

README

        


  

    



The

Design System

powering WSO2's core products.




  

  

  

  

  

  

  






Oxygen UI is the underlying design system that powers WSO2's core products like Asgardeo, Choreo, WSO2 Identity Server, etc.

This repository contains the source code of the key components that works together for building resilient UIs.

## Packages

| Package | Description | Version |

| --- | --- | --- |

| [`@oxygen-ui/primitives`](./packages/primitives) | Low level building blocks of Oxygen UI (e.g. icons, fonts)  | ![npm](https://img.shields.io/npm/v/@oxygen-ui/primitives?color=blue) |

| [`@oxygen-ui/react`](./packages/react) | The React implementation of Oxygen UI. | ![npm](https://img.shields.io/npm/v/@oxygen-ui/react?color=green) |

| [`@oxygen-ui/react-icons`](./packages/react-icons) | React components for Oxygen UI icons. | ![npm](https://img.shields.io/npm/v/@oxygen-ui/react-icons?color=yellow) |

| [`@oxygen-ui/logger`](./packages/logger) | Logger for the Oxygen UI packages | ![npm](https://img.shields.io/npm/v/@oxygen-ui/logger?color=orange) |

## Examples

* [💅 Multi Brand Identity Demo](https://wso2.github.io/oxygen-ui/examples/multi-brand-identity/)

    Sample app to showcase Oxygen Design System's multi-branding capabilities.

    ✨ Features

    

    * Ability to switch between different WSO2 brand identities. i.e. Asgardeo, Choreo, etc.

    * Ability to integrate with [Asgardeo Branding](https://wso2.com/asgardeo/docs/guides/branding/configure-ui-branding/) feature.

    Click [here →](./examples/multi-brand-identity/) for the source code 🧑‍💻

## Documentation

For more information on how to use Oxygen UI, check out the [documentation](https://wso2.github.io/oxygen-ui) website.

## Changelog

You can find the latest changes and updates for Oxygen-UI in the [Changelog](./CHANGELOG.md) section. This includes information on new features, bug fixes, and improvements made to the project with each release.

💡 It's recommended to review the changelog before upgrading to a new version of Oxygen-UI.

## Contributing

Want to report a bug, contribute some code, or improve the documentation?

Excellent! Read up on our [guidelines for contributing](./CONTRIBUTING.md) to get started.

## License

Licenses this source under the Apache License, Version 2.0 [LICENSE](./LICENSE), You may not use this file except in compliance with the License.