Skip to content

Config form

An operator's add and edit form for a list of settings, with the editor state that opens it.

<div id="cf-editor" data-mount="editor"></div>

Installation

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

Usage

import { ConfigForm, useConfigForm, useEditor } from "capsomer/react/config-form";

const ed = useEditor<SiteRow>(() => read());
<button className="cap-btn" data-variant="primary" onClick={ed.add} disabled={ed.editing?.kind === "add"}>Add site</button>
{ed.editing && <SiteForm key={ed.formKey} editing={ed.editing} onClose={ed.close} />}
// a row: onEdit={() => ed.edit(row, row.namespace)}

function SiteForm({ editing, onClose }) {
  const { f, first } = useConfigForm();
  return (
    <ConfigForm f={f} first={first} title="Add a site" hint={hint} onSubmit={preview} onClose={onClose} danger={...}>
      <Field label="Name"><input className="cap-input" id={f("name")} ref={first} ... /></Field>
    </ConfigForm>
  );
}

API reference

ConfigForm

PropTypeRequiredDoes
f(k: string) => stringYes
firstRefObject<HTMLInputElement | null>Yes
titlestringYes
srcReactNodeWhere the setting lives: "Saved in D1".
hintstring | nullYesWhy the draft cannot be sent yet ("A name is needed"), shown above the buttons and announced.
onSubmit() => voidYes
onClose() => voidYes
submitLabelstringThe submit's words. "Preview" by default: it opens a confirm that shows what will change, and changes nothing itself.
dangerReactNodeA Danger area under the buttons (Remove this site), apart from the form's own actions.
childrenReactNodeYes

CSS variables

VariableDefault
--fields-gapvar(--gap) var(--space-6)

Parts and data attributes

ClassIs
.cap-config-actionsits own class
.cap-config-dangerits own class
.cap-config-formthe root
.cap-config-fullits own class

Accessibility

The panel is a named region (its heading). Fields are Capsomer Fields, labeled and described. The hint is announced when it appears.