Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upchore: move component definitions #3638
Open
+36
−39
Conversation
janechu
requested review from
awentzel,
chrisdholt,
EisenbergEffect,
Falkicon and
nicholasrice
as
code owners
|
@janechu Can you comment on these definitions vs the Open UI definitions? There's a lot of metadata going around... |
|
@EisenbergEffect Yep, so these "component definitions" are the ones that map to VS code web component definitions. They will become part of the Open UI definition, as I'm adding a new property "implementations" to their JSON schema. I imagine that a more fleshed out definition should look something like this: {
"name": "Button",
"uri": "https://fast.design/docs/components/button",
"implementations": [{
"type": "web-component",
"implementation": {
"version": 1,
"tags": [{
"name": "fast-button",
"description": "The FAST button element",
"attributes": [{
"name": "appearance",
"description": "The appearance attribute",
"type": "string",
"values": [{
"name": "accent"
}, {
"name": "lightweight"
}, {
"name": "neutral"
}, {
"name": "outline"
}, {
"name": "stealth"
}],
"default": "neutral",
"required": false
}, {
"name": "autofocus",
"description": "The autofocus attribute",
"type": "boolean",
"default": false,
"required": false
}, {
"name": "disabled",
"description": "The disabled attribute",
"type": "boolean",
"required": false
}, {
"name": "form",
"description": "The form attribute",
"type": "string",
"required": false
}, {
"name": "formaction",
"description": "The formaction attribute",
"type": "string",
"required": false
}, {
"name": "formenctype",
"description": "The formenctype attribute",
"type": "string",
"required": false
}, {
"name": "formmethod",
"description": "The formmethod attribute",
"type": "string",
"required": false
}, {
"name": "formnovalidate",
"description": "The formnovalidate attribute",
"type": "boolean",
"required": false
}, {
"name": "formtarget",
"description": "The formtarget attribute",
"type": "string",
"values": [{
"name": "_self"
}, {
"name": "_blank"
}, {
"name": "_parent"
}, {
"name": "_top"
}],
"required": false
}, {
"name": "name",
"description": "The name attribute",
"type": "string",
"required": false
}, {
"name": "type",
"description": "The type attribute",
"type": "string",
"required": false
}, {
"name": "value",
"description": "The value attribute",
"type": "string",
"required": false
}],
"slots": [{
"name": "",
"description": "The default slot"
}, {
"name": "start",
"description": "The start slot"
}, {
"name": "end",
"description": "The end slot"
}]
}]
}
}]
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
janechu commentedAug 6, 2020
Description
This change moves the component definitions from the
site-utilitiesfolder to@microsoft/fast-componentsbut not as a direct export.Motivation & context
This is part of the work to add Open UI schemas as exports. These will be combined with the additional definitions as dictated by their JSON schema as the
implementationsproperty, for more details see #3636Issue type checklist
Is this a breaking change?
Adding or modifying component(s) in
@microsoft/fast-componentschecklistProcess & policy checklist