Skip to content

Permission matrix

Who can do what, with agents against permissions as a table, as cards, or by permission.

<section class="cap-panel" aria-labelledby="p-wide">
  <header class="cap-panel-head"><h3 id="p-wide">Who can do what</h3><span class="cap-panel-src">4 agents, 5 permissions</span></header>
  <div class="cap-panel-body">
    <div class="cap-perms" data-cap="permission-matrix" id="perms-wide">
      <div class="cap-perms-bar">
        <fieldset class="cap-seg">
          <legend class="cap-sr-only">View</legend>
          <div class="cap-seg-options">
            <label><input type="radio" name="perms-view-wide" value="agent" checked />By agent</label>
            <label><input type="radio" name="perms-view-wide" value="permission" />By permission</label>
          </div>
        </fieldset>
        <p class="cap-perms-note">A filled box holds the permission; an empty box does not.</p>
      </div>
      <div class="cap-perms-view" data-view="agent">
        <div class="cap-perms-wide">
          <div class="cap-table-wrap" role="region" aria-label="Permissions by agent" tabindex="0">
            <table class="cap-table">
              <thead>
                <tr><th scope="col">Agent</th><th scope="col" class="cap-perms-col">Merge</th><th scope="col" class="cap-perms-col">Write to main</th><th scope="col" class="cap-perms-col">Start CI</th><th scope="col" class="cap-perms-col">Edit workflows</th><th scope="col" class="cap-perms-col">Money paths</th></tr>
              </thead>
              <tbody>
                <tr>
                  <th scope="row" class="cap-perms-agent cap-mono">seat</th>
                  <td class="cap-perms-cell" data-held="yes"><span class="cap-perms-check" aria-hidden="true"><svg viewBox="0 0 16 16" focusable="false"><path fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="m3.5 8.5 3 3 6-7" /></svg></span><span class="cap-sr-only">Yes</span></td>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                  <td class="cap-perms-cell" data-held="yes"><span class="cap-perms-check" aria-hidden="true"><svg viewBox="0 0 16 16" focusable="false"><path fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="m3.5 8.5 3 3 6-7" /></svg></span><span class="cap-sr-only">Yes</span></td>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                </tr>
                <tr>
                  <th scope="row" class="cap-perms-agent cap-mono">capsid-driver</th>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                  <td class="cap-perms-cell" data-held="yes"><span class="cap-perms-check" aria-hidden="true"><svg viewBox="0 0 16 16" focusable="false"><path fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="m3.5 8.5 3 3 6-7" /></svg></span><span class="cap-sr-only">Yes</span></td>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                </tr>
                <tr>
                  <th scope="row" class="cap-perms-agent cap-mono">capsomer-driver</th>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                </tr>
                <tr>
                  <th scope="row" class="cap-perms-agent cap-mono">billing-driver</th>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                  <td class="cap-perms-cell" data-held="yes"><span class="cap-perms-check" aria-hidden="true"><svg viewBox="0 0 16 16" focusable="false"><path fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="m3.5 8.5 3 3 6-7" /></svg></span><span class="cap-sr-only">Yes</span></td>
                  <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
                  <td class="cap-perms-cell" data-held="yes"><span class="cap-perms-check" aria-hidden="true"><svg viewBox="0 0 16 16" focusable="false"><path fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="m3.5 8.5 3 3 6-7" /></svg></span><span class="cap-sr-only">Yes</span></td>
                </tr>
              </tbody>
            </table>
          </div>
        </div>
        <div class="cap-perms-narrow">
          <ul class="cap-perms-cards" aria-label="Permissions by agent">
            <li class="cap-perms-card"><span class="cap-perms-name cap-mono">seat</span><div class="cap-perms-holds"><span class="cap-perms-key">Holds:</span> Merge, Start CI</div></li>
            <li class="cap-perms-card"><span class="cap-perms-name cap-mono">capsid-driver</span><div class="cap-perms-holds"><span class="cap-perms-key">Holds:</span> Start CI</div></li>
            <li class="cap-perms-card"><span class="cap-perms-name cap-mono">capsomer-driver</span><div class="cap-perms-holds" data-empty="">Holds no permissions</div></li>
            <li class="cap-perms-card"><span class="cap-perms-name cap-mono">billing-driver</span><div class="cap-perms-holds"><span class="cap-perms-key">Holds:</span> Start CI, Money paths</div></li>
          </ul>
        </div>
      </div>
      <div class="cap-perms-view" data-view="permission" hidden>
        <ul class="cap-perms-cards" aria-label="Agents by permission">
          <li class="cap-perms-card"><span class="cap-perms-name">Merge</span><div class="cap-perms-holds"><span class="cap-perms-key">Held by:</span> <span class="cap-mono">seat</span></div></li>
          <li class="cap-perms-card"><span class="cap-perms-name">Write to main</span><div class="cap-perms-holds" data-empty="">Nobody holds this</div></li>
          <li class="cap-perms-card"><span class="cap-perms-name">Start CI</span><div class="cap-perms-holds"><span class="cap-perms-key">Held by:</span> <span class="cap-mono">seat</span>, <span class="cap-mono">capsid-driver</span>, <span class="cap-mono">billing-driver</span></div></li>
          <li class="cap-perms-card"><span class="cap-perms-name">Edit workflows</span><div class="cap-perms-holds" data-empty="">Nobody holds this</div></li>
          <li class="cap-perms-card"><span class="cap-perms-name">Money paths</span><div class="cap-perms-holds"><span class="cap-perms-key">Held by:</span> <span class="cap-mono">billing-driver</span></div></li>
        </ul>
      </div>
    </div>
  </div>
