@workday/canvas-kit-docs 11.0.0-alpha.708-next.0 → 11.0.0-alpha.711-next.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.
Files changed (2) hide show
  1. package/dist/es6/lib/docs.js +805 -95
  2. package/package.json +6 -6
@@ -253910,12 +253910,12 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
253910
253910
  }
253911
253911
  },
253912
253912
  {
253913
- "name": "DefaultedVarsMap",
253913
+ "name": "DefaultedVarsMapToCSSVarNames",
253914
253914
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts",
253915
- "description": "",
253915
+ "description": "Maps JS var names to CSS variable names\n\n```ts\n// ID unknown\nDefaultedVarsMapToCSSVarNames<{foo: 'red'}, never> = Record<'foo', string>\n// ID unknown, nested\nDefaultedVarsMapToCSSVarNames<{foo: { bar: 'red' }}> = Record<'foo', Record<'bar', string>>\n\n// ID known\nDefaultedVarsMapToCSSVarNames<{foo: { bar: 'red' }}, 'my-id'> = { foo: '--my-id-red' }\n// ID known, nested\nDefaultedVarsMapToCSSVarNames<{foo: { bar: 'red' }}, 'my-id'> = { foo: { bar: '--my-id-red' }}\n```",
253916
253916
  "declarations": [
253917
253917
  {
253918
- "name": "DefaultedVarsMap",
253918
+ "name": "DefaultedVarsMapToCSSVarNames",
253919
253919
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
253920
253920
  }
253921
253921
  ],
@@ -253925,7 +253925,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
253925
253925
  "typeParameters": [
253926
253926
  {
253927
253927
  "kind": "typeParameter",
253928
- "name": "T",
253928
+ "name": "V",
253929
253929
  "constraint": {
253930
253930
  "kind": "union",
253931
253931
  "value": [
@@ -254017,7 +254017,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
254017
254017
  "kind": "conditional",
254018
254018
  "check": {
254019
254019
  "kind": "generic",
254020
- "name": "T"
254020
+ "name": "V"
254021
254021
  },
254022
254022
  "extends": {
254023
254023
  "kind": "external",
@@ -254042,7 +254042,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
254042
254042
  {
254043
254043
  "kind": "unknown",
254044
254044
  "value": "unknown",
254045
- "text": "keyof T"
254045
+ "text": "keyof V"
254046
254046
  },
254047
254047
  {
254048
254048
  "kind": "primitive",
@@ -254053,17 +254053,177 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
254053
254053
  "falseType": {
254054
254054
  "kind": "unknown",
254055
254055
  "value": "unknown",
254056
- "text": "{[K in keyof T]: Record<keyof T[K], string>}"
254056
+ "text": "{[K in keyof V]: Record<keyof V[K], string>}"
254057
254057
  }
254058
254058
  },
254059
254059
  "falseType": {
254060
254060
  "kind": "unknown",
254061
254061
  "value": "unknown",
254062
- "text": "{\n [K in keyof T]: T[K] extends Record<string, string>\n ? DefaultedVarsMap<T[K], `${ID}-${ToString<K>}`> // TypeScript doesn't know K is a string here and will throw an error, so we have to coerce it\n : CSSVarName<ID, K>;\n }"
254062
+ "text": "{\n [K in keyof V]: V[K] extends Record<string, string>\n ? DefaultedVarsMapToCSSVarNames<V[K], `${ID}-${ToString<K>}`> // TypeScript doesn't know K is a string here and will throw an error, so we have to coerce it\n : CSSVarName<ID, K>;\n }"
254063
254063
  }
254064
254064
  }
254065
254065
  }
254066
254066
  },
254067
+ {
254068
+ "name": "DefaultedVarsMap",
254069
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts",
254070
+ "description": "Maps CSS var names to defaulted values if possible. If no ID is provided, TypeScript won't know\nthe CSS var name and will return `Record<string, string>`. If the ID is known, a full mapping\nwill be returned.\n\n```ts\n// ID known\nDefaultedVarsMap<{foo: 'red'}, 'my-id'> = { '--my-id-foo': 'red' }\n// ID known, nested\nDefaultedVarsMap<{foo: { bar: 'red' }}, 'my-id'> = { foo: { '--my-id-bar': 'red' }}\n```",
254071
+ "declarations": [
254072
+ {
254073
+ "name": "DefaultedVarsMap",
254074
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
254075
+ }
254076
+ ],
254077
+ "tags": {},
254078
+ "type": {
254079
+ "kind": "object",
254080
+ "properties": [
254081
+ {
254082
+ "kind": "property",
254083
+ "name": "$defaults",
254084
+ "required": true,
254085
+ "type": {
254086
+ "kind": "conditional",
254087
+ "check": {
254088
+ "kind": "tuple",
254089
+ "value": [
254090
+ {
254091
+ "kind": "generic",
254092
+ "name": "ID"
254093
+ }
254094
+ ]
254095
+ },
254096
+ "extends": {
254097
+ "kind": "tuple",
254098
+ "value": [
254099
+ {
254100
+ "kind": "primitive",
254101
+ "value": "never"
254102
+ }
254103
+ ]
254104
+ },
254105
+ "trueType": {
254106
+ "kind": "external",
254107
+ "name": "Record",
254108
+ "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
254109
+ "typeParameters": [
254110
+ {
254111
+ "kind": "primitive",
254112
+ "value": "string"
254113
+ },
254114
+ {
254115
+ "kind": "primitive",
254116
+ "value": "string"
254117
+ }
254118
+ ]
254119
+ },
254120
+ "falseType": {
254121
+ "kind": "conditional",
254122
+ "check": {
254123
+ "kind": "generic",
254124
+ "name": "V"
254125
+ },
254126
+ "extends": {
254127
+ "kind": "external",
254128
+ "name": "Record",
254129
+ "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
254130
+ "typeParameters": [
254131
+ {
254132
+ "kind": "primitive",
254133
+ "value": "string"
254134
+ },
254135
+ {
254136
+ "kind": "primitive",
254137
+ "value": "string"
254138
+ }
254139
+ ]
254140
+ },
254141
+ "trueType": {
254142
+ "kind": "unknown",
254143
+ "value": "unknown",
254144
+ "text": "{\n [K in keyof V as CSSVarName<ID, K>]: V[K]; // The variables are a simple flat object with string values\n }"
254145
+ },
254146
+ "falseType": {
254147
+ "kind": "unknown",
254148
+ "value": "unknown",
254149
+ "text": "{[K in FlattenObjectKeys<V> as CSSVarName<ID, K>]: ExtractValue<V, K>}"
254150
+ }
254151
+ }
254152
+ },
254153
+ "description": "",
254154
+ "declarations": [
254155
+ {
254156
+ "name": "$defaults",
254157
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
254158
+ }
254159
+ ],
254160
+ "tags": {}
254161
+ }
254162
+ ],
254163
+ "typeParameters": [
254164
+ {
254165
+ "kind": "typeParameter",
254166
+ "name": "V",
254167
+ "constraint": {
254168
+ "kind": "union",
254169
+ "value": [
254170
+ {
254171
+ "kind": "external",
254172
+ "name": "Record",
254173
+ "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
254174
+ "typeParameters": [
254175
+ {
254176
+ "kind": "primitive",
254177
+ "value": "string"
254178
+ },
254179
+ {
254180
+ "kind": "primitive",
254181
+ "value": "string"
254182
+ }
254183
+ ]
254184
+ },
254185
+ {
254186
+ "kind": "external",
254187
+ "name": "Record",
254188
+ "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
254189
+ "typeParameters": [
254190
+ {
254191
+ "kind": "primitive",
254192
+ "value": "string"
254193
+ },
254194
+ {
254195
+ "kind": "external",
254196
+ "name": "Record",
254197
+ "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
254198
+ "typeParameters": [
254199
+ {
254200
+ "kind": "primitive",
254201
+ "value": "string"
254202
+ },
254203
+ {
254204
+ "kind": "primitive",
254205
+ "value": "string"
254206
+ }
254207
+ ]
254208
+ }
254209
+ ]
254210
+ }
254211
+ ]
254212
+ },
254213
+ "required": true
254214
+ },
254215
+ {
254216
+ "kind": "typeParameter",
254217
+ "name": "ID",
254218
+ "constraint": {
254219
+ "kind": "primitive",
254220
+ "value": "string"
254221
+ },
254222
+ "required": true
254223
+ }
254224
+ ]
254225
+ }
254226
+ },
254067
254227
  {
254068
254228
  "name": "createDefaultedVars",
254069
254229
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts",
@@ -254222,43 +254382,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
254222
254382
  "name": "T"
254223
254383
  },
254224
254384
  {
254225
- "kind": "parenthesis",
254226
- "value": {
254227
- "kind": "function",
254228
- "parameters": [
254229
- {
254230
- "kind": "parameter",
254231
- "name": "modifiers",
254232
- "type": {
254233
- "kind": "symbol",
254234
- "name": "Partial",
254235
- "typeParameters": [
254236
- {
254237
- "kind": "symbol",
254238
- "name": "ModifierValues",
254239
- "value": "ModifierValues<T>"
254240
- }
254241
- ],
254242
- "value": "Partial<T>"
254243
- },
254244
- "required": true,
254245
- "rest": false,
254246
- "description": "",
254247
- "declarations": [
254248
- {
254249
- "name": "modifiers",
254250
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
254251
- }
254252
- ],
254253
- "tags": {}
254254
- }
254255
- ],
254256
- "members": [],
254257
- "returnType": {
254258
- "kind": "primitive",
254259
- "value": "string"
254260
- }
254261
- }
254385
+ "kind": "symbol",
254386
+ "name": "ModifierFn",
254387
+ "value": "ModifierFn<T>"
254262
254388
  }
254263
254389
  ]
254264
254390
  }
@@ -254470,14 +254596,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
254470
254596
  "members": [],
254471
254597
  "returnType": {
254472
254598
  "kind": "symbol",
254473
- "name": "ModifierReturn",
254474
- "typeParameters": [
254475
- {
254476
- "kind": "generic",
254477
- "name": "M"
254478
- }
254479
- ],
254480
- "value": "ModifierReturn<T>"
254599
+ "name": "ModifierFn",
254600
+ "value": "ModifierFn<M>"
254481
254601
  }
254482
254602
  }
