Skip to content

Commit d19f6d3

Browse files
akucharskagrego952
akucharska
and
grego952
authored
docs: Add docs for time from now widget (#3937)
* Add docs for time from now widget * Fix links * Update docs/extensibility/50-list-and-details-widgets.md Co-authored-by: Grzegorz Karaluch <grzegorz.karaluch@sap.com> --------- Co-authored-by: Grzegorz Karaluch <grzegorz.karaluch@sap.com>
1 parent 044d5e0 commit d19f6d3

File tree

4 files changed

+63
-48
lines changed

4 files changed

+63
-48
lines changed

‎docs/extensibility/20-list-columns.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ You can customize the list page of the user interface component of your resource
66

77
This table lists the available parameters of the **data.list** section in your resource ConfigMap. You can learn whether each of the parameters is required and what purpose it serves.
88

9-
| Parameter | Required | Type | Description |
10-
| ------------------------- | -------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11-
| **source** | **Yes** | string or [JSONata](100-jsonata.md) expression | It is used to fetch data for the column. In its simplest form, it's the path to the value. |
12-
| **name** | **Yes** | string | Name for the primary label of this field. Required for most widgets (except for some rare cases that don't display a label). This can be a key to use from the [**translation** section](150-translations.md). |
13-
| **widget** | No | string | A widget used to render the field referred to by the **source** property. By default, the value is displayed verbatim. For more information about the available widgets, see [List and Details Widgets](./50-list-and-details-widgets.md). |
14-
| **valuePreprocessor** | No | string | The name of [value preprocessor](130-additional-sections-resources.md#value-preprocessors). |
15-
| **sort** | No | boolean | If set to `true`, it allows you to sort the resource list using this value. Defaults to `false`. It can also be set to an object with the following properties: |
16-
| **sort.default** | No | boolean | If the flag is set to `true`, the list view is sorted by this value by default. |
17-
| **sort.compareFunction** | No | [JSONata](100-jsonata.md) expression | It is required to use `$first` and `$second` variables when comparing two values. There is a special custom function [compareStrings](101-preset-functions.md#comparestrings-first-second) used to compare two strings, for example, `$compareStrings($first, $second)` |
18-
| **search** | No | boolean | A serach option. If set to `true`, it allows you to search the resource list by this value. Defaults to false. It can also be set to an object with the following property: |
19-
| **search.searchFunction** | No | [JSONata](100-jsonata.md) expression | It allows you to use `$input` variable to get the search input's value that can be used to search for more complex data. |
9+
| Parameter | Required | Type | Description |
10+
| ------------------------- | -------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11+
| **source** | **Yes** | string or [JSONata](100-jsonata.md) expression | It is used to fetch data for the column. In its simplest form, it's the path to the value. |
12+
| **name** | **Yes** | string | Name for the primary label of this field. Required for most widgets (except for some rare cases that don't display a label). This can be a key to use from the [**translation** section](150-translations.md). |
13+
| **widget** | No | string | A widget used to render the field referred to by the **source** property. By default, the value is displayed verbatim. For more information about the available widgets, see [List and Details Widgets](./50-list-and-details-widgets.md). |
14+
| **valuePreprocessor** | No | string | The name of [value preprocessor](130-additional-sections-resources.md#value-preprocessors). |
15+
| **sort** | No | boolean | If set to `true`, it allows you to sort the resource list using this value. Defaults to `false`. It can also be set to an object with the following properties: |
16+
| **sort.default** | No | boolean | If the flag is set to `true`, the list view is sorted by this value by default. |
17+
| **sort.compareFunction** | No | [JSONata](100-jsonata.md) expression | It is required to use `$first` and `$second` variables when comparing two values. There is a special custom function [compareStrings](101-jsonata-preset-functions.md#comparestrings-first-second) used to compare two strings, for example, `$compareStrings($first, $second)` |
18+
| **search** | No | boolean | A serach option. If set to `true`, it allows you to search the resource list by this value. Defaults to false. It can also be set to an object with the following property: |
19+
| **search.searchFunction** | No | [JSONata](100-jsonata.md) expression | It allows you to use `$input` variable to get the search input's value that can be used to search for more complex data. |
2020

2121
See the following example:
2222

0 commit comments

Comments
 (0)