User Workspace Directory
Typical tag name: ws-user-dir
Exported class: WSUserDirectory
Inheritance: WSUserDirectory <-- Directory <-- SKUIBase <-- (imm-dom stack)
Simple user Workspace viewer/chooser capable of allowing user to select Workspaces with filters. The Workspaces which are available are loaded from the directory model.
Required Assets
- imm-dom, i18n
- sk.css
External Requirements
- Open Props
- Font Awesome 6
- Shoelace
WC Dependencies
- DirectoryModel
- WSUserDirectoryView
- WSUserDirectoryEntry
- WSUserDirectoryEntryExpanded
- WSUserDirectoryEntryCondensed
API
Attributes
| Attribute | Default | Enumerators | Usage |
|---|---|---|---|
ui |
full |
full, condensed |
Sets tag to ws-user-dir-entry-expanded for full or ws-user-dir-entry-condensed for condensed and calls default view mode. |
tag |
ivc-dir-entry-debug |
N/A | Web component tag for each displayed Workspace. |
stg |
zs-ws |
N/A | sessionStorage key for Workspace information when logged in. |
evt-name-clicked |
interaction-clicked |
N/A | Event name to emit when a Workspace is clicked. |
evt-name-selected |
interaction-selected |
N/A | Event name to emit when an Workspace is selected. |
evt-name-saved |
user-saved-selection |
N/A | Event name to emit when user chooses to submit selected Documents. |
show-count |
true | N/A | Shows count in the footer (and total selected if can-select). |
can-select |
false | N/A | Changes the tag to a selectable view component unless tag is overwritten. |
save-btn-text |
Save Selection |
N/A | Text for button which triggers saved event. |
Properties
| Property | Type | Default | Usage |
|---|---|---|---|
| (None.) |
Events
| Event | Detail | Usage |
|---|---|---|
interaction-clicked |
doc_dir_entry |
User clicked on an entry. |
interaction-selected |
map( key -> record ) |
User selected an entry. |
user-saves-selection |
map( key -> record ) |
User confirmed submitting all selected records. |
Methods
| Method | Arguments | Usage |
|---|---|---|
| (None.) |
Slots
| Slot | Usage |
|---|---|
header |
Content prior to directory entries (used internally for filter). |
footer |
Content after directory entries (used internally for counts). |
CSS Parts
| Part | Usage |
|---|---|
| (None.) |
Example
<link rel="stylesheet" type="text/css" href="/css/sk-root.css">
<script type=module src='/cdn/@encipher-sk/ivcore/esm/auto.js'></script>
<div class='example'>
<ivc-i18n></ivc-i18n>
<ivc-zs reload-ws></ivc-zs>
<ws-user-dir ui=condensed></ws-user-dir>
</div>