request

Properties

Anchor to

design_mode

boolean

Returns true if the request is being made from within the theme editor. Returns false if not.

You can use request.design_mode to control theme behavior depending on whether the theme is being viewed in the editor. For example, you can prevent session data from being tracked by tracking scripts in the theme editor.

Caution

You shouldn't use request.design_mode to change customer-facing functionality. The theme editor preview should match what the merchant's customers see on the live store.

Anchor to

host

string

The domain that the request is hosted on.

Anchor to

locale

shop_locale

The locale of the request.

Anchor to

origin

string

The protocol and host of the request.

Example

Create a context-aware absolute URL

You can use request.origin with any object, object property, or filter that returns a relative URL to build a context-aware absolute URL.

CodeData

Reset Code

9

1

{{ product.selected_variant.url | default: product.url | prepend: request.origin }}

Code

{{ product.selected_variant.url | default: product.url | prepend: request.origin }}

Data

{
  "product": {
    "selected_variant": null,
    "url": "/products/health-potion"
  },
  "request": {
    "origin": "https://polinas-potent-potions.myshopify.com"
  }
}

Output

9

1

https://polinas-potent-potions.myshopify.com/products/health-potion

Output

https://polinas-potent-potions.myshopify.com/products/health-potion

Anchor to

page_type

string from a set of values

The type of page being requested.

Possible values
404
article
blog
captcha
cart
collection
list-collections
customers/account
customers/activate_account
customers/addresses
customers/login
customers/order
customers/register
customers/reset_password
gift_card
index
metaobject
page
password
policy
product
search

Anchor to

path

string

The path of the request.

Note

If the current path is for a page that doesn't exist, then nil is returned.

Anchor to

visual_preview_mode

boolean

Returns true if the request is being made from within the theme editor's visual section preview. Returns false if not.

You can use request.visual_preview_mode to control theme behavior depending on whether the theme is being viewed in the editor's visual section preview. For example, you can remove any scripts that interefere with how the section is displayed.