https://github.com/sap/fundamental-ngx

Fundamental Library for Angular is SAP Design System Angular component library
https://github.com/sap/fundamental-ngx

angular angular-components fundamentals open-source sap-fundamentals typescript

Last synced: about 18 hours ago
JSON representation

Fundamental Library for Angular is SAP Design System Angular component library

• Host: GitHub
• URL: https://github.com/sap/fundamental-ngx
• Owner: SAP
• License: apache-2.0
• Created: 2018-05-27T01:20:00.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2025-01-08T22:01:45.000Z (1 day ago)
• Last Synced: 2025-01-09T10:11:01.226Z (about 18 hours ago)
• Topics: angular, angular-components, fundamentals, open-source, sap-fundamentals, typescript
• Language: TypeScript
• Homepage: https://sap.github.io/fundamental-ngx
• Size: 686 MB
• Stars: 274
• Watchers: 26
• Forks: 132
• Open Issues: 172
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Fundamental Library for Angular

[![REUSE status](https://api.reuse.software/badge/github.com/SAP/fundamental-ngx)](https://api.reuse.software/info/github.com/SAP/fundamental-ngx)



  



## 1. Description

The Fundamental Library for Angular is an SAP Design System Angular component library used to build modern product user experiences with the SAP look and feel.

This repository contains 2 libraries(npm packages),

-   [@fundamental-ngx/core](https://github.com/SAP/fundamental-ngx/tree/main/libs/core):

    The Fundamental-NGX core provides base angular implementation of Fundamental Library Styles to offer developers a rich set of components

    they can use when building angular applications. Fundamental-ngx core angular components provides the end developer with some degree of flexibility as most of the components allow finer customization directly on the HTML template level.

-   [@fundamental-ngx/platform](https://github.com/SAP/fundamental-ngx/tree/main/libs/platform):

    The Fundamental-NGX platform is built on top of the core to both enhance existing functionality with additional features

    which are driven by application requirements and to provide higher abstraction for the components by hiding most of the internal implementation details which boosts productivity.

## 2. Requirements

To download and use Fundamental Library for Angular, you will first need to install the [node package manager](https://www.npmjs.com/get-npm) and [yarn package manager](https://yarnpkg.com/getting-started/install) (`corepack enable` and then `yarn`).

Fundamental Library for Angular is intended for use with Angular 15 or newer.

Prior knowledge of Angular is recommended, to use the fundamental-ngx library.

## 3. Known Issues

-   Please see [Issues](https://github.com/SAP/fundamental-ngx/issues).

-   Contribution Known [Issues](https://github.com/SAP/fundamental-ngx/wiki/Known-Contribution-Issues)

## 4. Support

If you encounter an issue, you can [create a ticket](https://github.com/SAP/fundamental-ngx/issues).

Angular Versions Support: Our versions offer Angular support. More information can be found [here](https://github.com/SAP/fundamental-ngx/wiki/Angular-Versions-Support).

-   Features and enhancements are developed to the latest version of fundamental-ngx.

-   Bugfixes can be downported to the latest ngx version, which is compiled with the second last Angular version.

## 5. Contributing

If you want to contribute, please check the [SAP Contribution Guidelines](https://github.com/SAP/.github/blob/main/CONTRIBUTING.md), the [CONTRIBUTING.md](https://github.com/SAP/fundamental-ngx/blob/main/CONTRIBUTING.md) documentation for contribution guidelines. Please follow the [Angular commit message guidelines](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit).

Check out the [NEW_COMPONENT.md](https://github.com/SAP/fundamental-ngx/blob/main/NEW_COMPONENT.md) guide on building a new component for the library and creating the necessary documentation for your new component.

## Similar Projects

## 7. Similar Projects

[Fundamental-react](https://github.com/SAP/fundamental-react) - React implementation of Fundamental Library Styles

[Fundamental-vue](https://github.com/SAP/fundamental-vue) - Vue implementation of Fundamental Library Styles