Knockout observable is not accessible inside function

Knockout observable is not accessible inside function

September 27, 2026 · Illustrated author avatarBy Stefan Bogdanescu
Knockout observable is not accessible inside function

Title: Resolving Knockout Observable Access Issues Inside Functions

Hello fellow developers! Today we’re tackling an issue that many of us have faced while working with Knockout.js in Magento 2 projects - the dreaded “it is not a function” error when trying to access and manipulate observables inside functions.

The Problem at Hand

Let’s examine the provided code snippet:

//...

initialize: function() {
   this._super();
   this.progressText('1 of 15 questions completed');
},

showNext: function() {
   let dataIndex = parseInt($('.quiz-card.show').attr('data-index')) + 1;
   alert(ko.isObservable(this.progressText));
   alert(this.progressText());

   this.progressText(dataIndex + ' of 15 questions completed');
}

//...

The developer is correctly initializing the progressText observable in the initialize function. However, when trying to access and update it inside the showNext function, they’re running into issues - this.progressText() returns “it is not a function”.

The Cause of the Error

The issue lies in how JavaScript handles scopes within functions. When you define your Knockout component, all properties are accessible to both the initialize method and the component itself. However, when you define methods like showNext, they don’t inherit from the same scope.

In other words, while this refers to the component instance within the initialize function, it doesn’t have access to the observables defined outside of any method in the component.

The Solution: Capturing the Context

To resolve this issue, you need to capture the correct context (i.e., the component instance) when defining your methods. This can be achieved using either of the following approaches:

  1. Using ES6 Arrow Functions

By default, arrow functions (=>) don’t create their own this scope - they inherit it from the outer function.

//...

initialize: function() {
   this._super();
   this.progressText = ko.observable('1 of 15 questions completed');
   this.showNext = () => { // Notice the arrow function here
       let dataIndex = parseInt($('.quiz-card.show').attr('data-index')) + 1;
       console.log(ko.isObservable(this.progressText)); // true
       console.log(this.progressText()); // '1 of 15 questions completed'

       this.progressText(dataIndex + ' of 15 questions completed');
   }
}

//...
  1. Using var self = this;

If you’re still using traditional function definitions, you can capture the correct context by assigning this to a variable before defining your method.

//...

initialize: function() {
   var self = this; // Capture 'this' in a new variable

   this._super();
   this.progressText = ko.observable('1 of 15 questions completed');
   this.showNext = function() { // Traditional function definition
       let dataIndex = parseInt($('.quiz-card.show').attr('data-index')) + 1;
       console.log(ko.isObservable(self.progressText)); // true
       console.log(self.progressText()); // '1 of 15 questions completed'

       self.progressText(dataIndex + ' of 15 questions completed');
   }
}

//...

Conclusion: Capturing the Correct Context

In this post, we’ve explored a common issue faced when working with Knockout observables inside functions in Magento components. By understanding how JavaScript handles scopes and using either ES6 arrow functions or capturing this within your methods, you can easily resolve these issues.

Remember to always capture the correct context - it’s crucial for accessing and manipulating observables within your component methods.

Happy coding! If you’re looking for more insights on Magento development best practices, be sure to check out https://laravelcompany.com/blog. Until next time!

Magento 2 Indexing Themes Errors

Our network