Skip to content
Angular components implementation of SAP Fundamental Styles guidelines. The library is aiming to provide an Angular implementation of the components designed in Fundamental Styles design system.
TypeScript CSS HTML Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update mergeable.yml (#1227) Sep 6, 2019
.vscode refactor(multilib): Added MultiLib & MultiApp support (#1221) Sep 6, 2019
apps docs: adds links to headers (#1260) Sep 17, 2019
ci-scripts refactor(multilib): Added MultiLib & MultiApp support (#1221) Sep 6, 2019
libs chore(release): version 0.11.0-rc.13 build 2696 [ci skip] Sep 17, 2019
scripts refactor(multilib): Added MultiLib & MultiApp support (#1221) Sep 6, 2019
tools refactor(multilib): Added MultiLib & MultiApp support (#1221) Sep 6, 2019
.editorconfig #224 fix an issue with duplicated ids Sep 22, 2018
.gitignore Change typedoc in .gitignore (#1240) Sep 9, 2019
.prettierignore refactor(multilib): Added MultiLib & MultiApp support (#1221) Sep 6, 2019
.prettierrc initial commit Jun 27, 2018
.travis.yml refactor(multilib): Added MultiLib & MultiApp support (#1221) Sep 6, 2019
CHANGELOG.md chore(release): version 0.11.0-rc.13 build 2696 [ci skip] Sep 17, 2019
CONTRIBUTING.md #638 revert #625 (#639) Mar 21, 2019
LICENSE.txt initial commit Jun 27, 2018
NEW_COMPONENT.md docs: remake new component docs (#858) Jun 5, 2019
NOTICE.txt #569 bump the year (#570) Feb 23, 2019
README.md #1231 update README.md and schematics to reflect the latest package n… Sep 10, 2019
angular.json feat: Changing default selector prefix for "platform" project (#1259) Sep 12, 2019
karma.conf.js refactor(multilib): Added MultiLib & MultiApp support (#1221) Sep 6, 2019
netlify.toml chore: add netlify.toml (#737) Apr 12, 2019
ngx-fundamental.iml initial commit Jun 27, 2018
nx.json feat: Changing default selector prefix for "platform" project (#1259) Sep 12, 2019
package-lock.json chore(deps-dev): bump ts-node from 8.3.0 to 8.4.1 (#1271) Sep 16, 2019
package.json chore(deps-dev): bump ts-node from 8.3.0 to 8.4.1 (#1271) Sep 16, 2019
protractor.conf.js initial commit Jun 27, 2018
tsconfig.json feat(platform): set up the `platform` package (#1235) Sep 9, 2019
tslint.json refactor(multilib): Added MultiLib & MultiApp support (#1221) Sep 6, 2019
tslint.yaml chore(deps-dev): bump codelyzer from 4.5.0 to 5.1.0 (#882) Jun 10, 2019

README.md

Fundamental NGX

npm version Minified Size Minzipped Size Build Status Coverage Status Slack

Description

The @fundamental-ngx/core library is a set of Angular components built using SAP Fundamental Styles.

The SAP Fundamental Styles 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 CLI application,

  1. Install Fundamental-NGX.

    ng add fundamental-ngx

    If you do not use the Angular CLI or if this command does not work for you, please see the full installation guide.

  2. Import the modules you want to use.

    To add the entire library, add the following import to your main application module.

    import { FundamentalNgxModule } from '@fundamental-ngx/core';
    
    @NgModule({
        ...
        imports: [FundamentalNgxModule],
    })
    export class DemoModule { }

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

    For example, to use Toggles, add the following import to your main application module.

    import { ToggleModule } from '@fundamental-ngx/core';
    
    @NgModule({
        ...
        imports: [ToggleModule],
    })
     export class DemoModule { }
  3. Add the component to your HTML.

    <fd-toggle [size]="'l'" [(checked)]="checked">Large Toggle</fd-toggle>

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 Fundamental Styles

Fundamental-vue - Vue implementation of SAP Fundamental Styles

You can’t perform that action at this time.