PCF AddressFinder Widget
To get a local copy up and running, follow these steps...
- .NET Framework 4.6.2
- .NET Core 2.2 SDK
- Visual Studio Code
- Microsoft PowerApps CLI
- AddressFinder API key
- Signup for a free AddressFinder plan and get an API key
- Clone the repo
git clone https://github.com/ryanmichaeljames/pcf-addressfinder-widget.git
- Navigate to the
- Install the NPM packages.
The following resources should be of help when contributing:
To install and use the AddressFinder Widget control within your Dynamics 365 or CDS instance, follow these steps...
- Download the latest release.
- Import the solution
AddressFinderWidget_x_x_managed.zipfile into your Dynamics 365 or CDS instance.
- Add the
AddressFinder Widgetcontrol to the desired entity form.
- Add your AddressFinder API key to the
API Keyproperty. If you don't already have an API key you can register for a free account that gives you 500 free lookups a month.
- Map the entity's address attributes to the AddressFinder Widget's address properties.
There is a know issue where you cannot map account and contact address attributes to a PCF control's properties. Until this issue is resolved by Microsoft you can use the FormXml Manager plugin in the XrmToolBox to map the address attributes to the AddressFinder Widget control's properties. See Binding to Address Fields in a PCF Control.
The following AddressFinder options are optional.
||The code of the country to search against. Supported country codes are
|Option: Empty Content||String||
||Message to display to users when there are no found addresses or locations.|
|Option: Ignore Returns||Boolean||
||Ignore the use of the enter key when no list item is selected.|
|Option: Max Results||Integer||
||Maximum number of results to display.|
|Option: Show Addresses||Boolean||
||Set to false to hide address results.|
|Option: Show Locations||Boolean||
||Set to true to return location (street, suburb, city and region) results.|
|Option: Show Nearby||Boolean||
||Enable the nearby address helper (uses device's GPS to suggest addresses at current location). This feature is only available for New Zealand addresses.|
|Option: Show Points of Interest||Boolean||
||Set to true to return points of interest (e.g. hospitals, schools and churches) results. This feature is only available for New Zealand addresses.|
For more information regarding the AddressFinder options see the options section of the AddressFinder Widget documentation.
New Zealand vs Australian addresses
By default, the AddressFinder Widget control will return New Zealand addresses, even if the
Country Code input property is not set. To return Australian addresses the
Country Code property must be set to
There are a few subtle differences in the properties that are populated between New Zealand and Australian addresses. This is due to the AddressFinder API returning different properties in the search responses for each country. As a result, the following output properties are only populated by their respective countries.
See the issues for a list of proposed features (and known issues).
Any contributions are more than welcome.
- Fork the project
- Create a feature branch
git checkout -b feature/my-feature
- Commit your changes
git commit -m 'Added my feature'
- Push the feature branch to origin
git push origin feature/my-feature
- Open a pull request
This project is distributed under the MIT License. See LICENSE more information.