@fluentui/web-components 3.0.0-alpha.23 → 3.0.0-alpha.25

package/dist/fluent-web-components.api.json

@@ -3226,6 +3226,412 @@
             "endIndex": 5
           }
         },
+        {
+          "kind": "Class",
+          "canonicalReference": "@fluentui/web-components!Checkbox:class",
+          "docComment": "/**\n * The base class used for constucting a fluent checkbox custom element\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class Checkbox extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "FASTCheckbox",
+              "canonicalReference": "@microsoft/fast-foundation!FASTCheckbox:class"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "Checkbox",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Property",
+              "canonicalReference": "@fluentui/web-components!Checkbox#labelPosition:member",
+              "docComment": "/**\n * Sets position of the label relative to the input\n *\n * @default 'after'\n *\n * @remarks\n *\n * HTML Attribute: label-position\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "labelPosition?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CheckboxLabelPosition",
+                  "canonicalReference": "@fluentui/web-components!CheckboxLabelPosition:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "labelPosition",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@fluentui/web-components!Checkbox#shape:member",
+              "docComment": "/**\n * Sets shape of the checkbox.\n *\n * @default 'square'\n *\n * @remarks\n *\n * HTML Attribute: shape\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "shape?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CheckboxShape",
+                  "canonicalReference": "@fluentui/web-components!CheckboxShape:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "shape",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@fluentui/web-components!Checkbox#size:member",
+              "docComment": "/**\n * Sets size of the checkbox.\n *\n * @default 'medium'\n *\n * @remarks\n *\n * HTML Attribute: size\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "size?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CheckboxSize",
+                  "canonicalReference": "@fluentui/web-components!CheckboxSize:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "size",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@fluentui/web-components!CheckboxDefinition:var",
+          "docComment": "/**\n * The Fluent Checkbox Element\n *\n * @remarks\n *\n * HTML Element: \\<fluent-checkbox\\>\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "definition: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@microsoft/fast-element\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "FASTElementDefinition",
+              "canonicalReference": "@microsoft/fast-element!FASTElementDefinition:class"
+            },
+            {
+              "kind": "Content",
+              "text": "<typeof "
+            },
+            {
+              "kind": "Reference",
+              "text": "Checkbox",
+              "canonicalReference": "@fluentui/web-components!Checkbox:class"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "CheckboxDefinition",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@fluentui/web-components!CheckboxLabelPosition:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare type CheckboxLabelPosition = "
+            },
+            {
+              "kind": "Reference",
+              "text": "ValuesOf",
+              "canonicalReference": "@microsoft/fast-foundation!ValuesOf:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<typeof "
+            },
+            {
+              "kind": "Reference",
+              "text": "CheckboxLabelPosition",
+              "canonicalReference": "@fluentui/web-components!CheckboxLabelPosition:var"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "CheckboxLabelPosition",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@fluentui/web-components!CheckboxLabelPosition:var",
+          "docComment": "/**\n * Checkbox label position\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "CheckboxLabelPosition: "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    readonly before: \"before\";\n    readonly after: \"after\";\n}"
+            }
+          ],
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "CheckboxLabelPosition",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@fluentui/web-components!CheckboxShape:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare type CheckboxShape = "
+            },
+            {
+              "kind": "Reference",
+              "text": "ValuesOf",
+              "canonicalReference": "@microsoft/fast-foundation!ValuesOf:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<typeof "
+            },
+            {
+              "kind": "Reference",
+              "text": "CheckboxShape",
+              "canonicalReference": "@fluentui/web-components!CheckboxShape:var"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "CheckboxShape",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@fluentui/web-components!CheckboxShape:var",
+          "docComment": "/**\n * Checkbox shape\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "CheckboxShape: "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    readonly circular: \"circular\";\n    readonly square: \"square\";\n}"
+            }
+          ],
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "CheckboxShape",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@fluentui/web-components!CheckboxSize:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare type CheckboxSize = "
+            },
+            {
+              "kind": "Reference",
+              "text": "ValuesOf",
+              "canonicalReference": "@microsoft/fast-foundation!ValuesOf:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<typeof "
+            },
+            {
+              "kind": "Reference",
+              "text": "CheckboxSize",
+              "canonicalReference": "@fluentui/web-components!CheckboxSize:var"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "CheckboxSize",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@fluentui/web-components!CheckboxSize:var",
+          "docComment": "/**\n * Checkbox size\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "CheckboxSize: "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    readonly medium: \"medium\";\n    readonly large: \"large\";\n}"
+            }
+          ],
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "CheckboxSize",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@fluentui/web-components!CheckboxStyles:var",
+          "docComment": "/**\n * Checkbox styles\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "styles: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@microsoft/fast-element\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ElementStyles",
+              "canonicalReference": "@microsoft/fast-element!ElementStyles:class"
+            }
+          ],
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "CheckboxStyles",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@fluentui/web-components!CheckboxTemplate:var",
+          "docComment": "/**\n * Template for the Checkbox component\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "template: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ElementViewTemplate",
+              "canonicalReference": "@microsoft/fast-element!ElementViewTemplate:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Checkbox",
+              "canonicalReference": "@fluentui/web-components!Checkbox:class"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "CheckboxTemplate",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@fluentui/web-components!colorBackgroundOverlay:var",
@@ -14287,6 +14693,42 @@
             "endIndex": 4
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@fluentui/web-components!FluentDesignSystem:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "FluentDesignSystem: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Readonly",
+              "canonicalReference": "!Readonly:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<{\n    prefix: \"fluent\";\n    shadowRootMode: \"open\";\n    registry: "
+            },
+            {
+              "kind": "Reference",
+              "text": "CustomElementRegistry",
+              "canonicalReference": "!CustomElementRegistry:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}>"
+            }
+          ],
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "FluentDesignSystem",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@fluentui/web-components!fontFamilyBase:var",

