Fundamental React

Description

The fundamental-react library is a set of React 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

You will need to install Node and Node Package Manager.

Getting Started

For an existing react application, follow the steps below:

Install fundamental-react
```
npm install fundamental-react
```
Load the fiori-fundamentals styles. If using create-react-app, this will be in App.css.
```
@import '~fiori-fundamentals/dist/fiori-fundamentals.min.css';
```
Import components as needed. See Component Documentation for examples and API details.
```
import { Alert } from 'fundamental-react/lib/Alert/Alert';
```
or
```
import { Alert } from 'fundamental-react';
```
NOTE: Importing from lib is recommended. Doing so will bring in only the component you are using instead of the whole library, which will reduce your bundle size significantly.

Versioning

The fundamental-react 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 or want to request a feature, you can create an issue.

Contributing

If you want to contribute, please check the Contribution Guidelines. Also see our Developer Guide to Getting Started.

joaopereirawd/fundamental-react