Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/munchedbox23/simple-ui-component-library
A simple and safe-to-read library of user interface components based on Reach, Typescript, Styled-components and Storybook
https://github.com/munchedbox23/simple-ui-component-library
munchedbox-ui react react-testing-library storybook styled-components typescript
Last synced: about 1 month ago
JSON representation
A simple and safe-to-read library of user interface components based on Reach, Typescript, Styled-components and Storybook
- Host: GitHub
- URL: https://github.com/munchedbox23/simple-ui-component-library
- Owner: munchedbox23
- Created: 2024-07-19T18:20:21.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-01T13:10:41.000Z (4 months ago)
- Last Synced: 2024-09-29T22:41:40.468Z (about 2 months ago)
- Topics: munchedbox-ui, react, react-testing-library, storybook, styled-components, typescript
- Language: TypeScript
- Homepage: https://munchedbox23.github.io/simple-ui-component-library/
- Size: 3.42 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/Contributing.mdx
Awesome Lists containing this project
README
## Table of Contents
- [Welcome](#welcome)
- [Features](#features)
- [Usage](#installation)
- [Contributing](#contributing)
# 👋 Welcome
Welcome to Munchedbox component library, a collection of reusable UI components built with design code principles. Our library aims to provide developers with a set of consistent, customizable, and easy-to-use components to streamline the development process and ensure a cohesive user experience across applications.
## ✨ Features
- **Reusable Components**: Our library includes a variety of reusable components such as buttons, inputs, cards, and more, allowing you to quickly build interfaces without reinventing the wheel.
- **Customizable Styles**: Components are highly customizable, with support for theming, custom styles, and props to adapt to your project's specific needs.
- **Documentation and Examples**: Comprehensive documentation and live examples are provided for each component, making it easy to understand how to use and customize them in your projects.
# Installation
MunchedboxUI is available as an [npm package](https://www.npmjs.com/package/munchedbox-ui).
## npm
To get started with our component library, simply install it via npm or yarn:
```bash
npm i munchedbox-ui
```
In order to have `munchedbox-ui` working properly, you'll also need
[styled-components 💅](https://github.com/styled-components/styled-components),
this way you can use custom themes and get the best of the library.
## Usage
Import the component and start using the library
```bash
import { Button, Input } from "munchedbox-ui";
const ExampleComponent = () => {
return (
Click me
);
};
```
## Support
If you like this project, please consider giving it a ⭐️ on [GitHub](https://github.com/munchedbox23/simple-ui-component-library). It helps us know that you appreciate our work and motivates us to continue improving the library.
## 🤝 Contribution
Thank you for considering contributing to our project! To maintain a collaborative and productive environment, please adhere to the following guidelines when contributing:
1. Reporting Issues: If you encounter any bugs, inconsistencies, or have suggestions for improvements, please create an issue on GitHub. Clearly describe the problem or suggestion, along with steps to reproduce if applicable.
2. Submitting Pull Requests: Before starting work on a new feature or fix, please open an issue to discuss the proposed changes. This helps ensure that your contribution aligns with the project goals and prevents duplicate efforts.
3. Testing: Write tests for any new features or fixes you contribute. Ensure existing tests pass and write additional tests as necessary to cover edge cases.
4. Commit Messages: Write clear and descriptive commit messages that explain the purpose of each change. Use present-tense verbs and be concise but informative. Before commiting husky will automatically format, lint and test the code, please respect those pre-commit guidelines and make sure it passes.
If you want to help with the project, feel free to [open pull requests][1],
[submit issues or component proposals][2].
Let's bring this UI back to life ♥️
[1]: https://github.com/munchedbox23/simple-ui-component-library/pulls
[2]: https://github.com/munchedbox23/simple-ui-component-library/issues