The fundamental-react library is a set of React 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.
See Component Documentation for examples and API details.
You will need to install Node and Node Package Manager.
For an existing react application, follow the steps below:
-
Install
fundamental-react.npm install fundamental-react
-
All components are currently packaged together with their respective
css, you will need to edit your webpack configuration to handle these files. See css-loader. -
Import components as needed. See Component Documentation for examples and API details.
import { MessageStrip } from 'fundamental-react/MessageStrip';
or
import { MessageStrip } from 'fundamental-react';
NOTE: Importing from specific component 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.
-
This project does not contain fonts and icons - they must be added to your project separately. Download Font 72 and SAP icons. After adding fonts and icons to your project, include the following in your css:
@font-face {
font-family: "72";
src: url("path/to/fonts") format("woff"); /* Bold, Light, Regular available in woff and woff2 */
font-weight: normal;
font-style: normal;
};
@font-face {
font-family: "SAP-icons";
src: url("path/to/icons") format("woff"); /* available in woff, woff2 and ttf */
font-weight: normal;
font-style: normal;
}Additionally, edit your webpack configuration to load font and icon fonts - see file-loader.
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]).
The following circumstances will be considered a BREAKING change:
- A component’s existing API is altered (with the exception of additions)
- The existing underlying HTML markup of a component is altered
- An existing unit test is altered to account for either of the above
The following circumstances will NOT be considered a BREAKING change:
- Additions to a component’s API
- Non-visual HTML attribute changes/additions (such as
role,aria-*,data-*) - An existing unit test is altered to account for non-visual HTML attribute changes/additions (such as
role,aria-*,data-*)
Please see Issues.
If you encounter an issue or want to request a feature, you can create an issue.
If you want to contribute, please check the Contribution Guidelines. Also see our Developer Guide to Getting Started.
Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This library is licensed under the Apache Software License, v. 2 except as noted otherwise in the License File.