Location Picker¶
This control allows you to search and select the Location, also allows enter a custom location.
How to use this control in your solutions¶
-
Check that you installed the
@pnp/spfx-controls-reactdependency. Check out the getting started page for more information about installing the dependency. -
Import the following modules to your component:
import { LocationPicker,ILocationPickerItem } from "@pnp/spfx-controls-react/lib/LocationPicker";
- Use the LocationPicker control in your code as follows:
<LocationPicker
context={this.props.context}
label="Location"
onChange={(locValue: ILocationPickerItem) => {
console.log(locValue.DisplayName + ", " + locValue.Address.Street)
}
}/>
| Location searching mode |
|---|
![]() |
| Entering into edit mode |
|---|
![]() |
| Readonly mode |
|---|
![]() |
Implementation¶
The LocationPicker can be configured with the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
| context | WebPartContext or ExtensionContext | yes | The context object of the SPFx loaded webpart or customizer. |
| disabled | boolean | no | Option allows to be enable or disable. Default value is false |
| defaultValue | ILocationPickerItem | no | Option allows set default value |
| errorMessage | string | no | Static error message displayed below the picker. |
| className | string | no | Applies custom styling |
| label | string | no | Label to use for the control. |
| placeholder | string | no | Placeholder label to show in the dropdown. |
| onChange | (locItem: ILocationPickerItem) => void | no | The method that returns location data JSON object. |


