@sidera/mui-kit
v0.2.4
Published
Custom components and utilities for MUI
Maintainers
Readme
@sidera/mui-kit
Overview
@sidera/mui-kit is a custom UI component library built on top of Material-UI (MUI).
Installation
To install the package, use the following command:
npm install @sidera/mui-kitComponents
FitText
The FitText component is a responsive text container that dynamically adjusts its font size and width to fit within its parent container. It is built using Material-UI's Box component and provides additional customization options for scaling and font size.
Props
| Prop | Type | Default | Description |
|---------------|---------------------|---------------|-----------------------------------------------------------------------------|
| minFontSize | number | undefined | The minimum font size allowed for the text. |
| maxFontSize | number | undefined | The maximum font size allowed for the text. |
| fontRatio | number, string | 1 | Ratio for fine-tuning font size. Usually used with a fixed ratio of 1. |
| minScaleX | number | 0.25 | The minimum horizontal scaling factor for the text. |
| sx | BoxProps["sx"] | {} | Custom styles to apply to the component. |
