https://github.com/afek-sakaju/colors-table-react
Colors Table component for ReactJS web applications (available as an NPM package), developed during my time at the JLT coding bootcamp. This package allows users to customize rows, columns, color repetition, predefined color lists, and table background color.
https://github.com/afek-sakaju/colors-table-react
colors-table custom-npm-package eslint jest jsdocs reactjs sass storybook
Last synced: 3 months ago
JSON representation
Colors Table component for ReactJS web applications (available as an NPM package), developed during my time at the JLT coding bootcamp. This package allows users to customize rows, columns, color repetition, predefined color lists, and table background color.
- Host: GitHub
- URL: https://github.com/afek-sakaju/colors-table-react
- Owner: Afek-Sakaju
- Created: 2023-01-28T11:01:28.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-09T11:24:14.000Z (over 2 years ago)
- Last Synced: 2025-10-10T08:06:08.029Z (4 months ago)
- Topics: colors-table, custom-npm-package, eslint, jest, jsdocs, reactjs, sass, storybook
- Language: JavaScript
- Homepage:
- Size: 12.4 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Colors-Table-React
### This NPM package delivers an immersive and visually striking table component for web applications, developed with ReactJS, JavaScript, SASS, and ESLINT, designed to effortlessly enhance user engagement and excitement.
---
**Live demo:** [colors-table-react](https://Afek-Sakaju.github.io/colors-table-react/)
---
## Configuration Options
### The colors-table component offers a variety of configuration options to customize its appearance and functionality, including:
- **rows\columns**: You have the ability to configure the count of rows and columns in the table according to your specific preferences.
- **allowRepeatedColors**: The provided prop gives you the flexibility to determine whether you want the color of the clicked item to be repeatable after each click.
- **colors**: You can choose colors from a predefined list when generating the table initially and when changing the color of any item within the table.
- **backgroundColor**: You have the option to specify a background color for the table, but it is not mandatory.
- **onChange**: By using the provided prop, you can pass an `onChange` function to the table, enabling the component to be utilized in various ways and adaptable to different concepts.
## Usage
```js
import React from "react";
import { ManagedColorsTable } from "colors-table-react";
import { MY_COLORS_LIST } from "./consts";
function App() {
return (
console.log("change-detected!")}
/>
);
}
export default App;
```
**Installation:**
- `npm install colors-table-react`
Include the package in your project's dependencies.
**Development:**
- `npm run build-jsdocs`For JSDocs of the utils functions, after running open the 'index.html' file located inside the 'js-docs' folder.
---
### **Here's an example showcasing the utilization of the colors-table component:**
https://github.com/Afek-Sakaju/colors-table-react/assets/100536372/92159353-e3cc-4766-b059-9a6595d4e92b
---
## Author
:octocat: **Afek Sakaju**
- LinkedIn: [@afeksa](https://www.linkedin.com/in/afeksa/)
- GitHub: [@Afek-Sakaju](https://github.com/Afek-Sakaju)