Guide / Controls / Media

Web page

A web page inside your app

When to use it. An embedded web browser that renders a URL inline within the layout grid. Supports interactive browsing, scroll control, and periodic auto-refresh.

Type
webView
Also titled
Web View
Default size
4 rows × 4 columns
Symbol
globe
Docs
Docs complete
Search for it as
  • web
  • browser
  • webpage
  • url
  • site
  • embed
Web page: Embedded dashboard
Rendered by the app

Fields

6 fields you can set on a webView control. Every control also takes the shared fields (id, position, span, sync, action).

Fields
FieldTypeDefaultWhat it does
urlurltext—

The web page to show

Loads this web address inside the control; a missing address shows a globe and "No URL". A live synced value that is a full URL replaces it.

Titlelabeltext—

The name shown above the page

Shows this text above the page in the label font size (8-24 pt, default 12); with no label no header row appears.

InteractivewebInteractiveon / offtrue (on)

Whether you can tap and type in the page

When off, touches pass through the page so it is display only; when on, links and forms work.

ScrollingwebScrollEnabledon / offtrue (on)

Whether the page can be scrolled

When off, the page stays at its top position and cannot be dragged; when on, you can scroll it.

webRefreshIntervalwebRefreshIntervalnumber1–3600step 1—

How often the page reloads by itself

Reloads the page every this many seconds (1 to 3600) while it is on screen; leave it unset for no automatic reload.

BackgroundhideBackgroundon / offfalse (off)

Whether the card behind it is drawn

Removes the glass card, fill and border so only the page sits on the layout.

Emits and receives

What this control sends when you use it, and what it can show or follow when data arrives.

Receives

Receives
TakesFromTypeWhat it does
valueshowhub, mqtt, http, store, derivestring

a web address, with its scheme (https://...)

the page loads that address in place of the configured url; a value that is not a full address is ignored and the url stays

Example: https://example.com

Examples

3 examples, each one a control you can paste into a layout.

Embedded dashboard

A scroll-locked dashboard that refreshes every 30 seconds.

JSON 11 lines
{
  "type": "webView",
  "id": "grafana",
  "position": [0, 0],
  "span": [4, 4],
  "label": "Metrics Dashboard",
  "url": "https://grafana.local/d/overview?kiosk",
  "webInteractive": true,
  "webScrollEnabled": false,
  "webRefreshInterval": 30
}

Open in CAR-TER

Web page: Embedded dashboard
Rendered by the app

Auto-refreshing status page

A read-only page that reloads itself every minute.

JSON 11 lines
{
  "type": "webView",
  "id": "status-page",
  "position": [0, 0],
  "span": [4, 3],
  "label": "Service status",
  "url": "https://example.com/status",
  "webInteractive": false,
  "webScrollEnabled": false,
  "webRefreshInterval": 60
}

Open in CAR-TER

Plain page without a card

A browsable page with no frosted card or title row.

JSON 8 lines
{
  "type": "webView",
  "id": "docs-page",
  "position": [0, 4],
  "span": [4, 4],
  "url": "https://example.com",
  "hideBackground": true
}

Open in CAR-TER

Try it on your phone

carterkit serves a small hub on your computer and pushes one example to CAR-TER on your iPhone or iPad. Pair once with the code it prints.

  1. Install the Python kit.

    pip install carterkit
  2. Show “Embedded dashboard” on your phone.

    carterkit demo webView --example 'Embedded dashboard'
  3. Swap in any example name from this page, or leave --example off for the first one.

carterkit quickstart · Get CAR-TER

Generated from ControlDocs/web-view.md. Something unclear or missing? Tell me.