From 3bec7efef32864b7cbecd87b0026c865bef7f0a4 Mon Sep 17 00:00:00 2001 From: Faton Ramadani Date: Mon, 4 Sep 2023 11:43:01 +0200 Subject: [PATCH] update doc (#289) --- .../1_app_component_library.md | 33 ++++---- .../13_json_schema_and_parsing/index.md | 6 +- docs/flows/3_editor_components.mdx | 77 ++++++++++--------- docs/script_editor/customize_arguments.mdx | 20 ++--- 4 files changed, 70 insertions(+), 66 deletions(-) diff --git a/docs/apps/4_app_configuration-settings/1_app_component_library.md b/docs/apps/4_app_configuration-settings/1_app_component_library.md index 2fb4ccef9..b2ba1c9d5 100644 --- a/docs/apps/4_app_configuration-settings/1_app_component_library.md +++ b/docs/apps/4_app_configuration-settings/1_app_component_library.md @@ -138,9 +138,7 @@ The container component has no configuration. #### Outputs -| Name | Type | Description | -| ---------------- | :----: | ------------------------------- | -| selectedTabIndex | number | The number of the selected tab. | +The container component has no output. ### List @@ -191,13 +189,16 @@ List components also support having [inputs](#inputs) set inside them. Retrieve #### List configuration -| Name | Type | Connectable | Templatable | Default | Description | -| ------------ | :----: | :---------: | :---------: | :------------: | -------------------------------------------- | -| items | array | true | false | 3 items | The list items. | -| item keys | string | true | false | `"foo": 1` ... | The keys of each card. | -| Width | string | false | false | false | Wether items should be "Card" of "Full Row". | -| Min Width Px | number | true | true | 300 | The minimum width in pixels. | -| Height Px | number | true | true | 280 | The height in pixels. | +| Name | Type | Connectable | Templatable | Default | Description | +| ------------ | :----: | :---------: | :---------: | :-------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| items | array | true | false | 3 items | The list items. | +| item keys | string | true | false | `"foo": 1` ... | The keys of each card. | +| Width | string | false | false | "Card" | Whether items should be "Card" of "Full Row". | +| Min Width Px | number | true | true | 300 | The minimum width in pixels. Only applies when "Width" is set to Card | +| Height Px | number | true | true | 280 | The height in pixels. | +| Pagination | string | false | false | "Managed by runnable" | Pagination can be managed using two methods: By the component: Based on a specified page size, the component divides the array into several pages. By the runnable: The component shows all items, leaving the task of pagination to the runnable. The current page number is available in the component outputs. | +| Page count | number | false | false | 1 | The number of pages. Only applies when pagination is managed by the runnable. | +| Page size | number | false | false | 3 | The number of items per page. Only applies when pagination is managed by component. | #### Outputs @@ -206,6 +207,7 @@ List components also support having [inputs](#inputs) set inside them. Retrieve | result | any | The result of the list component. | | loading | boolean | The loading state of the component. | | inputs | any | The [inputs](#inputs) of the component. | +| page | number | The current page number. | ### Divider X @@ -352,11 +354,12 @@ A validation function can be set and won't allow users to go to the next step wh #### Outputs -| Name | Type | Description | -| ---------------- | :-----: | -------------------------------- | -| currentStepIndex | number | Number of the step / tab. | -| result | any | The result of the runnable. | -| loading | boolean | The loading state of the button. | +| Name | Type | Description | +| ---------------- | :------------------------: | -------------------------------------- | --- | +| currentStepIndex | number | Number of the step / tab. | +| result | any | The result of the runnable. | +| loading | boolean | The loading state of the button. | +| lastAction | string: "previous", "next" | The last action performed by the user. | F | ## Tabs diff --git a/docs/core_concepts/13_json_schema_and_parsing/index.md b/docs/core_concepts/13_json_schema_and_parsing/index.md index c3d5391f3..b64628236 100644 --- a/docs/core_concepts/13_json_schema_and_parsing/index.md +++ b/docs/core_concepts/13_json_schema_and_parsing/index.md @@ -157,9 +157,9 @@ Below is the list of all available advanced settings for each argument type: | Type | Advanced Configuration | | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | Integer | No advanced configuration for this type. | -| Number | No advanced configuration for this type. | -| String | - File (base64) | Enum | Format: email, hostname, uri, uuid, ipv4, yaml, sql | Pattern (Regex) | +| Number | Min and Max. | +| String | - File (base64) | Enum | Format: email, hostname, uri, uuid, ipv4, yaml, sql, date-time | Pattern (Regex) | | Boolean | No advanced configuration for this type. | -| Object | Advanced settings are [Resource Types](../3_resources_and_types/index.mdx). | +| Object | Advanced settings are [Resource Types](../3_resources_and_types/index.mdx). | | Array | - Items are strings | Items are strings from an enum | Items are objects (JSON) | Items are numbers | Items are bytes | | Any | No advanced configuration for this type. | diff --git a/docs/flows/3_editor_components.mdx b/docs/flows/3_editor_components.mdx index 0ad4d0acd..f0ae69ca5 100644 --- a/docs/flows/3_editor_components.mdx +++ b/docs/flows/3_editor_components.mdx @@ -23,6 +23,7 @@ The Flow Builder has the following major components we will detail below: The toolbar allows you to export the flow, configure the flow settings, and test the flow. Here are the different options available in the toolbar: + - **Summary**: shortcut to edit the flow summary. - **Previous/Next**: undo actions. - **[Path](../core_concepts/16_roles_and_permissions/index.mdx#path)**: define the permissions of the flow. @@ -56,17 +57,17 @@ The owner can be either a user, or a group of users ([folder](../core_concepts/8
- + + />
#### Description @@ -90,12 +91,12 @@ Have more details on all the ways to trigger flows [here](../getting_started/9_t :::
- +
### Shared Directory @@ -129,12 +130,12 @@ This flow can be found on the Demo workspace. Another example is to be found from the [Hub](https://hub.windmill.dev/flows/32/same-worker-example-of-using-the-'.%2Fshared'-folder).
- + description="Ensure that your data is safely stored and easily accessible whenever required." + href="/docs/core_concepts/persistent_storage" + />
### Worker Group Tag @@ -161,20 +162,20 @@ You can also test up to a certain step by clicking on an action (x) and then on At last, you can directly [test a step](#test-this-step).