Skip to content

🕸️ Collection of reusable projects (npm packages) for the development of the Web projects based on the MORYX Platform

Notifications You must be signed in to change notification settings

PHOENIXCONTACT/ngx-moryx-web

Repository files navigation

MORYX - Web

This project was generated with Angular CLI version 13.2.5.

How to use the npm packages

  1. Add a .npmrc file to the project
registry=https://registry.npmjs.org
@moryx:registry=https://www.myget.org/F/moryx-ci/auth/4cd70c3b-c8e8-4186-8c35-3d4c8789bbdd/npm
  1. Turn ssl off with npm config set strict-ssl false
  2. Install the package with npm install @moryx/ngx-web-framework
  3. Turn back on ssl with npm config set strict-ssl true

It is intended that releases of this package live on the moryx-ci feed because it's an internal package which is not distributed publicly.

Components

Navigable Entry Editor

The Navigable Entry Editor is a is an entry editor with breadcrumbs on top. You can navigate to lists and other objects in the entry.
It has the following parameters

  • entry contains the base entry
  • disabled disables all fields of the entry editor
  • queryParam is the name of the query parameter in which the entry path is saved in order to navigate to a specific subentry on reloading (optional)
<navigable-entry-editor [entry]="entry" [disabled]="disabled" queryParam="entryEditor1"></navigable-entry-editor>

Empty State Component

The empty state component provides a styled screen to show the user when no content is available to be shown. As a reference for your decision when to use this screen take a look at the respective design guidline. The following parameters are available

  • header The header shown on the page
  • message The messaage shown on the page
  • icon The icon shown on the page. We recommend the rocket_launch icon for screens that get active if the user does something and the bedtime icon for screnns that are inactive if everything is in order. For more icons take a look here
<empty-state [header]="'Nothing to show'" [message]="'We can´t show you anything here.'" icon="bedtime"></empty-state>

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

About

🕸️ Collection of reusable projects (npm packages) for the development of the Web projects based on the MORYX Platform

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 6