</section>

Installation

// package.json: "capsomer": "github:DrDustinEdwards/capsomer#v0.152.2"
import "capsomer/tokens.css";
import "capsomer/base.css";
import "capsomer/permission-matrix.css";
import { enhance } from "capsomer/behavior/permission-matrix";

enhance();

Usage

<div class="cap-perms" data-cap="permission-matrix">
  <div class="cap-perms-bar">
    <fieldset class="cap-seg">
      <legend class="cap-sr-only">View</legend>
      <div class="cap-seg-options">
        <label><input type="radio" name="perms-view" value="agent" checked>By agent</label>
        <label><input type="radio" name="perms-view" value="permission">By permission</label>
      </div>
    </fieldset>
    <p class="cap-perms-note">A filled box holds the permission; an empty box does not.</p>
  </div>
  <div class="cap-perms-view" data-view="agent">
    <div class="cap-perms-wide">
      <div class="cap-table-wrap" role="region" aria-label="Permissions by agent" tabindex="0">
        <table class="cap-table">
          <thead><tr><th scope="col">Agent</th><th scope="col" class="cap-perms-col">Merge</th>...</tr></thead>
          <tbody>
            <tr>
              <th scope="row" class="cap-perms-agent cap-mono">seat</th>
              <td class="cap-perms-cell" data-held="yes">[checked box]<span class="cap-sr-only">Yes</span></td>
              <td class="cap-perms-cell" data-held="no">[empty box]<span class="cap-sr-only">No</span></td>
            </tr>
          </tbody>
        </table>
      </div>
    </div>
    <div class="cap-perms-narrow">
      <ul class="cap-perms-cards" aria-label="Permissions by agent">
        <li class="cap-perms-card"><span class="cap-perms-name cap-mono">seat</span><div class="cap-perms-holds"><span class="cap-perms-key">Holds:</span> Merge, Start CI</div></li>
        <li class="cap-perms-card"><span class="cap-perms-name cap-mono">capsomer-driver</span><div class="cap-perms-holds" data-empty>Holds no permissions</div></li>
      </ul>
    </div>
  </div>
  <div class="cap-perms-view" data-view="permission" hidden>
    <ul class="cap-perms-cards" aria-label="Agents by permission">
      <li class="cap-perms-card"><span class="cap-perms-name">Start CI</span><div class="cap-perms-holds"><span class="cap-perms-key">Held by:</span> <span class="cap-mono">seat</span>, <span class="cap-mono">billing-driver</span></div></li>
      <li class="cap-perms-card"><span class="cap-perms-name">Write to main</span><div class="cap-perms-holds" data-empty>Nobody holds this</div></li>
    </ul>
  </div>
</div>

Examples

By permission

