@clarium/ngce-components

ngce-components

A comprehensive set of Angular UI components designed to accelerate your development workflow, similar to Angular Material. ngce-components provides ready-made, customizable UI components to help you build modern, responsive applications faster.

Table of Contents

• Features
• Installation
• Getting Started
• Usage
  • Basic Example
  • Customizing Components
• Documentation
• License

Features

• Ready-made Angular components to accelerate UI development.
• Similar to Angular Material but more lightweight and flexible.
• Fully customizable components.
• Designed to be responsive out of the box.
• Easy integration with existing Angular applications.
• Supports multiple Angular versions (8.0.0 to 18.2.0).
• Built with best practices and optimization in mind.

Installation

To use ngce-components in your Angular project, install it from npm. If the package is private within your organization, make sure you are logged in with the appropriate permissions.

Public Installation (if the package is public):

npm install @clarium/ngce-components --save

Private Installation (if the package is private):

Make sure you have access to your organization's private npm packages, then install:

npm install @clarium/ngce-components --save

Don't forget to install the peer dependencies if they are not already present:

npm install @angular/common @angular/core @angular/cdk tslib --save

Getting Started

Once installed, you can import the components into your Angular module. Start by importing the NgceComponentsModule into your root module (usually app.module.ts):

import { NgceComponentsModule } from '@clarium/ngce-components';

@NgModule({
  declarations: [AppComponent],
  imports: [
    BrowserModule,
    NgceComponentsModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule {}

Usage

Basic Example

Here’s a simple example of how to use a button component from ngce-components:

<ngce-button [color]="'primary'" (click)="onClick()">Click Me</ngce-button>

In your component:

export class AppComponent {
  onClick() {
    console.log('Button clicked!');
  }
}

Customizing Components

You can easily customize the appearance of the components by passing input properties. For example, you can change the color, size, or behavior of the components:

<ngce-button [color]="'success'" [disabled]="true">Disabled Button</ngce-button>

Components are designed to be flexible, and you can use Angular directives, custom CSS, or global styles to modify their appearance and behavior to suit your application.

Documentation

For detailed documentation on each component and usage examples, please refer to the official documentation.

The following components are included in the library:

• ngce-button: A customizable button component.
• ngce-input: A material-styled input field.
• ngce-card: A flexible card component for displaying content.
• And many more...

You can explore the entire list of available components in the documentation.

License

This library is licensed under the MIT License. See the LICENSE file for more information.