/fundamental-react

React components implementation of SAP Fundamental Styles design guideline. The library is aiming to provide a React implementation of the components designed in Fundamental Styles design system.

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Fundamental React

npm version Minified Size Minzipped Size Build Status Coverage Status Slack

Description

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.

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:

  1. Install fundamental-react.

    npm install fundamental-react

  2. As some components are currently packaged together with their respective scss, you will need to edit your webpack configuration to handle these files. See sass-loader.

  3. Load the fundamental-styles styles. This is now packaged as a dependency with fundamental-react. If using create-react-app, this will be in App.css.

    @import '~fundamental-styles/scss/fundamental-styles-ie11.css';

    NOTE: Once all components are packaged with their respective scss, this step will not be needed.

  4. Import components as needed. See Component Documentation for examples and API details.

    import { Alert } from 'fundamental-react/Alert';

    or

    import { Alert } 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.

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.

License

Copyright (c) 2019 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.

Similar Projects