design.explain

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
module design
#design
#ui
#provenance
#introspection

Zpřístupnění

Kde je tato jedna definice dosažitelná. Absence je explicitní: povrch, který není uveden, ji nenese.

povrch	jako
MCP	nástroj majordomus_design_explain
HTTP	GET /api/v1/design/explain operationId design.explain
příkazová řádka	—

Schémata

Kanonický vstup a výstup z typů Rustu; schéma nástroje MCP a parametry a odpovědi OpenAPI se odvozují z nich.

vstup · ExplainTokenInput

Vstup design.explain: jeden token podle jména.

vlastnost	typ	povinné	popis
token	string	ano	Role (`fg`), stav (`ok`), slovo stavu (`succeeded`), krok typografie (`meta`), položka palety (`gray-600`) nebo vlastní vlastnost, kterou se kterákoli z nich stává (`--mj-fg`).

JSON Schema

{
  "additionalProperties": false,
  "description": "The input of `design.explain`: one token by name.",
  "properties": {
    "token": {
      "description": "A role (`fg`), a status (`ok`), a state word (`succeeded`), a type step (`meta`), a\npalette entry (`gray-600`), or the custom property any of them becomes (`--mj-fg`).",
      "type": "string"
    }
  },
  "required": [
    "token"
  ],
  "title": "ExplainTokenInput",
  "type": "object"
}

výstup · Token

Jeden token, vysvětlený: odkud pochází, na co se rozřeší, co jej čte.

vlastnost	typ	povinné	popis
about	string	ano	K čemu slouží, podle deklarace.
aliasy	array	ne	Názvy z Flowbite, které jsou jeho synonyma.
css	array	ano	Vlastní vlastnosti (custom properties) a utility Tailwindu, ve které se mění.
druh	reference	ano	Jaký druh tokenu.
název	string	ano	Název tak, jak je deklarován.
části	array	ne	U barevného tokenu: jeho části, každá vyřešená pro motiv.
projections	array	ano	Generované soubory, kterých se token dotýká.
role	string \| null	ne	U stavového slova: stav, pod nímž je vedeno.
stavy	array	ne	U stavu: stavová slova vedená pod ním.
hodnota	string \| null	ne	Pro skalární token: hodnota.

JSON Schema

{
  "$defs": {
    "ColourPart": {
      "description": "One part of a colour token — a role has one, a status has its text, ground and border.",
      "properties": {
        "css": {
          "description": "The custom property a surface reads.",
          "type": "string"
        },
        "dark": {
          "$ref": "#/$defs/Resolved",
          "description": "In the dark theme."
        },
        "light": {
          "$ref": "#/$defs/Resolved",
          "description": "In the light theme."
        },
        "part": {
          "description": "`fg`, `bg` or `line`.",
          "type": "string"
        }
      },
      "required": [
        "part",
        "css",
        "light",
        "dark"
      ],
      "type": "object"
    },
    "Resolved": {
      "description": "What a colour reference resolved to.",
      "properties": {
        "css": {
          "description": "The CSS value a stylesheet gets: the literal of a palette entry, or `var(--mj-<role>)`.",
          "type": "string"
        },
        "literal": {
          "description": "The literal after every reference is followed.",
          "type": "string"
        },
        "reference": {
          "description": "The palette entry or role the declaration named.",
          "type": "string"
        }
      },
      "required": [
        "reference",
        "css",
        "literal"
      ],
      "type": "object"
    },
    "TokenKind": {
      "description": "What kind of thing a token is.",
      "oneOf": [
        {
          "const": "font",
          "description": "A type stack.",
          "type": "string"
        },
        {
          "const": "palette",
          "description": "A raw palette entry.",
          "type": "string"
        },
        {
          "const": "role",
          "description": "A semantic surface role.",
          "type": "string"
        },
        {
          "const": "status",
          "description": "A status meaning.",
          "type": "string"
        },
        {
          "const": "state",
          "description": "A state word, filed under a status.",
          "type": "string"
        },
        {
          "const": "tone",
          "description": "A tone: a hue for identity, never for meaning.",
          "type": "string"
        },
        {
          "const": "type",
          "description": "A step of the type scale.",
          "type": "string"
        },
        {
          "const": "tracking",
          "description": "A letter-spacing.",
          "type": "string"
        },
        {
          "const": "layout",
          "description": "A shared layout value.",
          "type": "string"
        },
        {
          "const": "radius",
          "description": "A corner radius.",
          "type": "string"
        },
        {
          "const": "motion",
          "description": "A duration.",
          "type": "string"
        },
        {
          "const": "theme",
          "description": "The theme contract.",
          "type": "string"
        }
      ]
    }
  },
  "description": "One token, explained: where it came from, what it resolves to, what reads it.",
  "properties": {
    "about": {
      "description": "What it is for, from the declaration.",
      "type": "string"
    },
    "aliases": {
      "description": "The Flowbite names that are synonyms of it.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "css": {
      "description": "The custom properties and Tailwind utilities it becomes.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "kind": {
      "$ref": "#/$defs/TokenKind",
      "description": "What kind of token."
    },
    "name": {
      "description": "The name as declared.",
      "type": "string"
    },
    "parts": {
      "description": "For a colour token: its parts, each resolved per theme.",
      "items": {
        "$ref": "#/$defs/ColourPart"
      },
      "type": "array"
    },
    "projections": {
      "description": "The generated files the token reaches.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "role": {
      "description": "For a state word: the status it is filed under.",
      "type": [
        "string",
        "null"
      ]
    },
    "states": {
      "description": "For a status: the state words filed under it.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "value": {
      "description": "For a scalar token: the value.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "name",
    "kind",
    "about",
    "css",
    "projections"
  ],
  "title": "Token",
  "type": "object"
}

Politiky

benchmark: povinné — cíl na každém transportu, který expozice deklaruje; případy jsou ty ze vstupního typu
cache: vypnuto — každé volání spustí handler

Cíle benchmarku

Odvozeno z registru pro tento repozitář: jeden požadavek na transport a případy, které poskytuje typ vstupu. Celá matice je na stránce měření výkonu.

transport	state	případy	targets
direct	pokryto	2	role state
mcp	pokryto	2	role state
http	pokryto	2	role state