254483
254603
  },
@@ -255016,6 +255136,38 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255016
255136
  ]
255017
255137
  },
255018
255138
  "required": false
255139
+ },
255140
+ {
255141
+ "kind": "typeParameter",
255142
+ "name": "E",
255143
+ "defaultValue": {
255144
+ "kind": "primitive",
255145
+ "value": "never"
255146
+ },
255147
+ "constraint": {
255148
+ "kind": "symbol",
255149
+ "name": "BaseStencil",
255150
+ "typeParameters": [
255151
+ {
255152
+ "kind": "primitive",
255153
+ "value": "any"
255154
+ },
255155
+ {
255156
+ "kind": "primitive",
255157
+ "value": "any"
255158
+ },
255159
+ {
255160
+ "kind": "primitive",
255161
+ "value": "any"
255162
+ },
255163
+ {
255164
+ "kind": "primitive",
255165
+ "value": "any"
255166
+ }
255167
+ ],
255168
+ "value": "BaseStencil<M, V, E, ID>"
255169
+ },
255170
+ "required": false
255019
255171
  }
255020
255172
  ],
255021
255173
  "value": {
@@ -255039,7 +255191,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255039
255191
  {
255040
255192
  "kind": "symbol",
255041
255193
  "name": "StylesReturn",
255042
- "value": "StylesReturn<V>"
255194
+ "value": "StylesReturn<V, E>"
255043
255195
  }
255044
255196
  ]