<div class="cap-perms" data-cap="permission-matrix" id="perms-by-permission">
  <div class="cap-perms-bar">
    <fieldset class="cap-seg">
      <legend class="cap-sr-only">View</legend>
      <div class="cap-seg-options">
        <label><input type="radio" name="perms-view-perm" value="agent" />By agent</label>
        <label><input type="radio" name="perms-view-perm" value="permission" checked />By permission</label>
      </div>
    </fieldset>
  </div>
  <div class="cap-perms-view" data-view="agent" hidden>
    <div class="cap-perms-wide">
      <div class="cap-table-wrap" role="region" aria-label="Permissions by agent, second sample" tabindex="0">
        <table class="cap-table">
          <thead>
            <tr><th scope="col">Agent</th><th scope="col" class="cap-perms-col">Merge</th><th scope="col" class="cap-perms-col">Start CI</th></tr>
          </thead>
          <tbody>
            <tr>
              <th scope="row" class="cap-perms-agent cap-mono">seat</th>
              <td class="cap-perms-cell" data-held="yes"><span class="cap-perms-check" aria-hidden="true"><svg viewBox="0 0 16 16" focusable="false"><path fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="m3.5 8.5 3 3 6-7" /></svg></span><span class="cap-sr-only">Yes</span></td>
              <td class="cap-perms-cell" data-held="yes"><span class="cap-perms-check" aria-hidden="true"><svg viewBox="0 0 16 16" focusable="false"><path fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="m3.5 8.5 3 3 6-7" /></svg></span><span class="cap-sr-only">Yes</span></td>
            </tr>
            <tr>
              <th scope="row" class="cap-perms-agent cap-mono">docs-reviewer</th>
              <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
              <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
            </tr>
          </tbody>
        </table>
      </div>
    </div>
    <div class="cap-perms-narrow">
      <ul class="cap-perms-cards" aria-label="Permissions by agent, second sample">
        <li class="cap-perms-card"><span class="cap-perms-name cap-mono">seat</span><div class="cap-perms-holds"><span class="cap-perms-key">Holds:</span> Merge, Start CI</div></li>
        <li class="cap-perms-card"><span class="cap-perms-name cap-mono">docs-reviewer</span><div class="cap-perms-holds" data-empty="">Holds no permissions</div></li>
      </ul>
    </div>
  </div>
  <div class="cap-perms-view" data-view="permission">
    <ul class="cap-perms-cards" aria-label="Agents by permission, second sample">
      <li class="cap-perms-card"><span class="cap-perms-name">Merge</span><div class="cap-perms-holds"><span class="cap-perms-key">Held by:</span> <span class="cap-mono">seat</span></div></li>
      <li class="cap-perms-card"><span class="cap-perms-name">Start CI</span><div class="cap-perms-holds"><span class="cap-perms-key">Held by:</span> <span class="cap-mono">seat</span></div></li>
      <li class="cap-perms-card"><span class="cap-perms-name">Write to main</span><div class="cap-perms-holds" data-empty="">Nobody holds this</div></li>
    </ul>
  </div>
</div>

Comfortable density

<div class="cap-perms" data-cap="permission-matrix" data-density="comfortable" id="perms-comfy">
  <div class="cap-perms-bar">
    <fieldset class="cap-seg">
      <legend class="cap-sr-only">View</legend>
      <div class="cap-seg-options">
        <label><input type="radio" name="perms-view-comfy" value="agent" checked />By agent</label>
        <label><input type="radio" name="perms-view-comfy" value="permission" />By permission</label>
      </div>
    </fieldset>
  </div>
  <div class="cap-perms-view" data-view="agent">
    <div class="cap-perms-wide">
      <div class="cap-table-wrap" role="region" aria-label="Permissions by agent, comfortable" tabindex="0">
        <table class="cap-table">
          <thead>
            <tr><th scope="col">Agent</th><th scope="col" class="cap-perms-col">Merge</th><th scope="col" class="cap-perms-col">Start CI</th></tr>
          </thead>
          <tbody>
            <tr>
              <th scope="row" class="cap-perms-agent cap-mono">seat</th>
              <td class="cap-perms-cell" data-held="yes"><span class="cap-perms-check" aria-hidden="true"><svg viewBox="0 0 16 16" focusable="false"><path fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="m3.5 8.5 3 3 6-7" /></svg></span><span class="cap-sr-only">Yes</span></td>
              <td class="cap-perms-cell" data-held="no"><span class="cap-perms-check" aria-hidden="true"></span><span class="cap-sr-only">No</span></td>
            </tr>
          </tbody>
        </table>
      </div>
    </div>
    <div class="cap-perms-narrow">
      <ul class="cap-perms-cards" aria-label="Permissions by agent, comfortable">
        <li class="cap-perms-card"><span class="cap-perms-name cap-mono">seat</span><div class="cap-perms-holds"><span class="cap-perms-key">Holds:</span> Merge</div></li>
      </ul>
    </div>
  </div>
  <div class="cap-perms-view" data-view="permission" hidden>
    <ul class="cap-perms-cards" aria-label="Agents by permission, comfortable">
      <li class="cap-perms-card"><span class="cap-perms-name">Merge</span><div class="cap-perms-holds"><span class="cap-perms-key">Held by:</span> <span class="cap-mono">seat</span></div></li>
    </ul>
  </div>
</div>

By agent, narrow (390 px)

