Skip to content

Commit fd2dae5

Browse files
committed
Module-tutorial
1 parent 3c8f1ca commit fd2dae5

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

website/docs/packages/reference/ui-module-instance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Inputs enable you to dynamically populate widget properties, run queries, or exe
2929
You can bind static values, widget outputs, query results, or app/user data into Inputs using JavaScript bindings.
3030

3131

32-
If you want to pass customer details fetched from a query into the module, you can set Inputs using the query response fields.
32+
*Example:* If you want to pass customer details fetched from a query into the module, you can set Inputs using the query response fields.
3333

3434
```js
3535
//inputCustomerName

website/docs/packages/reference/ui-module.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Content properties control the functional behavior of the UI Module container an
1919

2020

2121
Inputs allow you to pass dynamic values from the application into the UI Module.
22-
They act as a bridge between the app and the widgets, queries, or JavaScript logic inside the module.
22+
They act as a bridge between the app and the widgets, queries, or JS logic inside the module.
2323

2424
You can create multiple Inputs when designing the module. Each Input has:
2525

@@ -31,7 +31,7 @@ Inputs help you dynamically configure the behavior of widgets inside the UI Modu
3131

3232
**Accessing Inputs**
3333

34-
Inputs are accessed using the same syntax across widgets, queries, and JavaScript functions inside the module:
34+
Inputs can be accessed using the same syntax across widgets, queries, and JavaScript functions within the module:
3535

3636
```javascript
3737
{{inputs.inputName}}
@@ -90,15 +90,15 @@ Controls whether a loading animation appears while the UI Module's widgets, quer
9090
### Style Properties
9191

9292
Style properties control the appearance of the UI Module container, including background, border, and shadow settings.
93-
Some style properties are also JavaScript configurable and can accept dynamic values through Inputs.
93+
Some style properties are also JS configurable and can accept dynamic values through Inputs.
9494

9595
#### Background Color `string`
9696

9797
<dd>
9898

9999
Sets the background color of the UI Module container. You can define a static color value or bind a dynamic color using JavaScript expressions.
100100

101-
Background Color is JavaScript configurable and can also be dynamically controlled by passing a color value through an **Input**.
101+
Background Color is JS configurable and can also be dynamically controlled by passing a color value through an **Input**.
102102

103103

104104
</dd>

website/docs/packages/tutorial/ui-module.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# UI Module
1+
# UI Modules
22

3-
4-
A UI Module is a reusable, self-contained component built using widgets, queries, and JS Objects.
5-
It enables you to package visual elements, business logic, and data integrations into a module that can be easily reused across applications.
3+
A UI Module is a reusable, self-contained component built using widgets, queries, and JS Objects. It allows you to group UI elements, logic, and data interactions into a single unit that can be reused across multiple applications.
64

75
In this tutorial, you will learn how to create a reusable UI Module that accepts dynamic inputs from an application.
86

97

10-
:::tip What will I learn? 📝
11-
In this tutorial, you will create a reusable **User Profile Card** UI Module that displays basic user details dynamically.
8+
:::tip What will I build? 🧩
9+
You’ll build a **User Profile Card** UI Module that displays user details like name, email, and profile photo based on values passed from the app.
10+
11+
- **Basics**: Learn how to create and configure a UI Module.
12+
- **Dynamic Data**: Learn how to pass data from an application into the UI Module.
13+
- **Reusability**: Learn how to reuse the UI Module across multiple applications.
1214

13-
- 🔧 **Basics**: Learn how to create and configure a UI Module.
14-
- 🔄 **Dynamic Data**: Learn how to pass data from an application into the UI Module.
15-
- ♻️ **Reusability**: Discover how to reuse the UI Module across multiple applications
15+
⏱️ **Estimated time:** 15 minutes
1616
:::
1717

1818

@@ -132,6 +132,7 @@ Use the following bindings:
132132
| `userID` | `{{Table1.selectedRow.id}}` |
133133
| `userImg` | `{{Table1.selectedRow.image}}` |
134134

135+
Now, when you select any row in the Table widget, the corresponding user details will automatically be displayed in the UI Module.
135136

136137
</dd>
137138

0 commit comments

Comments
 (0)