@terrestris/react-geo

react-geo

react-geo is a JavaScript library providing a large number of components to build modern mapping applications. It is used in combination with React, OpenLayers and Ant Design.

Installation

npm i --save @terrestris/react-geo

Usage

For a full list of available components, their properties and examples see here.

TypeScript

The react-geo package includes TypeScript declarations as *.d.ts files. The build itself is included in ESM format (currently ES2022).

Ant-Design ConfigProvider

react-geo supports dynamic theming of the Toggle Button via the antd ConfigProvider.

<ConfigProvider
  theme={{
    cssVar: true,
    Component: {
      Button: {
        primaryActive: '#0958d9'
      }
    }
  }}
>
  //...
</ConfigProvider>

Workshop

For a comprehensive introduction into the usage of react-geo you might want to have a look at our tutorial.

Starter application

Also don't miss the create-react-geo-app (CRGA) to quickly create a fully working web-mapping application based on react-geo.

Contribution

Contributions are much appreciated! 🥳

Read the hints for developers to get started. We look forward to your contributions!

License

react-geo is released under the BSD 2-Clause license. Please see the file LICENSE in the root of this repository for more details.