Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clementallen/react-leaflet-textpath
React wrapper for the leaflet-textpath plugin
https://github.com/clementallen/react-leaflet-textpath
Last synced: about 2 months ago
JSON representation
React wrapper for the leaflet-textpath plugin
- Host: GitHub
- URL: https://github.com/clementallen/react-leaflet-textpath
- Owner: clementallen
- License: mit
- Created: 2019-01-13T20:33:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-04T10:01:32.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T05:38:57.374Z (3 months ago)
- Language: JavaScript
- Homepage: https://npmjs.com/package/react-leaflet-textpath
- Size: 1.39 MB
- Stars: 8
- Watchers: 2
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# react-leaflet-textpath
[](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_
## Requirements
The current version of this library supports React Leaflet v3.
If you are using React Leaflet v2, please use the v1 version of this library:
https://github.com/clementallen/react-leaflet-textpath/tree/v1
## Installation
```bash
npm install react-leaflet-textpath --save
```
## Usage
### Complete example with react-leaflet
```jsx
import { MapContainer, TileLayer } from 'react-leaflet';
import TextPath from 'react-leaflet-textpath';
;
```
### \
```jsx
```
#### Props
| 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)**