Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add API docs for fast-components #3321

Merged
merged 7 commits into from
Jun 16, 2020
Merged

chore: add API docs for fast-components #3321

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
299d9fb
Document component implementations
nicholasrice Jun 16, 2020
bc696d1
document recipes
nicholasrice Jun 16, 2020
d2c1d40
update the rest of the elements
nicholasrice Jun 16, 2020
c0b6cb5
update site
nicholasrice Jun 16, 2020
7b5b7d7
wire docs to ci
nicholasrice Jun 16, 2020
547f125
Merge branch 'master' into users/nirice/document-fast-components
nicholasrice Jun 16, 2020
1bcccb4
pretty pretty
nicholasrice Jun 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update site
  • Loading branch information
@nicholasrice
nicholasrice committed Jun 16, 2020
commit c0b6cb59c778d3767e52c79cf036aaab684cff02
61 changes: 8 additions & 53 deletions sites/website/src/docs/api/fast-components.api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@
{
"kind": "Function",
"canonicalReference": "@microsoft/fast-components!createColorPalette:function(1)",
"docComment": "/**\n * Creates a color palette from a provided source color\n *\n * @param baseColor - \n *\n * @returns {string[]}\n */\n",
"docComment": "/**\n * Creates a color palette from a provided source color\n *\n * @param baseColor - ColorRGBA64\n *\n * @returns string[]\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down Expand Up @@ -555,7 +555,7 @@
{
"kind": "Class",
"canonicalReference": "@microsoft/fast-components!FASTAccordion:class",
"docComment": "",
"docComment": "/**\n * The FAST Accordion Element. Implements {@link @microsoft/fast-foundation#Accordion}, {@link @microsoft/fast-foundation#AccordionTemplate}\n *\n * @remarks\n *\n * HTML Element: \\<fast-accordion\\>\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down Expand Up @@ -583,7 +583,7 @@
{
"kind": "Class",
"canonicalReference": "@microsoft/fast-components!FASTAccordionItem:class",
"docComment": "",
"docComment": "/**\n * The FAST Accordion Item Element. Implements {@link @microsoft/fast-foundation#AccordionItem}, {@link @microsoft/fast-foundation#AccordionItemTemplate}\n *\n * @remarks\n *\n * HTML Element: \\<fast-accordion-item\\>\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down Expand Up @@ -611,7 +611,7 @@
{
"kind": "Class",
"canonicalReference": "@microsoft/fast-components!FASTAnchor:class",
"docComment": "",
"docComment": "/**\n * The FAST Anchor Element. Implements {@link @microsoft/fast-foundation#Anchor}, {@link @microsoft/fast-foundation#AnchorTemplate}\n *\n * @remarks\n *\n * HTML Element: \\<fast-anchor\\>\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down Expand Up @@ -639,7 +639,7 @@
{
"kind": "Class",
"canonicalReference": "@microsoft/fast-components!FASTBadge:class",
"docComment": "",
"docComment": "/**\n * The FAST Badge Element. Implements {@link @microsoft/fast-foundation#Badge}, {@link @microsoft/fast-foundation#BadgeTemplate}\n *\n * @remarks\n *\n * HTML Element: \\<fast-badge\\>\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down Expand Up @@ -667,7 +667,7 @@
{
"kind": "Class",
"canonicalReference": "@microsoft/fast-components!FASTButton:class",
"docComment": "",
"docComment": "/**\n * The FAST Button Element. Implements {@link @microsoft/fast-foundation#Button}, {@link @microsoft/fast-foundation#ButtonTemplate}\n *\n * @remarks\n *\n * HTML Element: \\<fast-button\\>\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down Expand Up @@ -695,7 +695,7 @@
{
"kind": "Class",
"canonicalReference": "@microsoft/fast-components!FASTCard:class",
"docComment": "",
"docComment": "/**\n * The FAST Card Element. Implements {@link @microsoft/fast-foundation#Card}, {@link @microsoft/fast-foundation#CardTemplate}\n *\n * @remarks\n *\n * HTML Element: \\<fast-card\\>\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down Expand Up @@ -723,7 +723,7 @@
{
"kind": "Class",
"canonicalReference": "@microsoft/fast-components!FASTCheckbox:class",
"docComment": "",
"docComment": "/**\n * The FAST Checkbox Element. Implements {@link @microsoft/fast-foundation#Checkbox}, {@link @microsoft/fast-foundation#CheckboxTemplate}\n *\n * @remarks\n *\n * HTML Element: \\<fast-checkbox\\>\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down Expand Up @@ -4848,51 +4848,6 @@
"endIndex": 3
}
},
{
"kind": "Function",
"canonicalReference": "@microsoft/fast-components!neutralFillCard:function(2)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function neutralFillCard(backgroundResolver: "
},
{
"kind": "Reference",
"text": "SwatchResolver",
"canonicalReference": "@microsoft/fast-components!SwatchResolver:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SwatchResolver",
"canonicalReference": "@microsoft/fast-components!SwatchResolver:type"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "backgroundResolver",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "neutralFillCard"
},
{
"kind": "Variable",
"canonicalReference": "@microsoft/fast-components!neutralFillCardRestBehavior:var",
Expand Down