Giter Club home page Giter Club logo

react-map-components-core's Introduction

MapComponents logo

A React component library for declarative web map application development.

npm version License: MIT downloads downloads

Tests

Usage / Installation

  1. yarn add @mapcomponents/react-core to install and add this package as a dependency to your projects package.json

Available Scripts

yarn build

Build esm and csm packages and save them to ./dist.

yarn test or yarn test --coverage --watchall=false

Run tests and watch & rerun tests for affected components if the filesystem changes.

Components

MapComponentsProvider

MapComponentsProvider must be imported and wrapped around all MapComponents.

MapComponentsProvider requires exactly one use of the MapLibreMap or OpenLayersMap components somewhere down the component tree that will create a map engine instance and register it to MapContext (using mapContext.registerMap()).

MapContext

The MapContext component can be used to access the registered map eninge instances from components located in the component tree somewhere below MapComponentsProvider. Import the useContext hook from React and the MapContext component from react-map-components-core (both named exports).

import { useContext } from "react";
import { MapContext } from "react-map-components-core";

In the body of your function component add the following:

const mapContext = useContext(MapContext);

You can now retrieve map engine instances using mapContext.getMap(mapId)

react-map-components-core's People

Contributors

cioddi avatar waffeln avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.