Přeskočit na obsah

Tato stránka byla automaticky přeložena z angličtiny, jediného jazyka, ve kterém se tento web píše. Číst originál.

HTTP API: design

Jediná deklarace, jak vypadá každý povrch tohoto nástroje — sémantické role, slovník stavů, typografická škála, kontrakt motivů — tak, jak ji nese tento spustitelný soubor: její otisk, tokeny, co znamená kterýkoli z nich a zda jsou barvy, které spárovává, na sobě čitelné. Stylesheety, které načítá web a Cockpit, tokeny, které si kompilují vlastní stránky spustitelného souboru, a dataset, který čtou šablony webu, jsou všechno její projekce; stránka porovná svůj `--mj-design` s tímto otiskem, aby poznala, zda nosí design, se kterým byl tento spustitelný soubor sestaven.

Vykresleno z docs/generated/openapi.json, který spustitelný soubor generuje ze svého registru schopností a CI jej odmítne, je-li zastaralý. Surový dokument je na /openapi.json; běžící server servíruje stejný dokument na vlastní /openapi.json a Swagger UI na /swagger.

design

Jediná deklarace, jak vypadá každý povrch tohoto nástroje — sémantické role, slovník stavů, typografická škála, kontrakt motivů — tak, jak ji nese tento spustitelný soubor: její otisk, tokeny, co znamená kterýkoli z nich a zda jsou barvy, které spárovává, na sobě čitelné. Stylesheety, které načítá web a Cockpit, tokeny, které si kompilují vlastní stránky spustitelného souboru, a dataset, který čtou šablony webu, jsou všechno její projekce; stránka porovná svůj `--mj-design` s tímto otiskem, aby poznala, zda nosí design, se kterým byl tento spustitelný soubor sestaven.

GET /api/v1/design design.system

Designový systém

Čím návrh je: otisk, který nese každý stylopis, identita, sady písem, kontrakt motivu s prohlášením před vykreslením, které spouští každý povrch, šířky auditu, kolik tokenů každého druhu a každý vygenerovaný soubor, do něhož se deklarace promítá.

  • query
  • behaviorally_verified
  • vyžaduje se měření výkonu
  • cache vypnuta
  • Nástroj MCP majordomus_design
  • Zdroj MCP {"name": "design", "uri": "majordomus://design"}

Žádné parametry.

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/design"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

statustělovýznam
200 DesignReport Návrhový systém: výsledek.
400 ErrorBody invalid_input: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404 ErrorBody not_found: Vstup pojmenovává něco, co repozitář nemá.
500 ErrorBody internal: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí ErrorBody Jakékoli jiné selhání, které transport hlásí: 405 method_not_allowed pro jinou metodu na této cestě, 400 invalid_input pro tělo, které není objektem JSON.
GET /api/v1/design/contrast design.contrast

Zda lze deklarované barvy přečíst

Každé popředí, které design klade na pozadí, v obou motivech, změřené proti WCAG 2.1 AA: dvojice, položky palety za ní, poměr a práh. Dvojice nejsou seznam — odvozují se z deklarace, která řadí text každého stavu na jeho vlastní pozadí, a z primitiv, které ji využívají, kde pravidlo nastavující barvu a pozadí vyjadřuje dvojici a pravidlo nastavující jen barvu vyjadřuje popředí, které dopadne na každé pozadí, jež kontejner nastaví. Dvojice pod prahem je zjištění, které pojmenovává roli, pozadí, motiv, naměřený poměr a požadovaný.

  • query
  • behaviorally_verified
  • vyžaduje se měření výkonu
  • cache vypnuta
  • Nástroj MCP majordomus_design_contrast

Žádné parametry.

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/design/contrast"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

statustělovýznam
200 ContrastReport Zda lze deklarované barvy přečíst: výsledek.
400 ErrorBody invalid_input: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404 ErrorBody not_found: Vstup pojmenovává něco, co repozitář nemá.
500 ErrorBody internal: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí ErrorBody Jakékoli jiné selhání, které transport hlásí: 405 method_not_allowed pro jinou metodu na této cestě, 400 invalid_input pro tělo, které není objektem JSON.
GET /api/v1/design/explain design.explain

Co znamená návrhový token

Jeden token jménem nebo podle vlastní vlastnosti, kterou se stává: k čemu slouží, na co se rozliší v každém motivu, které názvy Flowbite jsou jeho synonyma, která slova stavů barví a do kterých vygenerovaných souborů proniká.

  • query
  • behaviorally_verified
  • vyžaduje se měření výkonu
  • cache vypnuta
  • Nástroj MCP majordomus_design_explain

Parametry dotazu

názevtyppovinnépopispříklady
token string ano Role (`fg`), stav (`ok`), slovo stavu (`succeeded`), typografický stupeň (`meta`), položka palety (`gray-600`) nebo vlastní vlastnost, kterou se kterákoli z nich stane (`--mj-fg`). role: "fg"state: "succeeded"

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/design/explain?token=fg"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

