Ketch.UP: components for web applications

)

Intro

Ketch.UP is a web components library, built with Ionic’s Stencil, a small TypeScript based web component compiler.

Web Components is a suite of different technologies allowing to create reusable custom elements — with their functionality encapsulated away from the rest of your code — that you can use in your web apps. For more information visit this link: https://developer.mozilla.org/en-US/docs/Web/Web_Components

The primary focus of Ketch.UP is to provide a suite of powerful and customizable web components, whose main objective is abstracting complex and recurrent programming patterns.

Showcase

Go to Ketch.UP Showcase to see our components live.

How the repository is organized

Ketch.UP repository is a monorepo multi-package repository managed with Lerna.

• packages/ketchup contains the Stencil web components library
• packages/ketchup_showcase contains the code of the components showcase (a Vue application built using Vue CLI)
• docs contains documentation

Development

All information for developers is to be found in the Development guide.

Are there any presentations about your work?

Yes, of course: see the presentation list

TODO: add presentations page

How to use this code in your project

• Add Ketch.UP dependency to your project:

npm install @sme.up/ketchup --save

• Define Ketch.UP custom elements in your pages:

import { defineCustomElements } from 'ketchup/dist/loader';
defineCustomElements(window);

• Use Ketch.UP components in your pages. About components and their props and events see Ketch.UP Showcase. A simple sample for a Ketch.UP button can be:

<kup-btn :buttons.prop="btnlist" @kupBtnClick="onKupBtnClicked" />

Contributing

Every kind of contribution to this project is really welcome. See our contributing guide for more details.

TODO: add contributing page

Open issues

Here you can find a list of open issues.