@fluentui/web-components 3.0.0-alpha.12 → 3.0.0-alpha.13

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 (32) hide show
  1. package/CHANGELOG.json +22 -1
  2. package/CHANGELOG.md +12 -2
  3. package/dist/dts/button/button.d.ts +55 -0
  4. package/dist/dts/button/button.definition.d.ts +10 -0
  5. package/dist/dts/button/button.options.d.ts +46 -0
  6. package/dist/dts/button/button.styles.d.ts +1 -0
  7. package/dist/dts/button/button.template.d.ts +7 -0
  8. package/dist/dts/button/define.d.ts +1 -0
  9. package/dist/dts/button/index.d.ts +5 -0
  10. package/dist/dts/index.d.ts +1 -0
  11. package/dist/esm/button/button.definition.js +21 -0
  12. package/dist/esm/button/button.definition.js.map +1 -0
  13. package/dist/esm/button/button.js +72 -0
  14. package/dist/esm/button/button.js.map +1 -0
  15. package/dist/esm/button/button.options.js +30 -0
  16. package/dist/esm/button/button.options.js.map +1 -0
  17. package/dist/esm/button/button.styles.js +253 -0
  18. package/dist/esm/button/button.styles.js.map +1 -0
  19. package/dist/esm/button/button.template.js +7 -0
  20. package/dist/esm/button/button.template.js.map +1 -0
  21. package/dist/esm/button/define.js +4 -0
  22. package/dist/esm/button/define.js.map +1 -0
  23. package/dist/esm/button/index.js +6 -0
  24. package/dist/esm/button/index.js.map +1 -0
  25. package/dist/esm/index.js +1 -0
  26. package/dist/esm/index.js.map +1 -1
  27. package/dist/fluent-web-components.api.json +595 -0
  28. package/dist/web-components.d.ts +126 -0
  29. package/dist/web-components.js +361 -20
  30. package/dist/web-components.min.js +136 -132
  31. package/docs/api-report.md +60 -0
  32. package/package.json +7 -3
package/dist/fluent-web-components.api.json CHANGED
@@ -1998,6 +1998,601 @@
1998
1998
  "endIndex": 4
1999
1999
  }
2000
2000
  },
