> For the complete documentation index, see [llms.txt](https://docs.umbraco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.umbraco.com/umbraco-cms/17.latest/extend-your-project/backoffice-extensions/property-editors/property-editor-value-summary.md).

# Property Editor Value Summary

A guide to adding a Value Summary to a custom Property Editor in Umbraco.

When Documents are displayed in a collection, the backoffice shows each property's value in a compact table column. By default, raw values appear as plain text. Register a [Value Summary](/umbraco-cms/17.latest/extend-your-project/backoffice-extensions/extending-overview/extension-types/value-summary.md) for your Property Editor to control how that value is presented. You can show a formatted date, a color swatch, or a tag — without any configuration in the collection itself.

The Document Collection receives the Editor Alias from the server for each property and uses it to look up the correct summary. This means the Value Type key for a Property Editor must match the schema alias exactly.

## Defining the Value Type

Define the Value Type constant alongside your Property Editor. Use the Schema Alias as the key:

{% code title="my-property-editor/value-type/constants.ts" %}

```typescript
export interface MyPropertyEditorValue {
  value: string;
  label: string;
}

export const MY_PROPERTY_EDITOR_VALUE_TYPE = 'My.PropertyEditor.Alias' as const;

declare global {
  interface UmbValueTypeMap {
    [MY_PROPERTY_EDITOR_VALUE_TYPE]: MyPropertyEditorValue;
  }
}
```

{% endcode %}

## Registering the Value Summary

Register a `valueSummary` manifest using the Value Type constant as `forValueType`:

{% code title="my-property-editor/value-summary/manifests.ts" %}

```typescript
{
  type: 'valueSummary',
  kind: 'default',
  alias: 'My.ValueSummary.PropertyEditor.Alias',
  name: 'My Property Editor Value Summary',
  forValueType: MY_PROPERTY_EDITOR_VALUE_TYPE,
  element: () => import('./my-property-editor-value-summary.element.js'),
}
```

{% endcode %}

## Implementing the Element

The element receives the property value and renders a compact representation of it. Extend `UmbValueSummaryElementBase` and override `render()`:

{% code title="my-property-editor/value-summary/my-property-editor-value-summary.element.ts" %}

```typescript
@customElement('my-property-editor-value-summary')
export class MyPropertyEditorValueSummaryElement extends UmbValueSummaryElementBase<MyPropertyEditorValue> {
  override render() {
    if (!this._value) return nothing;
    return html`<uui-tag look="secondary">${this._value.label}</uui-tag>`;
  }
}
```

{% endcode %}

See [Value Summary](/umbraco-cms/17.latest/extend-your-project/backoffice-extensions/extending-overview/extension-types/value-summary.md) for the full range of options, including resolving server-side values.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.umbraco.com/umbraco-cms/17.latest/extend-your-project/backoffice-extensions/property-editors/property-editor-value-summary.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.