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

Wix Design System (WDS)

Client (Deprecated)

API Preview

Wix CLI

Contexts

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso

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

{/* Generated by @wix/tw-typedoc-to-wix-docs from packages/portfolio-packages/showcase-portfolio-context/src/extensions/context/projectContext.tsx. Do not edit this file directly — edit the TSDoc in the source package. */}

# Portfolio Project Context Properties

## isResolving

**Type:** `boolean`

`true` while the project is loading.

`false` once the project loads, and when there's no project to load. In an item of a projects
list, it's always `false`.

---

## link

**Type:** `Link | undefined`

A link to the project's page. Its `target` is `'_self'`.

`undefined` while loading, or when there is no project.

---

## nextProjectCoverMedia

**Type:** `VisualMedia | null`

The next project's cover image or video, in the same format as `projectCoverMedia`.

`null` while loading, when there is no project, or when the next project has no cover.

---

## nextProjectLink

**Type:** `Link | undefined`

A link to the next project's page. The last project's next project is the first one.

`undefined` while loading, or when there is no project.

---

## nextProjectName

**Type:** `string`

The next project's title. Empty while loading, when there is no project, or when the next
project has no title.

---

## previousProjectCoverMedia

**Type:** `VisualMedia | null`

The previous project's cover image or video, in the same format as `projectCoverMedia`.

`null` while loading, when there is no project, or when the previous project has no cover.

---

## previousProjectLink

**Type:** `Link | undefined`

A link to the previous project's page. The first project's previous project is the last one.

`undefined` while loading, or when there is no project.

---

## previousProjectName

**Type:** `string`

The previous project's title. Empty while loading, when there is no project, or when the
previous project has no title.

---

## projectCoverMedia

**Type:** `VisualMedia | null`

The project's cover image or video. When the project has a cover video, it's the video.

A `VisualMedia` object. Its `type` is `'image'` or `'video'`, and its `src` is a Wix Media
identifier that starts with `wix:image://` or `wix:video://`, not a URL.

`null` while loading, when there is no project, or when the project has no cover.

---

## projectDescription

**Type:** `string`

The project description. Empty while loading, when there is no project, or when it has no
description.

---

## projectInfo

**Type:** `ProjectInfoField[] | undefined`

The project's info rows, such as its client or year, in the order the project lists them. It
leaves out rows with no label.

Empty while loading, when there is no project, or when the project has no info rows.

<ExpandableSection name="Child Properties">
  <PropertyList>
    <Property name="label" type="string">
      The row's label.
    </Property>
    <Property name="value" type="RichText">
      The row's value, as a `RichText` object: `text` holds the plain text, and `html` the markup to
      render.

      When the row is a link, `html` is one `a` element that links to the row's URL, with the link's
      text, or the URL when the link has no text. When the row's link opens in a new tab, the `a`
      element has `target="_blank"`.
    </Property>
  </PropertyList>
</ExpandableSection>

---

## projectMedia

**Type:** `ProjectMediaItem[] | undefined`

The project's media items. Holds the loaded pages only; call `loadMoreItems` for the rest.

It starts with the project's first page of media items. A page holds up to 50 items, and each
`loadMoreItems()` call adds the next page. It leaves out media items that have neither an image
nor a video.

In an item of a projects list, it's empty until the item's media loads. The media starts
loading the first time a component reads `projectMedia`.

Empty while loading, when there is no project, or when the project has no media.

<ExpandableSection name="Child Properties">
  <PropertyList>
    <Property name="description" type="string">
      The media item's description. Empty string when the item has no description.
    </Property>
    <Property name="media" type="VisualMedia">
      The image or video, as a `VisualMedia` object with its `type`, `src`, `title`, and
      `description`. `type` is `'image'` or `'video'`.

      `src` is a Wix Media identifier that starts with `wix:image://` or `wix:video://`, not a URL.
    </Property>
    <Property name="title" type="string">
      The media item's title. Empty string when the item has no title.
    </Property>
  </PropertyList>
</ExpandableSection>

---

## projectName

**Type:** `string`

The project title. Empty while loading, when there is no project, or when it has no title.