components/copy-field

Import

Import

import * as api from "@fungi.computer/caps/components/copy-field";

Exports

Kind	Export	Description
Ttype alias	CopyFieldTokenKind	The colour role of one run of text in a block’s code.
Ttype alias	CopyFieldToken	One run of a block’s code; the runs, joined, are the copied value.
Ttype alias	CopyFieldProps	Props accepted by CopyField.
fnfunction	CopyField()	A value with an explicit copy action and visible outcome: wrapped code by default, a labelled read-only input when fieldLabel is given, or a titled code panel with layout="block".

CopyFieldTokenKindTtype alias

Signature

type CopyFieldTokenKind = "text" | "tag" | "attribute" | "string";

The colour role of one run of text in a block’s code.

---

CopyFieldTokenTtype alias

Signature

type CopyFieldToken = object;

One run of a block’s code; the runs, joined, are the copied value.

Properties

kind

Signature

kind: CopyFieldTokenKind;

text

Signature

text: string;

---

CopyFieldPropsTtype alias

Signature

type CopyFieldProps = object &
  | {
  value: string;
  fieldLabel?: undefined;
  displayValue?: undefined;
  layout?: "inline";
  title?: undefined;
  tokens?: undefined;
}
  | {
  value: string;
  fieldLabel: string;
  displayValue?: string;
  layout?: "inline";
  title?: undefined;
  tokens?: undefined;
}
  | object &
  | {
  value: string;
  tokens?: undefined;
}
  | {
  tokens: readonly CopyFieldToken[];
  value?: undefined;
} & Omit<HTMLAttributes<HTMLElement>, "children" | "title">;

Props accepted by CopyField.

Type Declaration

Name	Type	Description
label?	string	Copy action text; the code presentations default to “Copy”.

CopyField()fnfunction

Signature

function CopyField(__namedParameters): Element;

A value with an explicit copy action and visible outcome: wrapped code by default, a labelled read-only input when fieldLabel is given, or a titled code panel with layout="block".

Parameters

Parameter	Type
__namedParameters	CopyFieldProps

Returns

Element