Skip to content

KORTxyz/kortxyz-components

Repository files navigation

Built With Stencil


Logo

KORTxyz - Components

A collection of webcomponents mainly for geospatial webapps.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage examples
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

Plug and play webcomponents for making a webapp.

Product Name Screen Shot

(back to top)

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

(back to top)

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>

(back to top)

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).

(back to top)

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!

(back to top)

License

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

(back to top)

Contact

KORTxyz [email protected]

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

(back to top)

Acknowledgments

(back to top)

About

Plug and play components for geospatial webapps

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors