c3-components v0.0.11
C3-components
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.
Table of Contents
Installation
To install C3-components in your Angular project, run the following command:
npm install C3-components
Also, make sure you have installed and configured @angular/material as per their documentation.
Components
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 | Completed |
Dropdown | Completed |
File Upload | Planned |
File Viewer | In Progress |
Highlight Text | Completed |
Menu | Planned |
Modal | Planned |
NavBar | Planned |
Pdf Dialog | Planned |
Rounded Title | Planned |
Tabs | Planned |
Documentation
Complete documentation for the C3-components is available on our documentation website. You'll find usage examples, guides, and API references for each component.
Development
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/Kroenen62/C3-components.git
- Install the dependencies:
npm install
- Start the development server:
npm start
This will launch a local instance of the demo application to aid in the development and testing of the components.
Contributing
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.
License
C3-components are licensed under the MIT License. You are free to use, modify, and distribute it, subject to the terms of this license.