@gluonjs/core / packages/quarks/src / UiContractEntry

Interface: UiContractEntry

Properties

accessibility

readonly accessibility: string

---

example

readonly example: string

---

extension

readonly extension: string

---

kind

readonly kind: "behavior" | "factory" | "component" | "stylesheet"

---

name

readonly name: string

---

preview?

readonly optional preview?: string

Optional stable Storybook or docs preview id.

---

states?

readonly optional states?: readonly string[]

Public interaction/loading/error states shown by the generated catalog.

---

status

readonly status: "stable"

---

styles?

readonly optional styles?: readonly string[]

Stable component stylesheet ids retained when this entry is rendered.

---

tests

readonly tests: readonly string[]

---

variants?

readonly optional variants?: readonly string[]

Public visual variants shown by the generated component catalog.

Example

Inspect one stable UI export's layer kind, accessibility responsibility, runnable example, and automated evidence:

import { quarkManifest, type UiContractEntry, type UiPackageManifest } from '@gluonjs/quarks';

const manifest: UiPackageManifest = quarkManifest;
const dialog: UiContractEntry | undefined = manifest.entries.find((entry) => entry.name === 'Dialog');
console.log(manifest.package, manifest.layer, dialog?.accessibility, dialog?.tests);