statustělovýznam
200 Token Co znamená designový token: výsledek.
400 ErrorBody invalid_input: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404 ErrorBody not_found: Vstup pojmenovává něco, co repozitář nemá.
500 ErrorBody internal: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí ErrorBody Jakékoli jiné selhání, které transport hlásí: 405 method_not_allowed pro jinou metodu na této cestě, 400 invalid_input pro tělo, které není objektem JSON.
GET /api/v1/design/tokens design.tokens

Designové tokeny

Každý token návrhu vysvětlený: role s jejich světlými a tmavými hodnotami, stavy s jejich textem, pozadím a ohraničením a slovy stavů zařazenými pod ně, typografická škála, hodnoty rozvržení, kontrakt motivu, paleta. Zúžit lze na jeden druh.

  • query
  • behaviorally_verified
  • vyžaduje se měření výkonu
  • cache vypnuta
  • MCP nástroj majordomus_design_tokens

Parametry dotazu

názevtyppovinnépopispříklady
druh TokenKind | null ne Jen tokeny tohoto druhu. roles: "role"

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/design/tokens?kind=role"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

statustělovýznam
200 TokenList Návrhové tokeny: výsledek.
400 ErrorBody invalid_input: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404 ErrorBody not_found: Vstup pojmenovává něco, co repozitář nemá.
500 ErrorBody internal: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí ErrorBody Jakékoli jiné selhání, které transport hlásí: 405 method_not_allowed pro jinou metodu na této cestě, 400 invalid_input pro tělo, které není objektem JSON.

Schémata

Komponenty, které používají jen operace tohoto tagu. Každý řádek je pole daného typu, jeho doc komentář je popis; typ vlastněný jinou stránkou na ni odkazuje.

Nese

"text" | "non_text"
Co barva dělá tam, kde byla nalezena.
  • textText: držen na MINIMUM_TEXT.
  • non_textOhraničení nebo obrys: měří se vůči MINIMUM_NON_TEXT, hlásí se, nevynucuje se.

Používá Measured

ColourPart

object
Jedna část barevného tokenu — role má jednu, stav má text, pozadí a ohraničení.
vlastnosttyppovinnépopis
část string ano fg, bg nebo line.
css string ano Vlastní vlastnost, kterou povrch čte.
světlý Vyřešeno → Resolved ano Ve světlém tématu.
tmavý Vyřešeno → Resolved ano V tmavém tématu.

Používá Token

ContrastReport

object
Každá dvojice, kterou deklarace a její spotřebitelé uvádějí, změřená.
vlastnosttyppovinnépopis
otisk string ano Otisk měřené deklarace.
standard string ano Standard, z něhož prahy pocházejí.
minimum_text číslo (double) ano Poměr požadovaný od textu.
minimum_non_text číslo (double) ano Poměr požadovaný od netextového prvku, který nese význam.
zdroje pole Source → Source ano Přečtené stylesheety a zda byl každý nalezen.
naměřeno integer (uint) ano Kolik dvojic bylo odvozeno a změřeno.
dvojice pole Measured → Measured ano Každý pár ve stabilním pořadí: téma, pak co nese, pak oba tokeny.
složeno integer (uint) ano Deklarace přeskočené, protože jejich hodnota se skládá za běhu.
zjištění array of string ano Jeden řádek na každou vynucovanou dvojici, která nedosahuje, s názvem role, podkladu, motivu, naměřeného poměru a požadovaného poměru.
čitelné boolean ano Zda každá vynucená dvojice dosahuje svého prahu.

Používá design.contrast

DesignReport

object
Design systém: co to je a kam patří.
vlastnosttyppovinnépopis
otisk string ano SHA-256 kanonické podoby deklarace.
design string ano Prvních dvanáct číslic, tak jak je nese každý stylesheet v --mj-design.
schema integer (uint64) ano Verze formátu deklarace.
zdroj string ano Kde deklarace žije, relativně k repozitáři.
identity Identity → Identity ano Kdo to je.
písmo Fonts → Fonts ano Dva typové stacky.
téma ThemeView → ThemeView ano Smlouva motivu.
viewporty pole integer (uint32) ano Šířky, ve kterých audit v prohlížeči měří každou stránku.
součty TokenTallies → TokenTallies ano Kolik tokenů každého druhu.
projections pole ProjectionView → ProjectionView ano Každý generovaný soubor, do kterého se deklarace promítá.

Používá design.system

Fonty

object
Dva typové stacky.
vlastnosttyppovinnépopis
sans string ano Systémový stack.
mono string ano Neproporcionální stack.

Používá DesignReport

Identita

object
Kdo to je.
vlastnosttyppovinnépopis
název string ano Název produktu, který ukazuje každý povrch.
značka string ano Značka, relativně k adresáři designu.
logo string ano Plné logo, relativně k adresáři designu.
sociální string ano Náhledový obrázek pro sociální sítě, relativně k adresáři designu.

