https://github.com/ozaytsev86/react-leaflet-waypoints
React component to show waypoints on Leaflet's map.
https://github.com/ozaytsev86/react-leaflet-waypoints
leaflet react waypoints
Last synced: 4 months ago
JSON representation
React component to show waypoints on Leaflet's map.
- Host: GitHub
- URL: https://github.com/ozaytsev86/react-leaflet-waypoints
- Owner: ozaytsev86
- License: mit
- Created: 2021-04-01T13:55:49.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-01-22T12:35:23.000Z (over 3 years ago)
- Last Synced: 2024-08-09T03:53:38.734Z (almost 2 years ago)
- Topics: leaflet, react, waypoints
- Language: JavaScript
- Homepage:
- Size: 337 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# react-leaflet-waypoints
React component to show waypoints on Leaflet's map.
# Installation
Install `react-leaflet-waypoints` with [npm](https://www.npmjs.com/):
`npm install react-leaflet-waypoints`
or
`yarn add react-leaflet-waypoints`
# Usage
```javascript
import {ReactLeafletWaypoints} from 'react-leaflet-waypoints';
export const MyComponent = () => {
return (
);
}
```
# Demo
[Storybook Live Demo](https://61b5bfcdbf0a96003acf004d-ibwoiilpin.chromatic.com/?path=/story/components-reactleafletwaypoints--custom)
You can easily check the Storybook in your local.
Clone the repository and move into:
```
git clone git@github.com:ozaytsev86/react-leaflet-waypoints.git
cd react-leaflet-waypoints
```
Install dependencies:
```
yarn / npm install
```
Run Storybook
```
yarn sb / npm run sb
```
# Roadmap
WIP
# Issues
If you found an issue, or you have a suggestion please create a ticket [here](https://github.com/ozaytsev86/react-leaflet-waypoints/issues)
# Contributions
Create or take an already created issue
Clone the repository
Create a branch with the issue name
Once you finish create a pull request
# License
[MIT](https://opensource.org/licenses/MIT)