<main class="specimen-page">
  <section class="cap-panel" aria-labelledby="p-narrow">
    <header class="cap-panel-head"><h1 id="p-narrow">Who can do what</h1><span class="cap-panel-src">4 agents, 5 permissions</span></header>
    <div class="cap-panel-body">
      <div class="cap-perms" data-cap="permission-matrix" id="perms-narrow">
        <div class="cap-perms-bar">
          <fieldset class="cap-seg">
            <legend class="cap-sr-only">View</legend>
            <div class="cap-seg-options">
              <label><input type="radio" name="perms-view-narrow" value="agent" checked />By agent</label>
              <label><input type="radio" name="perms-view-narrow" value="permission" />By permission</label>
            </div>
          </fieldset>
        </div>
        <div class="cap-perms-view" data-view="agent">
          <div class="cap-perms-wide">
            <div class="cap-table-wrap" role="region" aria-label="Permissions by agent" tabindex="0">
              <table class="cap-table">
                <thead>
                  <tr><th scope="col">Agent</th><th scope="col" class="cap-perms-col">Merge</th><th scope="col" class="cap-perms-col">Start CI</th><th scope="col" class="cap-perms-col">Money paths</th></tr>
                </thead>
                <tbody>
                  <tr><th scope="row" class="cap-perms-agent cap-mono">seat</th><td class="cap-perms-cell" data-held="yes"><span class="cap-sr-only">Yes</span></td><td class="cap-perms-cell" data-held="yes"><span class="cap-sr-only">Yes</span></td><td class="cap-perms-cell" data-held="no"><span class="cap-sr-only">No</span></td></tr>
                </tbody>
              </table>
            </div>
          </div>
          <div class="cap-perms-narrow">
            <ul class="cap-perms-cards" aria-label="Permissions by agent">
              <li class="cap-perms-card"><span class="cap-perms-name cap-mono">seat</span><div class="cap-perms-holds"><span class="cap-perms-key">Holds:</span> Merge, Start CI</div></li>
              <li class="cap-perms-card"><span class="cap-perms-name cap-mono">capsid-driver</span><div class="cap-perms-holds"><span class="cap-perms-key">Holds:</span> Start CI</div></li>
              <li class="cap-perms-card"><span class="cap-perms-name cap-mono">capsomer-driver</span><div class="cap-perms-holds" data-empty="">Holds no permissions</div></li>
              <li class="cap-perms-card"><span class="cap-perms-name cap-mono">billing-driver</span><div class="cap-perms-holds"><span class="cap-perms-key">Holds:</span> Start CI, Money paths</div></li>
            </ul>
          </div>
        </div>
        <div class="cap-perms-view" data-view="permission" hidden>
          <ul class="cap-perms-cards" aria-label="Agents by permission">
            <li class="cap-perms-card"><span class="cap-perms-name">Merge</span><div class="cap-perms-holds"><span class="cap-perms-key">Held by:</span> <span class="cap-mono">seat</span></div></li>
            <li class="cap-perms-card"><span class="cap-perms-name">Start CI</span><div class="cap-perms-holds"><span class="cap-perms-key">Held by:</span> <span class="cap-mono">seat</span>, <span class="cap-mono">capsid-driver</span>, <span class="cap-mono">billing-driver</span></div></li>
            <li class="cap-perms-card"><span class="cap-perms-name">Money paths</span><div class="cap-perms-holds"><span class="cap-perms-key">Held by:</span> <span class="cap-mono">billing-driver</span></div></li>
          </ul>
        </div>
      </div>
    </div>
  </section>
</main>

API reference

PermissionMatrix

PropTypeRequiredDoes
matrixPermMatrixYes
labelstringThe table region's name and the agent cards' list name.
defaultViewPermView
viewPermViewControlled view, for an app that keeps it in the address.
onViewChange(view: PermView) => void
notestring

Functions

FunctionSignatureDoes
holdings(m: PermMatrix): Holding[]One entry per agent: what it holds, in column order, and the card's sentence.
holders(m: PermMatrix): Holders[]One entry per permission: who holds it, in row order, and the card's sentence.
showView(root: HTMLElement, view: PermView): voidShows one view of one matrix and hides the other with the hidden attribute, so the hidden view leaves the accessibility tree too.
enhance(root?: ParentNode): () => voidAttaches to every [data-cap="permission-matrix"] under root that is not attached yet. Returns a function that detaches them all.

Parts and data attributes

ClassIs
.cap-permsthe root
.cap-perms-agenta part
.cap-perms-bara part
.cap-perms-carda part
.cap-perms-cardsa part
.cap-perms-cella part
.cap-perms-checka part
.cap-perms-cola part
.cap-perms-holdsa part
.cap-perms-keya part
.cap-perms-namea part
.cap-perms-narrowa part
.cap-perms-notea part
.cap-perms-widea part
AttributeValues
data-emptypresent or absent
data-heldyes

Accessibility

KeyDoes
TabReaches the view switch (the chosen view), then the table's scroll region
Arrow keys on the switchMove between By agent and By permission, and show that view
  • The view switch is a fieldset of native radios named "View"; arrow keys are the browser's own.
  • Each cell's word ("Yes", "No") is in the accessibility tree; the glyph is hidden from it.
  • Row headers (th scope="row") name the agent, column headers the permission, so a screen reader reads "billing-driver, Money paths, Yes".
  • The filled box and the empty box's edge reach 3:1 as graphics; every word reaches 4.5:1 in both themes.
  • Forced colors: the boxes are drawn in CanvasText (filled when held); card edges become CanvasText.