2001
+ {
2002
+ "kind": "Class",
2003
+ "canonicalReference": "@fluentui/web-components!Button:class",
2004
+ "docComment": "/**\n * The base class used for constructing a fluent-button custom element\n *\n * @public\n */\n",
2005
+ "excerptTokens": [
2006
+ {
2007
+ "kind": "Content",
2008
+ "text": "export declare class Button extends "
2009
+ },
2010
+ {
2011
+ "kind": "Reference",
2012
+ "text": "FASTButton",
2013
+ "canonicalReference": "@microsoft/fast-foundation!FASTButton:class"
2014
+ },
2015
+ {
2016
+ "kind": "Content",
2017
+ "text": " "
2018
+ }
2019
+ ],
2020
+ "releaseTag": "Public",
2021
+ "name": "Button",
2022
+ "preserveMemberOrder": false,
2023
+ "members": [
2024
+ {
2025
+ "kind": "Property",
2026
+ "canonicalReference": "@fluentui/web-components!Button#appearance:member",
2027
+ "docComment": "/**\n * The appearance the button should have.\n *\n * @remarks\n *\n * HTML Attribute: appearance\n *\n * @public\n */\n",
2028
+ "excerptTokens": [
2029
+ {
2030
+ "kind": "Content",
2031
+ "text": "appearance?: "
2032
+ },
2033
+ {
2034
+ "kind": "Reference",
2035
+ "text": "ButtonAppearance",
2036
+ "canonicalReference": "@fluentui/web-components!ButtonAppearance:type"
2037
+ },
2038
+ {
2039
+ "kind": "Content",
2040
+ "text": " | undefined"
2041
+ },
2042
+ {
2043
+ "kind": "Content",
2044
+ "text": ";"
2045
+ }
2046
+ ],
2047
+ "isReadonly": false,
2048
+ "isOptional": true,
2049
+ "releaseTag": "Public",
2050
+ "name": "appearance",
2051
+ "propertyTypeTokenRange": {
2052
+ "startIndex": 1,
2053
+ "endIndex": 3
2054
+ },
2055
+ "isStatic": false,
2056
+ "isProtected": false
2057
+ },
2058
+ {
2059
+ "kind": "Method",
2060
+ "canonicalReference": "@fluentui/web-components!Button#connectedCallback:member(1)",
2061
+ "docComment": "",
2062
+ "excerptTokens": [
2063
+ {
2064
+ "kind": "Content",
2065
+ "text": "connectedCallback(): "
2066
+ },
2067
+ {
2068
+ "kind": "Content",
2069
+ "text": "void"
2070
+ },
2071
+ {
2072
+ "kind": "Content",
2073
+ "text": ";"
2074
+ }
2075
+ ],
2076
+ "isStatic": false,
2077
+ "returnTypeTokenRange": {
2078
+ "startIndex": 1,
2079
+ "endIndex": 2
2080
+ },
2081
+ "releaseTag": "Public",
2082
+ "isProtected": false,
2083
+ "overloadIndex": 1,
2084
+ "parameters": [],
2085
+ "isOptional": false,
2086
+ "name": "connectedCallback"
2087
+ },
2088
+ {
2089
+ "kind": "Property",
2090
+ "canonicalReference": "@fluentui/web-components!Button#disabledFocusable:member",
2091
+ "docComment": "/**\n * The button is disabled but focusable\n *\n * @remarks\n *\n * HTML Attribute: disabled-focusable\n *\n * @public\n */\n",
2092
+ "excerptTokens": [
2093
+ {
2094
+ "kind": "Content",
2095
+ "text": "disabledFocusable?: "
2096
+ },
2097
+ {
2098
+ "kind": "Content",
2099
+ "text": "boolean"
2100
+ },
2101
+ {
2102
+ "kind": "Content",
2103
+ "text": ";"
2104
+ }
2105
+ ],
2106
+ "isReadonly": false,
2107
+ "isOptional": true,
2108
+ "releaseTag": "Public",
2109
+ "name": "disabledFocusable",
2110
+ "propertyTypeTokenRange": {
2111
+ "startIndex": 1,
2112
+ "endIndex": 2
2113
+ },
2114
+ "isStatic": false,
2115
+ "isProtected": false
2116
+ },
2117
+ {
2118
+ "kind": "Method",
2119
+ "canonicalReference": "@fluentui/web-components!Button#disabledFocusableChanged:member(1)",
2120
+ "docComment": "",
2121
+ "excerptTokens": [
2122
+ {
2123
+ "kind": "Content",
2124
+ "text": "protected disabledFocusableChanged(prev: "
2125
+ },
2126
+ {
2127
+ "kind": "Content",
2128
+ "text": "boolean"
2129
+ },
2130
+ {
2131
+ "kind": "Content",
2132
+ "text": ", next: "
2133
+ },
2134
+ {
2135
+ "kind": "Content",
2136
+ "text": "boolean"
2137
+ },
2138
+ {
2139
+ "kind": "Content",
2140
+ "text": "): "
2141
+ },
2142
+ {
2143
+ "kind": "Content",
2144
+ "text": "void"
2145
+ },
2146
+ {
2147
+ "kind": "Content",
2148
+ "text": ";"
2149
+ }
2150
+ ],
2151
+ "isStatic": false,
2152
+ "returnTypeTokenRange": {
2153
+ "startIndex": 5,
2154
+ "endIndex": 6
2155
+ },
2156
+ "releaseTag": "Public",
2157
+ "isProtected": true,
2158
+ "overloadIndex": 1,
2159
+ "parameters": [
2160
+ {
2161
+ "parameterName": "prev",
2162
+ "parameterTypeTokenRange": {
2163
+ "startIndex": 1,
2164
+ "endIndex": 2
2165
+ },
2166
+ "isOptional": false
2167
+ },
2168
+ {
2169
+ "parameterName": "next",
2170
+ "parameterTypeTokenRange": {
2171
+ "startIndex": 3,
2172
+ "endIndex": 4
2173
+ },
2174
+ "isOptional": false
2175
+ }
2176
+ ],
2177
+ "isOptional": false,
2178
+ "name": "disabledFocusableChanged"
2179
+ },
2180
+ {
2181
+ "kind": "Method",
2182
+ "canonicalReference": "@fluentui/web-components!Button#disconnectedCallback:member(1)",
2183
+ "docComment": "",
2184
+ "excerptTokens": [
2185
+ {
2186
+ "kind": "Content",
2187
+ "text": "disconnectedCallback(): "
2188
+ },
2189
+ {
2190
+ "kind": "Content",
2191
+ "text": "void"
2192
+ },
2193
+ {
2194
+ "kind": "Content",
2195
+ "text": ";"
2196
+ }
2197
+ ],
2198
+ "isStatic": false,
2199
+ "returnTypeTokenRange": {
2200
+ "startIndex": 1,
2201
+ "endIndex": 2
2202
+ },
2203
+ "releaseTag": "Public",
2204
+ "isProtected": false,
2205
+ "overloadIndex": 1,
2206
+ "parameters": [],
2207
+ "isOptional": false,
2208
+ "name": "disconnectedCallback"
2209
+ },
2210
+ {
2211
+ "kind": "Property",
2212
+ "canonicalReference": "@fluentui/web-components!Button#iconOnly:member",
2213
+ "docComment": "/**\n * The button has an icon only, no text content\n *\n * @remarks\n *\n * HTML Attribute: icon-only\n *\n * @public\n */\n",
2214
+ "excerptTokens": [
2215
+ {
2216
+ "kind": "Content",
2217
+ "text": "iconOnly: "
2218
+ },
2219
+ {
2220
+ "kind": "Content",
2221
+ "text": "boolean"
2222
+ },
2223
+ {
2224
+ "kind": "Content",
2225
+ "text": ";"
2226
+ }
2227
+ ],
2228
+ "isReadonly": false,
2229
+ "isOptional": false,
2230
+ "releaseTag": "Public",
2231
+ "name": "iconOnly",
2232
+ "propertyTypeTokenRange": {
2233
+ "startIndex": 1,
2234
+ "endIndex": 2
2235
+ },
2236
+ "isStatic": false,
2237
+ "isProtected": false
2238
+ },
2239
+ {
2240
+ "kind": "Property",
2241
+ "canonicalReference": "@fluentui/web-components!Button#shape:member",
2242
+ "docComment": "/**\n * The shape the button should have.\n *\n * @remarks\n *\n * HTML Attribute: shape\n *\n * @public\n */\n",
2243
+ "excerptTokens": [
2244
+ {
2245
+ "kind": "Content",
2246
+ "text": "shape?: "
2247
+ },
2248
+ {
2249
+ "kind": "Reference",
2250
+ "text": "ButtonShape",
2251
+ "canonicalReference": "@fluentui/web-components!ButtonShape:type"
2252
+ },
2253
+ {
2254
+ "kind": "Content",
2255
+ "text": " | undefined"
2256
+ },
2257
+ {
2258
+ "kind": "Content",
2259
+ "text": ";"
2260
+ }
2261
+ ],
2262
+ "isReadonly": false,
2263
+ "isOptional": true,
2264
+ "releaseTag": "Public",
2265
+ "name": "shape",
2266
+ "propertyTypeTokenRange": {
2267
+ "startIndex": 1,
2268
+ "endIndex": 3
2269
+ },
2270
+ "isStatic": false,
2271
+ "isProtected": false
2272
+ },
2273
+ {
2274
+ "kind": "Property",
2275
+ "canonicalReference": "@fluentui/web-components!Button#size:member",
2276
+ "docComment": "/**\n * The size the button should have.\n *\n * @remarks\n *\n * HTML Attribute: size\n *\n * @public\n */\n",
2277
+ "excerptTokens": [
2278
+ {
2279
+ "kind": "Content",
2280
+ "text": "size?: "
2281
+ },
2282
+ {
2283
+ "kind": "Reference",
2284
+ "text": "ButtonSize",
2285
+ "canonicalReference": "@fluentui/web-components!ButtonSize:type"
2286
+ },
2287
+ {
2288
+ "kind": "Content",
2289
+ "text": ";"
2290
+ }
2291
+ ],
2292
+ "isReadonly": false,
2293
+ "isOptional": true,
2294
+ "releaseTag": "Public",
2295
+ "name": "size",
2296
+ "propertyTypeTokenRange": {
2297
+ "startIndex": 1,
2298
+ "endIndex": 2
2299
+ },
2300
+ "isStatic": false,
2301
+ "isProtected": false
2302
+ }
2303
+ ],
2304
+ "extendsTokenRange": {
2305
+ "startIndex": 1,
2306
+ "endIndex": 2
2307
+ },
2308
+ "implementsTokenRanges": []
2309
+ },
2310
+ {
2311
+ "kind": "TypeAlias",
2312
+ "canonicalReference": "@fluentui/web-components!ButtonAppearance:type",
2313
+ "docComment": "/**\n * A Button can be secondary, primary, outline, subtle, transparent\n *\n * @public\n */\n",
2314
+ "excerptTokens": [
2315
+ {
2316
+ "kind": "Content",
2317
+ "text": "export declare type ButtonAppearance = "
2318
+ },
2319
+ {
2320
+ "kind": "Reference",
2321
+ "text": "ValuesOf",
2322
+ "canonicalReference": "@microsoft/fast-foundation!ValuesOf:type"
2323
+ },
2324
+ {
2325
+ "kind": "Content",
2326
+ "text": "<typeof "
2327
+ },
2328
+ {
2329
+ "kind": "Reference",
2330
+ "text": "ButtonAppearance",
2331
+ "canonicalReference": "@fluentui/web-components!ButtonAppearance:var"
2332
+ },
2333
+ {
2334
+ "kind": "Content",
2335
+ "text": ">"
2336
+ },
2337
+ {
2338
+ "kind": "Content",
2339
+ "text": ";"
2340
+ }
2341
+ ],
2342
+ "releaseTag": "Public",
2343
+ "name": "ButtonAppearance",
2344
+ "typeTokenRange": {
2345
+ "startIndex": 1,
2346
+ "endIndex": 5
2347
+ }
2348
+ },
2349
+ {
2350
+ "kind": "Variable",
2351
+ "canonicalReference": "@fluentui/web-components!ButtonAppearance:var",
2352
+ "docComment": "/**\n * ButtonAppearance constants\n *\n * @public\n */\n",
2353
+ "excerptTokens": [
2354
+ {
2355
+ "kind": "Content",
2356
+ "text": "ButtonAppearance: "
2357
+ },
2358
+ {
2359
+ "kind": "Content",
2360
+ "text": "{\n readonly primary: \"primary\";\n readonly outline: \"outline\";\n readonly subtle: \"subtle\";\n readonly secondary: \"secondary\";\n readonly transparent: \"transparent\";\n}"
2361
+ }
2362
+ ],
2363
+ "isReadonly": true,
2364
+ "releaseTag": "Public",
2365
+ "name": "ButtonAppearance",
2366
+ "variableTypeTokenRange": {
2367
+ "startIndex": 1,
2368
+ "endIndex": 2
2369
+ }
2370
+ },
2371
+ {
2372
+ "kind": "Variable",
2373
+ "canonicalReference": "@fluentui/web-components!ButtonDefinition:var",
2374
+ "docComment": "/**\n * The Fluent Button Element. Implements {@link @microsoft/fast-foundation#Button}, {@link @microsoft/fast-foundation#buttonTemplate}\n *\n * @remarks\n *\n * HTML Element: \\<fluent-button\\>\n *\n * @public\n */\n",
2375
+ "excerptTokens": [
2376
+ {
2377
+ "kind": "Content",
2378
+ "text": "definition: "
2379
+ },
2380
+ {
2381
+ "kind": "Content",
2382
+ "text": "import(\"@microsoft/fast-element\")."
2383
+ },
2384
+ {
2385
+ "kind": "Reference",
2386
+ "text": "FASTElementDefinition",
2387
+ "canonicalReference": "@microsoft/fast-element!FASTElementDefinition:class"
2388
+ },
2389
+ {
2390
+ "kind": "Content",
2391
+ "text": "<typeof "
2392
+ },
2393
+ {
2394
+ "kind": "Reference",
2395
+ "text": "Button",
2396
+ "canonicalReference": "@fluentui/web-components!Button:class"
2397
+ },
2398
+ {
2399
+ "kind": "Content",
2400
+ "text": ">"
2401
+ }
2402
+ ],
2403
+ "isReadonly": true,
2404
+ "releaseTag": "Public",
2405
+ "name": "ButtonDefinition",
2406
+ "variableTypeTokenRange": {
2407
+ "startIndex": 1,
2408
+ "endIndex": 6
2409
+ }
2410
+ },
2411
+ {
2412
+ "kind": "TypeAlias",
2413
+ "canonicalReference": "@fluentui/web-components!ButtonShape:type",
2414
+ "docComment": "/**\n * A Button can be square, circular or rounded\n *\n * @public\n */\n",
2415
+ "excerptTokens": [
2416
+ {
2417
+ "kind": "Content",
2418
+ "text": "export declare type ButtonShape = "
2419
+ },
2420
+ {
2421
+ "kind": "Reference",
2422
+ "text": "ValuesOf",
2423
+ "canonicalReference": "@microsoft/fast-foundation!ValuesOf:type"
2424
+ },
2425
+ {
2426
+ "kind": "Content",
2427
+ "text": "<typeof "
2428
+ },
2429
+ {
2430
+ "kind": "Reference",
2431
+ "text": "ButtonShape",
2432
+ "canonicalReference": "@fluentui/web-components!ButtonShape:var"
2433
+ },
2434
+ {
2435
+ "kind": "Content",
2436
+ "text": ">"
2437
+ },
2438
+ {
2439
+ "kind": "Content",
2440
+ "text": ";"
2441
+ }
2442
+ ],
2443
+ "releaseTag": "Public",
2444
+ "name": "ButtonShape",
2445
+ "typeTokenRange": {
2446
+ "startIndex": 1,
2447
+ "endIndex": 5
2448
+ }
2449
+ },
2450
+ {
2451
+ "kind": "Variable",
2452
+ "canonicalReference": "@fluentui/web-components!ButtonShape:var",
2453
+ "docComment": "/**\n * A Button can be square, circular or rounded.\n *\n * @public\n */\n",
2454
+ "excerptTokens": [
2455
+ {
2456
+ "kind": "Content",
2457
+ "text": "ButtonShape: "
2458
+ },
2459
+ {
2460
+ "kind": "Content",
2461
+ "text": "{\n readonly circular: \"circular\";\n readonly rounded: \"rounded\";\n readonly square: \"square\";\n}"
2462
+ }
2463
+ ],
2464
+ "isReadonly": true,
2465
+ "releaseTag": "Public",
2466
+ "name": "ButtonShape",
2467
+ "variableTypeTokenRange": {
2468
+ "startIndex": 1,
2469
+ "endIndex": 2
2470
+ }
2471
+ },
2472
+ {
2473
+ "kind": "TypeAlias",
2474
+ "canonicalReference": "@fluentui/web-components!ButtonSize:type",
2475
+ "docComment": "/**\n * A Button can be on of several preset sizes.\n *\n * @public\n */\n",
2476
+ "excerptTokens": [
2477
+ {
2478
+ "kind": "Content",
2479
+ "text": "export declare type ButtonSize = "
2480
+ },
2481
+ {
2482
+ "kind": "Reference",
2483
+ "text": "ValuesOf",
2484
+ "canonicalReference": "@microsoft/fast-foundation!ValuesOf:type"
2485
+ },
2486
+ {
2487
+ "kind": "Content",
2488
+ "text": "<typeof "
2489
+ },
2490
+ {
2491
+ "kind": "Reference",
2492
+ "text": "ButtonSize",
2493
+ "canonicalReference": "@fluentui/web-components!ButtonSize:var"
2494
+ },
2495
+ {
2496
+ "kind": "Content",
2497
+ "text": ">"
2498
+ },
2499
+ {
2500
+ "kind": "Content",
2501
+ "text": ";"
2502
+ }
2503
+ ],
2504
+ "releaseTag": "Public",
2505
+ "name": "ButtonSize",
2506
+ "typeTokenRange": {
2507
+ "startIndex": 1,
2508
+ "endIndex": 5
2509
+ }
2510
+ },
2511
+ {
2512
+ "kind": "Variable",
2513
+ "canonicalReference": "@fluentui/web-components!ButtonSize:var",
2514
+ "docComment": "/**\n * A Button can be a size of small, medium or large.\n *\n * @public\n */\n",
2515
+ "excerptTokens": [
2516
+ {
2517
+ "kind": "Content",
2518
+ "text": "ButtonSize: "
2519
+ },
2520
+ {
2521
+ "kind": "Content",
2522
+ "text": "{\n readonly small: \"small\";\n readonly medium: \"medium\";\n readonly large: \"large\";\n}"
2523
+ }
2524
+ ],
2525
+ "isReadonly": true,
2526
+ "releaseTag": "Public",
2527
+ "name": "ButtonSize",
2528
+ "variableTypeTokenRange": {
2529
+ "startIndex": 1,
2530
+ "endIndex": 2
2531
+ }
2532
+ },
2533
+ {
2534
+ "kind": "Variable",
2535
+ "canonicalReference": "@fluentui/web-components!ButtonStyles:var",
2536
+ "docComment": "",
2537
+ "excerptTokens": [
2538
+ {
2539
+ "kind": "Content",
2540
+ "text": "styles: "
2541
+ },
2542
+ {
2543
+ "kind": "Content",
2544
+ "text": "import(\"@microsoft/fast-element\")."
2545
+ },
2546
+ {
2547
+ "kind": "Reference",
2548
+ "text": "ElementStyles",
2549
+ "canonicalReference": "@microsoft/fast-element!ElementStyles:class"
2550
+ }
2551
+ ],
2552
+ "isReadonly": true,
2553
+ "releaseTag": "Public",
2554
+ "name": "ButtonStyles",
2555
+ "variableTypeTokenRange": {
2556
+ "startIndex": 1,
2557
+ "endIndex": 3
2558
+ }
2559
+ },
2560
+ {
2561
+ "kind": "Variable",
2562
+ "canonicalReference": "@fluentui/web-components!ButtonTemplate:var",
2563
+ "docComment": "/**\n * The template for the Button component.\n *\n * @public\n */\n",
2564
+ "excerptTokens": [
2565
+ {
2566
+ "kind": "Content",
2567
+ "text": "template: "
2568
+ },
2569
+ {
2570
+ "kind": "Reference",
2571
+ "text": "ElementViewTemplate",
2572
+ "canonicalReference": "@microsoft/fast-element!ElementViewTemplate:interface"
2573
+ },
2574
+ {
2575
+ "kind": "Content",
2576
+ "text": "<"
2577
+ },
2578
+ {
2579
+ "kind": "Reference",
2580
+ "text": "Button",
2581
+ "canonicalReference": "@fluentui/web-components!Button:class"
2582
+ },
2583
+ {
2584
+ "kind": "Content",
2585
+ "text": ">"
2586
+ }
2587
+ ],
2588
+ "isReadonly": true,
2589
+ "releaseTag": "Public",
2590
+ "name": "ButtonTemplate",
2591
+ "variableTypeTokenRange": {
2592
+ "startIndex": 1,
2593
+ "endIndex": 5
2594
+ }
2595
+ },
2001
2596
  {
2002
2597
  "kind": "Variable",
2003
2598
  "canonicalReference": "@fluentui/web-components!colorBackgroundOverlay:var",