@urbicon-ui/shared-types 6.44.0 → 6.45.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/component.d.ts +21 -1
- package/dist/component.d.ts.map +1 -1
- package/dist/playground.d.ts +21 -1
- package/dist/playground.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/component.ts +21 -1
- package/src/playground.ts +21 -1
package/dist/component.d.ts
CHANGED
|
@@ -20,8 +20,16 @@ export interface ComponentInfo {
|
|
|
20
20
|
filePath: string;
|
|
21
21
|
/** Version */
|
|
22
22
|
version?: string;
|
|
23
|
-
/** Component description */
|
|
23
|
+
/** Component description — the long form, for `llm.txt` and the MCP catalog. */
|
|
24
24
|
description: string;
|
|
25
|
+
/**
|
|
26
|
+
* One human-facing sentence, from `@summary` JSDoc. What the landing page
|
|
27
|
+
* and the component index show under the name; `description` is the
|
|
28
|
+
* contract an agent reads. Split apart in 2026-07 because one field for
|
|
29
|
+
* both readers served neither — the median description ran 259 characters,
|
|
30
|
+
* so the landing page truncated it mid-clause.
|
|
31
|
+
*/
|
|
32
|
+
summary?: string;
|
|
25
33
|
/** Deprecation information */
|
|
26
34
|
deprecated?: DeprecationInfo;
|
|
27
35
|
/** Experimental status */
|
|
@@ -67,6 +75,18 @@ export interface PropInfo {
|
|
|
67
75
|
required: boolean;
|
|
68
76
|
/** Property description */
|
|
69
77
|
description: string;
|
|
78
|
+
/**
|
|
79
|
+
* One line for a person standing at a control, from a prop-level
|
|
80
|
+
* `@summary`. The prop-level twin of {@link ComponentInfo.summary} and the
|
|
81
|
+
* same division of labour: {@link PropInfo.description} is the contract an
|
|
82
|
+
* agent reads and may run to a paragraph, this is the sentence a playground
|
|
83
|
+
* shows beside a knob.
|
|
84
|
+
*
|
|
85
|
+
* Optional, and meant to stay that way — most props say all they need in one
|
|
86
|
+
* sentence, and a required second field would mean hundreds of copies of the
|
|
87
|
+
* first. Read it as `summary ?? description`.
|
|
88
|
+
*/
|
|
89
|
+
summary?: string;
|
|
70
90
|
/** Default value */
|
|
71
91
|
defaultValue?: string;
|
|
72
92
|
/** Where this prop comes from */
|
package/dist/component.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"component.d.ts","sourceRoot":"","sources":["../src/component.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAEtE;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAE5B,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,
|
|
1
|
+
{"version":3,"file":"component.d.ts","sourceRoot":"","sources":["../src/component.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAEtE;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAE5B,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gFAAgF;IAChF,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,0BAA0B;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8EAA8E;IAC9E,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,8DAA8D;IAC9D,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAG7B,2BAA2B;IAC3B,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,yBAAyB;IACzB,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,8BAA8B;IAC9B,WAAW,EAAE,eAAe,EAAE,CAAC;IAC/B,2BAA2B;IAC3B,KAAK,EAAE,cAAc,CAAC;IAGtB,8BAA8B;IAC9B,aAAa,CAAC,EAAE,sBAAsB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,QAAQ,EAAE,OAAO,CAAC;IAClB,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iCAAiC;IACjC,MAAM,EAAE,UAAU,CAAC;IACnB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IACzB,uBAAuB;IACvB,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,wBAAwB;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,EAAE,CAAC;KAClB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uBAAuB;IACvB,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,wBAAwB;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,WAAW,GAAG,MAAM,GAAG,UAAU,CAAC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}
|
package/dist/playground.d.ts
CHANGED
|
@@ -27,8 +27,28 @@ export interface ControlDefinition {
|
|
|
27
27
|
type: ControlType;
|
|
28
28
|
/** Control options (for select/dropdown) */
|
|
29
29
|
items?: ControlOption[];
|
|
30
|
-
/**
|
|
30
|
+
/** Where this playground starts, and what "reset" returns to. */
|
|
31
31
|
defaultValue?: unknown;
|
|
32
|
+
/**
|
|
33
|
+
* What the *component* does when the prop is omitted — which is not always
|
|
34
|
+
* where the playground starts. A Table playground may open at
|
|
35
|
+
* `itemsPerPage: 5` while the component defaults to 10; the reset dot follows
|
|
36
|
+
* the former, the generated code snippet the latter, or it would print a
|
|
37
|
+
* snippet that does not reproduce the preview above it.
|
|
38
|
+
*
|
|
39
|
+
* Set by `deriveControls` from the generated API. Absent means "same as
|
|
40
|
+
* `defaultValue`".
|
|
41
|
+
*/
|
|
42
|
+
componentDefault?: unknown;
|
|
43
|
+
/**
|
|
44
|
+
* This knob steers the demo, it is not a prop of the component — a scenario
|
|
45
|
+
* switch that picks a payload, a "show marks" toggle that builds an array.
|
|
46
|
+
* Such a control must never reach the generated snippet: `scenario="survey"`
|
|
47
|
+
* would document an attribute that does not exist.
|
|
48
|
+
*
|
|
49
|
+
* Set by `deriveControls` for everything passed as `extra`.
|
|
50
|
+
*/
|
|
51
|
+
demoOnly?: boolean;
|
|
32
52
|
/** Minimum value (for number/range) */
|
|
33
53
|
min?: number;
|
|
34
54
|
/** Maximum value (for number/range) */
|
package/dist/playground.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"playground.d.ts","sourceRoot":"","sources":["../src/playground.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,2BAA2B;IAC3B,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,8BAA8B;IAC9B,aAAa,CAAC,EAAE,aAAa,GAAG,mBAAmB,CAAC;IACpD,kCAAkC;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,kCAAkC;IAClC,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC/B,4BAA4B;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,kBAAkB,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,yBAAyB;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB,4CAA4C;IAC5C,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,
|
|
1
|
+
{"version":3,"file":"playground.d.ts","sourceRoot":"","sources":["../src/playground.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,2BAA2B;IAC3B,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,8BAA8B;IAC9B,aAAa,CAAC,EAAE,aAAa,GAAG,mBAAmB,CAAC;IACpD,kCAAkC;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,kCAAkC;IAClC,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC/B,4BAA4B;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,kBAAkB,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,yBAAyB;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB,4CAA4C;IAC5C,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,iEAAiE;IACjE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;;;;OASG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uCAAuC;IACvC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0BAA0B;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,SAAS,CAAC,EAAE,gBAAgB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,UAAU,GACV,QAAQ,GACR,UAAU,GACV,SAAS,GACT,MAAM,GACN,UAAU,GACV,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,OAAO,GACP,OAAO,GACP,cAAc,GACd,MAAM,GACN,MAAM,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,mBAAmB;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sFAAsF;IACtF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wBAAwB;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,uCAAuC;IACvC,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC;IACf,gCAAgC;IAChC,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,kCAAkC;IAClC,QAAQ,EAAE,MAAM,GAAG,aAAa,CAAC;IACjC,yBAAyB;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,wBAAwB;IACxB,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAC5B,8BAA8B;IAC9B,UAAU,CAAC,EAAE;QACX,QAAQ,CAAC,EAAE,YAAY,GAAG,YAAY,GAAG,QAAQ,GAAG,OAAO,CAAC;QAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,qBAAqB;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpD,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,WAAW,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,uBAAuB;IACvB,QAAQ,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;IAC1D,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,yBAAyB;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC/B,2BAA2B;IAC3B,WAAW,CAAC,EAAE;QACZ,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;IACF,6BAA6B;IAC7B,aAAa,CAAC,EAAE;QACd,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,cAAc,GACd,iBAAiB,GACjB,aAAa,GACb,YAAY,GACZ,oBAAoB,GACpB,WAAW,GACX,uBAAuB,GACvB,qBAAqB,CAAC"}
|
package/package.json
CHANGED
package/src/component.ts
CHANGED
|
@@ -23,8 +23,16 @@ export interface ComponentInfo {
|
|
|
23
23
|
filePath: string;
|
|
24
24
|
/** Version */
|
|
25
25
|
version?: string;
|
|
26
|
-
/** Component description */
|
|
26
|
+
/** Component description — the long form, for `llm.txt` and the MCP catalog. */
|
|
27
27
|
description: string;
|
|
28
|
+
/**
|
|
29
|
+
* One human-facing sentence, from `@summary` JSDoc. What the landing page
|
|
30
|
+
* and the component index show under the name; `description` is the
|
|
31
|
+
* contract an agent reads. Split apart in 2026-07 because one field for
|
|
32
|
+
* both readers served neither — the median description ran 259 characters,
|
|
33
|
+
* so the landing page truncated it mid-clause.
|
|
34
|
+
*/
|
|
35
|
+
summary?: string;
|
|
28
36
|
/** Deprecation information */
|
|
29
37
|
deprecated?: DeprecationInfo;
|
|
30
38
|
/** Experimental status */
|
|
@@ -75,6 +83,18 @@ export interface PropInfo {
|
|
|
75
83
|
required: boolean;
|
|
76
84
|
/** Property description */
|
|
77
85
|
description: string;
|
|
86
|
+
/**
|
|
87
|
+
* One line for a person standing at a control, from a prop-level
|
|
88
|
+
* `@summary`. The prop-level twin of {@link ComponentInfo.summary} and the
|
|
89
|
+
* same division of labour: {@link PropInfo.description} is the contract an
|
|
90
|
+
* agent reads and may run to a paragraph, this is the sentence a playground
|
|
91
|
+
* shows beside a knob.
|
|
92
|
+
*
|
|
93
|
+
* Optional, and meant to stay that way — most props say all they need in one
|
|
94
|
+
* sentence, and a required second field would mean hundreds of copies of the
|
|
95
|
+
* first. Read it as `summary ?? description`.
|
|
96
|
+
*/
|
|
97
|
+
summary?: string;
|
|
78
98
|
/** Default value */
|
|
79
99
|
defaultValue?: string;
|
|
80
100
|
/** Where this prop comes from */
|
package/src/playground.ts
CHANGED
|
@@ -28,8 +28,28 @@ export interface ControlDefinition {
|
|
|
28
28
|
type: ControlType;
|
|
29
29
|
/** Control options (for select/dropdown) */
|
|
30
30
|
items?: ControlOption[];
|
|
31
|
-
/**
|
|
31
|
+
/** Where this playground starts, and what "reset" returns to. */
|
|
32
32
|
defaultValue?: unknown;
|
|
33
|
+
/**
|
|
34
|
+
* What the *component* does when the prop is omitted — which is not always
|
|
35
|
+
* where the playground starts. A Table playground may open at
|
|
36
|
+
* `itemsPerPage: 5` while the component defaults to 10; the reset dot follows
|
|
37
|
+
* the former, the generated code snippet the latter, or it would print a
|
|
38
|
+
* snippet that does not reproduce the preview above it.
|
|
39
|
+
*
|
|
40
|
+
* Set by `deriveControls` from the generated API. Absent means "same as
|
|
41
|
+
* `defaultValue`".
|
|
42
|
+
*/
|
|
43
|
+
componentDefault?: unknown;
|
|
44
|
+
/**
|
|
45
|
+
* This knob steers the demo, it is not a prop of the component — a scenario
|
|
46
|
+
* switch that picks a payload, a "show marks" toggle that builds an array.
|
|
47
|
+
* Such a control must never reach the generated snippet: `scenario="survey"`
|
|
48
|
+
* would document an attribute that does not exist.
|
|
49
|
+
*
|
|
50
|
+
* Set by `deriveControls` for everything passed as `extra`.
|
|
51
|
+
*/
|
|
52
|
+
demoOnly?: boolean;
|
|
33
53
|
/** Minimum value (for number/range) */
|
|
34
54
|
min?: number;
|
|
35
55
|
/** Maximum value (for number/range) */
|