-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(wes): create Lit package for WES (#149)
- Loading branch information
Showing
24 changed files
with
1,426 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
# Form Component <Badge type="warning" text="beta" /> | ||
|
||
<div class="component-name"><ecc-client-lit-ga4gh-wes-create-run></div> | ||
This component is used to create workflows runs using WES API. | ||
<ClientOnly> | ||
<div :class="isDark ? 'component-dark component' : 'component-light component'"> | ||
<ecc-client-lit-ga4gh-wes-create-run /> | ||
|
||
::: details Code Blocks | ||
::: code-group | ||
|
||
```js [HTML] | ||
import "@elixir-cloud/lit-wes"; | ||
|
||
<ecc-utils-design-form />; | ||
``` | ||
|
||
<!-- ```jsx [React] | ||
``` --> | ||
|
||
::: | ||
|
||
</div> | ||
</ClientOnly> | ||
|
||
## Importing | ||
|
||
```js [HTML] | ||
import "@elixir-cloud/lit-wes"; | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Required | Default | Type | Description | | ||
| --------------------- | -------- | ----------------------------------------- | -------- | ----------- | | ||
| [`baseURL`](#baseURL) | `false` | `https://prowes.rahtiapp.fi/ga4gh/wes/v1` | `String` | Base URL | | ||
|
||
### baseURL | ||
|
||
This property is used to give `POST` endpoint to create workflow. The provided baseURL is concatinated with `/runs` and is used as an endpoint to create a `POST` request. | ||
|
||
## Parts | ||
|
||
TODO: | ||
|
||
<!-- | Part Name | Description | | ||
| --------------- | --------------------------------------------------------------------------------- | | ||
| `` | Component's internal form. | --> | ||
|
||
## CSS Variables | ||
|
||
## Examples | ||
|
||
### With baseURL | ||
|
||
<ClientOnly> | ||
<div :class="isDark ? 'component-dark component' : 'component-light component'"> | ||
<!-- Render ecc-utils-design-form component only after the component is loaded --> | ||
<ecc-client-lit-ga4gh-wes-create-run | ||
baseURL="http://localhost:8090/ga4gh/wes/v1" | ||
/> | ||
|
||
::: details Code Blocks | ||
::: code-group | ||
|
||
```js [HTML] | ||
import "@elixir-cloud/lit-wes"; | ||
|
||
<ecc-client-lit-ga4gh-wes-create-run baseURL="http://localhost:8090/ga4gh/wes/v1" />; | ||
``` | ||
|
||
<!-- ```jsx [React] | ||
``` --> | ||
|
||
::: | ||
|
||
</div> | ||
</ClientOnly> | ||
|
||
> The baseURL provided is localhost:8090, for this to work, have a WES implementation running on PORT 8090 or locally deploy [proWES](https://github.com/elixir-cloud-aai/proWES). | ||
<script setup> | ||
import { onMounted } from "vue"; | ||
import { useData } from "vitepress"; | ||
const { isDark } = useData(); | ||
onMounted(() => { | ||
import("@elixir-cloud/lit-wes").then((module) => { | ||
renderComponent.value = false; | ||
renderComponent.value = true; | ||
document.querySelectorAll("ecc-client-lit-ga4gh-wes-create-run").forEach((element) => { | ||
element.addEventListener("form-submit", (e) => { | ||
console.log("form-submitted", e.detail); | ||
}); | ||
}); | ||
}); | ||
}); | ||
</script> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<!-- # Installation | ||
`@elixir-cloud/wes` can be installed using npm as | ||
```bash | ||
npm install @elixir-cloud/lit-wes | ||
``` --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Introduction | ||
|
||
`@elixir-cloud/wes` package provides a collection of Web Components for interacting with [WES (Workflow Execution Service)](https://github.com/ga4gh/workflow-execution-service-schemas/blob/develop/openapi/workflow_execution_service.openapi.yaml). It offers functionalities for listing, creating, and deleting task runs. These components facilitate seamless integration and enhanced user experience when working with WES. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.