C3 Components Library
C3-components is an open-source component library that extends the @angular/material library. This collection of components aims to facilitate and accelerate the development of modern Angular applications by providing reusable and customizable components to meet specific needs.
- Installation
- Components
- Documentation
- Development
- Contributing
- License
To install C3-components in your Angular project, run the following command:
``bash`
npm install C3-components
Also, make sure you have installed and configured @angular/material as per their documentation.
C3-components offer a variety of components that extend the functionality of @angular/material. Below is a table listing the available components and the progress status of their documentation:
| Component | Documentation Status |
| -------------- | --------------------------------------------------------------------------- |
| Dialog | !#4caf50 Completed |
| Dropdown | !#4caf50 Completed |
| File Upload | !#f03c15 Planned |
| File Viewer | !#ff9800 In Progress |
| Highlight Text | !#4caf50 Completed |
| Menu | !#f03c15 Planned |
| Modal | !#f03c15 Planned |
| NavBar | !#f03c15 Planned |
| Pdf Dialog | !#f03c15 Planned |
| Rounded Title | !#f03c15 Planned |
| Tabs | !#f03c15 Planned |
Complete documentation for the C3-components is available on our documentation website. You'll find usage examples, guides, and API references for each component.
If you'd like to contribute to the development of C3-components, follow the steps below to set up your development environment:
1. Clone the repository:
`bash`
git clone https://github.com/c3ulnta0rk/C3-components.git
2. Install the dependencies:
`bash`
npm install
3. Start the development server:
`bash``
npm start
This will launch a local instance of the demo application to aid in the development and testing of the components.
This is my first contribution, and I am learning as I go. Please be understanding and patient as I work to improve this project.
Before contributing, please read our contribution guide for best practices and guidelines for our project.
C3-components are licensed under the MIT License. You are free to use, modify, and distribute it, subject to the terms of this license.