Fundamental-react is a set of React.js components implementation of SAP Fiori Fundamentals library.
Current Version
0.0.12-beta
Description
Fundamental-react is a set of React.js components implementation of SAP Fiori Fundamentals library. 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. This will allow you to stay/use React for your application and get SAP look and feel.
Requirements
To download and use Fundamental-react library, you first need to install the node package manager. https://www.npmjs.com/get-npm
Some prior knowledge of React is required for using this library.
Getting started
Install
To download and use this library, you first need to install the node package manager - npm. Fundamental-react does not include the SAP Fiori Fundamentals library which is required for styling.
- Install Fiori Fundamentals:
npm install --save fiori-fundamentals
- Install Fundamental-react:
npm install --save @jay.wang/fundamental-react
npm package for fundamental-react
- Include the Fiori Fundamentals CSS in your React application. In your App.css or App.scss file include the following lines:
$fd-icons-path: "~fiori-fundamentals/scss/icons/";
$fd-fonts-path: "~fiori-fundamentals/scss/fonts/";
@import '../node_modules/fiori-fundamentals/scss/all.scss';
You can now use the Component Documentation to browse the components currently available with Fundamental Vue. To use a Fundamental-react component, paste the desired code snippet from the Component Documentation and configure it as necessarry:
...
<Button compact>Compact</Button>
<Icon glyph="cart" size="l" />
...
Available Scripts
npm start
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will automatically reload on changes.
Lint errors are shown in the console.
npm test
Launches the test runner in the interactive watch mode.
npm test -- --coverage
Launches the test runner and display code coverage report.
npm test -- --coverage --watch
Launches the test runner and display code coverage report and interactive watch mode.
npm run build
Builds the app for production to the build folder.
Known Issues
There are no known major issues.
How to obtain 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.
License
Copyright (c) 2018 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