diff --git a/src/designer/elsa-workflows-studio/src/components/controls/elsa-context-menu/readme.md b/src/designer/elsa-workflows-studio/src/components/controls/elsa-context-menu/readme.md new file mode 100644 index 000000000..5c9aff4c4 --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/controls/elsa-context-menu/readme.md @@ -0,0 +1,35 @@ +# elsa-context-menu + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| ----------- | --------- | ----------- | --------------- | ----------- | +| `history` | -- | | `RouterHistory` | `undefined` | +| `menuItems` | -- | | `MenuItem[]` | `[]` | + + +## Dependencies + +### Used by + + - [elsa-studio-workflow-registry](../../dashboard/pages/elsa-studio-workflow-registry) + - [elsa-workflow-definitions-list-screen](../../screens/workflow-definition-list/elsa-workflow-definitions-screen) + - [elsa-workflow-instances-list-screen](../../screens/workflow-instances-list/elsa-workflow-instances-list-screen) + +### Graph +```mermaid +graph TD; + elsa-studio-workflow-registry --> elsa-context-menu + elsa-workflow-definitions-list-screen --> elsa-context-menu + elsa-workflow-instances-list-screen --> elsa-context-menu + style elsa-context-menu fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/controls/elsa-dropdown-button/readme.md b/src/designer/elsa-workflows-studio/src/components/controls/elsa-dropdown-button/readme.md new file mode 100644 index 000000000..8129f82ff --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/controls/elsa-dropdown-button/readme.md @@ -0,0 +1,45 @@ +# elsa-dropdown-button + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | --------------------------------------------------------------- | ------------------------------ | +| `icon` | `icon` | | `any` | `undefined` | +| `items` | -- | | `DropdownButtonItem[]` | `[]` | +| `origin` | `origin` | | `DropdownButtonOrigin.TopLeft \| DropdownButtonOrigin.TopRight` | `DropdownButtonOrigin.TopLeft` | +| `text` | `text` | | `string` | `undefined` | + + +## Events + +| Event | Description | Type | +| -------------- | ----------- | --------------------------------- | +| `itemSelected` | | `CustomEvent` | + + +## Dependencies + +### Used by + + - [elsa-workflow-instances-list-screen](../../screens/workflow-instances-list/elsa-workflow-instances-list-screen) + +### Depends on + +- stencil-route-link + +### Graph +```mermaid +graph TD; + elsa-dropdown-button --> stencil-route-link + elsa-workflow-instances-list-screen --> elsa-dropdown-button + style elsa-dropdown-button fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/controls/elsa-input-tags/readme.md b/src/designer/elsa-workflows-studio/src/components/controls/elsa-input-tags/readme.md index 1118e4640..e189609ae 100644 --- a/src/designer/elsa-workflows-studio/src/components/controls/elsa-input-tags/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/controls/elsa-input-tags/readme.md @@ -15,11 +15,18 @@ | `values` | -- | | `string[]` | `[]` | +## Events + +| Event | Description | Type | +| -------------- | ----------- | ----------------------- | +| `valueChanged` | | `CustomEvent` | + + ## Dependencies ### Used by - - [elsa-multi-text-property](../../properties/elsa-multi-text-property) + - [elsa-multi-text-property](../../editors/properties/elsa-multi-text-property) ### Graph ```mermaid diff --git a/src/designer/elsa-workflows-studio/src/components/controls/elsa-monaco/readme.md b/src/designer/elsa-workflows-studio/src/components/controls/elsa-monaco/readme.md index b0efc2472..8ed07075f 100644 --- a/src/designer/elsa-workflows-studio/src/components/controls/elsa-monaco/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/controls/elsa-monaco/readme.md @@ -11,6 +11,7 @@ | ---------------- | --------------- | ----------- | --------- | ----------- | | `editorHeight` | `editor-height` | | `string` | `'6em'` | | `language` | `language` | | `string` | `undefined` | +| `padding` | `padding` | | `string` | `undefined` | | `singleLineMode` | `single-line` | | `boolean` | `false` | | `value` | `value` | | `string` | `undefined` | @@ -34,20 +35,30 @@ Type: `Promise` +### `setValue(value: string) => Promise` + + + +#### Returns + +Type: `Promise` + + + ## Dependencies ### Used by - - [elsa-script-property](../../properties/elsa-script-property) - - [elsa-text-property](../../properties/elsa-text-property) - - [elsa-workflow-settings-modal](../../workflow-editor/elsa-workflow-settings-modal) + - [elsa-expression-editor](../../editors/elsa-expression-editor) + - [elsa-script-property](../../editors/properties/elsa-script-property) + - [elsa-workflow-settings-modal](../../screens/workflow-definition-editor/elsa-workflow-settings-modal) ### Graph ```mermaid graph TD; + elsa-expression-editor --> elsa-monaco elsa-script-property --> elsa-monaco - elsa-text-property --> elsa-monaco elsa-workflow-settings-modal --> elsa-monaco style elsa-monaco fill:#f9f,stroke:#333,stroke-width:4px ``` diff --git a/src/designer/elsa-workflows-studio/src/components/controls/elsa-pager/readme.md b/src/designer/elsa-workflows-studio/src/components/controls/elsa-pager/readme.md new file mode 100644 index 000000000..511ba7cec --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/controls/elsa-pager/readme.md @@ -0,0 +1,33 @@ +# elsa-pager + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| ------------ | ------------- | ----------- | --------------- | ----------- | +| `history` | -- | | `RouterHistory` | `undefined` | +| `page` | `page` | | `number` | `undefined` | +| `pageSize` | `page-size` | | `number` | `undefined` | +| `totalCount` | `total-count` | | `number` | `undefined` | + + +## Dependencies + +### Used by + + - [elsa-workflow-instances-list-screen](../../screens/workflow-instances-list/elsa-workflow-instances-list-screen) + +### Graph +```mermaid +graph TD; + elsa-workflow-instances-list-screen --> elsa-pager + style elsa-pager fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-root/readme.md b/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-root/readme.md new file mode 100644 index 000000000..3951202d3 --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-root/readme.md @@ -0,0 +1,36 @@ +# elsa-studio-root + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| ----------- | ------------ | ----------- | -------- | ----------- | +| `serverUrl` | `server-url` | | `string` | `undefined` | + + +## Dependencies + +### Depends on + +- stencil-route-link +- stencil-router +- stencil-route-switch +- stencil-route + +### Graph +```mermaid +graph TD; + elsa-studio-root --> stencil-route-link + elsa-studio-root --> stencil-router + elsa-studio-root --> stencil-route-switch + elsa-studio-root --> stencil-route + style elsa-studio-root fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-workflow-definitions-edit/readme.md b/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-workflow-definitions-edit/readme.md new file mode 100644 index 000000000..5888b00e0 --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-workflow-definitions-edit/readme.md @@ -0,0 +1,45 @@ +# elsa-studio-workflow-definitions-edit + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| ----------- | ------------ | ----------- | -------------- | ----------- | +| `match` | -- | | `MatchResults` | `undefined` | +| `serverUrl` | `server-url` | | `string` | `undefined` | + + +## Dependencies + +### Depends on + +- [elsa-workflow-definition-editor-screen](../../../screens/workflow-definition-editor/elsa-workflow-definition-editor-screen) + +### Graph +```mermaid +graph TD; + elsa-studio-workflow-definitions-edit --> elsa-workflow-definition-editor-screen + elsa-workflow-definition-editor-screen --> elsa-designer-tree + elsa-workflow-definition-editor-screen --> elsa-workflow-settings-modal + elsa-workflow-definition-editor-screen --> elsa-workflow-definition-editor-notifications + elsa-workflow-definition-editor-screen --> elsa-activity-picker-modal + elsa-workflow-definition-editor-screen --> elsa-activity-editor-modal + elsa-workflow-definition-editor-screen --> elsa-workflow-publish-button + elsa-workflow-definition-editor-screen --> context-consumer + elsa-designer-tree --> elsa-designer-tree-activity + elsa-workflow-settings-modal --> elsa-modal-dialog + elsa-workflow-settings-modal --> elsa-monaco + elsa-workflow-definition-editor-notifications --> elsa-toast-notification + elsa-activity-picker-modal --> elsa-modal-dialog + elsa-activity-editor-modal --> elsa-modal-dialog + elsa-workflow-publish-button --> context-consumer + style elsa-studio-workflow-definitions-edit fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-workflow-definitions-list/readme.md b/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-workflow-definitions-list/readme.md new file mode 100644 index 000000000..36852c818 --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-workflow-definitions-list/readme.md @@ -0,0 +1,37 @@ +# elsa-studio-workflow-definitions-list + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| ----------- | ------------ | ----------- | --------------- | ----------- | +| `history` | -- | | `RouterHistory` | `undefined` | +| `serverUrl` | `server-url` | | `string` | `undefined` | + + +## Dependencies + +### Depends on + +- stencil-route-link +- [elsa-workflow-definitions-list-screen](../../../screens/workflow-definition-list/elsa-workflow-definitions-screen) + +### Graph +```mermaid +graph TD; + elsa-studio-workflow-definitions-list --> stencil-route-link + elsa-studio-workflow-definitions-list --> elsa-workflow-definitions-list-screen + elsa-workflow-definitions-list-screen --> stencil-route-link + elsa-workflow-definitions-list-screen --> elsa-context-menu + elsa-workflow-definitions-list-screen --> elsa-confirm-dialog + elsa-confirm-dialog --> elsa-modal-dialog + style elsa-studio-workflow-definitions-list fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-workflow-instances-list/readme.md b/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-workflow-instances-list/readme.md new file mode 100644 index 000000000..f2d7060c4 --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-workflow-instances-list/readme.md @@ -0,0 +1,37 @@ +# elsa-studio-workflow-instances-list + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| ----------- | ------------ | ----------- | --------------- | ----------- | +| `history` | -- | | `RouterHistory` | `undefined` | +| `serverUrl` | `server-url` | | `string` | `undefined` | + + +## Dependencies + +### Depends on + +- [elsa-workflow-instances-list-screen](../../../screens/workflow-instances-list/elsa-workflow-instances-list-screen) + +### Graph +```mermaid +graph TD; + elsa-studio-workflow-instances-list --> elsa-workflow-instances-list-screen + elsa-workflow-instances-list-screen --> elsa-context-menu + elsa-workflow-instances-list-screen --> elsa-pager + elsa-workflow-instances-list-screen --> elsa-confirm-dialog + elsa-workflow-instances-list-screen --> elsa-dropdown-button + elsa-confirm-dialog --> elsa-modal-dialog + elsa-dropdown-button --> stencil-route-link + style elsa-studio-workflow-instances-list fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-workflow-registry/readme.md b/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-workflow-registry/readme.md new file mode 100644 index 000000000..972d9aa88 --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/dashboard/pages/elsa-studio-workflow-registry/readme.md @@ -0,0 +1,25 @@ +# elsa-studio-workflow-registry + + + + + + +## Dependencies + +### Depends on + +- stencil-route-link +- [elsa-context-menu](../../../controls/elsa-context-menu) + +### Graph +```mermaid +graph TD; + elsa-studio-workflow-registry --> stencil-route-link + elsa-studio-workflow-registry --> elsa-context-menu + style elsa-studio-workflow-registry fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/designers/tree/elsa-designer-tree/readme.md b/src/designer/elsa-workflows-studio/src/components/designers/tree/elsa-designer-tree/readme.md index 23a540bff..5ac5b5095 100644 --- a/src/designer/elsa-workflows-studio/src/components/designers/tree/elsa-designer-tree/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/designers/tree/elsa-designer-tree/readme.md @@ -7,9 +7,9 @@ ## Properties -| Property | Attribute | Description | Type | Default | -| -------- | --------- | ----------- | --------------- | ----------------------------------- | -| `model` | -- | | `WorkflowModel` | `{activities: [], connections: []}` | +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | --------------- | ----------------------------------------------------------------------------------------------------- | +| `model` | -- | | `WorkflowModel` | `{ activities: [], connections: [], persistenceBehavior: WorkflowPersistenceBehavior.WorkflowBurst }` | ## Events @@ -19,11 +19,24 @@ | `workflow-changed` | | `CustomEvent` | +## Methods + +### `destroyJsPlumb() => Promise` + + + +#### Returns + +Type: `Promise` + + + + ## Dependencies ### Used by - - [elsa-workflow-editor](../../../editors/workflow-editor/elsa-workflow-editor) + - [elsa-workflow-definition-editor-screen](../../../screens/workflow-definition-editor/elsa-workflow-definition-editor-screen) ### Depends on @@ -33,7 +46,7 @@ ```mermaid graph TD; elsa-designer-tree --> elsa-designer-tree-activity - elsa-workflow-editor --> elsa-designer-tree + elsa-workflow-definition-editor-screen --> elsa-designer-tree style elsa-designer-tree fill:#f9f,stroke:#333,stroke-width:4px ``` diff --git a/src/designer/elsa-workflows-studio/src/components/editors/elsa-expression-editor/readme.md b/src/designer/elsa-workflows-studio/src/components/editors/elsa-expression-editor/readme.md new file mode 100644 index 000000000..0eb979c35 --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/editors/elsa-expression-editor/readme.md @@ -0,0 +1,66 @@ +# elsa-expression-editor + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| ---------------------- | ------------------------ | ----------- | --------- | ----------- | +| `context` | `context` | | `string` | `undefined` | +| `editorHeight` | `editor-height` | | `string` | `'6em'` | +| `expression` | `expression` | | `string` | `undefined` | +| `language` | `language` | | `string` | `undefined` | +| `padding` | `padding` | | `string` | `undefined` | +| `serverUrl` | `server-url` | | `string` | `undefined` | +| `singleLineMode` | `single-line` | | `boolean` | `false` | +| `workflowDefinitionId` | `workflow-definition-id` | | `string` | `undefined` | + + +## Events + +| Event | Description | Type | +| ------------------- | ----------- | --------------------- | +| `expressionChanged` | | `CustomEvent` | + + +## Methods + +### `setExpression(value: string) => Promise` + + + +#### Returns + +Type: `Promise` + + + + +## Dependencies + +### Used by + + - [elsa-multi-expression-editor](../elsa-multi-expression-editor) + - [elsa-switch-cases-property](../properties/elsa-switch-cases-property) + +### Depends on + +- [elsa-monaco](../../controls/elsa-monaco) +- context-consumer + +### Graph +```mermaid +graph TD; + elsa-expression-editor --> elsa-monaco + elsa-expression-editor --> context-consumer + elsa-multi-expression-editor --> elsa-expression-editor + elsa-switch-cases-property --> elsa-expression-editor + style elsa-expression-editor fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/editors/elsa-multi-expression-editor/readme.md b/src/designer/elsa-workflows-studio/src/components/editors/elsa-multi-expression-editor/readme.md new file mode 100644 index 000000000..bb78887f9 --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/editors/elsa-multi-expression-editor/readme.md @@ -0,0 +1,55 @@ +# elsa-multi-expression-editor + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| ------------------- | ---------------- | ----------- | ---------------------------- | --------------------- | +| `context` | `context` | | `string` | `undefined` | +| `defaultSyntax` | `default-syntax` | | `string` | `SyntaxNames.Literal` | +| `editorHeight` | `editor-height` | | `string` | `'6em'` | +| `expressions` | -- | | `{ [key: string]: string; }` | `{}` | +| `fieldName` | `field-name` | | `string` | `undefined` | +| `label` | `label` | | `string` | `undefined` | +| `singleLineMode` | `single-line` | | `boolean` | `false` | +| `supportedSyntaxes` | -- | | `string[]` | `[]` | +| `syntax` | `syntax` | | `string` | `undefined` | + + +## Events + +| Event | Description | Type | +| ------------------- | ----------- | --------------------- | +| `expressionChanged` | | `CustomEvent` | +| `syntaxChanged` | | `CustomEvent` | + + +## Dependencies + +### Used by + + - [elsa-property-editor](../elsa-property-editor) + - [elsa-switch-cases-property](../properties/elsa-switch-cases-property) + +### Depends on + +- [elsa-expression-editor](../elsa-expression-editor) + +### Graph +```mermaid +graph TD; + elsa-multi-expression-editor --> elsa-expression-editor + elsa-expression-editor --> elsa-monaco + elsa-expression-editor --> context-consumer + elsa-property-editor --> elsa-multi-expression-editor + elsa-switch-cases-property --> elsa-multi-expression-editor + style elsa-multi-expression-editor fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/editors/elsa-property-editor/readme.md b/src/designer/elsa-workflows-studio/src/components/editors/elsa-property-editor/readme.md new file mode 100644 index 000000000..1a4e48548 --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/editors/elsa-property-editor/readme.md @@ -0,0 +1,60 @@ +# elsa-property-editor + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| -------------------- | --------------- | ----------- | ---------------------------- | ----------- | +| `context` | `context` | | `string` | `undefined` | +| `editorHeight` | `editor-height` | | `string` | `'6em'` | +| `propertyDescriptor` | -- | | `ActivityPropertyDescriptor` | `undefined` | +| `propertyModel` | -- | | `ActivityDefinitionProperty` | `undefined` | +| `showLabel` | `show-label` | | `boolean` | `true` | +| `singleLineMode` | `single-line` | | `boolean` | `false` | + + +## Events + +| Event | Description | Type | +| --------------------------- | ----------- | --------------------- | +| `defaultSyntaxValueChanged` | | `CustomEvent` | + + +## Dependencies + +### Used by + + - [elsa-check-list-property](../properties/elsa-check-list-property) + - [elsa-checkbox-property](../properties/elsa-checkbox-property) + - [elsa-dropdown-property](../properties/elsa-dropdown-property) + - [elsa-multi-line-property](../properties/elsa-multi-line-property) + - [elsa-multi-text-property](../properties/elsa-multi-text-property) + - [elsa-single-line-property](../properties/elsa-single-line-property) + +### Depends on + +- [elsa-multi-expression-editor](../elsa-multi-expression-editor) + +### Graph +```mermaid +graph TD; + elsa-property-editor --> elsa-multi-expression-editor + elsa-multi-expression-editor --> elsa-expression-editor + elsa-expression-editor --> elsa-monaco + elsa-expression-editor --> context-consumer + elsa-check-list-property --> elsa-property-editor + elsa-checkbox-property --> elsa-property-editor + elsa-dropdown-property --> elsa-property-editor + elsa-multi-line-property --> elsa-property-editor + elsa-multi-text-property --> elsa-property-editor + elsa-single-line-property --> elsa-property-editor + style elsa-property-editor fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-check-list-property/readme.md b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-check-list-property/readme.md index 117121e53..7be093c7b 100644 --- a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-check-list-property/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-check-list-property/readme.md @@ -13,6 +13,23 @@ | `propertyModel` | -- | | `ActivityDefinitionProperty` | `undefined` | +## Dependencies + +### Depends on + +- [elsa-property-editor](../../elsa-property-editor) + +### Graph +```mermaid +graph TD; + elsa-check-list-property --> elsa-property-editor + elsa-property-editor --> elsa-multi-expression-editor + elsa-multi-expression-editor --> elsa-expression-editor + elsa-expression-editor --> elsa-monaco + elsa-expression-editor --> context-consumer + style elsa-check-list-property fill:#f9f,stroke:#333,stroke-width:4px +``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-checkbox-property/readme.md b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-checkbox-property/readme.md index 89b7b0b36..d760d5e9b 100644 --- a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-checkbox-property/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-checkbox-property/readme.md @@ -13,6 +13,23 @@ | `propertyModel` | -- | | `ActivityDefinitionProperty` | `undefined` | +## Dependencies + +### Depends on + +- [elsa-property-editor](../../elsa-property-editor) + +### Graph +```mermaid +graph TD; + elsa-checkbox-property --> elsa-property-editor + elsa-property-editor --> elsa-multi-expression-editor + elsa-multi-expression-editor --> elsa-expression-editor + elsa-expression-editor --> elsa-monaco + elsa-expression-editor --> context-consumer + style elsa-checkbox-property fill:#f9f,stroke:#333,stroke-width:4px +``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-dropdown-property/readme.md b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-dropdown-property/readme.md index 767db91cf..50a9b8999 100644 --- a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-dropdown-property/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-dropdown-property/readme.md @@ -13,6 +13,23 @@ | `propertyModel` | -- | | `ActivityDefinitionProperty` | `undefined` | +## Dependencies + +### Depends on + +- [elsa-property-editor](../../elsa-property-editor) + +### Graph +```mermaid +graph TD; + elsa-dropdown-property --> elsa-property-editor + elsa-property-editor --> elsa-multi-expression-editor + elsa-multi-expression-editor --> elsa-expression-editor + elsa-expression-editor --> elsa-monaco + elsa-expression-editor --> context-consumer + style elsa-dropdown-property fill:#f9f,stroke:#333,stroke-width:4px +``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-multi-line-property/readme.md b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-multi-line-property/readme.md new file mode 100644 index 000000000..dacd9cb2f --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-multi-line-property/readme.md @@ -0,0 +1,35 @@ +# elsa-multi-line-property + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| -------------------- | --------- | ----------- | ---------------------------- | ----------- | +| `propertyDescriptor` | -- | | `ActivityPropertyDescriptor` | `undefined` | +| `propertyModel` | -- | | `ActivityDefinitionProperty` | `undefined` | + + +## Dependencies + +### Depends on + +- [elsa-property-editor](../../elsa-property-editor) + +### Graph +```mermaid +graph TD; + elsa-multi-line-property --> elsa-property-editor + elsa-property-editor --> elsa-multi-expression-editor + elsa-multi-expression-editor --> elsa-expression-editor + elsa-expression-editor --> elsa-monaco + elsa-expression-editor --> context-consumer + style elsa-multi-line-property fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-multi-text-property/readme.md b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-multi-text-property/readme.md index adffdba17..eedbc2238 100644 --- a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-multi-text-property/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-multi-text-property/readme.md @@ -17,12 +17,18 @@ ### Depends on -- [elsa-input-tags](../../controls/elsa-input-tags) +- [elsa-property-editor](../../elsa-property-editor) +- [elsa-input-tags](../../../controls/elsa-input-tags) ### Graph ```mermaid graph TD; + elsa-multi-text-property --> elsa-property-editor elsa-multi-text-property --> elsa-input-tags + elsa-property-editor --> elsa-multi-expression-editor + elsa-multi-expression-editor --> elsa-expression-editor + elsa-expression-editor --> elsa-monaco + elsa-expression-editor --> context-consumer style elsa-multi-text-property fill:#f9f,stroke:#333,stroke-width:4px ``` diff --git a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-script-property/readme.md b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-script-property/readme.md index a1091d032..a937e7062 100644 --- a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-script-property/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-script-property/readme.md @@ -23,7 +23,7 @@ ### Depends on -- [elsa-monaco](../../monaco/elsa-monaco) +- [elsa-monaco](../../../controls/elsa-monaco) - context-consumer ### Graph diff --git a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-single-line-property/readme.md b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-single-line-property/readme.md index 807394842..543f21281 100644 --- a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-single-line-property/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-single-line-property/readme.md @@ -7,30 +7,27 @@ ## Properties -| Property | Attribute | Description | Type | Default | -| ---------------------- | ------------------------ | ----------- | ---------------------------- | ----------- | -| `context` | `context` | | `string` | `undefined` | -| `editorHeight` | `editor-height` | | `string` | `'6em'` | -| `propertyDescriptor` | -- | | `ActivityPropertyDescriptor` | `undefined` | -| `propertyModel` | -- | | `ActivityDefinitionProperty` | `undefined` | -| `serverUrl` | `server-url` | | `string` | `undefined` | -| `singleLineMode` | `single-line` | | `boolean` | `false` | -| `workflowDefinitionId` | `workflow-definition-id` | | `string` | `undefined` | +| Property | Attribute | Description | Type | Default | +| -------------------- | --------- | ----------- | ---------------------------- | ----------- | +| `propertyDescriptor` | -- | | `ActivityPropertyDescriptor` | `undefined` | +| `propertyModel` | -- | | `ActivityDefinitionProperty` | `undefined` | ## Dependencies ### Depends on -- [elsa-monaco](../../monaco/elsa-monaco) -- context-consumer +- [elsa-property-editor](../../elsa-property-editor) ### Graph ```mermaid graph TD; - elsa-text-property --> elsa-monaco - elsa-text-property --> context-consumer - style elsa-text-property fill:#f9f,stroke:#333,stroke-width:4px + elsa-single-line-property --> elsa-property-editor + elsa-property-editor --> elsa-multi-expression-editor + elsa-multi-expression-editor --> elsa-expression-editor + elsa-expression-editor --> elsa-monaco + elsa-expression-editor --> context-consumer + style elsa-single-line-property fill:#f9f,stroke:#333,stroke-width:4px ``` ---------------------------------------------- diff --git a/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-switch-cases-property/readme.md b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-switch-cases-property/readme.md new file mode 100644 index 000000000..1e3914627 --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/editors/properties/elsa-switch-cases-property/readme.md @@ -0,0 +1,36 @@ +# elsa-switch-cases-property + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| -------------------- | --------- | ----------- | ---------------------------- | ----------- | +| `propertyDescriptor` | -- | | `ActivityPropertyDescriptor` | `undefined` | +| `propertyModel` | -- | | `ActivityDefinitionProperty` | `undefined` | + + +## Dependencies + +### Depends on + +- [elsa-expression-editor](../../elsa-expression-editor) +- [elsa-multi-expression-editor](../../elsa-multi-expression-editor) + +### Graph +```mermaid +graph TD; + elsa-switch-cases-property --> elsa-expression-editor + elsa-switch-cases-property --> elsa-multi-expression-editor + elsa-expression-editor --> elsa-monaco + elsa-expression-editor --> context-consumer + elsa-multi-expression-editor --> elsa-expression-editor + style elsa-switch-cases-property fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/pickers/elsa-activity-picker-modal/readme.md b/src/designer/elsa-workflows-studio/src/components/pickers/elsa-activity-picker-modal/readme.md index cbacfe0b6..6b86614a5 100644 --- a/src/designer/elsa-workflows-studio/src/components/pickers/elsa-activity-picker-modal/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/pickers/elsa-activity-picker-modal/readme.md @@ -9,7 +9,7 @@ ### Used by - - [elsa-workflow-editor](../../editors/workflow-editor/elsa-workflow-editor) + - [elsa-workflow-definition-editor-screen](../../screens/workflow-definition-editor/elsa-workflow-definition-editor-screen) ### Depends on @@ -19,7 +19,7 @@ ```mermaid graph TD; elsa-activity-picker-modal --> elsa-modal-dialog - elsa-workflow-editor --> elsa-activity-picker-modal + elsa-workflow-definition-editor-screen --> elsa-activity-picker-modal style elsa-activity-picker-modal fill:#f9f,stroke:#333,stroke-width:4px ``` diff --git a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-activity-editor-modal/readme.md b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-activity-editor-modal/readme.md index 232fb5c0d..0369d7d58 100644 --- a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-activity-editor-modal/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-activity-editor-modal/readme.md @@ -9,7 +9,7 @@ ### Used by - - [elsa-workflow-editor](../elsa-workflow-editor) + - [elsa-workflow-definition-editor-screen](../elsa-workflow-definition-editor-screen) ### Depends on @@ -19,7 +19,7 @@ ```mermaid graph TD; elsa-activity-editor-modal --> elsa-modal-dialog - elsa-workflow-editor --> elsa-activity-editor-modal + elsa-workflow-definition-editor-screen --> elsa-activity-editor-modal style elsa-activity-editor-modal fill:#f9f,stroke:#333,stroke-width:4px ``` diff --git a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-definition-editor-notifications/readme.md b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-definition-editor-notifications/readme.md index 6a13c365e..0f8bd6499 100644 --- a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-definition-editor-notifications/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-definition-editor-notifications/readme.md @@ -9,7 +9,7 @@ ### Used by - - [elsa-workflow-editor](../elsa-workflow-editor) + - [elsa-workflow-definition-editor-screen](../elsa-workflow-definition-editor-screen) ### Depends on @@ -18,9 +18,9 @@ ### Graph ```mermaid graph TD; - elsa-workflow-editor-notifications --> elsa-toast-notification - elsa-workflow-editor --> elsa-workflow-editor-notifications - style elsa-workflow-editor-notifications fill:#f9f,stroke:#333,stroke-width:4px + elsa-workflow-definition-editor-notifications --> elsa-toast-notification + elsa-workflow-definition-editor-screen --> elsa-workflow-definition-editor-notifications + style elsa-workflow-definition-editor-notifications fill:#f9f,stroke:#333,stroke-width:4px ``` ---------------------------------------------- diff --git a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-definition-editor-screen/readme.md b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-definition-editor-screen/readme.md index ae52b8164..fe509ff03 100644 --- a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-definition-editor-screen/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-definition-editor-screen/readme.md @@ -9,12 +9,30 @@ | Property | Attribute | Description | Type | Default | | ---------------------- | ------------------------ | ----------- | -------- | ----------- | +| `monacoLibPath` | `monaco-lib-path` | | `string` | `undefined` | | `serverUrl` | `server-url` | | `string` | `undefined` | | `workflowDefinitionId` | `workflow-definition-id` | | `string` | `undefined` | +## Events + +| Event | Description | Type | +| --------------- | ----------- | --------------------------------- | +| `workflowSaved` | | `CustomEvent` | + + ## Methods +### `exportWorkflow() => Promise` + + + +#### Returns + +Type: `Promise` + + + ### `getServerUrl() => Promise` @@ -35,14 +53,28 @@ Type: `Promise` +### `importWorkflow(file: File) => Promise` + + + +#### Returns + +Type: `Promise` + + + ## Dependencies +### Used by + + - [elsa-studio-workflow-definitions-edit](../../../dashboard/pages/elsa-studio-workflow-definitions-edit) + ### Depends on - [elsa-designer-tree](../../../designers/tree/elsa-designer-tree) - [elsa-workflow-settings-modal](../elsa-workflow-settings-modal) -- [elsa-workflow-editor-notifications](../elsa-workflow-editor-notifications) +- [elsa-workflow-definition-editor-notifications](../elsa-workflow-definition-editor-notifications) - [elsa-activity-picker-modal](../../../pickers/elsa-activity-picker-modal) - [elsa-activity-editor-modal](../elsa-activity-editor-modal) - [elsa-workflow-publish-button](../elsa-workflow-publish-button) @@ -51,20 +83,22 @@ Type: `Promise` ### Graph ```mermaid graph TD; - elsa-workflow-editor --> elsa-designer-tree - elsa-workflow-editor --> elsa-workflow-settings-modal - elsa-workflow-editor --> elsa-workflow-editor-notifications - elsa-workflow-editor --> elsa-activity-picker-modal - elsa-workflow-editor --> elsa-activity-editor-modal - elsa-workflow-editor --> elsa-workflow-publish-button - elsa-workflow-editor --> context-consumer + elsa-workflow-definition-editor-screen --> elsa-designer-tree + elsa-workflow-definition-editor-screen --> elsa-workflow-settings-modal + elsa-workflow-definition-editor-screen --> elsa-workflow-definition-editor-notifications + elsa-workflow-definition-editor-screen --> elsa-activity-picker-modal + elsa-workflow-definition-editor-screen --> elsa-activity-editor-modal + elsa-workflow-definition-editor-screen --> elsa-workflow-publish-button + elsa-workflow-definition-editor-screen --> context-consumer elsa-designer-tree --> elsa-designer-tree-activity elsa-workflow-settings-modal --> elsa-modal-dialog elsa-workflow-settings-modal --> elsa-monaco - elsa-workflow-editor-notifications --> elsa-toast-notification + elsa-workflow-definition-editor-notifications --> elsa-toast-notification elsa-activity-picker-modal --> elsa-modal-dialog elsa-activity-editor-modal --> elsa-modal-dialog - style elsa-workflow-editor fill:#f9f,stroke:#333,stroke-width:4px + elsa-workflow-publish-button --> context-consumer + elsa-studio-workflow-definitions-edit --> elsa-workflow-definition-editor-screen + style elsa-workflow-definition-editor-screen fill:#f9f,stroke:#333,stroke-width:4px ``` ---------------------------------------------- diff --git a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-publish-button/readme.md b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-publish-button/readme.md index 2c1e615e1..3a20c3b2c 100644 --- a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-publish-button/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-publish-button/readme.md @@ -15,22 +15,29 @@ ## Events -| Event | Description | Type | -| ------------------ | ----------- | ------------------ | -| `publishClicked` | | `CustomEvent` | -| `unPublishClicked` | | `CustomEvent` | +| Event | Description | Type | +| ------------------ | ----------- | ------------------- | +| `exportClicked` | | `CustomEvent` | +| `importClicked` | | `CustomEvent` | +| `publishClicked` | | `CustomEvent` | +| `unPublishClicked` | | `CustomEvent` | ## Dependencies ### Used by - - [elsa-workflow-editor](../elsa-workflow-editor) + - [elsa-workflow-definition-editor-screen](../elsa-workflow-definition-editor-screen) + +### Depends on + +- context-consumer ### Graph ```mermaid graph TD; - elsa-workflow-editor --> elsa-workflow-publish-button + elsa-workflow-publish-button --> context-consumer + elsa-workflow-definition-editor-screen --> elsa-workflow-publish-button style elsa-workflow-publish-button fill:#f9f,stroke:#333,stroke-width:4px ``` diff --git a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-settings-modal/elsa-workflow-settings-modal.tsx b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-settings-modal/elsa-workflow-settings-modal.tsx index ab62dd42c..dc9a3c18a 100644 --- a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-settings-modal/elsa-workflow-settings-modal.tsx +++ b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-settings-modal/elsa-workflow-settings-modal.tsx @@ -204,7 +204,7 @@ export class ElsaWorkflowDefinitionSettingsModal {
{textInput(formContext, 'contextOptions.contextType', 'Type', contextOptions.contextType, 'The fully qualified workflow context type name.', 'workflowContextType')} - {selectField(formContext, 'contextOptions.contextFidelity', 'Fidelity', contextOptions.contextFidelity.toString(), fidelityOptions, 'The workflow context refresh fidelity controls the behavior of when to load and persist the workflow context.', 'workflowContextFidelity')} + {selectField(formContext, 'contextOptions.contextFidelity', 'Fidelity', contextOptions.contextFidelity, fidelityOptions, 'The workflow context refresh fidelity controls the behavior of when to load and persist the workflow context.', 'workflowContextFidelity')}
); diff --git a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-settings-modal/readme.md b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-settings-modal/readme.md index b1e95afdc..9d49c61ce 100644 --- a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-settings-modal/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-editor/elsa-workflow-settings-modal/readme.md @@ -16,19 +16,19 @@ ### Used by - - [elsa-workflow-editor](../elsa-workflow-editor) + - [elsa-workflow-definition-editor-screen](../elsa-workflow-definition-editor-screen) ### Depends on - [elsa-modal-dialog](../../../shared/elsa-modal-dialog) -- [elsa-monaco](../../monaco/elsa-monaco) +- [elsa-monaco](../../../controls/elsa-monaco) ### Graph ```mermaid graph TD; elsa-workflow-settings-modal --> elsa-modal-dialog elsa-workflow-settings-modal --> elsa-monaco - elsa-workflow-editor --> elsa-workflow-settings-modal + elsa-workflow-definition-editor-screen --> elsa-workflow-settings-modal style elsa-workflow-settings-modal fill:#f9f,stroke:#333,stroke-width:4px ``` diff --git a/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-list/elsa-workflow-definitions-screen/readme.md b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-list/elsa-workflow-definitions-screen/readme.md new file mode 100644 index 000000000..74f9b72af --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/screens/workflow-definition-list/elsa-workflow-definitions-screen/readme.md @@ -0,0 +1,41 @@ +# elsa-workflow-definitions-list-screen + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| ----------- | ------------ | ----------- | --------------- | ----------- | +| `history` | -- | | `RouterHistory` | `undefined` | +| `serverUrl` | `server-url` | | `string` | `undefined` | + + +## Dependencies + +### Used by + + - [elsa-studio-workflow-definitions-list](../../../dashboard/pages/elsa-studio-workflow-definitions-list) + +### Depends on + +- stencil-route-link +- [elsa-context-menu](../../../controls/elsa-context-menu) +- [elsa-confirm-dialog](../../../shared/elsa-confirm-dialog) + +### Graph +```mermaid +graph TD; + elsa-workflow-definitions-list-screen --> stencil-route-link + elsa-workflow-definitions-list-screen --> elsa-context-menu + elsa-workflow-definitions-list-screen --> elsa-confirm-dialog + elsa-confirm-dialog --> elsa-modal-dialog + elsa-studio-workflow-definitions-list --> elsa-workflow-definitions-list-screen + style elsa-workflow-definitions-list-screen fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/screens/workflow-instances-list/elsa-workflow-instances-list-screen/readme.md b/src/designer/elsa-workflows-studio/src/components/screens/workflow-instances-list/elsa-workflow-instances-list-screen/readme.md new file mode 100644 index 000000000..1339c198f --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/screens/workflow-instances-list/elsa-workflow-instances-list-screen/readme.md @@ -0,0 +1,44 @@ +# elsa-workflow-instances-list-screen + + + + + + +## Properties + +| Property | Attribute | Description | Type | Default | +| ----------- | ------------ | ----------- | --------------- | ----------- | +| `history` | -- | | `RouterHistory` | `undefined` | +| `serverUrl` | `server-url` | | `string` | `undefined` | + + +## Dependencies + +### Used by + + - [elsa-studio-workflow-instances-list](../../../dashboard/pages/elsa-studio-workflow-instances-list) + +### Depends on + +- [elsa-context-menu](../../../controls/elsa-context-menu) +- [elsa-pager](../../../controls/elsa-pager) +- [elsa-confirm-dialog](../../../shared/elsa-confirm-dialog) +- [elsa-dropdown-button](../../../controls/elsa-dropdown-button) + +### Graph +```mermaid +graph TD; + elsa-workflow-instances-list-screen --> elsa-context-menu + elsa-workflow-instances-list-screen --> elsa-pager + elsa-workflow-instances-list-screen --> elsa-confirm-dialog + elsa-workflow-instances-list-screen --> elsa-dropdown-button + elsa-confirm-dialog --> elsa-modal-dialog + elsa-dropdown-button --> stencil-route-link + elsa-studio-workflow-instances-list --> elsa-workflow-instances-list-screen + style elsa-workflow-instances-list-screen fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/shared/elsa-confirm-dialog/readme.md b/src/designer/elsa-workflows-studio/src/components/shared/elsa-confirm-dialog/readme.md new file mode 100644 index 000000000..4c21b6523 --- /dev/null +++ b/src/designer/elsa-workflows-studio/src/components/shared/elsa-confirm-dialog/readme.md @@ -0,0 +1,53 @@ +# elsa-confirm-dialog + + + + + + +## Methods + +### `hide() => Promise` + + + +#### Returns + +Type: `Promise` + + + +### `show(caption: string, message: string) => Promise` + + + +#### Returns + +Type: `Promise` + + + + +## Dependencies + +### Used by + + - [elsa-workflow-definitions-list-screen](../../screens/workflow-definition-list/elsa-workflow-definitions-screen) + - [elsa-workflow-instances-list-screen](../../screens/workflow-instances-list/elsa-workflow-instances-list-screen) + +### Depends on + +- [elsa-modal-dialog](../elsa-modal-dialog) + +### Graph +```mermaid +graph TD; + elsa-confirm-dialog --> elsa-modal-dialog + elsa-workflow-definitions-list-screen --> elsa-confirm-dialog + elsa-workflow-instances-list-screen --> elsa-confirm-dialog + style elsa-confirm-dialog fill:#f9f,stroke:#333,stroke-width:4px +``` + +---------------------------------------------- + +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/designer/elsa-workflows-studio/src/components/shared/elsa-modal-dialog/readme.md b/src/designer/elsa-workflows-studio/src/components/shared/elsa-modal-dialog/readme.md index ba205a22f..70c99a182 100644 --- a/src/designer/elsa-workflows-studio/src/components/shared/elsa-modal-dialog/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/shared/elsa-modal-dialog/readme.md @@ -32,15 +32,17 @@ Type: `Promise` ### Used by - - [elsa-activity-editor-modal](../../editors/workflow-editor/elsa-activity-editor-modal) + - [elsa-activity-editor-modal](../../screens/workflow-definition-editor/elsa-activity-editor-modal) - [elsa-activity-picker-modal](../../pickers/elsa-activity-picker-modal) - - [elsa-workflow-settings-modal](../../editors/workflow-editor/elsa-workflow-settings-modal) + - [elsa-confirm-dialog](../elsa-confirm-dialog) + - [elsa-workflow-settings-modal](../../screens/workflow-definition-editor/elsa-workflow-settings-modal) ### Graph ```mermaid graph TD; elsa-activity-editor-modal --> elsa-modal-dialog elsa-activity-picker-modal --> elsa-modal-dialog + elsa-confirm-dialog --> elsa-modal-dialog elsa-workflow-settings-modal --> elsa-modal-dialog style elsa-modal-dialog fill:#f9f,stroke:#333,stroke-width:4px ``` diff --git a/src/designer/elsa-workflows-studio/src/components/shared/elsa-toast-notification/readme.md b/src/designer/elsa-workflows-studio/src/components/shared/elsa-toast-notification/readme.md index 39498bd9c..d92eae47e 100644 --- a/src/designer/elsa-workflows-studio/src/components/shared/elsa-toast-notification/readme.md +++ b/src/designer/elsa-workflows-studio/src/components/shared/elsa-toast-notification/readme.md @@ -32,12 +32,12 @@ Type: `Promise` ### Used by - - [elsa-workflow-editor-notifications](../../editors/workflow-editor/elsa-workflow-editor-notifications) + - [elsa-workflow-definition-editor-notifications](../../screens/workflow-definition-editor/elsa-workflow-definition-editor-notifications) ### Graph ```mermaid graph TD; - elsa-workflow-editor-notifications --> elsa-toast-notification + elsa-workflow-definition-editor-notifications --> elsa-toast-notification style elsa-toast-notification fill:#f9f,stroke:#333,stroke-width:4px ```