255045
255197
  }
@@ -255131,6 +255283,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255131
255283
  "type": {
255132
255284
  "kind": "object",
255133
255285
  "properties": [
255286
+ {
255287
+ "kind": "property",
255288
+ "name": "extends",
255289
+ "required": false,
255290
+ "type": {
255291
+ "kind": "generic",
255292
+ "name": "E"
255293
+ },
255294
+ "description": "A Stencil can extend another stencil. Styles are not copied from one stencil to another, but\nrather the class name generated for each stencil will be included in the stencil output. For\nexample:\n\n```ts\nconst baseStencil = createStencil({\n base: {padding: 5}\n});\nconst extendingStencil = createStencil({\n extends: baseStencil,\n base: {margin: 5}\n});\n```\n\nIn this example, `extendingStencil` does not have a base style that includes `padding`, but\ncalling the stencil will return both style classes created:\n\n```ts\nextendingStencil() // {className: 'css-{base} css-{extending}'}\n```\n\nNotice when the stencil is called, it will return the CSS class name of each stencil.\n\nAn extending stencil can use a `compound` modifier that includes references to the base stencil\nmodifiers. For runtime, each compound modifier has a unique class name. The static CSS\nextraction will use the base modifier name in the selector.",
255295
+ "declarations": [
255296
+ {
255297
+ "name": "extends",
255298
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
255299
+ }
255300
+ ],
255301
+ "tags": {}
255302
+ },
255134
255303
  {
255135
255304
  "kind": "property",
255136
255305
  "name": "vars",
@@ -255139,7 +255308,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255139
255308
  "kind": "generic",
255140
255309
  "name": "V"
255141
255310
  },
255142
- "description": "",
255311
+ "description": "A stencil can support CSS variables. Since CSS variables cascade by default, variables are\ndefined with defaults. These defaults are added automatically to the `base` styles to prevent\nCSS variables defined higher in the DOM tree from cascading into a component.\n\n```ts\nconst buttonStencil = createStencil({\n vars: {color: 'red'},\n base: {padding: 5}\n})\n```\n\n```css\n.css-button {\n --css-button-color: red;\n padding: 5px;\n}\n```\n\nAccess to variables in `base` and `modifiers` is done via a function wrapper that gives\nall variables.\n\n```ts\nconst buttonStencil = createStyles({\n vars: {color: 'red'},\n base({color}) {\n return {color: color}\n }\n})\n```\n\n```css\n.css-button {\n --css-button-color: red;\n color: var(--css-button-color);\n}\n```",
255143
255312
  "declarations": [
255144
255313
  {
255145
255314
  "name": "vars",
@@ -255155,7 +255324,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255155
255324
  "type": {
255156
255325
  "kind": "symbol",
255157
255326
  "name": "StylesReturn",
255158
- "value": "StylesReturn<V>"
255327
+ "value": "StylesReturn<V, E>"
255159
255328
  },
255160
255329
  "description": "Base styles. These styles will always be returned when the stencil is called",
255161
255330
  "declarations": [
@@ -255190,22 +255359,104 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255190
255359
  "type": {
255191
255360
  "kind": "array",
255192
255361
  "value": {
255193
- "kind": "symbol",
255194
- "name": "StencilCompoundConfig",
255195
- "typeParameters": [
255196
- {
255197
- "kind": "generic",
255198
- "name": "M"
255199
- }
255200
- ],
255201
- "value": "StencilCompoundConfig<M>"
255202
- }
255203
- },
255204
- "description": "Stencil compound modifiers. The styles of a compound modifier are returned only if each modifier\nmatches the specified value. For example:\n\n```tsx\nconst stencil = createStencil({\n base: {\n padding: 5,\n },\n modifiers: {\n size: {\n large: {\n padding: 10\n }\n },\n position: {\n start: {\n paddingInlineStart: 0\n }\n }\n },\n compound: [\n {\n modifiers: {\n size: 'large',\n position: 'start',\n },\n styles: {\n paddingInlineStart: 5\n }\n }\n ]\n})\n\nstencil({})\n// {padding: 5px;}\nstencil({size: 'large'})\n// {padding: 10px;}\nstencil({position: 'start' })\n// {padding: 5px; paddingInlineStart: 0}\nstencil({size: 'large', position: 'start' })\n// {padding: 10px; paddingInlineStart: 5px;}\n```",
255205
- "declarations": [
255206
- {
255207
- "name": "compound",
255208
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
255362
+ "kind": "parenthesis",
255363
+ "value": {
255364
+ "kind": "conditional",
255365
+ "check": {
255366
+ "kind": "tuple",
255367
+ "value": [
255368
+ {
255369
+ "kind": "generic",
255370
+ "name": "E"
255371
+ }
255372
+ ]
255373
+ },
255374
+ "extends": {
255375
+ "kind": "tuple",
255376
+ "value": [
255377
+ {
255378
+ "kind": "primitive",
255379
+ "value": "never"
255380
+ }
255381
+ ]
255382
+ },
255383
+ "trueType": {
255384
+ "kind": "symbol",
255385
+ "name": "StencilCompoundConfig",
255386
+ "typeParameters": [
255387
+ {
255388
+ "kind": "generic",
255389
+ "name": "M"
255390
+ }
255391
+ ],
255392
+ "value": "StencilCompoundConfig<M>"
255393
+ },
255394
+ "falseType": {
255395
+ "kind": "conditional",
255396
+ "check": {
255397
+ "kind": "generic",
255398
+ "name": "E"
255399
+ },
255400
+ "extends": {
255401
+ "kind": "symbol",
255402
+ "name": "BaseStencil",
255403
+ "typeParameters": [
255404
+ {
255405
+ "kind": "infer",
255406
+ "value": {
255407
+ "kind": "typeParameter",
255408
+ "name": "ME",
255409
+ "required": true
255410
+ }
255411
+ },
255412
+ {
255413
+ "kind": "primitive",
255414
+ "value": "any"
255415
+ },
255416
+ {
255417
+ "kind": "primitive",
255418
+ "value": "any"
255419
+ },
255420
+ {
255421
+ "kind": "primitive",
255422
+ "value": "any"
255423
+ }
255424
+ ],
255425
+ "value": "BaseStencil<M, V, E, ID>"
255426
+ },
255427
+ "trueType": {
255428
+ "kind": "symbol",
255429
+ "name": "StencilCompoundConfig",
255430
+ "typeParameters": [
255431
+ {
255432
+ "kind": "intersection",
255433
+ "value": [
255434
+ {
255435
+ "kind": "generic",
255436
+ "name": "ME"
255437
+ },
255438
+ {
255439
+ "kind": "generic",
255440
+ "name": "M"
255441
+ }
255442
+ ]
255443
+ }
255444
+ ],
255445
+ "value": "StencilCompoundConfig<M>"
255446
+ },
255447
+ "falseType": {
255448
+ "kind": "primitive",
255449
+ "value": "never"
255450
+ }
255451
+ }
255452
+ }
255453
+ }
255454
+ },
255455
+ "description": "Stencil compound modifiers. The styles of a compound modifier are returned only if each modifier\nmatches the specified value. For example:\n\n```tsx\nconst stencil = createStencil({\n base: {\n padding: 5,\n },\n modifiers: {\n size: {\n large: {\n padding: 10\n }\n },\n position: {\n start: {\n paddingInlineStart: 0\n }\n }\n },\n compound: [\n {\n modifiers: {\n size: 'large',\n position: 'start',\n },\n styles: {\n paddingInlineStart: 5\n }\n }\n ]\n})\n\nstencil({})\n// {padding: 5px;}\nstencil({size: 'large'})\n// {padding: 10px;}\nstencil({position: 'start' })\n// {padding: 5px; paddingInlineStart: 0}\nstencil({size: 'large', position: 'start' })\n// {padding: 10px; paddingInlineStart: 5px;}\n```",
255456
+ "declarations": [
255457
+ {
255458
+ "name": "compound",
255459
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
255209
255460
  }
255210
255461
  ],
255211
255462
  "tags": {}
@@ -255258,23 +255509,235 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255258
255509
  {
255259
255510
  "kind": "generic",
255260
255511
  "name": "V"
255512
+ },
255513
+ {
255514
+ "kind": "generic",
255515
+ "name": "E"
255261
255516
  }
255262
255517
  ],
255263
- "value": "StylesReturn<V>"
255518
+ "value": "StylesReturn<V, E>"
255519
+ }
255520
+ ]
255521
+ }
255522
+ ]
255523
+ },
255524
+ "required": true
255525
+ },
255526
+ {
255527
+ "kind": "typeParameter",
255528
+ "name": "V",
255529
+ "defaultValue": {
255530
+ "kind": "object",
255531
+ "properties": []
255532
+ },
255533
+ "constraint": {
255534
+ "kind": "union",
255535
+ "value": [
255536
+ {
255537
+ "kind": "external",
255538
+ "name": "Record",
255539
+ "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
255540
+ "typeParameters": [
255541
+ {
255542
+ "kind": "primitive",
255543
+ "value": "string"
255544
+ },
255545
+ {
255546
+ "kind": "primitive",
255547
+ "value": "string"
255264
255548
  }
255265
255549
  ]
255550
+ },
255551
+ {
255552
+ "kind": "external",
255553
+ "name": "Record",
255554
+ "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
255555
+ "typeParameters": [
255556
+ {
255557
+ "kind": "primitive",
255558
+ "value": "string"
255559
+ },
255560
+ {
255561
+ "kind": "external",
255562
+ "name": "Record",
255563
+ "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
255564
+ "typeParameters": [
255565
+ {
255566
+ "kind": "primitive",
255567
+ "value": "string"
255568
+ },
255569
+ {
255570
+ "kind": "primitive",
255571
+ "value": "string"
255572
+ }
255573
+ ]
255574
+ }
255575
+ ]
255576
+ }
255577
+ ]
255578
+ },
255579
+ "required": false
255580
+ },
255581
+ {
255582
+ "kind": "typeParameter",
255583
+ "name": "E",
255584
+ "defaultValue": {
255585
+ "kind": "primitive",
255586
+ "value": "never"
255587
+ },
255588
+ "constraint": {
255589
+ "kind": "symbol",
255590
+ "name": "BaseStencil",
255591
+ "typeParameters": [
255592
+ {
255593
+ "kind": "primitive",
255594
+ "value": "any"
255595
+ },
255596
+ {
255597
+ "kind": "primitive",
255598
+ "value": "any"
255599
+ },
255600
+ {
255601
+ "kind": "primitive",
255602
+ "value": "any"
255603
+ },
255604
+ {
255605
+ "kind": "primitive",
255606
+ "value": "any"
255607
+ }
255608
+ ],
255609
+ "value": "BaseStencil<M, V, E, ID>"
255610
+ },
255611
+ "required": false
255612
+ },
255613
+ {
255614
+ "kind": "typeParameter",
255615
+ "name": "ID",
255616
+ "defaultValue": {
255617
+ "kind": "primitive",
255618
+ "value": "never"
255619
+ },
255620
+ "constraint": {
255621
+ "kind": "union",
255622
+ "value": [
255623
+ {
255624
+ "kind": "primitive",
255625
+ "value": "string"
255626
+ },
255627
+ {
255628
+ "kind": "primitive",
255629
+ "value": "never"
255630
+ }
255631
+ ]
255632
+ },
255633
+ "required": false
255634
+ }
255635
+ ]
255636
+ }
255637
+ },
255638
+ {
255639
+ "name": "BaseStencil",
255640
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts",
255641
+ "description": "",
255642
+ "declarations": [
255643
+ {
255644
+ "name": "BaseStencil",
255645
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
255646
+ }
255647
+ ],
255648
+ "tags": {},
255649
+ "type": {
255650
+ "kind": "object",
255651
+ "properties": [
255652
+ {
255653
+ "kind": "property",
255654
+ "name": "__extends",
255655
+ "required": false,
255656
+ "type": {
255657
+ "kind": "generic",
255658
+ "name": "E"
255659
+ },
255660
+ "description": "",
255661
+ "declarations": [
255662
+ {
255663
+ "name": "__extends",
255664
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
255665
+ }
255666
+ ],
255667
+ "tags": {}
255668
+ },
255669
+ {
255670
+ "kind": "property",
255671
+ "name": "__vars",
255672
+ "required": true,
255673
+ "type": {
255674
+ "kind": "generic",
255675
+ "name": "V"
255676
+ },
255677
+ "description": "",
255678
+ "declarations": [
255679
+ {
255680
+ "name": "__vars",
255681
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
255682
+ }
255683
+ ],
255684
+ "tags": {}
255685
+ },
255686
+ {
255687
+ "kind": "property",
255688
+ "name": "__modifiers",
255689
+ "required": true,
255690
+ "type": {
255691
+ "kind": "generic",
255692
+ "name": "M"
255693
+ },
255694
+ "description": "",
255695
+ "declarations": [
255696
+ {
255697
+ "name": "__modifiers",
255698
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
255699
+ }
255700
+ ],
255701
+ "tags": {}
255702
+ },
255703
+ {
255704
+ "kind": "property",
255705
+ "name": "__id",
255706
+ "required": true,
255707
+ "type": {
255708
+ "kind": "generic",
255709
+ "name": "ID"
255710
+ },
255711
+ "description": "",
255712
+ "declarations": [
255713
+ {
255714
+ "name": "__id",
255715
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
255716
+ }
255717
+ ],
255718
+ "tags": {}
255719
+ }
255720
+ ],
255721
+ "typeParameters": [
255722
+ {
255723
+ "kind": "typeParameter",
255724
+ "name": "M",
255725
+ "constraint": {
255726
+ "kind": "symbol",
255727
+ "name": "StencilModifierConfig",
255728
+ "typeParameters": [
255729
+ {
255730
+ "kind": "generic",
255731
+ "name": "V"
255266
255732
  }
255267
- ]
255733
+ ],
255734
+ "value": "StencilModifierConfig<V, E>"
255268
255735
  },
255269
255736
  "required": true
255270
255737
  },
255271
255738
  {
255272
255739
  "kind": "typeParameter",
255273
255740
  "name": "V",
255274
- "defaultValue": {
255275
- "kind": "object",
255276
- "properties": []
255277
- },
255278
255741
  "constraint": {
255279
255742
  "kind": "union",
255280
255743
  "value": [
@@ -255321,27 +255784,50 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255321
255784
  }
255322
255785
  ]
255323
255786
  },
255324
- "required": false
255787
+ "required": true
255325
255788
  },
255326
255789
  {
255327
255790
  "kind": "typeParameter",
255328
- "name": "ID",
255791
+ "name": "E",
255329
255792
  "defaultValue": {
255330
255793
  "kind": "primitive",
255331
255794
  "value": "never"
255332
255795
  },
255333
255796
  "constraint": {
255334
- "kind": "union",
255335
- "value": [
255797
+ "kind": "symbol",
255798
+ "name": "BaseStencil",
255799
+ "typeParameters": [
255336
255800
  {
255337
255801
  "kind": "primitive",
255338
- "value": "string"
255802
+ "value": "any"
255339
255803
  },
255340
255804
  {
255341
255805
  "kind": "primitive",
255342
- "value": "never"
255806
+ "value": "any"
255807
+ },
255808
+ {
255809
+ "kind": "primitive",
255810
+ "value": "any"
255811
+ },
255812
+ {
255813
+ "kind": "primitive",
255814
+ "value": "any"
255343
255815
  }
255344
- ]
255816
+ ],
255817
+ "value": "BaseStencil<M, V, E, ID>"
255818
+ },
255819
+ "required": false
255820
+ },
255821
+ {
255822
+ "kind": "typeParameter",
255823
+ "name": "ID",
255824
+ "defaultValue": {
255825
+ "kind": "primitive",
255826
+ "value": "never"
255827
+ },
255828
+ "constraint": {
255829
+ "kind": "primitive",
255830
+ "value": "string"
255345
255831
  },
255346
255832
  "required": false
255347
255833
  }
@@ -255367,9 +255853,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255367
255853
  "name": "vars",
255368
255854
  "required": true,
255369
255855
  "type": {
255370
- "kind": "symbol",
255371
- "name": "DefaultedVars",
255372
- "value": "DefaultedVars<V, ID>"
255856
+ "kind": "generic",
255857
+ "name": "StencilDefaultVars"
255373
255858
  },
255374
255859
  "description": "",
255375
255860
  "declarations": [
@@ -255402,9 +255887,72 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255402
255887
  "name": "modifiers",
255403
255888
  "required": true,
255404
255889
  "type": {
255405
- "kind": "symbol",
255406
- "name": "StencilModifierReturn",
255407
- "value": "StencilModifierReturn<M, V>"
255890
+ "kind": "conditional",
255891
+ "check": {
255892
+ "kind": "tuple",
255893
+ "value": [
255894
+ {
255895
+ "kind": "generic",
255896
+ "name": "E"
255897
+ }
255898
+ ]
255899
+ },
255900
+ "extends": {
255901
+ "kind": "tuple",
255902
+ "value": [
255903
+ {
255904
+ "kind": "symbol",
255905
+ "name": "BaseStencil",
255906
+ "typeParameters": [
255907
+ {
255908
+ "kind": "infer",
255909
+ "value": {
255910
+ "kind": "typeParameter",
255911
+ "name": "ME",
255912
+ "required": true
255913
+ }
255914
+ },
255915
+ {
255916
+ "kind": "infer",
255917
+ "value": {
255918
+ "kind": "typeParameter",
255919
+ "name": "VE",
255920
+ "required": true
255921
+ }
255922
+ },
255923
+ {
255924
+ "kind": "primitive",
255925
+ "value": "any"
255926
+ },
255927
+ {
255928
+ "kind": "primitive",
255929
+ "value": "any"
255930
+ }
255931
+ ],
255932
+ "value": "BaseStencil<M, V, E, ID>"
255933
+ }
255934
+ ]
255935
+ },
255936
+ "trueType": {
255937
+ "kind": "symbol",
255938
+ "name": "StencilModifierReturn",
255939
+ "value": "StencilModifierReturn<ME & M, VE & V>"
255940
+ },
255941
+ "falseType": {
255942
+ "kind": "symbol",
255943
+ "name": "StencilModifierReturn",
255944
+ "typeParameters": [
255945
+ {
255946
+ "kind": "generic",
255947
+ "name": "M"
255948
+ },
255949
+ {
255950
+ "kind": "generic",
255951
+ "name": "V"
255952
+ }
255953
+ ],
255954
+ "value": "StencilModifierReturn<M, V>"
255955
+ }
255408
255956
  },
255409
255957
  "description": "",
255410
255958
  "declarations": [
@@ -255414,6 +255962,92 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255414
255962
  }
255415
255963
  ],
255416
255964
  "tags": {}
255965
+ },
255966
+ {
255967
+ "kind": "property",
255968
+ "name": "defaultModifiers",
255969
+ "required": true,
255970
+ "type": {
255971
+ "kind": "unknown",
255972
+ "value": "unknown",
255973
+ "text": "{[K in keyof M]?: keyof M[K]}"
255974
+ },
255975
+ "description": "",
255976
+ "declarations": [
255977
+ {
255978
+ "name": "defaultModifiers",
255979
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
255980
+ }
255981
+ ],
255982
+ "tags": {}
255983
+ },
255984
+ {
255985
+ "kind": "property",
255986
+ "name": "__extends",
255987
+ "required": false,
255988
+ "type": {
255989
+ "kind": "generic",
255990
+ "name": "E"
255991
+ },
255992
+ "description": "",
255993
+ "declarations": [
255994
+ {
255995
+ "name": "__extends",
255996
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
255997
+ }
255998
+ ],
255999
+ "tags": {}
256000
+ },
256001
+ {
256002
+ "kind": "property",
256003
+ "name": "__vars",
256004
+ "required": true,
256005
+ "type": {
256006
+ "kind": "generic",
256007
+ "name": "V"
256008
+ },
256009
+ "description": "",
256010
+ "declarations": [
256011
+ {
256012
+ "name": "__vars",
256013
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
256014
+ }
256015
+ ],
256016
+ "tags": {}
256017
+ },
256018
+ {
256019
+ "kind": "property",
256020
+ "name": "__modifiers",
256021
+ "required": true,
256022
+ "type": {
256023
+ "kind": "generic",
256024
+ "name": "M"
256025
+ },
256026
+ "description": "",
256027
+ "declarations": [
256028
+ {
256029
+ "name": "__modifiers",
256030
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
256031
+ }
256032
+ ],
256033
+ "tags": {}
256034
+ },
256035
+ {
256036
+ "kind": "property",
256037
+ "name": "__id",
256038
+ "required": true,
256039
+ "type": {
256040
+ "kind": "generic",
256041
+ "name": "ID"
256042
+ },
256043
+ "description": "",
256044
+ "declarations": [
256045
+ {
256046
+ "name": "__id",
256047
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
256048
+ }
256049
+ ],
256050
+ "tags": {}
255417
256051
  }
