https://github.com/newaeonweb/ngx-aeon-wrapper

NgxAeonWrapper it's a library to encapsulate UI components from any UI framework like: Bulma, Bootstrap and other's, by default we are using Angular Material.
https://github.com/newaeonweb/ngx-aeon-wrapper

angular angular-cli angularmaterial npm-package semantic-release

Last synced: 14 days ago
JSON representation

NgxAeonWrapper it's a library to encapsulate UI components from any UI framework like: Bulma, Bootstrap and other's, by default we are using Angular Material.

• Host: GitHub
• URL: https://github.com/newaeonweb/ngx-aeon-wrapper
• Owner: newaeonweb
• License: mit
• Created: 2021-05-08T15:45:58.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-06-03T22:14:51.000Z (over 3 years ago)
• Last Synced: 2024-10-10T11:21:34.830Z (about 1 month ago)
• Topics: angular, angular-cli, angularmaterial, npm-package, semantic-release
• Language: HTML
• Homepage:
• Size: 1.68 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
NgxAeonWrapper




  

    This project was generated with Angular CLI version 11.2.12. But was updated to Angular v12.

  





  

    

  

  

    

  

  

    

  

  

  

    

  



---

## What is it or what does this project do?

The intention of this project is to create reusable components encapsulating their use, so it is possible to use any UI framework such as Angular Material, Bootstrap, Bulma, among others.

By default we use Angular Material.

Feel free to contribute.

## How to use in your project

Check the demo project on [stackblitz](https://stackblitz.com/edit/angular-ngx-aeon-wrapper-demo?file=src/app/app.component.ts).

Just install like any other npm package:

```

npm i ngx-aeon-wrapper

```

Import into your application:

```

import { NgxAeonWrapperModule } from 'ngx-aeon-wrapper';

```

> At the moment this library contain just one `cw-navbar` component.

## How to run this project

First we need to compile and generate the library using the following command:

```

 ng build --prod ngx-aeon-wrapper

```

Now, just start the server, to see the example app running:

```

ng serve example-app

```

## Docs

We are using compodoc for our library, and you can generate on your local machine using the following command:

```

 ng run build:doc

```

Now after, run:

```

 ng run doc

```