Používá DesignReport

Změřeno

object
Jedna změřená dvojice: popředí na pozadí, v jednom motivu.
vlastnosttyppovinnépopis
popředí string ano Token popředí, jak jej jmenuje deklarace (muted, ok).
foreground_entry string ano Položka palety, na kterou se v tomto motivu rozřeší.
foreground_value string ano Literál, který tato položka drží.
základ string ano Základní token.
ground_entry string ano Položka palety, na kterou se pozadí v tomto tématu rozřeší.
ground_value string ano Literál, který tato položka drží.
téma string ano light nebo dark.
nese Nese → Carries ano Text nebo ohraničení.
poměr číslo (double) ano Naměřený poměr na dvě desetinná místa.
povinné číslo (double) ano Co standard od tohoto páru žádá.
průchody boolean ano Zda na něj dosáhne.
vynuceno boolean ano Zda je nedostatek zjištěním. Nepravda u hranice; viz dokumentace modulu.
viděno string ano Kde byla dvojice přečtena: stylesheet a selektor, který ji uvádí.

Používá ContrastReport

ProjectionView

object
Jedna generovaná projekce návrhu a k čemu slouží.
vlastnosttyppovinnépopis
path string ano Cesta relativní k repozitáři.
read_by string ano Co to čte.

Používá DesignReport

Vyřešeno

object
Na co se odkaz na barvu vyřešil.
vlastnosttyppovinnépopis
reference string ano Položka palety nebo role, kterou deklarace jmenovala.
css string ano Hodnota CSS, kterou stylesheet dostane: literál položky palety, nebo var(--mj-<role>).
literál string ano Dodržuje se literál za každým odkazem.

Používá ColourPart

Zdroj

object
Jeden stylesheet, z něhož byla odvozena množina dvojic.
vlastnosttyppovinnépopis
path string ano Odkud bylo čteno, tak jak to volající pojmenoval.
rules integer (uint) ano Kolik jeho pravidel uvádí barvu.

Používá ContrastReport

ThemeView

object
Kontrakt motivu tak, jak ho čte klient.
vlastnosttyppovinnépopis
třída string ano Třída na kořenovém elementu, která znamená tmavý režim.
storage_key string ano Klíč localStorage, pod kterým se uchovává volba osoby.
bootstrap string ano Jediný příkaz před vykreslením, který spouští každý povrch.

Používá DesignReport

Token

object
Jeden token, vysvětlený: odkud pochází, na co se rozřeší, co jej čte.
vlastnosttyppovinnépopis
název string ano Název tak, jak je deklarován.
druh TokenKind → TokenKind ano Jaký druh tokenu.
about string ano K čemu slouží, podle deklarace.
css array of string ano Vlastní vlastnosti (custom properties) a utility Tailwindu, ve které se mění.
části pole ColourPart → ColourPart ne U barevného tokenu: jeho části, každá vyřešená pro motiv.
hodnota string | null ne Pro skalární token: hodnota.
role string | null ne U stavového slova: stav, pod nímž je vedeno.
stavy array of string ne U stavu: stavová slova vedená pod ním.
aliasy array of string ne Názvy z Flowbite, které jsou jeho synonyma.
projections array of string ano Generované soubory, kterých se token dotýká.

Používá design.explain TokenList

TokenKind

"font" | "palette" | "role" | "status" | "state" | "tone" | "type" | "tracking" | "layout" | "radius" | "motion" | "theme"
Jakého druhu věcí je token.
  • fontZásobník typů.
  • paletteSurová položka palety.
  • roleSémantická role povrchu.
  • statusVýznam stavu.
  • stateStavové slovo, zařazené pod stav.
  • toneTón: odstín pro identitu, nikdy pro význam.
  • typeStupeň typografické škály.
  • trackingProstrkání písma (letter-spacing).
  • layoutSdílená hodnota rozložení.
  • radiusPoloměr rohu.
  • motionDoba trvání.
  • themeSmlouva motivu.

Používá design.tokens Token

TokenList

object
Tokeny, vypsané.
vlastnosttyppovinnépopis
otisk string ano Otisk deklarace, z níž pocházejí.
celkem integer (uint) ano Kolik jich je vypsáno.
tokeny pole Token → Token ano Tokeny v pořadí inventáře.

Používá design.tokens

TokenTallies

object
Kolik tokenů každého druhu.
vlastnosttyppovinnépopis
paleta integer (uint) ano Surové položky palety.
role integer (uint) ano Sémantické role.
stavy integer (uint) ano Významy stavů.
stavy integer (uint) ano Slova stavů zařazená pod stav.
type_steps integer (uint) ano Kroky typografické škály.
aliasy integer (uint) ano Názvy Flowbite deklarované jako synonyma.

Používá DesignReport

Prohledává názvy a popisy všech stránek, které tento web publikuje.