Overview

The Mezzanine UI project is currently in beta version and is being used by rytass internal projects. It should be noted that there is a possibility of API changes if used in production mode. The project offers a Storybook preview for those interested and provides migration guides for existing Mezzanine users. It is supported on Google Chrome, Edge, Safari, and Firefox browsers.

Features

• Setup: A quick setup process requiring the creation of a main.scss file.
• Customize Palette: Allows customization of the default palette.
• Customize Common System Variables: Customize system variables such as typography, motion, spacing, and z-index.
• Use Mezzanine Typography: Apply Mezzanine typography to components.
• Use Mezzanine Transition (Motion): Apply Mezzanine transitions to components.
• Use Mezzanine z-index: Apply Mezzanine z-index values to components.
• React Hooks: Provides useful hooks like useComposeRefs, useClickAway, usePreviousValue, useWindowWidth, and more.
• Development Guidelines: Provides guidelines such as monorepo structure, component naming conventions, props sorting, adding comments to component interfaces, BEM CSS naming, unit tests, and more.

Installation

To fully install Mezzanine UI, the following steps should be followed:

1. Create a main.scss file or use your preferred filename.
2. Add the necessary code snippet to the main.scss file.
3. Import the main.scss file at your root.

Summary

Mezzanine UI is a beta version project used by rytass internal projects. It provides a range of features such as quick setup, customization of palette and system variables, and the usage of Mezzanine typography, transitions, and z-index values. It also offers useful React hooks and follows specific development guidelines. Users should be aware of the possibility of API changes and can refer to migration guides if needed.