loki Documentation

LokiCheckout_CustomerNote

Checkout
Checkout - Other
PHP 8.1 - 8.4
Magento 2.4.7 | 2.4.8
CSP Yes
Latest Release 0.0.1

This Magento 2 module is an add-on package for the LokiCheckout. It adds a textarea customer_note to the sidebar so that customers are able to add additional comments to their order.

Installation

Install this package via composer:

composer require loki-checkout/magento2-customer-note

Next, enable this module:

bin/magento module:enable LokiCheckout_CustomerNote

Support

For getting support, create an Issue under the following project URL:

https://gitlab.yireo.com/loki-checkout/LokiCheckout_CustomerNote.git

Loki Components

The following LokiComponents are created or references in this module:

loki-checkout.sidebar.customer_note
Module Dependencies

The following dependencies are declared in the module its `etc/module.xml` file:

LokiCheckout_Core Loki_Base Loki_Components Loki_CssUtils Loki_FieldComponents Loki_MapComponents Magento_Backend Magento_Catalog Magento_Checkout Magento_CheckoutAgreements Magento_Config Magento_Customer Magento_Directory Magento_Eav Magento_Newsletter Magento_Payment Magento_Quote Magento_Sales Magento_Shipping Magento_Store Magento_Vault Yireo_CspUtilities
Composer details
Magento module name
LokiCheckout_CustomerNote
Composer name
loki-checkout/magento2-customer-note
Composer version
2.0.8
Default branch
main
Requirements
loki-checkout/magento2-core: ^2.0
loki/magento2-components: ^2.0
loki/magento2-css-utils: ^1.0
magento/framework: ^103.0
Releases
2.0.8 07 December 2025
2.0.7 07 December 2025
2.0.6 07 December 2025
2.0.5 07 December 2025
2.0.4 07 December 2025
2.0.3 07 December 2025
2.0.2 07 December 2025
2.0.1 07 December 2025
2.0.0 07 December 2025
1.0.1 07 December 2025
1.0.0 07 December 2025
0.0.5 07 December 2025
0.0.4 07 December 2025
0.0.3 07 December 2025
0.0.2 07 December 2025
0.0.1 07 December 2025
Changelog

[2.0.8] - 22 October 2025

Fixed

  • Do not escape $css() with escapeHtmlAttr() but escapeHtml()
  • Update README

[2.0.7] - 24 September 2025

Fixed

  • Fix escaping of HTML break-tags when displaying customer note
  • Add .prevent modifier to @click event handler
  • Rename loki-components container to loki.components

[2.0.6] - 02 September 2025

Fixed

  • Add CI files
  • Replace yireo/opensearch with yireo/opensearch-dummy in Gitlab CI

[2.0.5] - 26 August 2025

Fixed

  • 473f3c1 Add GitLab CI files

[2.0.4] - 21 August 2025

Fixed

  • Add dependency with loki/magento2-css-utils
  • Fix duplicate import
  • Replace LokiComponentsUtilBlockCssClass with LokiCssUtilsUtilCssClass
  • Declare used PHP namespaces
  • Document latest version of template
  • Add missing strict_types declaration

[2.0.3] - 18 August 2025

Fixed

  • Lower requirements to PHP 8.1
  • Fix missing label association
  • Fix A11Y issues

[2.0.2] - 13 August 2025

Fixed

  • Add data-valid attribute to fields

[2.0.1] - 07 August 2025

Fixed

  • Lower PHP requirement to PHP 8.2+

[2.0.0] - 22 July 2025

Fixed

  • Bump loki/magento2-field-components to major 2.0
  • Bump LokiCheckout_Core to 2.0.0
  • Bump loki/magento2-components to major 2.0
  • Rename PHP namespace from Yireo_Loki* to Loki*
  • Rename composer package from yireo/magento2-loki* to loki/magento2*

[1.0.1] - 18 June 2025

Fixed

  • Convert newlines to breaks

[1.0.0] - 24 May 2025

Fixed

  • Update MODULE.json
  • Generate new MODULE.json with simple test count
  • Allow PHP 8.4 in CI

[0.0.5] - 24 May 2025

Fixed

  • Allow upgrading to LokiFieldComponents and LokiCheckout 1.0
  • Remove x-model because of CSP compliance
  • Rewrite getCartRepository()->save() to getCheckoutState()->saveQuote()

[0.0.4] - 08 April 2025

Fixed

  • Add textarea field-sizing-content

[0.0.3] - 11 March 2025

Fixed

  • Accessibility fixes
  • Add module dependencies
  • Huge refactoring to move logic into new LokiFieldComponents

[0.0.2] - 22 February 2025

  • Change deps
  • Move CssClass to LokiComponents
  • Add proper README
  • Replace TODO.md with TODO.json

[0.0.1] - 21 January 2025

  • Add proper deps
  • Initial release

Last modified: September 1, 2025