Skip to content

Commit

Permalink
updated documentation for modules: @tridion-sites-extensions-3.0.0,@t…
Browse files Browse the repository at this point in the history
…ridion-sites-extensions-cli-1.2.0,@tridion-sites-extensions-cli-1.2.1,@tridion-sites-models-2.0.0,@tridion-sites-open-api-client-4.0.0
  • Loading branch information
RWS authored and RWS committed Jan 8, 2025
1 parent db5d599 commit 1690353
Show file tree
Hide file tree
Showing 3,608 changed files with 57,477 additions and 0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
11 changes: 11 additions & 0 deletions docs/extensions-cli.extensionsrequestbasepath.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md) &gt; [extensionsRequestBasePath](./extensions-cli.extensionsrequestbasepath.md)

## extensionsRequestBasePath variable

**Signature:**

```typescript
extensionsRequestBasePath = '/api/uiExtensionsRepository';
```
11 changes: 11 additions & 0 deletions docs/extensions-cli.getlocalfrontendaddon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md) &gt; [getLocalFrontendAddon](./extensions-cli.getlocalfrontendaddon.md)

## getLocalFrontendAddon variable

**Signature:**

```typescript
getLocalFrontendAddon: ({ manifestPath, addonConfigPath }: GetLocalFrontendAddonParams) => BackendFrontendAddon;
```
11 changes: 11 additions & 0 deletions docs/extensions-cli.getlocalfrontendaddonparams.addonconfigpath.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md) &gt; [GetLocalFrontendAddonParams](./extensions-cli.getlocalfrontendaddonparams.md) &gt; [addonConfigPath](./extensions-cli.getlocalfrontendaddonparams.addonconfigpath.md)

## GetLocalFrontendAddonParams.addonConfigPath property

**Signature:**

```typescript
addonConfigPath?: string;
```
11 changes: 11 additions & 0 deletions docs/extensions-cli.getlocalfrontendaddonparams.manifestpath.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md) &gt; [GetLocalFrontendAddonParams](./extensions-cli.getlocalfrontendaddonparams.md) &gt; [manifestPath](./extensions-cli.getlocalfrontendaddonparams.manifestpath.md)

## GetLocalFrontendAddonParams.manifestPath property

**Signature:**

```typescript
manifestPath: string;
```
18 changes: 18 additions & 0 deletions docs/extensions-cli.getlocalfrontendaddonparams.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md) &gt; [GetLocalFrontendAddonParams](./extensions-cli.getlocalfrontendaddonparams.md)

## GetLocalFrontendAddonParams interface

**Signature:**

```typescript
export interface GetLocalFrontendAddonParams
```

## Properties

| Property | Modifiers | Type | Description |
| ----------------------------------------------------------------------------------- | --------- | ------ | ------------ |
| [addonConfigPath?](./extensions-cli.getlocalfrontendaddonparams.addonconfigpath.md) | | string | _(Optional)_ |
| [manifestPath](./extensions-cli.getlocalfrontendaddonparams.manifestpath.md) | | string | |
20 changes: 20 additions & 0 deletions docs/extensions-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md)

## extensions-cli package

## Interfaces

| Interface | Description |
| ---------------------------------------------------------------------------------- | ----------- |
| [GetLocalFrontendAddonParams](./extensions-cli.getlocalfrontendaddonparams.md) | |
| [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) | |

## Variables

| Variable | Description |
| -------------------------------------------------------------------------- | ----------- |
| [extensionsRequestBasePath](./extensions-cli.extensionsrequestbasepath.md) | |
| [getLocalFrontendAddon](./extensions-cli.getlocalfrontendaddon.md) | |
| [setupExtensionsResponse](./extensions-cli.setupextensionsresponse.md) | |
11 changes: 11 additions & 0 deletions docs/extensions-cli.setupextensionsresponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md) &gt; [setupExtensionsResponse](./extensions-cli.setupextensionsresponse.md)

## setupExtensionsResponse variable

**Signature:**

