Skip to content

Commit 16f8a8a

Browse files
committed
Update microsite homepage content
1 parent 6502099 commit 16f8a8a

1 file changed

Lines changed: 2 additions & 31 deletions

File tree

docs/index.md

Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,6 @@
1-
# Interactive Map Documentation
1+
# InteractiveMap documentation
22

3-
Welcome to the DEFRA Interactive Map documentation. This is an accessible map component designed for specific use cases with a focus on accessibility.
4-
5-
## Quick Start
6-
7-
Install the package:
8-
9-
```shell
10-
npm i @defra/interactive-map
11-
```
12-
13-
Create a simple map:
14-
15-
```js
16-
import InteractiveMap from '@defra/interactive-map'
17-
import maplibreProvider from '@defra/interactive-map/providers/maplibre'
18-
19-
const interactiveMap = new InteractiveMap('map', {
20-
mapProvider: maplibreProvider(),
21-
behaviour: 'hybrid',
22-
mapLabel: 'Ambleside',
23-
zoom: 14,
24-
center: [-2.968, 54.425],
25-
containerHeight: '650px',
26-
mapStyle: {
27-
url: 'https://tiles.openfreemap.org/styles/liberty',
28-
attribution: 'OpenFreeMap © OpenMapTiles Data from OpenStreetMap',
29-
backgroundColor: '#f5f5f0'
30-
}
31-
})
32-
```
3+
InteractiveMap is a lightweight map component designed for public-facing government services, and available for anyone to use. Built to GOV.UK standards, with accessibility at its core, Interactive Map supports a wide range of users across abilities, devices and input methods. It is open source and works with multiple mapping engines. The component can be extended through plugins to meet the specific needs of a service.
334

345
## What's Inside
356

0 commit comments

Comments
 (0)