Introduction

MMPG Softwares components

MMPG Softwares components library

Getting started

Install the package with npm by running: npm install @mmpg-soft/components@latest

Requirements

This package requires:

• Next js
• Tailwind css

How to use it

In order to be able to use this package, you need to adhere to the following instructions

tailwind.config.ts

Include the path of the package's components in your tailwind config: './node_modules/@mmpg-soft/components/dist/esm/components/**/*.{js,ts,jsx,tsx,mdx}'

Define your colors scheme as follow:

colors: {
    primary: 'primary-color',
    secondary: 'secondary-color',
    accent: 'accent-color',
    text: 'text-color',
    warning: 'warning-color',
    danger: 'danger-color',
    success: 'success-color',
},

So your tailwind.config.ts should look like this:

import type { Config } from 'tailwindcss';

const config: Config = {
	content: [
		'./src/pages/**/*.{js,ts,jsx,tsx,mdx}',
		'./src/components/**/*.{js,ts,jsx,tsx,mdx}',
		'./src/app/**/*.{js,ts,jsx,tsx,mdx}',
		'./node_modules/@mmpg-soft/components/dist/esm/components/**/*.{js,ts,jsx,tsx,mdx}',
	],
	theme: {
		extend: {
			colors: {
				primary: '#1c3773',
                		secondary: '#646464',
				accent: '#337ab7',
                		text: '#333333',
                		warning: '#f5a623',
                		danger: '#d0021b',
                		success: '#28a745',
			},
		},
	},
	plugins: [],
};
export default config;

After fullfilling all the prerequesties, you can start using all the package features.