Passphrase Gate · Sapphire UI

Examples

Document

JSX usage

Install this example’s dependencies, load the package stylesheet from Setup, and add Example CSS where shown. The snippet includes its local helpers.

bun add @kongmy-dev/sapphire-ui react react-dom

"use client";
import { useId, useState } from "react";
import { Button } from "@kongmy-dev/sapphire-ui/button";
import { PassphraseGate } from "@kongmy-dev/sapphire-ui/passphrase-gate";

function PassphraseDocument() {
  const id = useId();
  const [hidden, setHidden] = useState(false);
  const [error, setError] = useState('');
  return (
    <>
      <PassphraseGate
        isHidden={hidden}
        brandMark="S"
        brandName="Sapphire"
        documentTitle="Cloud migration"
        description="Use the demonstration passphrase: demo."
      >
        <form
          onSubmit={(event) => {
            event.preventDefault();
            const value = new FormData(event.currentTarget).get('passphrase');
            if (value === 'demo') {
              setError('');
              setHidden(true);
            } else setError('Incorrect passphrase. Try demo.');
          }}
        >
          <label className="sp-passphrase-gate-label" htmlFor={id}>
            Passphrase
          </label>
          <div className="sp-passphrase-gate-field">
            <input
              id={id}
              name="passphrase"
              type="password"
              className="sp-passphrase-gate-input"
              aria-invalid={Boolean(error)}
              aria-describedby={error ? `${id}-error` : undefined}
            />
            <button className="sp-passphrase-gate-submit" type="submit">
              Unlock
            </button>
          </div>
          {error && (
            <p
              id={`${id}-error`}
              className="sp-passphrase-gate-error"
              role="alert"
            >
              {error}
            </p>
          )}
        </form>
      </PassphraseGate>
      {hidden && (
        <div>
          <p>Document unlocked.</p>
          <Button onClick={() => setHidden(false)}>Lock document</Button>
        </div>
      )}
    </>
  );
}

export default PassphraseDocument;

Example CSS

Load these demo styles alongside the package stylesheet for the same layout and surfaces.

.docs-main {
  max-width: none;
}

.docs-gate-frame {
  position: relative;
  height: calc(var(--space-1) * 150);
  overflow: hidden;
  contain: layout;
  border-radius: var(--radius-md);
}

.docs-gate-frame--short {
  height: calc(var(--space-1) * 24);
  background: var(--background);
}

.docs-gate-row {
  margin: var(--space-4) 0 0;
}

HTML markup

Initial rendered HTML only. React handlers and portalled content require the JSX example; static HTML does not reproduce those interactions.

Props

Generated from the current public TypeScript signatures, including composed behaviour props. “—” means no default is declared in the local signature; forwarded behaviour defaults are not inferred.

PassphraseGate

PassphraseGate component props
Prop	Type	Required	Local default
`children`	`ReactNode`	Yes	—
`isHidden`	`boolean \| undefined`	No	`false`
`brandMark`	`ReactNode`	No	—
`brandName`	`ReactNode`	No	—
`title`	`ReactNode`	No	`'Protected Document'`
`documentTitle`	`ReactNode`	No	—
`description`	`ReactNode`	No	—

Inherited HTML / React props (278)

PassphraseGate common platform props
Prop	Type	Required	Local default
`style`	`import("react").CSSProperties \| undefined`	No	—
`ref`	`import("react").Ref<HTMLDivElement> \| undefined`	No	—
`defaultValue`	`string \| number \| readonly string[] \| undefined`	No	—
`className`	`string \| undefined`	No	—
`id`	`string \| undefined`	No	—
`tabIndex`	`number \| undefined`	No	—
`role`	`import("react").AriaRole \| undefined`	No	—
`aria-label`	`string \| undefined`	No	—
`onChange`	`import("react").ChangeEventHandler<HTMLDivElement, Element> \| undefined`	No	—

All inherited prop names:

