Code Monkey home page Code Monkey logo

polgubau / pol-ui Goto Github PK

View Code? Open in Web Editor NEW
5.0 1.0 0.0 38.16 MB

Beautiful and reusable React components with ease using our NPM package. Built with Tailwind, React, and TypeScript, these components are fully customizable and ready to be integrated into any reactive website. Save time and effort by using our pre-built components for common UI elements such as buttons, inputs, and more.

Home Page: https://www.npmjs.com/package/pol-ui

License: MIT License

TypeScript 99.89% JavaScript 0.02% CSS 0.09%
components library npm react reactui ui pol-ui

pol-ui's Introduction

Pol-ui

A complete UI solution for React projects, based on Storybook and Vite.

Stars are welcome ๐Ÿ˜Š

๐ŸŽ๏ธ Using this package

  1. Install the package with npm
npm i pol-ui

You can also use yarn

yarn add pol-ui
  1. Import the components you want to use
import { Button } from 'pol-ui'
  1. Use them in your project
<Button>Click me!</Button>

๐Ÿ“š Documentation

  • npm run docs: Run Storybook documentation in dev mode
  • npm run build:docs: Build Storybook documentation

โœ… Testing

This package has unit and component tests configured with Jest

npm run test: Run unit tests with Jest and React Testing Library npm run test:watch: Run unit tests on watch mode

๐Ÿ”ฆ Linting

  • npm run lint: Run linter
  • npm run lint:fix: Fix lint issues

๐Ÿš€ CI and Publishing

This template comes with a GitHub Actions workflow to automatically publish on any push to main when the package.json version number differs from the latest on npm.

pol-ui's People

Contributors

dependabot[bot] avatar polgubau avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

pol-ui's Issues

JSDOC all enums that are used in the Pol-ui theme to improve DX

Checklist

  • I have searched the Issues to see if this bug has already been reported.
  • I have tested the latest version.

Summary

This pull request aims to improve the developer experience (DX) by adding JSDoc comments to all enums used in the Pol-ui theme. Properly documenting the enums will make it easier for developers to understand and use the theme in their projects.

Context

Currently, the enums used in the Pol-ui theme lack proper documentation in the form of JSDoc comments. This can be problematic for developers who want to use the theme as they may not fully understand the available options and their usage. By adding JSDoc comments to these enums, we can provide clear and concise documentation that will enhance the developer experience.

Example

Here's an example of how the JSDoc comments can be added to an enum:

/**
 * Enum representing the color options for the Pol-ui theme.
 * @enum {string}
 * ... more tags
 */
const ThemeColors = {
  PRIMARY: 'primary',
  SECONDARY: 'secondary',
  // Add more color options here
};

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.