react-leaflet-textpath
Version:
React wrapper of leaflet-textpath
86 lines (68 loc) • 5.02 kB
Markdown
[](http://npmjs.com/package/react-leaflet-textpath)
[](http://npmjs.com/package/react-leaflet-textpath)
[](https://github.com/clementallen/react-leaflet-textpath)
[](https://david-dm.org/clementallen/react-leaflet-textpath)
[](https://david-dm.org/clementallen/react-leaflet-textpath?type=dev)
[](https://codeclimate.com/github/clementallen/react-leaflet-textpath)
[](https://codeclimate.com/github/clementallen/react-leaflet-textpath)
React wrapper of [leaflet-textpath](https://github.com/makinacorpus/Leaflet.TextPath)
for [react-leaflet](https://github.com/PaulLeCam/react-leaflet).
Polyline with text for [Leaflet](https://leafletjs.com) maps. Extends [L.Polyline](http://leafletjs.com/reference.html#polyline).
_Most recently tested with Leaflet 1.7.1 and React-Leaflet 3.0.5_
The current version of this library supports React Leaflet v3. <br/>
If you are using React Leaflet v2, please use the v1 version of this library: <br/>
https://github.com/clementallen/react-leaflet-textpath/tree/v1
```bash
npm install react-leaflet-textpath --save
```
```jsx
import { MapContainer, TileLayer } from 'react-leaflet';
import TextPath from 'react-leaflet-textpath';
<MapContainer center={[51.505, -0.09]} zoom={13}>
<TileLayer
url="https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
attribution='© <a href="http://osm.org/copyright">OpenStreetMap</a> contributors'
/>
<TextPath
positions={[
[],
[],
]}
text="Polyline text"
center
offset={10}
/>
</MapContainer>;
```
```jsx
<TextPath
positions={[51.505, -0.09], [51.505, -0.02]}
text="Polyline text"
repeat
center
below
offset={10}
orientation={20}
attributes={{
'font-size': 20,
}}
/>
```
| Name | Type | Default | Description |
| ----------- | -------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| positions | Array of L.LatLng[] **or** Array\[number, number\] | **required** | Array of Latitude and Longitude points |
| text | string | **required** | Text to display along the polyline |
| repeat | boolean | false | Repeat text along the polyline |
| center | boolean | false | Center text according to the polyline bounding box |
| below | boolean | false | Show text underneath the polyline |
| offset | number | 0 | Offset the text relative to the polyline |
| orientation | number **or** string | 0 | Rotate text in degrees relative to the polyline |
| attributes | object | {} | Attributes applied to the `text` tag. Check valid attributes [here](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/text#Attributes) |
**All other options from L.Polyline are also supported. [View them here](https://leafletjs.com/reference#polyline)**