0.1.3 • Published 6 months ago

@kortxyz/kortxyz-components v0.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

Built With Stencil

About The Project

Plug and play webcomponents for making a webapp.

Product Name Screen Shot

Getting Started

To use the components your can either use them directly or install them from npm:

Prerequisites

  • Add the HTML tags to your website
      <script type="module" src="https://cdn.kort.xyz/kortxyz-components%40latest//kortxyz-components.esm.js"></script>
      <link rel="stylesheet" href="https://cdn.kort.xyz/kortxyz-components%40latest//kortxyz-components.css" />

Installation

  1. Install the plugin through npm
    npm i @kortxyz/kortxyz-components

Usage

kortxyz-maplibre (map) readme

<kortxyz-maplibre 
    style="width:100%;height: 200px;display:block"
    mapstyle='https://demotiles.maplibre.org/style.json'
></kortxyz-maplibre>

kortxyz-aggrid (table) readme

<kortxyz-aggrid 
    data="https://api.dataforsyningen.dk/afstemningsomraader?kommunekode=183&&format=geojson"
></kortxyz-aggrid>

Roadmap

  • Map (Maplibre)
    • Standalone Source/Layer
    • Searchbar
    • [] Legend
  • Table (Aggrid)
  • Datastore
  • [] Charts
  • [] Mapbox styleeditor
  • [] QR-code

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

KORTxyz info@kort.xyz

Project Link: https://github.com/kortxyz/kortxyz-components

Acknowledgments