2. Page Variables and Methods

This tutorial will teach you what page variables are in BagaWork, and how you can create them and change them using page methods.

Why page variables are needed

An app that should only display static data (that is, the data/text shown in the app is the same all the time, so the GUI on each page always looks the same) is quite rare these days. Most apps allows the user to make changes to the data in the app, and those changes are then reflected in the GUI shown to the user.

For example, in an app that plays music, the user can usually create her own playlists, and add and remove song to/from that playlist. To achieve that, we can store the data that represents the songs in the user's playlist in a page variable. We will start off with much simpler examples than a playlist with songs, but it's a good example of that the data in an app often need to change as the user do different things in the app.

How to create page variables

Instead of hardcoding values in the code, you in previous tutorials learned that you could put those values in page constants (or app constants) instead. The idea with page variables is the very same, but with the different that after a page variable has been created an assigned its value, it can later store another value, for example when the user clicks on a Button.

Page variables are created the same way as page constants, but we use thisNamingConvention for app variables instead of THIS_NAMING_CONVENTION (which is only used for constants).

In the code below you find an example of how to create the following page variables:

• name will have the string value Alice
• lastVisit will have the string value 2023-09-16

class MyPage extends Page{
	
	name = `Alice`
	lastVisit = `2023-09-16`
	// You can create as many page variables as you want.
	
	// And then you have createGui() as usual.
	
}

How to use page variables

You obtain the value stored in a page variable the same way as you would retrieve a constant from it, i.e. you would write p.theName. For example, to obtain the value stored in the page variable lastVisit, we would write p.lastVisit (which would evaluate to the string 2023-09-16 in this case).

class StartPage extends Page{
	
	name = `Alice`
	
	createGui(){
		return Text.text(`Hello ${p.name}!`)
	}
	
}

But the benefit with variables over constants is that they can also change value while the app is running. If we would want to store the name Bob in the page variable name while the app is running we would write the code p.name = `Bob`. Easy as that!

However, a very good question is where we should write the code p.name = `Bob`. And it all depends on when we want the app to change the name to Bob. Very often, it is when the user has interacted with the GUI somehow, for example have clicked on a button, so let's go through how to make that happen.

In your own Page class, you can not only write different pre-defined methods, but you can also create your own methods (you can name them whatever you want). To tell the computer which code that should run when the user clicks on a Button, that code needs to be written in a method. So your Page class can for example look like this:

class MyPage extends Page{
	
	name = `Alice`
	
	setNameToBob(){
		p.name = `Bob`
	}
	
	// And then you have createGui() as usual.
	
}

The method in the example above is named setNameToBob(), but you can name it whatever you want. However, to get code that is easy to read, the name of the method should reflect what the code in the method does, so setNameToBob() is a very good name in this case, since that's precisely what the code in the method does.

To tell the computer that the code in the method setNameToBob() should be executed when the user clicks on a button, we need to call the configuration method onClick() on the button, and pass it the method as an argument (i.e. write p.setNameToBob between the parentheses):

class StartPage extends Page{
	
	name = `Alice`
	
	setNameToBob(){
		p.name = `Bob`
	}
	
	createGui(){
		return Rows.children(
			Text.text(`Hello ${p.name}!`),
			Button.text(`Change name to Bob`).onClick(p.setNameToBob)
		)
	}
	
}

Button.onClick(p.setNameToBob)

Button.onClick(p.setNameToBob())

The final solution

So, here's all the code for the app using a page variable, and that has two buttons to change the value stored in it.

class StartPage extends Page{
	
	name = `Alice`
	
	setNameToAlice(){
		p.name = `Alice`
	}
	
	setNameToBob(){
		p.name = `Bob`
	}
	
	createGui(){
		return Rows.children(
			Text.text(`Hello ${p.name}!`),
			Button.text(`Change name to Alice`).onClick(p.setNameToAlice),
			Button.text(`Change name to Bob`).onClick(p.setNameToBob)
		)
	}
	
}

Exercises

Complete the exercises below to see if you have fully mastered what has been taught in this tutorial.

That's it!

Congratulation, now you know how to use page variables and page methods too! 🥳 But your App class can have its own variables and methods too, let's take a look at how those works next.