```typescript
setupExtensionsResponse: ({ app, webAppPath, manifestPath, addonConfigPath, targetUrl, }: SetupExtensionsResponseParams) => void
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md) &gt; [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) &gt; [addonConfigPath](./extensions-cli.setupextensionsresponseparams.addonconfigpath.md)

## SetupExtensionsResponseParams.addonConfigPath property

**Signature:**

```typescript
addonConfigPath?: string;
```
11 changes: 11 additions & 0 deletions docs/extensions-cli.setupextensionsresponseparams.app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md) &gt; [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) &gt; [app](./extensions-cli.setupextensionsresponseparams.app.md)

## SetupExtensionsResponseParams.app property

**Signature:**

```typescript
app: Application;
```
11 changes: 11 additions & 0 deletions docs/extensions-cli.setupextensionsresponseparams.manifestpath.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md) &gt; [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) &gt; [manifestPath](./extensions-cli.setupextensionsresponseparams.manifestpath.md)

## SetupExtensionsResponseParams.manifestPath property

**Signature:**

```typescript
manifestPath: string;
```
21 changes: 21 additions & 0 deletions docs/extensions-cli.setupextensionsresponseparams.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md) &gt; [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md)

## SetupExtensionsResponseParams interface

**Signature:**

```typescript
export interface SetupExtensionsResponseParams
```

## Properties

| Property | Modifiers | Type | Description |
| ------------------------------------------------------------------------------------- | --------- | ----------- | ------------ |
| [addonConfigPath?](./extensions-cli.setupextensionsresponseparams.addonconfigpath.md) | | string | _(Optional)_ |
| [app](./extensions-cli.setupextensionsresponseparams.app.md) | | Application | |
| [manifestPath](./extensions-cli.setupextensionsresponseparams.manifestpath.md) | | string | |
| [targetUrl?](./extensions-cli.setupextensionsresponseparams.targeturl.md) | | string | _(Optional)_ |
| [webAppPath](./extensions-cli.setupextensionsresponseparams.webapppath.md) | | string | |
11 changes: 11 additions & 0 deletions docs/extensions-cli.setupextensionsresponseparams.targeturl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md) &gt; [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) &gt; [targetUrl](./extensions-cli.setupextensionsresponseparams.targeturl.md)

## SetupExtensionsResponseParams.targetUrl property

**Signature:**

```typescript
targetUrl?: string;
```
11 changes: 11 additions & 0 deletions docs/extensions-cli.setupextensionsresponseparams.webapppath.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions-cli](./extensions-cli.md) &gt; [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) &gt; [webAppPath](./extensions-cli.setupextensionsresponseparams.webapppath.md)

## SetupExtensionsResponseParams.webAppPath property

**Signature:**

```typescript
webAppPath: string;
```
11 changes: 11 additions & 0 deletions docs/extensions.accessiblecomponentprops.aria.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [AccessibleComponentProps](./extensions.accessiblecomponentprops.md) &gt; [aria](./extensions.accessiblecomponentprops.aria.md)

## AccessibleComponentProps.aria property

**Signature:**

```typescript
aria: Pick<Partial<AriaProps>, K>;
```
19 changes: 19 additions & 0 deletions docs/extensions.accessiblecomponentprops.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [AccessibleComponentProps](./extensions.accessiblecomponentprops.md)

## AccessibleComponentProps interface

Accessibility-related props

**Signature:**

```typescript
export interface AccessibleComponentProps<K extends keyof AriaProps>
```

## Properties

| Property | Modifiers | Type | Description |
| ----------------------------------------------------- | --------- | ---------------------------------------------------------------------------- | ----------- |
| [aria](./extensions.accessiblecomponentprops.aria.md) | | Pick&lt;Partial&lt;[AriaProps](./extensions.ariaprops.md)<!-- -->&gt;, K&gt; | |
13 changes: 13 additions & 0 deletions docs/extensions.actionextension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [ActionExtension](./extensions.actionextension.md)

## ActionExtension type

**Signature:**

```typescript
export type ActionExtension = () => ActionExtensionConfiguration;
```

**References:** [ActionExtensionConfiguration](./extensions.actionextensionconfiguration.md)
13 changes: 13 additions & 0 deletions docs/extensions.actionextensionconfiguration.icon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [ActionExtensionConfiguration](./extensions.actionextensionconfiguration.md) &gt; [icon](./extensions.actionextensionconfiguration.icon.md)

## ActionExtensionConfiguration.icon property

Icon associated with the action.

**Signature:**

```typescript
readonly icon: CustomIcon;
```
13 changes: 13 additions & 0 deletions docs/extensions.actionextensionconfiguration.id.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [ActionExtensionConfiguration](./extensions.actionextensionconfiguration.md) &gt; [id](./extensions.actionextensionconfiguration.id.md)

## ActionExtensionConfiguration.id property

A unique identifier for the action.

**Signature:**

```typescript
readonly id: string;
```
13 changes: 13 additions & 0 deletions docs/extensions.actionextensionconfiguration.label.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [ActionExtensionConfiguration](./extensions.actionextensionconfiguration.md) &gt; [label](./extensions.actionextensionconfiguration.label.md)

## ActionExtensionConfiguration.label property

Label associated with the action.

**Signature:**

```typescript
readonly label: string;
```
20 changes: 20 additions & 0 deletions docs/extensions.actionextensionconfiguration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [ActionExtensionConfiguration](./extensions.actionextensionconfiguration.md)

## ActionExtensionConfiguration interface

**Signature:**

```typescript
export interface ActionExtensionConfiguration
```

## Properties

| Property | Modifiers | Type | Description |
| ------------------------------------------------------------------- | --------- | ---------------------------------------- | ------------------------------------------ |
| [icon](./extensions.actionextensionconfiguration.icon.md) | | [CustomIcon](./extensions.customicon.md) | Icon associated with the action. |
| [id](./extensions.actionextensionconfiguration.id.md) | | string | A unique identifier for the action. |
| [label](./extensions.actionextensionconfiguration.label.md) | | string | Label associated with the action. |
| [useAction](./extensions.actionextensionconfiguration.useaction.md) | | [ActionHook](./extensions.actionhook.md) | Hook that contains behavior of the action. |
13 changes: 13 additions & 0 deletions docs/extensions.actionextensionconfiguration.useaction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [ActionExtensionConfiguration](./extensions.actionextensionconfiguration.md) &gt; [useAction](./extensions.actionextensionconfiguration.useaction.md)

## ActionExtensionConfiguration.useAction property

Hook that contains behavior of the action.

**Signature:**

```typescript
readonly useAction: ActionHook;
```
13 changes: 13 additions & 0 deletions docs/extensions.actiongroup.actionids.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [ActionGroup](./extensions.actiongroup.md) &gt; [actionIds](./extensions.actiongroup.actionids.md)

## ActionGroup.actionIds property

An ordered array of action IDs that are included in the group.

**Signature:**

```typescript
readonly actionIds: readonly string[];
```
13 changes: 13 additions & 0 deletions docs/extensions.actiongroup.id.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [ActionGroup](./extensions.actiongroup.md) &gt; [id](./extensions.actiongroup.id.md)

## ActionGroup.id property

A unique identifier for the action group.

**Signature:**

```typescript
readonly id: string;
```
17 changes: 17 additions & 0 deletions docs/extensions.actiongroup.label.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [ActionGroup](./extensions.actiongroup.md) &gt; [label](./extensions.actiongroup.label.md)

## ActionGroup.label property

Label associated with the action group.

**Signature:**

```typescript
readonly label: string;
```

## Remarks

It can be used to provide insight into why specific actions are grouped together.
19 changes: 19 additions & 0 deletions docs/extensions.actiongroup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [ActionGroup](./extensions.actiongroup.md)

## ActionGroup interface

**Signature:**

```typescript
export interface ActionGroup
```

## Properties

| Property | Modifiers | Type | Description |
| -------------------------------------------------- | --------- | ------------------- | -------------------------------------------------------------- |
| [actionIds](./extensions.actiongroup.actionids.md) | | readonly string\[\] | An ordered array of action IDs that are included in the group. |
| [id](./extensions.actiongroup.id.md) | | string | A unique identifier for the action group. |
| [label](./extensions.actiongroup.label.md) | | string | Label associated with the action group. |
13 changes: 13 additions & 0 deletions docs/extensions.actionhook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [ActionHook](./extensions.actionhook.md)

## ActionHook type

**Signature:**

```typescript
export type ActionHook = () => ActionHookResult;
```

**References:** [ActionHookResult](./extensions.actionhookresult.md)
13 changes: 13 additions & 0 deletions docs/extensions.actionhookresult.execute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@tridion-sites/extensions](./extensions.md) &gt; [ActionHookResult](./extensions.actionhookresult.md) &gt; [execute](./extensions.actionhookresult.execute.md)

## ActionHookResult.execute property

A callback function that is executed when the action is triggered.

**Signature:**

```typescript
readonly execute: () => void;
```
Loading

0 comments on commit 1690353

Please sign in to comment.