/corporate-ui

The white label design system for implementing a coherent user interface on an enterprise level.

Primary LanguageTypeScriptMIT LicenseMIT

Build Status npm version Github release Components library Join Slack code style: prettier

Corporate UI

Demo page

Simple HTML ↗ | Angular ↗ | React ↗ | Vue ↗

Technical documentation

Check out components library for migration guidelines, component status, and technical documentation.

Quick start

Several options to add corporate-ui in the project:

NPM

Install corporate-ui via NPM package by running the command below.

npm i corporate-ui

Import component as a module with defineCustomElements function.

import { defineCustomElements } from 'corporate-ui';

defineCustomElements();
CDN

Add link to the script by adding the following to the head

<script src="https://static.scania.com/build/global/4.x/corporate-ui.js"></script>

Replace x with available releases.

See all available components in the components library.

Styling

To apply Scania styles, you need to add a theme package and use c-theme component. Check out Scania theme repository for detail documentation.

Browser support

  • Chrome (and all Chromium based browsers)
  • Firefox
  • IE 11+
  • Edge
  • Safari

Contributing

Please read through our contributing guidelines for the directions to develop components, create a pull request and coding standard.

Community

Get in touch with the team and the community:

License

All CSS, HTML and JS code are available under the MIT license. The Scania brand identity, logos and photographs found in this repository are copyrighted Scania CV AB and are not available on an open source basis or to be used as examples or in any other way, if not specifically ordered by Scania CV AB.