Community.Blazor.MapLibre 1.0.4

<a id="readme-top"></a>

<br /> <div align="center"> <a> <img src="https://maplibre.org/_astro/maplibre-logo.wyLiUNdu_Zcg5mX.svg" alt="Logo" width="300" height="100"> </a>

<h3 align="center">Blazor.MapLibre</h3>

<p align="center"> A C# wrapper around MapLibre GL JS library <br /> <br /> <a href="https://yet-another-solution.github.io/Blazor.MapLibre/">View Demo</a> · <a href="https://github.com/Yet-another-solution/Blazor.MapLibre/issues/new?labels=bug&template=bug-report---.md">Report Bug</a> · <a href="https://github.com/Yet-another-solution/Blazor.MapLibre/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a> </p> </div>

<details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#disclaimer">Disclaimer</a></li> <li><a href="#license">License</a></li> <li><a href="#acknowledgments">Acknowledgments</a></li> </ol> </details>

About The Project

This project should help people working on Blazor projects to use maps more easily.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Getting Started

Prerequisites

This project is created on .NET 9 so you need to use this or never version to run it.

Installation

Install the package:

dotnet add package Community.Blazor.MapLibre

For Blazor Server and Blazor Web App, add this to head of your file to load the css of the maps.

<link href="_content/Community.Blazor.MapLibre/maplibre-5.3.0.min.css" rel="stylesheet" />

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Usage

After the package is installed you can use it with simple:

<MapLibre />

You can customize the map more with options using MapOptions.cs:

<MapLibre Options="_mapOptions"></MapLibre>

@code
{
    private readonly MapOptions _mapOptions = new MapOptions();
}

Roadmap

• ✅ Completed
• ☑️ Partially implemented (missing C# models,...)
• ❌ Not started

<details> <summary> Map Implementation </summary>

</details>

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

<p align="right">(<a href="#readme-top">back to top</a>)</p>

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

<a href="https://github.com/Yet-another-solution/Blazor.MapLibre/graphs/contributors"> <img src="https://contrib.rocks/image?repo=Yet-another-solution/Blazor.MapLibre" alt="contrib.rocks image" /> </a>

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Disclaimer

Community.Blazor.MapLibre is provided "as-is," without warranties of any kind, express or implied. The author(s) make no guarantees regarding the accuracy, reliability, or suitability of the software for any particular purpose.

By using this library, you acknowledge that:

• The software is open-source and freely available, with no assurances of ongoing maintenance or support.
• The author(s) are not liable for any damages, data loss, or operational failures resulting from its use.
• Users assume full responsibility for implementing proper security and compliance measures when integrating this library into their applications.
• The software may change over time, and updates may introduce modifications or remove certain features.

Use of Community.Blazor.MapLibre is at your own risk, and contributions or modifications by third parties are not officially vetted. If you encounter issues or bugs, reporting them via the official repository is encouraged, but resolution is not guaranteed.

For licensing details, refer to the Unlicense statement included with the repository.

License

This project, Community.Blazor.MapLibre, is released under the Unlicense, meaning it is free and unencumbered software dedicated to the public domain.

However, this library is a wrapper around MapLibre GL JS, which is licensed under the BSD-3-Clause license. Users must comply with the original library’s license when using this wrapper.

For details on MapLibre GL JS licensing, visit: MapLibre GL JS License.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• GitHub Emoji Cheat Sheet
• Img Shields
• GitHub Pages
• Best-README-Template

<p align="right">(<a href="#readme-top">back to top</a>)</p>