Skip to content

playground page fix #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
romi-goldz wants to merge 3 commits into
base: main
Choose a base branch
from
Open

playground page fix #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1bad684
Update playground.mdx
romi-goldz Apr 21, 2025
e17b0c5
Add files via upload
romi-goldz Apr 21, 2025
62ce291
Update playground.mdx
romi-goldz Apr 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/images/learning/playground-addon-test.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 10 additions & 22 deletions docs/pages/learning/playground.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ The **Module Preview** shows how the module responds to the combinations that ha

The overview tab shows the details of the module displayed.

- **Module URL
- **Module URL**

- **Setup.JSON URL used for the module rendering
- **Setup.JSON URL** used for the module settings and rendering

- **Viewport - adjustable settings to render the module based on changing viewports
- **Viewport** render the module based on changing viewports

- **Template - render the module in various positions within a page
- **Template** preview the module as it will appear in different positions within a page

- **Context - the context of the module currently rendered. The context can be changed, by Editing the Module Payload
- **Context** the context of the module currently rendered. The context can be changed, by Editing the Module Payload

#### Module Payload

Expand All @@ -48,19 +48,7 @@ The Module Payload can be edited, to adjust the module context and details, in o

![Playground Addon Overview - Module Payload](@/assets/images/learning/playground-module-payload.png)

#### Template

Select a page template to review the module as it will appear within a web page.

![Playground Addon Overview - Template](@/assets/images/learning/playground-sample-page.png)

#### Viewport

Select the viewport of the module preview.

![Playground Addon Overview - Viewport](@/assets/images/learning/playground-mobile-viewport.png)

### Settings
#### Settings

The Settings tab allows configuring the module, using the available configuration available for the modules. For example, if a module allows adjusting the filters within the module, those settings can be set within the Settings tab, to test the module based on changing configurations.

Expand All @@ -80,14 +68,14 @@ In the I18n tab, the module labels can be set to update and preview the module c

### Test

The Test Tab can be used to render the module just as it will appear on a live airTRFX page.
The Test tab enables users to preview how an airModule will appear under different rendering conditions such as Tenant Code, Site-edition, Slug, and Theme ID.

This includes any page of a valid tenant, site edition, page slug, and defined theme.

The user can either manually enter test scenarios, or upload a JSON file, to populate pre-set scenarios.
The user can either manually enter test scenarios on the UI, or upload a JSON file with a bulk of preset scenarios, a template file can be found for download within the Test Tab.

*The test scenarios parameters are case sensitive*

![Playground Test Tab](@/assets/images/learning/playground-addon-test.png)

### Logs

This tab can be used to troubleshoot and get visibility over the API calls used to load data.
Expand Down