Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sap/fundamental
Fundamental Library - SAP Design System Component Library
https://github.com/sap/fundamental
css html5 open-source
Last synced: about 1 month ago
JSON representation
Fundamental Library - SAP Design System Component Library
- Host: GitHub
- URL: https://github.com/sap/fundamental
- Owner: SAP
- License: apache-2.0
- Created: 2017-10-24T17:01:41.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T19:14:39.000Z (2 months ago)
- Last Synced: 2024-10-07T11:14:32.700Z (about 1 month ago)
- Topics: css, html5, open-source
- Language: SCSS
- Homepage: https://fundamental.netlify.app/
- Size: 131 MB
- Stars: 269
- Watchers: 28
- Forks: 55
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SAP Fundamentals
**SAP Fundamentals is deprecated. [Fundamental Styles](https://sap.github.io/fundamental-styles) is its successor. If you are using this library consider migrating over to fundamental-styles.
SAP Fundamentals' Documentation Site is hosted [here](https://sap.github.io/fundamental/old.html) for time being.**
[](https://badge.fury.io/js/fiori-fundamentals)
[](https://travis-ci.org/SAP/fundamental)
[](https://ui-fundamentals.slack.com)
[](https://api.reuse.software/info/github.com/SAP/fundamental)
## 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](https://github.com/SAP/fundamental-ngx), [React](https://github.com/SAP/fundamental-react) and [Vue](https://github.com/SAP/fundamental-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.
```
```
### NPM Package
The compiled CSS for the full library and modules, e.g., core, layout, etc., are distributed via [NPM](https://www.npmjs.com/package/fiori-fundamentals) along with the SASS source.
This gives you incredible flexibility to use individual components and enable [advanced customization](https://github.com/SAP/fundamental/wiki/Advanced-Customization) options.
````
npm install fiori-fundamentals --save
````
> NOTE: We only distribute the fonts, icons and compiled CSS and [the SASS source](https://github.com/SAP/fundamental/tree/main/scss), not the full project or HTML for specific components. If your project uses LESS, see [LESS compatible Fiori Fundamentals](https://github.com/SAP/fundamental/wiki/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`
1. **Install NPM Dependencies**: `npm install`
1. **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`
1. **Serve the documentation website locally** - `npm start`
1. **Serve the development playground locally**: `npm run start:playground`
### Project Dependencies
The project has the following prerequisites:
* Git (for downloading this repo)
* [Node LTS](https://nodejs.org/)
* 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](https://github.com/SAP/fundamental/issues/new/choose) or post on the [Fundamentals Slack channel](https://join.slack.com/t/ui-fundamentals/shared_invite/enQtNTIzOTU0Mzc2NTc5LThlOTYxOGE3NGIzZDY3MGYyNjRiYWFlM2U0OGFjMGQ5YTA1MWU0ZjRjOTZmMGIzYWU1MmMyNzNjMjJhNzZhYzY).
## Contributing
If you want to contribute, please check the [SAP Contribution Guidelines](https://github.com/SAP/.github/blob/main/CONTRIBUTING.md), the [Contribution Guidelines](https://github.com/SAP/fundamental/wiki/Contribution-Guidelines). Also check the [Development Guidelines](https://github.com/SAP/fundamental/wiki/Development-Guidelines) and [Visual Testing Guide](https://github.com/SAP/fundamental/wiki/Visual-Testing).
## Versioning
The `fiori-fundamentals` library follows [Semantic Versioning](https://semver.org/). 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-*`)