package/dist/web-components.d.ts

@@ -9,6 +9,7 @@ import { FASTAccordion } from '@microsoft/fast-foundation';
 import { FASTAccordionItem } from '@microsoft/fast-foundation';
 import { FASTAnchor } from '@microsoft/fast-foundation';
 import { FASTButton } from '@microsoft/fast-foundation';
+import { FASTCheckbox } from '@microsoft/fast-foundation';
 import { FASTDivider } from '@microsoft/fast-foundation';
 import { FASTElement } from '@microsoft/fast-element';
 import { FASTElementDefinition } from '@microsoft/fast-element';
@@ -817,6 +818,94 @@ export declare type ButtonSize = ValuesOf<typeof ButtonSize>;
  */
 export declare const ButtonTemplate: ElementViewTemplate<Button>;
 
+/**
+ * The base class used for constucting a fluent checkbox custom element
+ * @public
+ */
+export declare class Checkbox extends FASTCheckbox {
+    /**
+     * Sets shape of the checkbox.
+     *
+     * @public
+     * @default 'square'
+     * @remarks
+     * HTML Attribute: shape
+     */
+    shape?: CheckboxShape;
+    /**
+     * Sets size of the checkbox.
+     *
+     * @public
+     * @default 'medium'
+     * @remarks
+     * HTML Attribute: size
+     */
+    size?: CheckboxSize;
+    /**
+     * Sets position of the label relative to the input
+     *
+     * @public
+     * @default 'after'
+     * @remarks
+     * HTML Attribute: label-position
+     */
+    labelPosition?: CheckboxLabelPosition;
+}
+
+/**
+ * The Fluent Checkbox Element
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fluent-checkbox\>
+ */
+export declare const CheckboxDefinition: FASTElementDefinition<typeof Checkbox>;
+
+/**
+ * Checkbox label position
+ * @public
+ */
+export declare const CheckboxLabelPosition: {
+    readonly before: "before";
+    readonly after: "after";
+};
+
+export declare type CheckboxLabelPosition = ValuesOf<typeof CheckboxLabelPosition>;
+
+/**
+ * Checkbox shape
+ * @public
+ */
+export declare const CheckboxShape: {
+    readonly circular: "circular";
+    readonly square: "square";
+};
+
+export declare type CheckboxShape = ValuesOf<typeof CheckboxShape>;
+
+/**
+ * Checkbox size
+ * @public
+ */
+export declare const CheckboxSize: {
+    readonly medium: "medium";
+    readonly large: "large";
+};
+
+export declare type CheckboxSize = ValuesOf<typeof CheckboxSize>;
+
+/** Checkbox styles
+ *
+ * @public
+ */
+export declare const CheckboxStyles: ElementStyles;
+
+/**
+ * Template for the Checkbox component
+ * @public
+ */
+export declare const CheckboxTemplate: ElementViewTemplate<Checkbox>;
+
 export declare const colorBackgroundOverlay: CSSDesignToken<string>;
 
 export declare const colorBrandBackground: CSSDesignToken<string>;
@@ -1796,6 +1885,12 @@ export declare const durationUltraFast: CSSDesignToken<string>;
 
 export declare const durationUltraSlow: CSSDesignToken<string>;
 
+export declare const FluentDesignSystem: Readonly<{
+    prefix: "fluent";
+    shadowRootMode: "open";
+    registry: CustomElementRegistry;
+}>;
+
 export declare const fontFamilyBase: CSSDesignToken<string>;
 
 export declare const fontFamilyMonospace: CSSDesignToken<string>;