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.
To install c3-components in your Angular project, run the following command:
npm install c3-componentsAlso, 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 | |
| Dropdown | |
| File Upload | |
| File Viewer | |
| Highlight Text | |
| Menu | |
| Modal | |
| NavBar | |
| Pdf Dialog | |
| Rounded Title | |
| Tabs |
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:
- Clone the repository:
git clone https://github.com/c3ulnta0rk/c3-components.git- Install the dependencies:
bun install- Build the library in watch mode:
bunx @angular/cli build c3-components --watch- (In a new cmd) Link the library to the demo application:
npm link c3-components- Run the demo application:
bun startThis 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.