JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1442
  • Score
    100M100P100Q84888F

Package Exports

  • meticulous-ui
  • meticulous-ui/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (meticulous-ui) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

meticulous-ui

A lightweight, modern React component library designed for elegance and precision ✨


πŸš€ Installation

npm install meticulous-ui

or

yarn add meticulous-ui

🧩 Usage

import { useState } from 'react';

import Pagination from 'meticulous-ui/components/Pagination';
import ChevronLeft from 'meticulous-ui/components/Icons/ChevronLeft';
import Ripple from 'meticulous-ui/components/Ripple';
import blue from 'meticulous-ui/colors/blue';
import capFirstLetter from 'meticulous-ui/utils/capFirstLetter';

function App() {
  const [pageNumber, setPageNumber] = useState(1);

  return (
    <div>
      <h2>{capFirstLetter('example with pagination')}</h2> // returns: Example with pagination
      <Ripple rippleColor={blue.m50}>
        <ChevronLeft size={10} color={blue.m400} onClick={setPrevPage} />
      </Ripple>
      <Pagination totalPages={10} pageNumber={pageNumber} setPageNumber={setPageNumber} />
    </div>
  );
}

export default App;

πŸ“¦ Components

Component Description
Pagination Fully responsive pagination component
Ripple A concentric circles visual animation
ChevronLeft Left navigation icon
ChevronRight Right navigation icon

πŸ“¦ Tokens

Types Description
Colors At least 10 shades of 23 colors
Colors Shades
amber m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
black m50, m100, m200, m300, m400, m500, m600, m700, m800, m900
blue m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
blueGray m50, m100, m200, m300, m400, m500, m600, m700, m800, m900
brown m50, m100, m200, m300, m400, m500, m600, m700, m800, m900
cider m50, m100, m200, m300, m400, m500, m600, m700, m800, m900
cyan m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
deepOrange m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
deepPurple m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
green m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
grey m50, m100, m200, m300, m400, m500, m600, m700, m800, m900
indigo m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
lightBlue m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
lightGreen m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
lime m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
orange m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
pink m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
purple m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
red m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
teal m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
violet m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700
white #FFFFFF
yellow m50, m100, m200, m300, m400, m500, m600, m700, m800, m900, a100, a200, a400, a700

πŸ“¦ Utils

Functions Description
capFirstLetter Takes a string and returns with first letter capitalised
compose Performs right-to-left function composition using transforming function
hasEqualProps Takes two args: Component’s previous props & its new props; returns true if all-non functional props are equal
isNonEmptyArray Takes an array & returns true if is not empty

Demo

https://xe3110.github.io/meticulous-ui/

🌱 Features

βš›οΈ Built with React + Styled Components

πŸ’¨ Zero external CSS dependencies

🧱 Easy to extend and customize

πŸͺΆ Small bundle size

πŸ“¦ ESM + CJS support out of the box

πŸ› οΈ Build Setup (for contributors)


# install dependencies
npm install

# run development build
npm run dev

# build for production (dist/)
npm run build