Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(common-css): update the Common CSS doc #4929

Merged
merged 1 commit into from
Oct 25, 2023
+9 −9
Merged

chore(common-css): update the Common CSS doc #4929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions packages/common-css/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
Fundamental Library Common CSS Package
SAP UI Common CSS Package

## What is Fundamental Library Common CSS?
## What is SAP UI Common CSS?

Fundamental Library Common CSS Package is a set of utility classes and SCSS mixins that allow developers to add padding, margin, color, font, shadow, and more to their applications and controls without writing custom css.
SAP UI Common CSS Package is a set of utility classes and SCSS mixins that allow developers to add padding, margin, color, font, shadow, and more to their applications and controls without writing custom css.
The class naming follows the BEM (Block Element Modifier) methodology and the values of the CSS rules are based on SAP Fiori Design Guidelines. Further customization is possible by using the SCSS mixins and providing user defined values as parameters. SCSS Mixins help in defining styles that can be re-used throughout the project's stylesheet.


## Getting Started

### 1. Fundamental Library Common CSS Package included in Fundamental Styles
### 1. SAP UI Common CSS Package included in Fundamental Styles

Fundamental Library Common CSS Package is part of the Fundamental Styles. If you have installed the Fundamental Styles in your project, you automatically get the Fundamental Library Common CSS Package.
SAP UI Common CSS Package is part of the Fundamental Styles. If you have installed the Fundamental Styles in your project, you automatically get the SAP UI Common CSS Package.

**Learn more at http://sap.github.io/fundamental-styles/**


### 2. Fundamental Library Common CSS Package on its own
### 2. SAP UI Common CSS Package on its own

Fundamental Library Common CSS Package can stand on its own. To install the package:
SAP UI Common CSS Package can stand on its own. To install the package:

```bash
npm i @sap-ui/common-css
```

## Common CSS Properties

The Fundamental Library Common CSS Package consists of property values that align with the SAP Fiori designs.
The SAP UI Common CSS Package consists of property values that align with the SAP Fiori designs.

border-radius
border
Expand Down
2 changes: 1 addition & 1 deletion packages/common-css/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "VERSION_PLACEHOLDER",
"license": "Apache-2.0",
"homepage": "https://sap.github.io/fundamental-styles/",
"description": "Fundamental Library Styles Common CSS",
"description": "SAP UI Common CSS",
"repository": {
"type": "git",
"url": "https://github.com/SAP/fundamental-styles"
Expand Down