showcar-ui is the pattern library that is used to build the frontend of AutoScout24. It provides CSS classes, custom elements and components.
To install showcar-ui within your project use npm.
npm install showcar-ui --save
For building on your local machine install all npm packages first. Then you can use the gulp command to run the build:
npm install
gulp build
You can use the gulp default command to run the build locally:
gulp
You can either include showcar-ui as a fragment or directly include the JS, CSS and inline HTML on your page. The library provides some HTML content that needs to be inlined on your page. Use the index.html in the dist folder as a template in order to include the inline HTML, CSS and JS on your page.
<link rel="stylesheet" href="@@ASSET_PATH/showcar-ui.css">
<script src="@@ASSET_PATH/showcar-ui.js"></script>
Make sure to replace the @@ASSET_PATH string with the path to the JS/CSS file.
You can check development state of the library on home, list and detail page with a parameter ?toguru=sc_develop%3dtrue.
The showcar-ui library includes some libraries and polyfills:
- showcar-storage (https://github.com/Scout24/showcar-storage)
- showcar-icons (also available as standalone fragment) (https://github.com/Scout24/showcar-icons)
- showcar-tracking (also available as standalone fragment) (https://github.com/Scout24/showcar-tracking)
- Zepto (zepto-modules v1.0.1 uses Zepto v1.2.0) (https://www.npmjs.com/package/zepto-modules) (http://zeptojs.com/)
- lazysizes (https://github.com/aFarkas/lazysizes)
- document-register-element
- dom4
- es6-collections
- whatwg-fetch (fetch)
- promiz (promises)
You can access the Stroage API via the global Storage object. For further information see the documentation under https://github.com/AutoScout24/showcar-storage
You can use all the icons defined by showcar-icons with the custom <as24-icon> tag. For further information see the documentation under https://github.com/AutoScout24/showcar-icons
Showcar-ui includes Zepto, which is a lightweight replacement for jQuery. You can access Zepto via the global variables $ and Zepto.
For a detailed usage guide, have a look at http://zeptojs.com/
for the use of the library have a look at the documentation.
See CONTRIBUTING.md
See LICENSE.md
See History.md
Published 13.03.2017
| ShowcarUI | notes | |||
|---|---|---|---|---|
| lightbox | overlay | 140 | useful | |
| modal window | 139 | useful | ||
| spy-navigation | wrapper | 21 | useful | |
| tooltip | 2 | useful | ||
| input group | focus | 2 | useful | |
| ad | 110 | useful | ||
| custom dropdown | 1 | useful | ||
| sticky | 2 | useful | Could have bigger z-index but lower than overlay | |
| navigation | ::before li | 100 | useful | Can be 10 |
| notification | 120 | useful | ||
| Contentservice | ||||
| header | 130 | useful | ||
| notification | 9999 | remove! |