Skip to content

status icons, validation result update #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

status icons, validation result update #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added extend/component/ui-options/ui-examples/status_icons.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 15 additions & 2 deletions extend/component/ui-options/ui-examples/sync-action-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,24 @@ The sync action code has to return the following stdout (JSON string):
```json
{
"message": "###This is display text. \n\n It can contain **Markdown** notation. ",
"type": "info", //possible values: success, info, warning, danger
"status": "success" // this is required and will never be other value than "success"
"type": "info", //possible values: success, info, warning, error, table
"status": "success" // possible values: success, error. Error will be always rendered as error type.
}
```

#### Custom Icons

Markdown supports special status icons that are rendered in Keboola UI style. The following icons are supported:

```
![success]()
![warning]()
![error]()
```

![status_icons.png](/extend/component/ui-options/ui-examples/status_icons.png)



When used in Python, you can use the [ValidationResult](https://github.com/keboola/python-component#validationresult) class as a return value.

Expand Down
Loading