255418
256052
  ],
255419
256053
  "typeParameters": [
@@ -255427,9 +256061,13 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255427
256061
  {
255428
256062
  "kind": "generic",
255429
256063
  "name": "V"
256064
+ },
256065
+ {
256066
+ "kind": "generic",
256067
+ "name": "E"
255430
256068
  }
255431
256069
  ],
255432
- "value": "StencilModifierConfig<V>"
256070
+ "value": "StencilModifierConfig<V, E>"
255433
256071
  },
255434
256072
  "required": true
255435
256073
  },
@@ -255484,6 +256122,38 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255484
256122
  },
255485
256123
  "required": true
255486
256124
  },
256125
+ {
256126
+ "kind": "typeParameter",
256127
+ "name": "E",
256128
+ "defaultValue": {
256129
+ "kind": "primitive",
256130
+ "value": "never"
256131
+ },
256132
+ "constraint": {
256133
+ "kind": "symbol",
256134
+ "name": "BaseStencil",
256135
+ "typeParameters": [
256136
+ {
256137
+ "kind": "primitive",
256138
+ "value": "any"
256139
+ },
256140
+ {
256141
+ "kind": "primitive",
256142
+ "value": "any"
256143
+ },
256144
+ {
256145
+ "kind": "primitive",
256146
+ "value": "any"
256147
+ },
256148
+ {
256149
+ "kind": "primitive",
256150
+ "value": "any"
256151
+ }
256152
+ ],
256153
+ "value": "BaseStencil<M, V, E, ID>"
256154
+ },
256155
+ "required": false
256156
+ },
255487
256157
  {
255488
256158
  "kind": "typeParameter",
255489
256159
  "name": "ID",
@@ -255526,7 +256196,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255526
256196
  "name": "V"
255527
256197
  }
