Laravel Address UI

The frontend UI kit for usage with enflow/laravel-address.

Usage

You can install the package with yarn or npm:

yarn add @enflow/laravel-address-ui
// or
npm install @enflow/laravel-address-ui --save

You may instance the Address component. For instance:

var Address = require('@enflow/laravel-address-ui');

window.onload = () => {
    document.querySelectorAll('[role=address]').forEach((field) => {
        new Address(field);
    });
};

You must include the CSS provides by this package in your build process as well. The easiest would be by using postcss-import and importing it in your core stylesheet. This can be modified based on your build process.

@import "@enflow/laravel-address-ui";

Then, add the field to your template:

.blade.php

<div role="address">
    <input type="text" role="address-label" value="{{ old('address_label', optional($user->address)->label) }}" id="address_label" name="address_label" class="form-input">
    <input type="hidden" role="address-value" value="{{ old('address', $user->address ? json_encode($user->address->value()) : null) }}" id="address" name="address">
</div>

.twig

<div class="mt-1 rounded-md shadow-sm" role="address">
    <input type="text" role="address-label" value="{{ old('address_label', user.address ? user.address.label : null) }}" id="address_label" name="address_label" class="form-input">
    <input type="hidden" role="address-value" value="{{ old('address', user.address ? user.address.value()|json_encode : null) }}" id="address" name="address">
</div>

Testing

$ npm run start

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

This package is forked from mapbox/mapbox-gl-geocoder and modified to work out of the box with enflow/laravel-address. They did an amazing job with the intital pacakge, and this work wouldn't be here without them.

• Michel Bardelmeijer
• Mapbox & Contributers
• All Contributors

About Enflow

Enflow is a digital creative agency based in Alphen aan den Rijn, Netherlands. We specialize in developing web applications, mobile applications and websites. You can find more info on our website.

License

The ISC License (ISC). Please see License File for more information.