⚠️ WARNING: This project is under development and it risk to have some majors changes since thev1.0.0will be release. One of the biggest change will be the usage oflitinstead of<kami-component>as base class of each element of the collection. It's because the<kami-component>package will be probably deprecate in the futur due to the complexity to maintain it.
You can install the whole collection using the @kamiapp/collection package.
$ npm install --save @kamiapp/collectionOr install each components individualy.
$ npm install --save @kamiapp/flash See the components section to see all components available.
First you need to declare components into your index.js. You can import the whole collection of components.
import '@kamiapp/collection';Or you can also declare a component individualy.
import '@kamiapp/markdown';See the documentation at collection.kamiapp.fr to get more information about how to use each components. You will also find a playground section to test all components.
You can get more informations about each components into the packages/<component-name> directory.
| Repository | description | version |
|---|---|---|
<kami-changelog> |
Display your releases directly into your app. |  |
<kami-flash> |
A simple alert component for your notifications. |  |
<kami-infinite-list> |
Infinite list based on web component. |  |
<kami-markdown> |
Convert markdown in html. |  |
<kami-media> |
A viewer element which can read all types of media. |  |
<kami-pdf> |
A simple viewer that allows users to easily read PDF. |  |
<kami-theme> |
Light and Dark kami theme. |  |
<kami-transition> |
Predefined transitions for your components. |  |
<kami-progress-bar> |
A simple horizontal progress bar. |  |
<kami-search-bar> |
Search bar component to find and sort data. |  |
We would love you for the contribution to kami-collection project, check the CONTRIBUTING file for more info.