Skip to content

Mode banner

The band atop an app's content while it shows demo data or an admin views an account read-only.

<div id="mb-demo">
  <div class="cap-mode-banner" data-mode="demo" role="status">
    <p class="cap-mode-banner-text"><strong>Demo with sample data.</strong> This is how the dashboard looks once you connect. The numbers are made up, and nothing you do here is saved.</p>
    <div class="cap-mode-banner-actions"><a class="cap-btn" data-variant="primary" data-size="sm" href="#signup">Connect</a><a class="cap-btn" data-size="sm" href="#exit">Exit demo</a></div>
  </div>
</div>

Installation

// package.json: "capsomer": "github:DrDustinEdwards/capsomer#v0.152.2"
import "capsomer/tokens.css";
import "capsomer/base.css";
import "capsomer/mode-banner.css";

Usage

import { ModeBanner } from "capsomer/react/mode-banner";
import "capsomer/mode-banner.css";
<ModeBanner mode="demo" actions={<a className="cap-btn" data-size="sm" href="/demo/exit">Exit demo</a>} />
<ModeBanner mode="view-as" who="Acme Supply Co." stopHref="/admin" />

Examples

Viewing as a customer

<div id="mb-view">
  <div class="cap-mode-banner" data-mode="view-as" role="status">
    <p class="cap-mode-banner-text">Viewing as <strong>Acme Supply Co.</strong>, read-only.</p>
    <div class="cap-mode-banner-actions"><a class="cap-btn" data-size="sm" href="#admin">Stop viewing</a></div>
  </div>
</div>

API reference

ModeBanner

PropTypeRequiredDoes
mode"demo"Yes

CSS variables

VariableDefault
--tonevar(--info)
--tone-softvar(--info-soft)

Parts and data attributes

ClassIs
.cap-mode-bannerthe root
.cap-mode-banner-actionsa part
.cap-mode-banner-texta part
AttributeValues
data-modeview-as

Accessibility

KeyDoes
TabReaches the band's links

A polite status, so it is announced once when it appears, never interrupting. Words reach 4.5:1 on the tint.