From 23d9df70d369fb5bc318ba357f81cd8f234fe3eb Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 17 Nov 2022 15:54:11 +0000 Subject: [PATCH] Automated update to repo's documentation from github action --- docs/search-ui-react.geolocationprops.handleclick.md | 2 +- docs/search-ui-react.geolocationprops.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/search-ui-react.geolocationprops.handleclick.md b/docs/search-ui-react.geolocationprops.handleclick.md index 502474da3..5e86891a8 100644 --- a/docs/search-ui-react.geolocationprops.handleclick.md +++ b/docs/search-ui-react.geolocationprops.handleclick.md @@ -4,7 +4,7 @@ ## GeolocationProps.handleClick property -A function which is called when the geolocation button is clicked. +A function which is called when the geolocation button is clicked, after user's position is successfully determined. Signature: diff --git a/docs/search-ui-react.geolocationprops.md b/docs/search-ui-react.geolocationprops.md index 3f280e30d..565771b33 100644 --- a/docs/search-ui-react.geolocationprops.md +++ b/docs/search-ui-react.geolocationprops.md @@ -19,7 +19,7 @@ export interface GeolocationProps | [customCssClasses?](./search-ui-react.geolocationprops.customcssclasses.md) | [GeolocationCssClasses](./search-ui-react.geolocationcssclasses.md) | (Optional) CSS classes for customizing the component styling. | | [GeolocationIcon?](./search-ui-react.geolocationprops.geolocationicon.md) | React.FunctionComponent | (Optional) Custom icon component to display along with the button. | | [geolocationOptions?](./search-ui-react.geolocationprops.geolocationoptions.md) | PositionOptions | (Optional) Configuration used when collecting the user's location. Definition: [https://w3c.github.io/geolocation-api/\#position\_options\_interface](https://w3c.github.io/geolocation-api/#position_options_interface). | -| [handleClick?](./search-ui-react.geolocationprops.handleclick.md) | (position: GeolocationPosition) => void | (Optional) A function which is called when the geolocation button is clicked. | +| [handleClick?](./search-ui-react.geolocationprops.handleclick.md) | (position: GeolocationPosition) => void | (Optional) A function which is called when the geolocation button is clicked, after user's position is successfully determined. | | [label?](./search-ui-react.geolocationprops.label.md) | string | (Optional) The label for the button. Defaults to 'Use my location'. | | [radius?](./search-ui-react.geolocationprops.radius.md) | number | (Optional) The radius, in miles, around the user's location to find results. Defaults to 50. If location accuracy is low, a larger radius may be used automatically. |