255528
256198
  ],
255529
- "value": "StencilModifierConfig<V>"
256199
+ "value": "StencilModifierConfig<V, E>"
255530
256200
  },
255531
256201
  "required": true
255532
256202
  },
@@ -255585,6 +256255,38 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255585
256255
  },
255586
256256
  "required": false
255587
256257
  },
256258
+ {
256259
+ "kind": "typeParameter",
256260
+ "name": "E",
256261
+ "defaultValue": {
256262
+ "kind": "primitive",
256263
+ "value": "never"
256264
+ },
256265
+ "constraint": {
256266
+ "kind": "symbol",
256267
+ "name": "BaseStencil",
256268
+ "typeParameters": [
256269
+ {
256270
+ "kind": "primitive",
256271
+ "value": "any"
256272
+ },
256273
+ {
256274
+ "kind": "primitive",
256275
+ "value": "any"
256276
+ },
256277
+ {
256278
+ "kind": "primitive",
256279
+ "value": "any"
256280
+ },
256281
+ {
256282
+ "kind": "primitive",
256283
+ "value": "any"
256284
+ }
256285
+ ],
256286
+ "value": "BaseStencil<M, V, E, ID>"
256287
+ },
256288
+ "required": false
256289
+ },
255588
256290
  {
255589
256291
  "kind": "typeParameter",
255590
256292
  "name": "ID",
@@ -255615,12 +256317,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255615
256317
  "kind": "generic",
255616
256318
  "name": "V"
255617
256319
  },
