Skip to content
Closed
3 changes: 3 additions & 0 deletions 18/umbraco-cms/.gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ redirects:
reference/management/services/externalloginservice: reference/management/README.md
reference/management/services/fileservice: reference/management/README.md
reference/management/services/localizationservice: reference/management/README.md
reference/management/using-services/localizationservice: reference/management/README.md
tutorials/creating-a-basic-website/creating-master-template-part-1: tutorials/creating-a-basic-website/creating-layout-template-part-1.md
tutorials/creating-a-basic-website/creating-master-template-part-2: tutorials/creating-a-basic-website/creating-layout-template-part-2.md
reference/management/services/macroservice: reference/management/README.md
reference/management/services/membergroupservice: reference/management/README.md
reference/management/services/memberservice: reference/management/README.md
Expand Down
5 changes: 2 additions & 3 deletions 18/umbraco-cms/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,6 @@
* [Relation Service](reference/management/using-services/relationservice.md)
* [Content Service](reference/management/using-services/contentservice.md)
* [Content Type Service](reference/management/using-services/contenttypeservice.md)
* [Localization Service](reference/management/using-services/localizationservice.md)
* [User Service](reference/management/using-services/userservice.md)
* [Plugins](reference/plugins/README.md)
* [Creating Resolvers](reference/plugins/creating-resolvers.md)
Expand Down Expand Up @@ -487,8 +486,8 @@
* [Creating Your First Template](tutorials/creating-a-basic-website/creating-your-first-template-and-content-node.md)
* [CSS and Images](tutorials/creating-a-basic-website/css-and-images.md)
* [Displaying the Document Type Properties](tutorials/creating-a-basic-website/displaying-the-document-type-properties.md)
* [Creating a Master Template](tutorials/creating-a-basic-website/creating-master-template-part-1.md)
* [Creating Pages and Using the Master Template](tutorials/creating-a-basic-website/creating-master-template-part-2.md)
* [Creating a Layout Template](tutorials/creating-a-basic-website/creating-layout-template-part-1.md)
* [Creating Pages and Using the Layout Template](tutorials/creating-a-basic-website/creating-layout-template-part-2.md)
* [Setting the Navigation Menu](tutorials/creating-a-basic-website/setting-the-navigation-menu.md)
* [Articles and Article Items](tutorials/creating-a-basic-website/article-parent-and-article-items.md)
* [Adding Language Variants](tutorials/creating-a-basic-website/adding-language-variants.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Prefer other context types such as [Workspace Contexts](workspaces/workspace-con
Global Context extensions are registered using a `umbraco-package.json` manifest file.

**Key fields:**
- `type`: Must be `"globalContext"`, see: [ManifestGlobalContext](https://apidocs.umbraco.com/v17/ui-api/interfaces/packages_core_extension-registry.ManifestGlobalContext.html)
- `type`: Must be `"globalContext"`, see: [ManifestGlobalContext](https://apidocs.umbraco.com/v18/ui-api/interfaces/packages_core_extension-registry.ManifestGlobalContext.html)
- `alias`: A unique identifier for the context
- `name`: A human-readable name
- `api`: The path to the compiled JavaScript file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The `sectionSidebarApp` manifest supports the following properties:
| `conditions` | array | No | Conditions that must pass for the app to appear. See [Extension Conditions](../../extension-conditions.md). |
| `overwrites` | string \| string[] | No | Alias(es) of extensions this manifest replaces. |

For the full TypeScript interface, see [`ManifestSectionSidebarApp`](https://apidocs.umbraco.com/v17/ui-api/interfaces/packages_core_section.ManifestSectionSidebarApp.html) in the API documentation.
For the full TypeScript interface, see [`ManifestSectionSidebarApp`](https://apidocs.umbraco.com/v18/ui-api/interfaces/packages_core_section.ManifestSectionSidebarApp.html) in the API documentation.

For a general overview of manifest properties shared across all extension types, see [Extension Manifest Introduction](../../extension-registry/extension-manifest.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Trees get their data from a **Repository**. The Repository implements methods to

### Repository Implementation

Create a Repository that implements the `TreeRepository` interface. The interface below is simplified for clarity and omits return types and arguments. See full interfaces in the [UI API Documentation](https://apidocs.umbraco.com/v17/ui-api/interfaces/packages_core_tree.UmbTreeRepository.html)
Create a Repository that implements the `TreeRepository` interface. The interface below is simplified for clarity and omits return types and arguments. See full interfaces in the [UI API Documentation](https://apidocs.umbraco.com/v18/ui-api/interfaces/packages_core_tree.UmbTreeRepository.html)

```typescript
interface UmbTreeRepository {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ interface UmbTreeRepository {
}
```

See the full interface in the [UI API Documentation](https://apidocs.umbraco.com/v17/ui-api/interfaces/packages_core_tree.UmbTreeRepository.html).
See the full interface in the [UI API Documentation](https://apidocs.umbraco.com/v18/ui-api/interfaces/packages_core_tree.UmbTreeRepository.html).

## Registering the Repository

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ The above example illustrates the process of making a request to the Management

## Executing the request

Regardless of method, you can execute the fetch requests through Umbraco's [tryExecute](https://apidocs.umbraco.com/v17/ui-api/classes/packages_core_auth.UmbAuthContext.html#tryexecute) function. This function will handle any errors that occur during the request and will automatically refresh the token if it is expired. If the session is expired, the function will also make sure the user logs in again.
Regardless of method, you can execute the fetch requests through Umbraco's [tryExecute](https://apidocs.umbraco.com/v18/ui-api/classes/packages_core_auth.UmbAuthContext.html#tryexecute) function. This function will handle any errors that occur during the request and will automatically refresh the token if it is expired. If the session is expired, the function will also make sure the user logs in again.

**Example:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ Read more about generating your own client here:
## Further reading

* [@hey-api/openapi-ts](https://heyapi.dev/openapi-ts/get-started)
* [@umbraco-cms/backoffice/http-client](https://apidocs.umbraco.com/v17/ui-api/modules/packages_core_http-client.html)
* [@umbraco-cms/backoffice/http-client](https://apidocs.umbraco.com/v18/ui-api/modules/packages_core_http-client.html)
* [Using the Fetch API](fetch-api.md)
* [Creating a Backoffice Entry Point](../../extending-overview/extension-types/backoffice-entry-point.md)
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description:: Learn how to execute requests in the Backoffice.
Requests can be made using the Fetch API or the Umbraco HTTP client. The Backoffice also provides a `tryExecute` function that you can use to execute requests. This function handles any errors that occur during the request and automatically refreshes the token if it has expired. If the session has expired, it prompts the user to log in again.

{% hint style="info" %}
You can read the technical documentation for the `tryExecute` function in the [UI API Documentation](https://apidocs.umbraco.com/v17/ui-api/functions/packages_core_resources.tryExecute.html) class.
You can read the technical documentation for the `tryExecute` function in the [UI API Documentation](https://apidocs.umbraco.com/v18/ui-api/functions/packages_core_resources.tryExecute.html) class.
{% endhint %}

## Using the Umbraco HTTP Client
Expand All @@ -29,7 +29,7 @@ if (error) {
}
```

The `tryExecute` function takes the context of the current class or element as the first argument and the request as the second argument. Therefore, the above example can be used in any class or element that extends from either the [UmbController](https://apidocs.umbraco.com/v17/ui-api/interfaces/libs_controller-api.UmbController.html) or [UmbLitElement](https://apidocs.umbraco.com/v17/ui-api/classes/packages_core_lit-element.UmbLitElement.html) classes.
The `tryExecute` function takes the context of the current class or element as the first argument and the request as the second argument. Therefore, the above example can be used in any class or element that extends from either the [UmbController](https://apidocs.umbraco.com/v18/ui-api/interfaces/libs_controller-api.UmbController.html) or [UmbLitElement](https://apidocs.umbraco.com/v18/ui-api/classes/packages_core_lit-element.UmbLitElement.html) classes.

{% hint style="info" %}
The above example requires a host element illustrated by the use of `this`. This is typically a custom element that extends the `UmbLitElement` class.
Expand Down
2 changes: 1 addition & 1 deletion 18/umbraco-cms/customizing/foundation/icons.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Icons

The icons in the Umbraco backoffice are based on [Lucide Icons](https://lucide.dev/) and [Simple Icons](https://simpleicons.org/). The syntax for using an icon starts with `icon-`. You can find the full list of available icons in the [All Icons article in the UI documentation](https://apidocs.umbraco.com/v17/ui/?path=/docs/umb-icons--docs).
The icons in the Umbraco backoffice are based on [Lucide Icons](https://lucide.dev/) and [Simple Icons](https://simpleicons.org/). The syntax for using an icon starts with `icon-`. You can find the full list of available icons in the [All Icons article in the UI documentation](https://apidocs.umbraco.com/v18/ui/?path=/docs/umb-icons--docs).
Comment thread
AndyButland marked this conversation as resolved.

## Example

Expand Down
4 changes: 2 additions & 2 deletions 18/umbraco-cms/customizing/foundation/localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The following example shows how you can display localized text with the `umb-loc
```

{% hint style="info" %}
You can have a look and try out the element in the [UI API Documentation](https://apidocs.umbraco.com/v17/ui/?path=/docs/guides-localization-umblocalizeelement--docs).
You can have a look and try out the element in the [UI API Documentation](https://apidocs.umbraco.com/v18/ui/?path=/docs/guides-localization-umblocalizeelement--docs).
{% endhint %}

### **Localize Controller**
Expand Down Expand Up @@ -106,7 +106,7 @@ export default {
```

{% hint style="info" %}
You can try out the arguments feature in the [UI API Documentation](https://apidocs.umbraco.com/v17/ui/?path=/story/guides-localization-umblocalizeelement--with-arguments).
You can try out the arguments feature in the [UI API Documentation](https://apidocs.umbraco.com/v18/ui/?path=/story/guides-localization-umblocalizeelement--with-arguments).
{% endhint %}

**Using the Localize Element**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A collection repository is a specific type of repository designed to handle operations related to collections of items. It provides methods to request collections of data in a filtered and paginated manner.

The interface below is simplified for clarity and omits return types and arguments. See full interfaces in the [UI API Documentation](https://apidocs.umbraco.com/v17/ui-api/interfaces/packages_core_collection.UmbCollectionRepository.html).
The interface below is simplified for clarity and omits return types and arguments. See full interfaces in the [UI API Documentation](https://apidocs.umbraco.com/v18/ui-api/interfaces/packages_core_collection.UmbCollectionRepository.html).

```typescript
interface UmbCollectionRepository {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A detail repository is a specific type of repository designed to handle operations related to individual entities. It provides methods to create, retrieve, update, and delete single entities.

The interface below is simplified for clarity and omits return types and arguments. See full interfaces in the [UI API Documentation](https://apidocs.umbraco.com/v17/ui-api/interfaces/packages_core_repository.UmbDetailRepository.html).
The interface below is simplified for clarity and omits return types and arguments. See full interfaces in the [UI API Documentation](https://apidocs.umbraco.com/v18/ui-api/interfaces/packages_core_repository.UmbDetailRepository.html).

```typescript
interface UmbDetailRepository {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

An item repository is a specific type of repository designed to handle operations related to multiple individual items. It provides methods to request multiple items based on unique identifiers.

The interface below is simplified for clarity and omits return types and arguments. See full interfaces in the [UI API Documentation](https://apidocs.umbraco.com/v17/ui-api/interfaces/packages_core_repository.UmbItemRepository.html).
The interface below is simplified for clarity and omits return types and arguments. See full interfaces in the [UI API Documentation](https://apidocs.umbraco.com/v18/ui-api/interfaces/packages_core_repository.UmbItemRepository.html).

```typescript
interface UmbItemRepository {
Expand Down
2 changes: 1 addition & 1 deletion 18/umbraco-cms/customizing/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In this section, you will find all the resources you need to customize or build

## General Resources

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Extensions Overview</strong></td><td>Explore the options for bringing your own piece into the platform.</td><td><a href="extending-overview/">extending-overview</a></td><td><a href="../.gitbook/assets/gitbook1.png">gitbook1.png</a></td></tr><tr><td><strong>Foundation</strong></td><td>Learn about the Core features of the Backoffice, how to integrate, and make a reactive UI.</td><td><a href="foundation/">foundation</a></td><td><a href="../.gitbook/assets/gitbook1.png">gitbook1.png</a></td></tr><tr><td><p><strong>Backoffice UI API</strong></p><p>See the modules export, interfaces, hierarchy, code examples, and much more.</p></td><td></td><td><a href="https://apidocs.umbraco.com/v17/ui-api/index.html">https://apidocs.umbraco.com/v17/ui-api/index.html</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_the_Starter_Kit.png">Documentations Icons_Umbraco_CMS_Tutorials_the_Starter_Kit.png</a></td></tr><tr><td><strong>Examples &#x26; Playground</strong></td><td>Experience fully working customizations. This is also the place for you to get hands-on experience.</td><td><a href="../examples-and-playground.md">examples-and-playground.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Reference_Querying_and_Models.png">Documentations Icons_Umbraco_CMS_Reference_Querying_and_Models.png</a></td></tr></tbody></table>
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Extensions Overview</strong></td><td>Explore the options for bringing your own piece into the platform.</td><td><a href="extending-overview/">extending-overview</a></td><td><a href="../.gitbook/assets/gitbook1.png">gitbook1.png</a></td></tr><tr><td><strong>Foundation</strong></td><td>Learn about the Core features of the Backoffice, how to integrate, and make a reactive UI.</td><td><a href="foundation/">foundation</a></td><td><a href="../.gitbook/assets/gitbook1.png">gitbook1.png</a></td></tr><tr><td><p><strong>Backoffice UI API</strong></p><p>See the modules export, interfaces, hierarchy, code examples, and much more.</p></td><td></td><td><a href="https://apidocs.umbraco.com/v18/ui-api/index.html">https://apidocs.umbraco.com/v18/ui-api/index.html</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_the_Starter_Kit.png">Documentations Icons_Umbraco_CMS_Tutorials_the_Starter_Kit.png</a></td></tr><tr><td><strong>Examples &#x26; Playground</strong></td><td>Experience fully working customizations. This is also the place for you to get hands-on experience.</td><td><a href="../examples-and-playground.md">examples-and-playground.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Reference_Querying_and_Models.png">Documentations Icons_Umbraco_CMS_Reference_Querying_and_Models.png</a></td></tr></tbody></table>

## Get started with a tutorial

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To create a Property Editor UI, the following needs to be done:

### Implement the interface

What makes a standard Umbraco Lit component a Property Editor UI is the implementation of the `UmbPropertyEditorUiElement` interface. The `UmbPropertyEditorUiElement` interface ensures that your element has the necessary properties and methods to be used as a Property Editor UI element. See the [UI API documentation](https://apidocs.umbraco.com/v17/ui-api/interfaces/packages_core_property-editor.UmbPropertyEditorUiElement.html) for the full interface definition.
What makes a standard Umbraco Lit component a Property Editor UI is the implementation of the `UmbPropertyEditorUiElement` interface. The `UmbPropertyEditorUiElement` interface ensures that your element has the necessary properties and methods to be used as a Property Editor UI element. See the [UI API documentation](https://apidocs.umbraco.com/v18/ui-api/interfaces/packages_core_property-editor.UmbPropertyEditorUiElement.html) for the full interface definition.

```typescript
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
Expand All @@ -36,7 +36,7 @@ This interface gives access to important information about the data and configur
* `readonly`: If you support read-only mode, this will indicate whether the component should be read-only.

{% hint style="info" %}
For the full interface properties of the `UmbPropertyEditorUiElement`, see the [UI API documentation](https://apidocs.umbraco.com/v17/ui-api/interfaces/packages_core_property-editor.UmbPropertyEditorUiElement.html) for more information.
For the full interface properties of the `UmbPropertyEditorUiElement`, see the [UI API documentation](https://apidocs.umbraco.com/v18/ui-api/interfaces/packages_core_property-editor.UmbPropertyEditorUiElement.html) for more information.
{% endhint %}

A minimal implementation where the value is read and placed in a textbox looks like this:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Picker Collection Data Source

The interface below is simplified for clarity and omits return types and arguments. See full interfaces in the [UI API Documentation](https://apidocs.umbraco.com/v17/ui-api/modules/packages_core_picker-data-source.html)
The interface below is simplified for clarity and omits return types and arguments. See full interfaces in the [UI API Documentation](https://apidocs.umbraco.com/v18/ui-api/modules/packages_core_picker-data-source.html)

```typescript
interface UmbPickerPropertyEditorCollectionDataSource {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Picker Tree Data Source

The interface below is simplified for clarity and omits return types and arguments. See full interfaces in the [UI API Documentation](https://apidocs.umbraco.com/v17/ui-api/modules/packages_core_picker-data-source.html)
The interface below is simplified for clarity and omits return types and arguments. See full interfaces in the [UI API Documentation](https://apidocs.umbraco.com/v18/ui-api/modules/packages_core_picker-data-source.html)


```typescript
Expand Down
Loading
Loading