Skip to content

Commit

Permalink
Updated README (#3)
Browse files Browse the repository at this point in the history
Added resources, usage and acknowledgements.
  • Loading branch information
ryanmichaeljames committed Oct 25, 2019
1 parent 105dfef commit 65f9f82
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,44 @@ cd src
npm install
```

### Resources

The following resources should be of help when contributing:
- [Create and build a code component](https://docs.microsoft.com/en-us/powerapps/developer/component-framework/create-custom-controls-using-pcf)
- [Debug code components](https://docs.microsoft.com/en-us/powerapps/developer/component-framework/debugging-custom-controls)
- [Package a code component](https://docs.microsoft.com/en-us/powerapps/developer/component-framework/import-custom-controls)

## Usage

🚧 Coming soon... 🚧
To install and use the AddressFinder Widget control within your Dynamics 365 or CDS instance, follow these steps...

### Installation

1. Download the [latest release](https://github.com/ryanmichaeljames/pcf-addressfinder-widget/releases/latest).
2. Import the solution `AddressFinderWidget_x_x_managed.zip` file into your Dynamics 365 or CDS instance.
3. Add the `AddressFinder Widget` control to the desired entity form.
4. Add your AddressFinder API key to the `API Key` property. If you don't already have an API key you can register for a free account that gives you 500 free lookups a month.
5. 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](https://www.xrmtoolbox.com) to map the address attributes to the AddressFinder Widget control's properties. See [Binding to Address Fields in a PCF Control](https://www.magnetismsolutions.com/blog/jaredjohnson/2019/07/04/binding-to-address-fields-in-a-pcf-control).
### Optional Properties

The following AddressFinder options are optional.

Property | Type | Default | Description
--- | --- | --- | ---
Country Code | String | `NZ` | The code of the country to search against. Supported country codes are `NZ` and `AU`.
Option: Empty Content | String | `No addresses were found. This could be a new address, or you may need to check the spelling.` | Message to display to users when there are no found addresses or locations.
Option: Ignore Returns | Boolean | `true` | Ignore the use of the enter key when no list item is selected.
Option: Max Results | Integer | `10` | Maximum number of results to display.
Option: Show Addresses | Boolean | `true` | Set to false to hide address results.
Option: Show Locations | Boolean | `false` | Set to true to return location (street, suburb, city and region) results.
Option: Show Nearby | Boolean | `false` | 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 | `false` | 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](https://addressfinder.nz/docs/widget_docs).

## Roadmap

Expand Down Expand Up @@ -69,4 +104,5 @@ This project is distributed under the MIT License. See [LICENSE](LICENSE) more i

## Acknowledgements

- [AddressFinder JavaScript Widget](https://addressfinder.nz/docs/widget_docs)
- [Best-README-Template](https://github.com/othneildrew/Best-README-Template)

0 comments on commit 65f9f82

Please sign in to comment.