Mintlify Sandbox

Coding Examples

Overview

Sled Tests

Go Headless

Studio Two

Dashboard Extensions

Backend Extensions

Site Extensions

Extend Websites with SDK

Wix APIs and References

Build Apps

Frontend Modules

Client (Deprecated)

API Preview

Wix CLI

Contexts

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso

import { Property, PropertyList, ExpandableSection } from "@wix/docs-ui/content";

# WebUrl

A URL with an `http` or `https` scheme. Use it for a field that points to a web address, such as a
site the component links out to. For example, `'https://www.example.com/page'`.

## Component

In your component code, import the `WebUrl` type from `@wix/editor-react-types`:

```ts
import type { WebUrl } from '@wix/editor-react-types';
```

At runtime it's a plain string:

```ts
type WebUrl = string
```

### Usage

Your code either consumes a value of type `WebUrl` or produces one:

::::tabs
:::Consumers
In a component that receives a `WebUrl`, apply it to an anchor element:

```tsx
import type { WebUrl } from '@wix/editor-react-types';

function VisitLink({ website }: { website?: WebUrl }) {
  return <a href={website}>Visit our site</a>;
}
```
:::
:::Producers
When your code produces a `WebUrl`, for a context or a function return, assign a URL with an
`http` or `https` scheme:

```ts
import type { WebUrl } from '@wix/editor-react-types';

const website: WebUrl = 'https://www.example.com/page';
```
:::
::::

## Manifest

In your manifest, declare the field with the `webUrl` dataType:

```json
{ "dataType": "webUrl" }
```

### Declaration

Declare a `webUrl` field in one of these ways, depending on where the value comes from:

::::tabs
:::Data-property
Declare it as a data property when the Wix user should enter the URL in a panel. It takes `dataType`,
`displayName`, and an optional `defaultValue`:

```json
{
  "website": {
    "dataType": "webUrl",
    "displayName": "Website URL",
    "defaultValue": "https://www.example.com/page"
  }
}
```
:::
:::Context-item
Declare it as a context item when your component supplies the URL to descendant components. It
takes just `dataType` and `displayName`:

```json
{
  "website": {
    "dataType": "webUrl",
    "displayName": "Website URL"
  }
}
```
:::
:::Function-parameter-and-return
Declare it on a function when the function accepts or returns a URL. It takes `dataType` and an
optional `displayName`, and a parameter may also set `optional`:

```json
{
  "parameters": [
    {
      "dataType": "webUrl",
      "displayName": "Website URL"
    }
  ],
  "returns": {
    "dataType": "webUrl"
  }
}
```
:::
::::