SKIM component library

SKIM is a library providing components/building blocks enabling for quick construct of UI. Besides UI each component/building block can contain additional logic.

Getting Started

These instructions will provide details on how to install the library or how to reference it before use.

Installing

Install from the command line:

$ npm install @skimgroup/skim

Install via package.json:

"@skimgroup/skim": "latest"

Reference it using a CDN

<script type="module" src="https://<cdn-location>/libs/skim/<version>/build/skim.esm.js"></script>
<script nomodule src="https://<cdn-location>/libs/skim/<version>/build/skim.js"></script>
<link type="text/css" rel="stylesheet" href="https://<cdn-location>/libs/skim/<version>/build/skim.css">

The <version> is tightly coupled to the github release version. If you want to stay up to date with the releases you can also use latest as version. This is at your own risk, since this could contain breaking changes.

Ionic Framework

Ionic comes stock with a number of components, including cards, lists, and tabs. Once you’re familiar with the basics, refer to the API Index for a complete list of each component and sub-component.

Components

• Shopping cart
• Longpress
• Pinboard
• Preview
• Ranking
• Stack
• Rating
• Swiper
• View
• Magnify

Utilities

• EventQueue
• Filter/Sort
• currencyFormatter
• File upload

Storybook

For viewing components in a simplistic and stand-alone way.

Publishing

Publish to Github packages

$ npm run build
$ npm publish

Built With

• Ionic framework - The web framework used
• Github packages - Publish and consume packages within your organization

Contributing

Please keep components small and adhere to the SOLID principle. Apply composition over inheritance.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Gerard van der Stelt - Initial setup

See also the list of contributors who participated in this project.