256320
+ {
256321
+ "kind": "generic",
256322
+ "name": "E"
256323
+ },
255618
256324
  {
255619
256325
  "kind": "generic",
255620
256326
  "name": "ID"
255621
256327
  }
255622
256328
  ],
255623
- "value": "StencilConfig<M, V, ID>"
256329
+ "value": "StencilConfig<M, V, E, ID>"
255624
256330
  },
255625
256331
  "required": true,
255626
256332
  "rest": false,
@@ -255665,12 +256371,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
255665
256371
  "kind": "generic",
255666
256372
  "name": "V"
255667
256373
  },
256374
+ {
256375
+ "kind": "generic",
256376
+ "name": "E"
256377
+ },
255668
256378
  {
255669
256379
  "kind": "generic",
255670
256380
  "name": "ID"
255671
256381
  }
255672
256382
  ],
255673
- "value": "Stencil<M, V, ID>"
256383
+ "value": "Stencil<M, V, E, ID>"
255674
256384
  }
255675
256385
  }
255676
256386
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workday/canvas-kit-docs",
3
- "version": "11.0.0-alpha.708-next.0",
3
+ "version": "11.0.0-alpha.711-next.0",
4
4
  "description": "Documentation components of Canvas Kit components",
5
5
  "author": "Workday, Inc. (https://www.workday.com)",
