mirror of
https://github.com/HSLdevcom/digitransit-ui
synced 2025-07-08 04:00:38 +02:00
80 lines
1.9 KiB
Markdown
80 lines
1.9 KiB
Markdown
# @digitransit-component/digitransit-component-favourite-editing-modal
|
|
|
|
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
|
|
|
|
## handleClose
|
|
|
|
Required. Close modal.
|
|
|
|
Type: [function][1]
|
|
|
|
## updateFavourites
|
|
|
|
Required.
|
|
|
|
Type: [function][1]
|
|
|
|
## deleteFavourite
|
|
|
|
Required.
|
|
|
|
Type: [function][1]
|
|
|
|
## onEditSelected
|
|
|
|
Required. Function that takes selected favourite object as parameter.
|
|
|
|
Type: [function][1]
|
|
|
|
## favourites
|
|
|
|
Required.
|
|
|
|
Type: [array][2]<[object][3]>
|
|
|
|
### Properties
|
|
|
|
- `type` **[string][4]**
|
|
- `address` **[string][4]**
|
|
- `gtfsId` **[string][4]**
|
|
- `gid` **[string][4]**
|
|
- `lat` **[number][5]**
|
|
- `lon` **[number][5]**
|
|
- `name` **[string][4]**
|
|
- `selectedIconId` **[string][4]**
|
|
- `favouriteId` **[string][4]**
|
|
- `layer` **[string][4]**
|
|
|
|
[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
|
|
|
|
[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
|
|
|
|
[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
|
|
|
|
[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
|
|
|
|
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
|
|
|
|
<!-- This file is automatically generated. Please don't edit it directly:
|
|
if you find an error, edit the source file (likely index.js), and re-run
|
|
./scripts/generate-readmes in the digitransit-component project. -->
|
|
|
|
---
|
|
|
|
This module is part of the Digitransit-ui project. It is maintained in the
|
|
[HSLdevcom/digitransit-ui](https://github.com/HSLdevcom/digitransit-ui) repository, where you can create
|
|
PRs and issues.
|
|
|
|
### Installation
|
|
|
|
Install this module individually:
|
|
|
|
```sh
|
|
$ npm install @digitransit-component/digitransit-component-favourite-editing-modal
|
|
```
|
|
|
|
Or install the digitransit-component module that includes it as a class:
|
|
|
|
```sh
|
|
$ npm install @digitransit-component/digitransit-component
|
|
```
|