How to get configuration settings values in web .html file in Magento 2?

In Magento 2, there are two types of template files. One is .phtml and second one is .html files under web/template directory.

In .phtml we easily get the config value, but it’s tricky to get config value in web template files which we are going to cover in this article.

You have to follow below steps :

Step 1 : Add below code to your web .js file:

app/code/[Vendor]/[ModuleName]/view/frontend/web/js/[DirectoryName]/[JsFileName].js

1	app/code/[Vendor]/[ModuleName]/view/frontend/web/js/[DirectoryName]/[JsFileName].js

define([
    'ko',
    'jquery',
    'uiComponent',
    'mage/storage',
    'mage/url'
], function (ko, $, Component, storage, url) {
    'use strict';

    return Component.extend({
        defaults: {
            template: 'Vendor_ModueName/[DirectoryName]/[TemplateFileName]'
        },
        getconfigSettingValue: function () {
            var serviceUrl = url.build('modulename/configsetting/settingfieldid');

            storage.get(serviceUrl).done(
                function (response) {
                    if (response.success) {
                        return response.value
                    }
                }
            ).fail(
                function (response) {
                    return response.value
                }
            );
            return false;
        }
    });
});

define([

'ko',

'jquery',

'uiComponent',

'mage/storage',

'mage/url'

], function (ko, $, Component, storage, url) {

'use strict';

return Component.extend({

defaults: {

template: 'Vendor_ModueName/[DirectoryName]/[TemplateFileName]'

getconfigSettingValue: function () {

var serviceUrl = url.build('modulename/configsetting/settingfieldid');

storage.get(serviceUrl).done(

function (response) {

if (response.success) {

return response.value

}

).fail(

function (response) {

return response.value

}

);

return false;

}

});

Step 2 : Create controller

app/code/[Vendor]/[ModuleName]/Controller/[DirectoryName]/ControllerFileName.php

1	app/code/[Vendor]/[ModuleName]/Controller/[DirectoryName]/ControllerFileName.php

Add below code

namespace [Vendor]\[ModuleName]\Controller\[DirectoryName];

class ControllerFileName extends \Magento\Framework\App\Action\Action
{

    protected $resultJsonFactory;

    protected $storeManager;

    protected $scopeConfig;

    public function __construct(
        \Magento\Framework\App\Action\Context $context,
        \Magento\Framework\Controller\Result\JsonFactory $resultJsonFactory,
        \Magento\Store\Model\StoreManagerInterface $storeManager,
        \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
    ) {
        $this->resultJsonFactory = $resultJsonFactory;
        $this->storeManager = $storeManager;
        $this->scopeConfig = $scopeConfig;
        parent::__construct($context);
    }

    /**
     * Execute view action
     *
     * @return \Magento\Framework\Controller\ResultInterface
     */
    public function execute()
    {
        $response = [];
        try {
            $configValue = $this->scopeConfig->getValue(
                'your/path/config',
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE
            );
            $response = [
                'success' => true,
                'value' => __($configValue)
            ];

        } catch (\Exception $e) {
            $response = [
                'success' => false,
                'value' => __($e->getMessage())
            ];
            $this->messageManager->addError($e->getMessage());
        }
        $resultJson = $this->resultJsonFactory->create();
        return $resultJson->setData($response);
    }

}

namespace [Vendor]\[ModuleName]\Controller\[DirectoryName];

class ControllerFileName extends \Magento\Framework\App\Action\Action

{

protected $resultJsonFactory;

protected $storeManager;

protected $scopeConfig;

public function __construct(

\Magento\Framework\App\Action\Context $context,

\Magento\Framework\Controller\Result\JsonFactory $resultJsonFactory,

\Magento\Store\Model\StoreManagerInterface $storeManager,

\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig

) {

$this->resultJsonFactory = $resultJsonFactory;

$this->storeManager = $storeManager;

$this->scopeConfig = $scopeConfig;

parent::__construct($context);

}

/**

* Execute view action

* @return \Magento\Framework\Controller\ResultInterface

public function execute()

{

$response = [];

try {

$configValue = $this->scopeConfig->getValue(

'your/path/config',

\Magento\Store\Model\ScopeInterface::SCOPE_STORE

);

$response = [

'success' => true,

'value' => __($configValue)

];

} catch (\Exception $e) {

$response = [

'success' => false,

'value' => __($e->getMessage())

];

$this->messageManager->addError($e->getMessage());

}

$resultJson = $this->resultJsonFactory->create();

return $resultJson->setData($response);

}

Step 3 : Get config value as per below code in .html file.

<div class="config-setting-value" data-bind="html: getconfigSettingValue"></div>

1	<div class="config-setting-value" data-bind="html: getconfigSettingValue"></div>

Fill the below form if you have any Magento programming need.

Add an image programmatically from any url in Magento 2
[crayon-641efb6cb0ddd053561623/] Using above fucntion Images can be imported directly from...
Magento 2 : Override the Category view block file
Override view block using di.xml and add the below code...
How to check list of Layout XML called for a specific page in Magento 2?
You can check a list of called layout XML for...
Magento 2 : Setup PWA from Scratch
Follow the below steps to install and set up PWA...
How to remove leading zero’s from the order, invoice and shipment number in Magento 2?
If you want to remove all leading zero's from order,...

Author Info

Hire B. Darji

Let’s have a call

Fill the form & Get Installation Support