6
6
  "license": "Apache-2.0",
@@ -44,10 +44,10 @@
44
44
  "dependencies": {
45
45
  "@emotion/styled": "^11.6.0",
46
46
  "@storybook/csf": "0.0.1",
47
- "@workday/canvas-kit-labs-react": "^11.0.0-alpha.708-next.0",
48
- "@workday/canvas-kit-preview-react": "^11.0.0-alpha.708-next.0",
49
- "@workday/canvas-kit-react": "^11.0.0-alpha.708-next.0",
50
- "@workday/canvas-kit-styling": "^11.0.0-alpha.708-next.0",
47
+ "@workday/canvas-kit-labs-react": "^11.0.0-alpha.711-next.0",
48
+ "@workday/canvas-kit-preview-react": "^11.0.0-alpha.711-next.0",
49
+ "@workday/canvas-kit-react": "^11.0.0-alpha.711-next.0",
50
+ "@workday/canvas-kit-styling": "^11.0.0-alpha.711-next.0",
51
51
  "@workday/canvas-system-icons-web": "^3.0.0",
52
52
  "@workday/canvas-tokens-web": "^1.0.2",
53
53
  "markdown-to-jsx": "^6.10.3",
@@ -59,5 +59,5 @@
59
59
  "mkdirp": "^1.0.3",
60
60
  "typescript": "4.2"
61
61
  },
62
- "gitHead": "c88b748b4f8ad105e0cc48bd7b67716841abe30d"
62
+ "gitHead": "1dc9ed8928cfa20e36933a878d798660ef07dde5"
63
63
  }