@rogers/oneview-components v6.0.31

Rogers OneView Angular5/6/7/8+ Component Library

Common components are elementary components that are ready to use for all Angular5+ applications at Rogers Communications Inc.

For more composite elements, not elementary unit, please look at @rogers/oneview-common.

It follows Angular Package Format.

• Works with Angular6, Angular7 and Angular8
• Accepting Development Requests(see details)
• Accepting Pull Request(see details)

Common Module Components

app-dialog oneview-carousel oneview-price-value oneview-search oneview-tabs oneview-text-field oneview-type-ahead oneview-cc-input

Service/Account Module (wireless/tv/internet..etc)

oneview-service-wireless-box oneview-shared-phone-box oneview-account-balance

Getting Started

1. Setup npm repository

2. Install Rogers fonts and icons

   • Copy fonts and rui-icons directory to your app.

     • from https://unpkg.com/oneview-components/rui-icons/ to assets/rui-icons
     • from https://unpkg.com/oneview-components@2.5.5/fonts/ to assets/fonts
     • from https://unpkg.com/oneview-components@2.5.5/rogers.css to assets/rogers.css

3. Change your index.html to have icons and fonts

   <link rel="stylesheet" href="assets/rogers.css">
   <link rel="stylesheet" href="assets/rui-icons/rui-icon.css">

4. Install @rogers/oneview-components

   npm i @rogers/oneview-components

5. Import the component modules to your application.

   import { OneviewCommonModule, AccountModule, AgentModule } from 'oneview-components';
   
   @NgModule({
     imports: [ ...  OneviewCommonModule, AgentModule, AccountModule ],
   })
   export class MyApplicatoinModule {}

6. You are ready. Use any component in your html.

Accepting Develpment Requests

• Create a development issue at https://github.com/RogersCommunications/oneview-components/issues including;
  • Input requirements; attributes, properties,
  • Output requirements; events
  • Look-and-feel
• The discussion will be followed within 24 hours.
• The actual development will start within 24 hours after requirements are discussed, updated, and ready, development.
• The ETA for the development will be notified in the issue, usually 2-3 days.
• When the development is done, a PR, pull request, is made.
• The new version will be notified when PR is accepted.

Accepting Pull Requests

• Ahead disuccssion would be appreciated for initial pull requests to avoid reject or surprise.
• A pull request will be reviewed and answered within 24 hours.
• A new version will be notified when a PR is accepted.

Engineers' Guide

Commands

• npm start to start test application for all modules
• npm run build to build library and test application for production
• npm test to run tests
• npm run test:coverage to see the coverage report
• npm run lint to run code linting
• npm run doc to generate documentation
• `npm run publish to publish to unpkg.com(npmjs.com)

Scaffolding

There is scaffold command to generate a component-related files $ ./scaffold.js

Directory Structure

.
├── demo             # application to test all components
├── src              # angular6+ components
├── test             # common jest unit test files 
├── forever          # forever configuration files
├── pupeteer-tests   # functional test files
├── dist             # `npm run build` result files
├── documentation    # `npm run doc` result files
├── reports          # `npm test` result files
└── compodoc-helpers # documentation setup files