Skip to content

Commit

Permalink
Update packages/plugins/Pins/README.md
Browse files Browse the repository at this point in the history
Co-authored-by: Pascal Röhling <[email protected]>
  • Loading branch information
Softwarecules and dopenguin authored Jul 31, 2024
1 parent 734d1f5 commit 359f1dc
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/plugins/Pins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The usage of `displayComponent` has no influence on the creation of Pins on the
| boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the pins feature, and style `'permissive'` will act as if no boundaryLayerId was set. Defaults to `'permissive'`. |
| coordinateSource | string? | The pins plugin may react to changes in other plugins. This specifies the path to such store positions. The position must, when subscribed to, return a GeoJSON feature. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. |
| initial | initial? | Configuration options for setting an initial pin. |
| movable | 'drag' \| 'click' \| 'none' | Whether a user may drag and re-click the pin (`drag` or `true`), only re-click it (`click`) or may only be placed programmatically (`none` or `false`). Defaults to 'none'. **Using a boolean for this configuration has been deprecated and will be removed in the next major release.** |
| movable | boolean \| 'drag' \| 'click' \| 'none'? | Whether a user may drag and re-click the pin (`drag` or `true`), only re-click it (`click`) or may only be placed programmatically (`none` or `false`). Defaults to 'none'. **Using a boolean for this configuration has been deprecated and will be removed in the next major release.** |
| style | style? | Display style configuration. |
| toastAction | string? | If `boundaryLayerId` is set, and the pin is moved or created outside the boundary, this string will be used as action to send a toast information to the user. If no toast information is desired, leave this field undefined; for testing purposes, you can still find information in the console. |
| toZoomLevel | number? | Zoom level to use on outside input by e.g. address search. Defaults to `0`. |
Expand Down

0 comments on commit 359f1dc

Please sign in to comment.