Package Exports
- kanishka-library
- kanishka-library/package.json
Readme
Kanishka UI — Professional Angular Component Library
Kanishka UI is a comprehensive, premium Angular component library built for speed, consistency, and beauty. Powered by PrimeNG, it provides a set of high-quality components designed to help developers build modern web applications faster.
🚀 Key Features
- 🛡️ Type Safe: Built with TypeScript for a robust developer experience.
- 🧱 Standalone Components: Fully compatible with modern Angular (v18+).
- 🎨 Premium Design: Modern, responsive, and aesthetically pleasing components.
- 🛠️ Extensible: Easily customizable with SCSS and design tokens.
- 📦 Lightweight: Optimized for performance and bundle size.
- 🔥 Comprehensive: 25+ components covering everything from Buttons to Complex Charts and Auth flows.
📦 Installation
To install Kanishka UI, run the following command:
npm install kanishka-library primeng primeiconsPeer Dependencies
Kanishka UI requires the following peer dependencies to be installed in your project:
@angular/common(>= 18.2.0)@angular/core(>= 18.2.0)primeng(>= 18.0.0)primeicons(>= 7.0.0)
🛠️ Configuration
To use the library, you need to import the styles in your angular.json or styles.scss.
1. Style Setup
Add the following to your styles.scss:
/* Required PrimeNG styles */
@import "primeng/resources/themes/lara-light-blue/theme.css";
@import "primeng/resources/primeng.min.css";
@import "primeicons/primeicons.css";
/* Kanishka UI Custom Styles (if any specific one provided by lib) */2. Browser Animations
Ensure you have provideAnimations() or BrowserAnimationsModule configured in your app.config.ts or app.module.ts.
📖 Usage Example
Search for your desired component and import it directly into your standalone component.
Using the Button Component
import { KnkButtonComponent } from "kanishka-library";
@Component({
selector: "app-root",
standalone: true,
imports: [KnkButtonComponent],
template: ` <knk-button label="Get Started" variant="primary" size="lg" (clicked)="onAction()"> </knk-button> `,
})
export class AppComponent {
onAction() {
console.log("Button Clicked!");
}
}🧩 Available Components
Kanishka UI comes packed with a wide variety of components:
| Category | Components |
|---|---|
| Foundations | Button, Card, Badge, Tag, Chip, Avatar, Progress Bar |
| Navigation | Breadcrumb, Sidebar, Aside, Tabs, Menu (Dropdown/Context) |
| Forms | Input, Textarea, Select, Checkbox, Radio, Toggle, Datepicker, File Upload |
| Auth | Login (Email/OTP), Register, Forgot/Reset Password, OTP Segmented |
| Feedback | Toast, Dialog, Confirm Dialog, Drawer |
| Content | Table, Excel Export, Charts, Accordion, Collapse |
| Search | Global Search (Command Palette), Searchable Select |
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
Developed with ❤️ by Kanishka Software Pvt ltd