{"type":"doc","content":[{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://github.com/magesuite/shipping-addons"}},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"This module adds a free shipping bar to inform a user about the minimal amount of order that is free shipped.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Installation","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This module is required by theme-creativeshop and is installed out of the box when theme-creativeshop is required","type":"text"}]}]},{"type":"codeBlock","content":[{"text":"composer require \"creativestyle/magesuite-shipping-addons\" ^1.0.0","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Admin settings","type":"text"}]},{"type":"paragraph","content":[{"text":"There are no admin settings. However, the free shipping bar is not enabled by default. Check the fronted section for more details.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Backend","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"TODO - BE documentation and review of documentation is needed","type":"text"}]}]},{"type":"paragraph","content":[{"text":"There is template with display free shiping bar","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"vendor/creativestyle/magesuite-shipping-addons/view/frontend/templates/cart/free-shipping-bar.phtml","type":"text"}]},{"type":"codeBlock","content":[{"text":"","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"We calculate ","type":"text"},{"text":"freeShipingForm","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"priceFormat","type":"text","marks":[{"type":"em"}]},{"text":" in plugin for ","type":"text"},{"text":"getJsLayout","type":"text","marks":[{"type":"em"}]},{"text":" method","type":"text"}]},{"type":"paragraph","content":[{"text":"For Cart Sidebar:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"vendor/creativestyle/magesuite-shipping-addons/Plugin/Checkout/Block/Cart/Sidebar/AddFreeShippingBarVariables.php:40","type":"text"}]},{"type":"codeBlock","content":[{"text":"class AddFreeShippingBarVariables\n{\n public function afterGetJsLayout(\\Magento\\Checkout\\Block\\Cart\\Sidebar $subject, $jsLayout)\n {\n $jsLayout = json_decode($jsLayout, true);\n\n $freeShippingBarConfig = $this->arrayManager->get(self::FREE_SHIPPING_BAR_CONFIG_PATH, $jsLayout);\n\n if (!empty($freeShippingBarConfig)) {\n $freeShippingBarConfig['freeShippingFrom'] = $this->shippingMethodsHelper->getMinimumFreeShippingAmount();\n $freeShippingBarConfig['priceFormat'] = $this->taxHelper->getPriceFormat($this->storeManager->getStore()->getId());\n\n $jsLayout = $this->arrayManager->set(self::FREE_SHIPPING_BAR_CONFIG_PATH, $jsLayout, $freeShippingBarConfig);\n }\n\n return json_encode($jsLayout);\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"or for Totals","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"vendor/creativestyle/magesuite-shipping-addons/Plugin/Checkout/Block/Cart/Totals/AddFreeShippingBarVariables.php:40","type":"text"}]},{"type":"codeBlock","content":[{"text":"class AddFreeShippingBarVariables\n{\n public function afterGetJsLayout(\\Magento\\Checkout\\Block\\Cart\\Totals $subject, $jsLayout)\n {\n $jsLayout = json_decode($jsLayout, true);\n\n $freeShippingBarConfig = $this->arrayManager->get(self::FREE_SHIPPING_BAR_CONFIG_PATH, $jsLayout);\n\n if (!empty($freeShippingBarConfig)) {\n $freeShippingBarConfig['freeShippingFrom'] = $this->shippingMethodsHelper->getMinimumFreeShippingAmount();\n $freeShippingBarConfig['priceFormat'] = $this->taxHelper->getPriceFormat($this->storeManager->getStore()->getId());\n\n $jsLayout = $this->arrayManager->set(self::FREE_SHIPPING_BAR_CONFIG_PATH, $jsLayout, $freeShippingBarConfig);\n }\n\n return json_encode($jsLayout);\n }\n}","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Calculating minimum amount","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"vendor/creativestyle/magesuite-shipping-addons/Helper/ShippingMethods.php:21","type":"text"}]},{"type":"codeBlock","content":[{"text":"class ShippingMethods extends \\Magento\\Framework\\App\\Helper\\AbstractHelper\n{\n public function getMinimumFreeShippingAmount()\n {\n $minimumAmount = null;\n\n foreach ($this->freeShippingMethodsProvider->getShippingMethodsWithFreeShipping() as $methodData) {\n if (!$minimumAmount || (int) $methodData['value'] < $minimumAmount) {\n $minimumAmount = (int) $methodData['value'];\n }\n }\n\n return $minimumAmount;\n }\n}","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":5},"content":[{"text":"vendor/creativestyle/magesuite-shipping-addons/Service/FreeShippingMethodsProvider.php:37","type":"text"}]},{"type":"codeBlock","content":[{"text":"class FreeShippingMethodsProvider\n{\n public function getShippingMethodsWithFreeShipping()\n {\n $activeCarriers = $this->shippingConfig->getActiveCarriers();\n $methods = [];\n\n foreach ($activeCarriers as $code => $model) {\n .....\n\n $freeShippingSubtotal = $this->configuration->getFreeShippingSubtotal($code, $subtotalField);\n $freeShippingTitle = $this->configuration->getFreeShippingTitle($code);\n\n $methods[$code] = [\n 'title' => $freeShippingTitle,\n 'value' => $freeShippingSubtotal\n ];\n }\n\n return $methods;\n }\n}","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Frontend","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"“Free shipping bar” component is disabled by default. In order to show the bar every child theme has to enable it in XML ","type":"text"}]}]},{"type":"paragraph","content":[{"text":"In order to use this feature, any shipping method with “Free Shipping” threshold has to be enabled. For eg. “Free Shipping” method takes a threshold value from ","type":"text"},{"text":"Minimum Order Amount","type":"text","marks":[{"type":"code"}]},{"text":" field.","type":"text"}]},{"type":"paragraph","content":[{"text":" In order to enable the component for the cart in ","type":"text"},{"text":"checkout_cart_index.xml","type":"text","marks":[{"type":"code"}]},{"text":" file the following code should be added:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n \n \n \n \n \n \n MageSuite_ShippingAddons/js/view/free-shipping-bar\n \n \n \n \n \n \n","type":"text"}]},{"type":"paragraph","content":[{"text":"A similar code should be applied in ","type":"text"},{"text":"default.xml","type":"text","marks":[{"type":"code"}]},{"text":" file if the free shipping bar placed in the sidebar should be enabled in the minicart.","type":"text"}]},{"type":"paragraph","content":[{"text":"There are the following options that can be changed from the XML file:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"1a60da5e-1af3-4ed5-8f99-e87f5444cae9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"default value","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"componentDisabled","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"template","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"MageSuite_ShippingAddons/cart/free-shipping-bar","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"fulfilledText","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Free shipping applied","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"displayThresholdValues","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"shippingIconUrl","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"images/icons/shipping.svg","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Minicart free shipping bar:","type":"text","marks":[{"type":"strong"}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":50.0},"content":[{"type":"media","attrs":{"width":441,"id":"3b71186f-7382-41e9-88e2-3e1d1ae71f37","collection":"contentId-2291957835","type":"file","height":747}}]},{"type":"paragraph","content":[{"text":"Cart free shipping bar:","type":"text","marks":[{"type":"strong"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1261,"id":"114a9f6e-45c8-46af-b7f2-adce4971365b","collection":"contentId-2291957835","type":"file","height":454}}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Some projects move the bar into the other place. In such case, the original component shod stay disabled, and a new component, with the same settings, but with a different name, should be created.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1262,"id":"f6349a3b-9739-446f-931e-da2672f572e0","collection":"contentId-2291957835","type":"file","height":529}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Styling","type":"text"}]},{"type":"paragraph","content":[{"text":"CSS styling is provided by default in theme-creativeshop, in ","type":"text"},{"text":"theme-creativeshop/src/components/free-shipping-indicator/free-shipping-indicator.scss","type":"text","marks":[{"type":"code"}]},{"text":" file. There are multiple variables that can be customized in order to achieve the desired design.","type":"text"}]}],"version":1}