Access Record Directory

Typical tag name: ar-dir

Exported class: ARDirectory

Inheritance: ARDirectory <-- Directory <-- SKUIBase <-- (imm-dom stack)

Simple Access Record viewer/chooser capable of allowing user to select Access Records with filters. The Access Records which are available are loaded from the directory model. Any Access Records you wish to display but be disabled may be supplied with the preselected property. Submit selection button label may be configured.

Required Assets

External Requirements

WC Dependencies

API

Attributes

Attribute Default Enumerators Usage
ui single single, multi Sets single or multi-select mode. In single-select mode, double click will trigger the submit event.
ar-kind N/A N/A Filters possible Access Records by ar_kind
use-qx dir N/A Changes imm-dom QX key for model.
tag ar-dir-entry if selectable, otherwise ar-dir-entry-static N/A Web component tag for each displayed Access Record.
evt-name-clicked interaction-ar-clicked N/A Event name to emit when an Access Record is clicked.
evt-name-dbl-clicked interaction-ar-dbl-clicked N/A Event name to emit when an Access Record is double clicked (NOTE: Also ensures AR is selected).
evt-name-selected interaction-ar-selected N/A Event name to emit when an Access Record is selected.
evt-name-saved user-ar-save-selection N/A Event name to emit when user chooses to submit selected Access Records.
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.
has-tool-edit false Boolean Pass attribute to instantiation of tag web component (by default shows AREditor in button UI mode).

Properties

Property Type Default Usage
preselected enumerable set Access Records to disable from selection.

Events

Event Detail Usage
interaction-ar-clicked ar_dir_entry User clicked on an entry.
interaction-ar-dbl-clicked ar_dir_entry User double clicked on an entry.
interaction-ar-selected map( ar -> record ) User selected an entry.
user-ar-save-selection map( ar -> record ) User confirmed submitting all selected records.

Methods

Method Arguments Usage
(None.)

Slots

Slot Usage
header Content prior to AR directory entries (used internally for filter).
footer Content after AR 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>
  <ar-dir></ar-dir>
</div>