zzebastien / fundamental-ngx

Angular components implementation of SAP Fiori Fundamentals UI guidelines

Fundamental NGX

Description

The fundamental-ngx library is a set of Angular components built using SAP Fiori Fundamentals.

The SAP Fiori Fundamentals library is a design system and HTML/CSS component library used to build modern product user experiences with the SAP look and feel.

API Reference

See Component Documentation for examples and API details.

Requirements

To download and use Fundamental NGX, you will first need to install the node package manager.

Fundamental NGX is intended for use with Angular 5 or newer.

Prior knowledge of Angular is recommended.

Getting Started

For an existing Angular application,

1. Install Fundamental-ngx and Fiori Fundamentals.

   npm install --save fiori-fundamentals fundamental-ngx
   

2. Include Fiori Fundamentals CSS in the styles array of the angular.json file.

   "./node_modules/fiori-fundamentals/dist/fiori-fundamentals.min.css"

   Note the path may be different if your CLI configuration is not in the root of your project directory or if you have set a custom root.

3. Import the modules you want to use.

   To add the entire library, add

   import { FundamentalNgxModule } from 'fundamental-ngx';

   to your app's module definition. Also add FundamentalNgxModule to the imports array in the @NgModule declaration.

   To include an individual Angular Fundamental component in your application, you only need to import the relevant module.

   For example, to use Alerts, add

   import { AlertModule } from 'fundamental-ngx/alert/alert.module';

   to the file that declares the module you're adding alerts to. It can also be added to the app module declaration to be used site-wide. You also need to add AlertModule to your app or module's imports array.

4. Add the component to your HTML.

   <fd-alert [dismissible]="true" type="warning" (close)="showAlert($event)"> A warning type alert. </fd-alert>
   

Demo Application

The documentation serves as a demo application in the docs/ directory. Run ng serve from the root of the repository to serve the app locally. The demo application utilizes the Angular Fundamental source code in this repository, so changes you make to any component source will be reflected in the demo app.

View the live demo here.

Tests

Fundamental NGX makes use of Jasmine and Karma for its unit tests.

Run ng test fundamental-ngx. Append --code-coverage to generate code coverage documentation.

Versioning

The fundamental-ngx library follows Semantic Versioning. These components strictly adhere to the [MAJOR].[MINOR].[PATCH] numbering system (also known as [BREAKING].[FEATURE].[FIX]).

Merges to the master branch will be published as a prerelease. Prereleases will include an rc version (e.g. [MAJOR].[MINOR].[PATCH]-rc.[RC]).

Known Issues

Please see issues

Support

If you encounter an issue, you can create a ticket.

Contributing

If you want to contribute, please check the CONTRIBUTING.md documentation for contribution guidelines. Please follow the Angular commit message guidelines.

Check out the NEW_COMPONENT.md guide on building a new component for the library and creating the necessary documentation for your new component.

License

Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v.2 except as noted otherwise in the LICENSE file.

Similar Projects

Fundamental-react - React implementation of SAP Fiori Fundamentals

Fundamental-vue - Vue implementation of SAP Fiori Fundamentals