Giter Club home page Giter Club logo

showcar-icons's Introduction

Showcar-icons

This module provides custom elements for simple inclusion of icons in your frontend project.

Installation:

To install showcar-icons within your project use npm.

$ npm i --save showcar-icons

How to include:

To make the custom elements available within you frontend, it is necessary to include some javascript (depending on your directory structure)

require("showcar-icons/dist/showcar-icons.min.js");

How to use:

use the following to include an icon in your frontend:

<as24-icon class="sc-icon-s" type="android" title="android"></as24-icon>

More documentation on usage: https://autoscout24.github.io/showcar-ui/#icon-target

All the available icons are placed within the icons folder, using subfolder is possible too.
If you want to use the icons without the showcar-ui library, you have to load a polyfill for custom elements first.
See https://cdnjs.com/libraries/document-register-element

<script src="//cdnjs.cloudflare.com/ajax/libs/document-register-element/0.5.4/document-register-element.js"></script>

Inline Icons

We recommend to use inline icons if you need to include icons just on one single page. For further details see the docs and CSS-Tricks

How to contribute:

If you need some additional icons within showcar-icons just add them to the icons folder or another subfolder. Afterwards it is necessary to create the showcar-icons.min.js again.

$ yarn build

To test your changes run, it will open docs page on port 8080

$ yarn start

License

MIT License

showcar-icons's People

Contributors

anders0l avatar andythedandy avatar bdadam avatar ctoutountzidis avatar dependabot[bot] avatar dzubovaautoscout24 avatar gvand avatar kamilchoroba avatar lakhanamdhari avatar m-idler avatar massi-scout24 avatar maximilian-lindsey avatar meckert avatar nawnaw7 avatar pommespanzer avatar pvoznenko avatar raqystyle avatar rowantower avatar yifan9916 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.