Git Product home page Git Product logo

address's Introduction

Address

Address widget for OctoberCMS.

Packagist

Installation

To install the Address widget, add the following to your plugin's composer.json file.

"require": {
    "owl/address": "~1.0@dev"
}

Next, register the widget in your plugin's Plugin.php file.

public function registerFormWidgets()
{
    return [
        'Owl\FormWidgets\Address\Widget' => [
            'label' => 'Address',
            'code' => 'owl-address'
        ],
    ];
}

Usage

You can add this widget to your forms simply by decalring the field type as owl-address.

address:
    label: Address
    type: owl-address

This allows the form field to query the google maps public API and predict the location using autocomplete.

You can customize it further by using field maps, so that it automatically fills other fields with values based on the selected place i.e. such as latitude, longitude, etc. To do this first declare the form field with the field maps.

address:
    label: Address
    type: owl-address
    fieldMap:
        latitude: latitude
        longitude: longitude
        city: city
        zip: zip
        country: country_code
        state: state_code
        name: place_name
        address: place_address
        formataddress: fmt_address

Now define fields which should get filled up with the result values. The field name should be same as the value specified in the fieldMap fields.

city:
    label: City
zip:
    label: Zip
country_code:
    label: Country
state_code:
    label: State
latitude:
    label: Latitude
longitude:
    label: Longitude
place_name:
    label: Place Name
place_address:
    label: Place Address
fmt_address:
    label: Formatted Address

The widget automatically detects the presence of the fields and applies the correct values whenever a place is selected using the autocomplete.

Available mappings:

  • street
  • city
  • zip
  • state
  • country
  • country-long
  • latitude
  • longitude
  • name
  • address
  • formataddress

address's People

Contributors

mohsin avatar scottbedard avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.