> For the complete documentation index, see [llms.txt](https://developer.singular.live/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.singular.live/composition-scripting/quick-start/read-and-update-widget-properties.md).

# Read and update widget properties

This example explains how to use composition scripting to read and update a composition's widget properties.

### Functions covered

* `comp.findWidget()`
* `widget.getPayload()`
* `widget.setPayload()`

Load this [example composition](https://app.singular.live/dashboard?templateLibraryItem=547) to follow along in a real composition.

### Composition structure

The example composition has one sub-composition called **Lower**, as you can see in the composition tree.

<figure><img src="https://lh6.googleusercontent.com/tqb-_aq0hgxDSFLSERmw9ZjxyvJWOHG5gXm98kQADOo07QzO3dYNeRfsjpkI62pCG-A2JmseSxAGxngufy39p2PuivPeBDetzC0MpnmK7n03jDVIfhkLcJbh2clFRk5u-KbkEwysF4ZfvNfwqt5p_KIHEA4k10zbx2LpqMttdD3E9Crj18XZNSUObi6U" alt=""><figcaption><p>The Lower sub-composition</p></figcaption></figure>

To go deeper and open the sub-composition's widgets:

* Double-click the Lower sub-composition.

This sub-composition contains three widgets.

* lowerTitle: a **text** widget
* lowerSubtitle: a **text** widget
* lowerLogo: an **image** widget

<figure><img src="https://lh5.googleusercontent.com/3-ZMOmymcdor5ltLX6kFt45MLVrAGykCXtqKzjRf_6HTlEuAZB27r-XN-iiy5R9H09fDCjrA9R0fYMmdPlwmLIA5xSN1C5fPcOaVXxiKzkIKMoDMNNEk6PLg0kv0R-9Q27Q5Gka0eoEg8SCkOlU2ORgVR-TInzr5sbPNiyD4ff8KLIZa3XhF6e3L9z9l" alt=""><figcaption><p>The sub-composition's widgets</p></figcaption></figure>

### **Composition script**

To get the same information using composition scripts, [open the composition script editor](/composition-scripting/composition-script-editor-reference.md#accessing-the-composition-script-editor) within the same [example composition](https://app.singular.live/compositions/458660/edit) as above.&#x20;

Then, read the comments in the Lower composition script to see the composition scripts needed to read and update widget properties.

You can also copy and paste the composition script below into your own compositions.&#x20;

{% code title="Lower Script" %}

```javascript
(function() {
  return {

    init: function(comp, context) {

      // get reference to the title widget
      const wiLowerTitle = comp.findWidget("lowerTitle")[0];

      // get widget properties
      const p = wiLowerTitle.getPayload();
      console.log(p);

      // get title text
      const titleText = p.text;

      // change title to uppercase
      wiLowerTitle.setPayload({
        "text": titleText.toUpperCase()
      });

    },

    close: function(comp, context) {}
  };
})();
```

{% endcode %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.singular.live/composition-scripting/quick-start/read-and-update-widget-properties.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.