elgentos/vat-switcher

Vat switcher to let customer decide on how to show their prices

Installs: 2 235

Dependents: 0

Suggesters: 0

Security: 0

Stars: 10

Watchers: 3

Forks: 1

Open Issues: 0

Type:magento2-module

0.1.0 2022-11-21 13:30 UTC

This package is auto-updated.

Last update: 2024-12-05 14:26:07 UTC


README

Adds a B2B VAT switcher to the header component to let customer decide on how to show their prices; including or excluding VAT. The decision is saved to the browser storage.

Because there are a lot of prices in magento, there is a reusable alpine component to switch between prices realtime. It only needs the including and excluding price.

Example with alpine component

            <div x-data="initVatSwitcherPrice()" x-spread="eventListeners">
                <span class="price-incl" x-show="vatMode == 'including'" x-html="hyva.formatPrice('<?= $priceModel->getValue() ?>')"></span>
                <span class="price-excl" x-show="vatMode == 'excluding'" x-html="hyva.formatPrice('<?= $priceModel->getBaseAmount() ?>')"></span>
            </div>

            <script>
                function initVatSwitcherPrice() {
                    return {
                        vatMode: vatSwitcher.getVatMode(),

                        eventListeners: {
                            ['@vat-switch.window'](event) {
                                this.vatMode = event.detail;
                            }
                        }
                    }
                }
            </script>

Example with existing alpine component

Sometimes you will need price info from an already existing price component, because it is hard to pass data from parent to child components in alpine. In this case you can simply add the vatmode: vatMode: vatSwitcher.getVatMode(), and the eventListener to the existing component:

function initExistingComponent() {
    return {
        vatMode: vatSwitcher.getVatMode(),

        eventListeners: {
            ['@vat-switch.window'](event) {
                this.vatMode = event.detail;
            }
        }
    }
}

And make sure the existing component uses: x-spread="eventListeners". No you can also use code like this in your existing component:

    <div x-data="initExistingComponent()" x-spread="eventListeners">
        <span class="price-incl" x-show="vatMode == 'including'" x-html="hyva.formatPrice('<?= $priceModel->getValue() ?>')"></span>
        <span class="price-excl" x-show="vatMode == 'excluding'" x-html="hyva.formatPrice('<?= $priceModel->getBaseAmount() ?>')"></span>
    </div>