Skip to content

Latest commit

 

History

History
108 lines (63 loc) · 5.67 KB

README.md

File metadata and controls

108 lines (63 loc) · 5.67 KB
Raw

SAP Fundamentals

SAP Fundamentals is deprecated. Fundamental Styles is its successor. If you are using this library consider migrating over to fundamental-styles. SAP Fundamentals' Documentation Site is hosted here for time being.

npm version Build Status Slack REUSE status

Deploys by Netlify

What is SAP Fundamentals?

SAP Fundamentals is a light-weight presentation layer that can be used with your UI framework of choice (e.g. Angular, React, Vue, etc.). With Fundamentals’ library of stylesheets and HTML tags, developers can build consistent Fiori apps in any web-based technology.

Learn more at http://sap.github.io/fundamental/old.html

We are also working on Angular, React and Vue implementations.

Getting Started

The library is modular so you can use as little or as much as you need.

CDN

The fully compiled, minified library is available via CDN for inclusion in your application.

<link href="//unpkg.com/fiori-fundamentals@latest/dist/fiori-fundamentals.min.css" rel="stylesheet">

NPM Package

The compiled CSS for the full library and modules, e.g., core, layout, etc., are distributed via NPM along with the SASS source.

This gives you incredible flexibility to use individual components and enable advanced customization options.

npm install fiori-fundamentals --save

NOTE: We only distribute the fonts, icons and compiled CSS and the SASS source, not the full project or HTML for specific components. If your project uses LESS, see LESS compatible Fiori Fundamentals.

Working with the Project

Download and Installation

  1. Clone Repository - Clone the repo using the git software of your choice or using the git command git clone https://github.com/SAP/fundamental.git

  2. Install NPM Dependencies: npm install

  3. Install Ruby Gems - These gems are needed to be installed for the documentation site. Navigate to the docs folder and gem install ruby bundler jekyll

  4. Serve the documentation website locally - npm start

  5. Serve the development playground locally: npm run start:playground

Project Dependencies

The project has the following prerequisites:

  • Git (for downloading this repo)
  • Node LTS
  • Ruby (for running the documentation website locally)

Known Issues

Configuring icons path when importing SCSS

If you are importing .scss files in your project, the icons path needs to be configured in your project's .scss file before the Fiori Fundamentals scss import as described below. Please note that the path variable name has to be $fd-icons-path in order to override the default value set in scss/icons/icon.scss.

$fd-icons-path : "../node_modules/fiori-fundamentals/scss/icons/"; // should be declared before the scss import

@import "../node_modules/fiori-fundamentals/scss/all.scss";

Support

If you encounter an issue, you can create a ticket or post on the Fundamentals Slack channel.

Contributing

If you want to contribute, please check the SAP Contribution Guidelines, the Contribution Guidelines. Also check the Development Guidelines and Visual Testing Guide.

Versioning

The fiori-fundamentals library follows Semantic Versioning. These components strictly adhere to the [MAJOR].[MINOR].[PATCH] numbering system (also known as [BREAKING].[FEATURE].[FIX]).

Merges to the main 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 MAJOR or BREAKING change:

  • Droppping existing classnames, css variables, color names, color groups, spacing parameters
  • 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 MAJOR or BREAKING change:

  • Introducing new classnames, css variables, color names, color groups, spacing parameters
  • Non-visual HTML attribute changes/additions (such as role, aria-*, data-*)
  • Adding or modifying CSS properties and values of existing classnames.
  • An existing unit test is altered to account for non-visual HTML attribute changes/additions (such as role, aria-*, data-*)