slot style ref key defaultChecked defaultValue suppressContentEditableWarning suppressHydrationWarning accessKey autoCapitalize autoFocus className contentEditable contextMenu dir draggable enterKeyHint hidden id lang nonce spellCheck tabIndex translate radioGroup role about content datatype inlist prefix property rel resource rev typeof vocab autoCorrect autoSave color itemProp itemScope itemType itemID itemRef results security unselectable popover popoverTargetAction popoverTarget inert inputMode is exportparts part aria-activedescendant aria-atomic aria-autocomplete aria-braillelabel aria-brailleroledescription aria-busy aria-checked aria-colcount aria-colindex aria-colindextext aria-colspan aria-controls aria-current aria-describedby aria-description aria-details aria-disabled aria-dropeffect aria-errormessage aria-expanded aria-flowto aria-grabbed aria-haspopup aria-hidden aria-invalid aria-keyshortcuts aria-label aria-labelledby aria-level aria-live aria-modal aria-multiline aria-multiselectable aria-orientation aria-owns aria-placeholder aria-posinset aria-pressed aria-readonly aria-relevant aria-required aria-roledescription aria-rowcount aria-rowindex aria-rowindextext aria-rowspan aria-selected aria-setsize aria-sort aria-valuemax aria-valuemin aria-valuenow aria-valuetext dangerouslySetInnerHTML onCopy onCopyCapture onCut onCutCapture onPaste onPasteCapture onCompositionEnd onCompositionEndCapture onCompositionStart onCompositionStartCapture onCompositionUpdate onCompositionUpdateCapture onFocus onFocusCapture onBlur onBlurCapture onChange onChangeCapture onBeforeInput onBeforeInputCapture onInput onInputCapture onReset onResetCapture onSubmit onSubmitCapture onInvalid onInvalidCapture onLoad onLoadCapture onError onErrorCapture onKeyDown onKeyDownCapture onKeyPress onKeyPressCapture onKeyUp onKeyUpCapture onAbort onAbortCapture onCanPlay onCanPlayCapture onCanPlayThrough onCanPlayThroughCapture onDurationChange onDurationChangeCapture onEmptied onEmptiedCapture onEncrypted onEncryptedCapture onEnded onEndedCapture onLoadedData onLoadedDataCapture onLoadedMetadata onLoadedMetadataCapture onLoadStart onLoadStartCapture onPause onPauseCapture onPlay onPlayCapture onPlaying onPlayingCapture onProgress onProgressCapture onRateChange onRateChangeCapture onSeeked onSeekedCapture onSeeking onSeekingCapture onStalled onStalledCapture onSuspend onSuspendCapture onTimeUpdate onTimeUpdateCapture onVolumeChange onVolumeChangeCapture onWaiting onWaitingCapture onAuxClick onAuxClickCapture onClick onClickCapture onContextMenu onContextMenuCapture onDoubleClick onDoubleClickCapture onDrag onDragCapture onDragEnd onDragEndCapture onDragEnter onDragEnterCapture onDragExit onDragExitCapture onDragLeave onDragLeaveCapture onDragOver onDragOverCapture onDragStart onDragStartCapture onDrop onDropCapture onMouseDown onMouseDownCapture onMouseEnter onMouseLeave onMouseMove onMouseMoveCapture onMouseOut onMouseOutCapture onMouseOver onMouseOverCapture onMouseUp onMouseUpCapture onSelect onSelectCapture onTouchCancel onTouchCancelCapture onTouchEnd onTouchEndCapture onTouchMove onTouchMoveCapture onTouchStart onTouchStartCapture onPointerDown onPointerDownCapture onPointerMove onPointerMoveCapture onPointerUp onPointerUpCapture onPointerCancel onPointerCancelCapture onPointerEnter onPointerLeave onPointerOver onPointerOverCapture onPointerOut onPointerOutCapture onGotPointerCapture onGotPointerCaptureCapture onLostPointerCapture onLostPointerCaptureCapture onScroll onScrollCapture onScrollEnd onScrollEndCapture onWheel onWheelCapture onAnimationStart onAnimationStartCapture onAnimationEnd onAnimationEndCapture onAnimationIteration onAnimationIterationCapture onToggle onBeforeToggle onTransitionCancel onTransitionCancelCapture onTransitionEnd onTransitionEndCapture onTransitionRun onTransitionRunCapture onTransitionStart onTransitionStartCapture

ARIA attributes and native event handlers keep their React types. data-* attributes are also accepted by React.

Setup

bun add @kongmy-dev/sapphire-ui react react-dom

For an app using package components throughout, load the full stylesheet once. Add this component import where you use it.

import "@kongmy-dev/sapphire-ui/sapphire.css";
import { PassphraseGate } from "@kongmy-dev/sapphire-ui/passphrase-gate";

Mixing package and vendored components? Follow application setup.