From 4e086429e10c489e84f8c09c791d94f2455c3b5d Mon Sep 17 00:00:00 2001 From: Chris Holt Date: Tue, 16 Jun 2020 18:12:41 -0700 Subject: [PATCH] update api docs --- .../src/docs/api/fast-foundation.api.json | 2362 ++++++++++++++--- 1 file changed, 2039 insertions(+), 323 deletions(-) diff --git a/sites/website/src/docs/api/fast-foundation.api.json b/sites/website/src/docs/api/fast-foundation.api.json index b206ee65689..4c8c89fd93a 100644 --- a/sites/website/src/docs/api/fast-foundation.api.json +++ b/sites/website/src/docs/api/fast-foundation.api.json @@ -18,7 +18,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-foundation!Accordion:class", - "docComment": "/**\n * An Accordion Custom HTML Element Implements {@link https://www.w3.org/TR/wai-aria-practices-1.1/#accordion | ARIA Accordion}.\n *\n * @remarks\n *\n * Designed to be used with {@link @microsoft/fast-foundation#AccordionTemplate} and {@link @microsoft/fast-foundation#(AccordionItem:class)}.\n *\n * @public\n */\n", + "docComment": "/**\n * An Accordion Custom HTML Element Implements {@link https://www.w3.org/TR/wai-aria-practices-1.1/#accordion | ARIA Accordion}.\n *\n * @remarks\n *\n * Designed to be used with {@link @microsoft/fast-foundation#AccordionTemplate} and {@link @microsoft/fast-foundation#AccordionItem}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -40,7 +40,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Accordion#expandmode:member", - "docComment": "/**\n * Controls the expand mode of the Accordion, either allowing single or multiple item expansion.\n *\n * @remarks\n *\n * HTML attribute: expand-mode\n *\n * @public\n */\n", + "docComment": "/**\n * Controls the expand mode of the Accordion, either allowing single or multiple item expansion.\n *\n * @remarks\n *\n * HTML attribute: expand-mode\n *\n * @defaultValue\n *\n * {@link AccordionExpandMode.multi}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -87,7 +87,7 @@ { "kind": "EnumMember", "canonicalReference": "@microsoft/fast-foundation!AccordionExpandMode.multi:member", - "docComment": "/**\n * Designates multiple {@link @microsoft/fast-foundation#(AccordionItem:class) | AccordionItems} can be open simultaneously.\n */\n", + "docComment": "/**\n * Designates multiple {@link @microsoft/fast-foundation#AccordionItem | AccordionItems} can be open simultaneously.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -108,7 +108,7 @@ { "kind": "EnumMember", "canonicalReference": "@microsoft/fast-foundation!AccordionExpandMode.single:member", - "docComment": "/**\n * Designates only a single {@link @microsoft/fast-foundation#(AccordionItem:class)} can be open a time.\n */\n", + "docComment": "/**\n * Designates only a single {@link @microsoft/fast-foundation#AccordionItem} can be open a time.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -131,7 +131,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-foundation!AccordionItem:class", - "docComment": "/**\n * An individual item in an {@link @microsoft/fast-foundation#(Accordion:class)}.\n *\n * @public\n */\n", + "docComment": "/**\n * An individual item in an {@link @microsoft/fast-foundation#Accordion}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -238,7 +238,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-foundation!AccordionItemTemplate:var", - "docComment": "/**\n * The template for the {@link @microsoft/fast-foundation#(AccordionItem:class)} component.\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -277,7 +277,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-foundation!AccordionTemplate:var", - "docComment": "/**\n * The template for the {@link @microsoft/fast-foundation#Accordion} component.\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -610,7 +610,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-foundation!AnchorTemplate:var", - "docComment": "/**\n * The template for the {@link @microsoft/fast-foundation#(Anchor:class)} component.\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -707,7 +707,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-foundation!Badge:class", - "docComment": "/**\n * A Badge Custom HTML Element.\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -729,7 +729,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Badge#circular:member", - "docComment": "/**\n * Indicates the element should be circular\n *\n * @remarks\n *\n * HTML Attribute: circular\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -755,7 +755,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Badge#color:member", - "docComment": "/**\n * Indicates the badge should have a filled style.\n *\n * @remarks\n *\n * HTML Attribute: fill\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -781,7 +781,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Badge#fill:member", - "docComment": "/**\n * Indicates the badge should have a filled style.\n *\n * @remarks\n *\n * HTML Attribute: fill\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -814,7 +814,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-foundation!BadgeTemplate:var", - "docComment": "/**\n * The template for the {@link @microsoft/fast-foundation#Badge} component.\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -853,7 +853,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-foundation!BaseProgress:class", - "docComment": "/**\n * An Progress HTML Element. Implements the {@link https://www.w3.org/TR/wai-aria-1.1/#progressbar | ARIA progressbar}.\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -875,7 +875,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!BaseProgress#max:member", - "docComment": "/**\n * The maximum value\n *\n * @remarks\n *\n * HTML Attribute: max\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -901,7 +901,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!BaseProgress#min:member", - "docComment": "/**\n * The minimum value\n *\n * @remarks\n *\n * HTML Attribute: min\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -927,7 +927,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!BaseProgress#paused:member", - "docComment": "/**\n * Indicates the progress is paused\n *\n * @remarks\n *\n * HTML Attribute: paused\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -953,7 +953,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!BaseProgress#value:member", - "docComment": "/**\n * The value of the progress\n *\n * @remarks\n *\n * HTML Attribute: value\n *\n * @public\n */\n", + "docComment": "", "excerptTokens": [ { "kind": "Content", @@ -986,7 +986,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-foundation!Button:class", - "docComment": "/**\n * An Button Custom HTML Element. Based largely on the {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button |