Skip to content

Commit

Permalink
[web-components] add definition files for Fluent UI Web Components (m…
Browse files Browse the repository at this point in the history 
…icrosoft#18961)

* create and export web component definitions for use with Monaco editor tooling

* Change files
  • Loading branch information
@chrisdholt @PeterDraex
chrisdholt authored and PeterDraex committed Aug 6, 2021
1 parent f3cb028 commit 41c53d0
Show file tree
Hide file tree
Showing 43 changed files with 3,269 additions and 0 deletions.
7 changes: 7 additions & 0 deletions change/@fluentui-web-components-b2c089bc-fb30-4667-9995-0d46720e6f35.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "minor",
"comment": "create and export web component definitions for use with Monaco editor tooling",
"packageName": "@fluentui/web-components",
"email": "chhol@microsoft.com",
"dependentChangeType": "patch"
}
67 changes: 67 additions & 0 deletions packages/web-components/src/accordion/accordion-item/accordion-item.vscode.definition.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
{
"version": 1.1,
"tags": [
{
"name": "fluent-accordion-item",
"title": "Accordion item",
"description": "The Fluent UI accordion item element",
"attributes": [
{
"name": "heading-level",
"title": "Level",
"description": "The aria-level value (1-6) for the item heading, representing its semantic hierarchy",
"type": "number",
"default": 2,
"required": false
},
{
"name": "expanded",
"title": "Expanded",
"description": "The expanded state of the item",
"type": "boolean",
"default": false,
"required": false
},
{
"name": "id",
"title": "ID",
"description": "The HTML ID attribute for the invoking element",
"type": "string",
"required": false
}
],
"slots": [
{
"name": "",
"title": "Default slot",
"description": "The contents of the item"
},
{
"name": "heading",
"title": "Heading slot",
"description": "The heading of the accordion item"
},
{
"name": "start",
"title": "Start slot",
"description": "Contents of the start slot are positioned before the heading"
},
{
"name": "end",
"title": "End slot",
"description": "Contents of the end slot are positioned after the heading and before the expand/collapse icons"
},
{
"name": "expanded-icon",
"title": "Expanded icon slot",
"description": "Slot to provide a custom icon representing the expanded state"
},
{
"name": "collapsed-icon",
"title": "Collapsed icon slot",
"description": "Slot to provide a custom icon representing the collapsed state"
}
]
}
]
}
35 changes: 35 additions & 0 deletions packages/web-components/src/accordion/accordion.vscode.definition.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"version": 1.1,
"tags": [
{
"name": "fluent-accordion",
"title": "Accordion",
"description": "The Fluent UI accordion element",
"attributes": [
{
"name": "expand-mode",
"title": "Expand mode",
"description": "The way items are allowed to expand",
"type": "string",
"values": [
{
"name": "single"
},
{
"name": "multi"
}
],
"default": "multi",
"required": false
}
],
"slots": [
{
"name": "item",
"title": "Item slot",
"description": "The default slot for accordion items"
}
]
}
]
}
138 changes: 138 additions & 0 deletions packages/web-components/src/anchor/anchor.vscode.definition.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
{
"version": 1.1,
"tags": [
{
"name": "fluent-anchor",
"title": "Anchor",
"description": "The Fluent UI anchor element",
"attributes": [
{
"name": "appearance",
"title": "Appearance",
"description": "The anchor's visual treatment",
"type": "string",
"values": [
{
"name": "accent"
},
{
"name": "lightweight"
},
{
"name": "neutral"
},
{
"name": "outline"
},
{
"name": "stealth"
},
{
"name": "hypertext"
}
],
"default": "neutral",
"required": false
},
{
"name": "download",
"title": "Download",
"description": "The HTML download attribute of the anchor",
"type": "string",
"required": false
},
{
"name": "href",
"title": "URL",
"description": "The URL the anchor points to",
"type": "string",
"required": false
},
{
"name": "hreflang",
"title": "Linked page language",
"description": "The language of the URL the anchor points to",
"type": "string",
"required": false
},
{
"name": "ping",
"title": "Ping URLs",
"description": "A space-separated list of URLs typically for tracking",
"type": "string",
"required": false
},
{
"name": "referrerpolicy",
"title": "Referrer policy",
"description": "The amount of referrer information that should be included with requests",
"type": "string",
"required": false,
"values": [
{ "name": "no-referrer" },
{ "name": "no-referrer-when-downgrade" },
{ "name": "origin" },
{ "name": "origin-when-cross-origin" },
{ "name": "same-origin" },
{ "name": "strict-origin" },
{ "name": "strict-origin-when-cross-origin" },
{ "name": "unsafe-url" }
]
},
{
"name": "rel",
"title": "Relationship",
"description": "Space-separated link types indicating the relationship of the linked URL",
"type": "string",
"required": false
},
{
"name": "target",
"title": "Target",
"description": "The display target of the URL",
"type": "string",
"default": "_self",
"values": [
{
"name": "_self"
},
{
"name": "_blank"
},
{
"name": "_parent"
},
{
"name": "_top"
}
],
"required": false
},
{
"name": "type",
"title": "Type",
"description": "The linked URL's format using a MIME type",
"type": "string",
"required": false
}
],
"slots": [
{
"name": "",
"title": "Default slot",
"description": "The content of the anchor"
},
{
"name": "start",
"title": "Start slot",
"description": "Contents of the start slot are positioned before the anchor content"
},
{
"name": "end",
"title": "End slot",
"description": "Contents of the end slot are positioned after the anchor content"
}
]
}
]
}
140 changes: 140 additions & 0 deletions packages/web-components/src/anchored-region/anchored-region.vscode.definition.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
{
"version": 1.1,
"tags": [
{
"name": "fluent-anchored-region",
"title": "Anchored region",
"description": "The Fluent UI anchored region element",
"attributes": [
{
"name": "anchor",
"title": "Anchor ID",
"type": "string",
"description": "The HTML ID of the element the region is positioned relative to",
"required": true
},
{
"name": "viewport",
"title": "Viewport ID",
"description": "The HTML ID of the viewport the region is positioned relative to",
"type": "string",
"required": false
},
{
"name": "horizontal-positioning-mode",
"title": "Horizontal positioning mode",
"description": "How the horizontal placement is determined",
"type": "string",
"values": [{ "name": "uncontrolled" }, { "name": "locktodefault" }, { "name": "dynamic" }],
"default": "uncontrolled",
"required": false
},
{
"name": "horizontal-default-position",
"title": "Horizontal default position",
"description": "The default horizontal position of the region relative to the configured 'Anchor ID'",
"type": "string",
"values": [
{ "name": "start" },
{ "name": "end" },
{ "name": "left" },
{ "name": "right" },
{ "name": "unset" }
],
"default": "unset",
"required": false
},
{
"name": "horizontal-inset",
"title": "Horizontal inset",
"description": "Determines whether the region should overlap the anchor on the horizontal axis",
"type": "boolean",
"default": false,
"required": false
},
{
"name": "horizontal-threshold",
"title": "Horizontal threshold",
"description": "The space allocated to the default position before the widest area is selected for layout",
"type": "number",
"required": false
},
{
"name": "horizontal-scaling",
"title": "Horizontal scaling",
"description": "Defines how the width of the region is calculated",
"type": "string",
"values": [{ "name": "anchor" }, { "name": "fill" }, { "name": "content" }],
"default": "content",
"required": false
},
{
"name": "vertical-positioning-mode",
"title": "Vertical positioning mode",
"description": "How the vertical placement is determined",
"type": "string",
"values": [{ "name": "uncontrolled" }, { "name": "locktodefault" }, { "name": "dynamic" }],
"default": "uncontrolled",
"required": false
},
{
"name": "vertical-default-position",
"title": "Vertical default position",
"description": "The default vertical position of the region relative to the configured 'Anchor ID'",
"type": "string",
"values": [{ "name": "top" }, { "name": "bottom" }, { "name": "unset" }],
"default": "unset",
"required": false
},
{
"name": "vertical-inset",
"title": "Vertical inset",
"description": "Determines whether the region should overlap the anchor on the vertical axis",
"type": "boolean",
"default": false,
"required": false
},
{
"name": "vertical-threshold",
"title": "Vertical threshold",
"description": "The space allocated to the default position before the widest area is selected for layout",
"type": "number",
"required": false
},
{
"name": "vertical-scaling",
"title": "Vertical scaling",
"description": "Defines how the width of the region is calculated",
"type": "string",
"values": [{ "name": "anchor" }, { "name": "fill" }, { "name": "content" }],
"default": "content",
"required": false
},
{
"name": "fixed-placement",
"title": "Fixed placement",
"description": "Fixed placement allows the region to break out of parent containers",
"type": "boolean",
"default": false,
"required": false
},
{
"name": "auto-update-mode",
"title": "Auto update mode",
"description": "Defines whether the component automatically updates its position",
"type": "string",
"values": [{ "name": "anchor" }, { "name": "auto" }],
"default": "anchor",
"required": false
}
],
"slots": [
{
"name": "",
"title": "Default slot",
"description": "The content of the anchored region"
}
]
}
]
}
Loading

0 comments on commit 41c53d0

Please sign in to comment.