momentral-ui
v2.13.0
Published
Momentral ui component library
Keywords
Readme
UI Library for Moment Sport App
This is the official UI library for Moment Sport App, built with React, TypeScript, Tailwind CSS, and PostCSS.
Installation
To install the UI library:
npm install momentral-ui
# or
yarn add momentral-ui
This package includes the necessary peer dependencies, such as:
React
Typescript
classnames
tailwindcss
postcss
autoprefixer
Note: These dependencies will be installed automatically.
Usage
1. Set up Tailwind CSS
Ensure you have Tailwind CSS configured in your project. If not, follow these steps:
- Install Tailwind CSS and PostCSS (if not already installed): Official Docs
npm install tailwindcss postcss autoprefixer
# or
yarn add tailwindcss postcss autoprefixer2. Configure Tailwind with TypeScript
Make sure your TypeScript setup is properly configured. Create or update your tsconfig.json as needed.
3. Import momentral-ui CSS styles in root layout
import 'momentral-ui/styles.css';4. Import Components
Import and use the UI components in your project like so:
import { Button } from 'momentral-ui';