Skip to content

Commit

Permalink
Merge branch 'develop' into feat/PXP-11370-data-library-controls
Browse files Browse the repository at this point in the history
  • Loading branch information
alilahrime committed Aug 22, 2024
2 parents 1503365 + f2ecb5f commit e444069
Show file tree
Hide file tree
Showing 60 changed files with 1,906 additions and 981 deletions.
42 changes: 41 additions & 1 deletion docs/Configuration/Explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ The downloads menu is a dropdown with the following members:
* `data-json`

### Download Buttons
Individual button (horliztonally laid out) can be configured as:
Individual button (horizontally laid out) can be configured as:

```json
"buttons": [
Expand Down Expand Up @@ -179,3 +179,43 @@ The details configuration has the following members:
* closeOnEscape - if true, closed when the esc key is pressed
* closeOnClickOutside - close when anywhere outside the modal is closed
* size - size of the modal

## Selection Facet

A new facet UI is available instead of the enumerated facet, which can be used when the number of facet keys becomes
quite large. To enable it, in the filters->tabs section of the config file:

```json
{
"filters": {
"tabs": [
{
"title": "Study Selection",
"fields": ["project"]
},
{
"title": "Subjects",
"fields": [
"study",
"gender",
"race",
"ethnicity",
"vital_status",
"whatever_lab_result_value"
],
"fieldsConfig": {
"gender" : {
"type" : "multiselect"
}
}
}
]
},

```

add a ```fieldsConfig``` entry. The format is _field_ name then _type_. In the example above the```gender``` field is
switch to use ```multiselect```. Note that ```multiselect``` is the only type supported. The selection is a dropdown that
is also searchable.

![MultiSelectFacet](images/MultiSelectFacet.png)
13 changes: 9 additions & 4 deletions docs/Configuration/Navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,17 @@ Example of a top bar item:
}
```

#### b. Login Display
#### b. Login Button Display

- **showLogin**: A boolean value that determines whether to show the login option in the top bar.
- **loginButtonVisibility**: one of 'visible', 'hidden' or 'logoutOnly'

where:
* 'visible' - always shown, if logged in shows userId and a logout button
* 'logoutOnly' - only show the logoutButton when logged in
* 'hidded' - never show

```json
"showLogin": true
"loginButtonVisibility": "logoutOnly"
```

### 4. Example Full Configuration
Expand Down Expand Up @@ -105,7 +110,7 @@ Below is an example of a full navigation configuration file combining both `navi
},
// More items...
],
"showLogin": true
"loginButtonVisibility": "visible"
}
}
```
Expand Down
Binary file added docs/Configuration/images/MultiSelectFacet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"packages": ["packages/*"],
"useWorkspaces": true,
"version": "0.10.36"
"version": "0.10.40"
}
Loading

0 comments on commit e444069

Please sign in to comment.