Skip to content

Instantly share code, notes, and snippets.

@CuddleBunny
Created May 5, 2022 17:48
Show Gist options
  • Save CuddleBunny/6abb740fbd7b7938234808754e335520 to your computer and use it in GitHub Desktop.
Save CuddleBunny/6abb740fbd7b7938234808754e335520 to your computer and use it in GitHub Desktop.
custom-elements.json
{
"version": "experimental",
"tags": [
{
"name": "natgen-accordion-item",
"path": "./src\\components\\accordion-item\\accordion-item.ts",
"properties": [
{
"name": "headinglevel",
"description": "Configures the {@link https://www.w3.org/TR/wai-aria-1.1/#aria-level | level} of the\r\nheading element.",
"type": "1 | 2 | 3 | 4 | 5 | 6"
},
{
"name": "expanded",
"description": "Expands or collapses the item.",
"type": "boolean"
},
{
"name": "id",
"description": "The item ID",
"type": "string"
},
{
"name": "expandbutton",
"type": "HTMLElement"
},
{
"name": "clickHandler",
"type": "(e: MouseEvent) => void"
},
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
},
{
"name": "start",
"type": "HTMLSlotElement"
},
{
"name": "startContainer",
"type": "HTMLSpanElement"
},
{
"name": "end",
"type": "HTMLSlotElement"
},
{
"name": "endContainer",
"type": "HTMLSpanElement"
}
]
},
{
"name": "natgen-accordion",
"path": "./src\\components\\accordion\\accordion.ts",
"properties": [
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
}
]
},
{
"name": "natgen-anchor",
"path": "./src\\components\\anchor\\anchor.ts",
"properties": [
{
"name": "appearance",
"description": "The appearance the anchor should have.",
"type": "ButtonAppearance"
},
{
"name": "download",
"description": "Prompts the user to save the linked URL. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
"type": "string"
},
{
"name": "href",
"description": "The URL the hyperlink references. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
"type": "string"
},
{
"name": "hreflang",
"description": "Hints at the language of the referenced resource. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
"type": "string"
},
{
"name": "ping",
"description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
"type": "string"
},
{
"name": "referrerpolicy",
"description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
"type": "string"
},
{
"name": "rel",
"description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
"type": "string"
},
{
"name": "target",
"description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
"type": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
},
{
"name": "type",
"description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
"type": "string"
},
{
"name": "defaultSlottedContent",
"description": "Default slotted content",
"type": "HTMLElement[]"
},
{
"name": "control",
"description": "References the root element",
"type": "HTMLAnchorElement"
},
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
},
{
"name": "ariaExpanded",
"description": "See {@link https://www.w3.org/WAI/PF/aria/roles#link} for more information",
"type": "\"true\" | \"false\" | undefined"
},
{
"name": "ariaAtomic",
"description": "Indicates whether assistive technologies will present all, or only parts of,\r\nthe changed region based on the change notifications defined by the aria-relevant attribute.\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-atomic}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaBusy",
"description": "Indicates an element is being modified and that assistive technologies MAY want to wait\r\nuntil the modifications are complete before exposing them to the user.\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-busy}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaControls",
"description": "Identifies the element (or elements) whose contents or presence are controlled by the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-controls}",
"type": "string"
},
{
"name": "ariaCurrent",
"description": "Indicates the element that represents the current item within a container or set of related elements.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-current}",
"type": "string"
},
{
"name": "ariaDescribedby",
"description": "Identifies the element (or elements) that describes the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-describedby}",
"type": "string"
},
{
"name": "ariaDetails",
"description": "Identifies the element that provides a detailed, extended description for the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-details}",
"type": "string"
},
{
"name": "ariaDisabled",
"description": "Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-disabled}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaErrormessage",
"description": "Identifies the element that provides an error message for the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-errormessage}",
"type": "string"
},
{
"name": "ariaFlowto",
"description": "Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,\r\nallows assistive technology to override the general default of reading in document source order.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-flowto}",
"type": "string"
},
{
"name": "ariaHaspopup",
"description": "Indicates the availability and type of interactive popup element,\r\nsuch as menu or dialog, that can be triggered by an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-haspopup}",
"type": "\"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\""
},
{
"name": "ariaHidden",
"description": "Indicates whether the element is exposed to an accessibility API\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-hidden}",
"type": "\"true\" | \"false\" | undefined"
},
{
"name": "ariaInvalid",
"description": "Indicates the entered value does not conform to the format expected by the application.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-invalid}",
"type": "\"true\" | \"false\" | \"grammar\" | \"spelling\""
},
{
"name": "ariaKeyshortcuts",
"description": "Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-keyshortcuts}",
"type": "string"
},
{
"name": "ariaLabel",
"description": "Defines a string value that labels the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-label}",
"type": "string"
},
{
"name": "ariaLabelledby",
"description": "Identifies the element (or elements) that labels the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-labelledby}",
"type": "string"
},
{
"name": "ariaLive",
"description": "Indicates that an element will be updated, and describes the types of updates the user agents,\r\nassistive technologies, and user can expect from the live region.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-live}",
"type": "\"assertive\" | \"off\" | \"polite\""
},
{
"name": "ariaOwns",
"description": "Identifies an element (or elements) in order to define a visual,\r\nfunctional, or contextual parent/child relationship between DOM elements\r\nwhere the DOM hierarchy cannot be used to represent the relationship.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-owns}",
"type": "string"
},
{
"name": "ariaRelevant",
"description": "Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-relevant}",
"type": "\"additions\" | \"additions text\" | \"all\" | \"removals\" | \"text\""
},
{
"name": "ariaRoledescription",
"description": "Defines a human-readable, author-localized description for the role of an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-roledescription}",
"type": "string"
},
{
"name": "start",
"type": "HTMLSlotElement"
},
{
"name": "startContainer",
"type": "HTMLSpanElement"
},
{
"name": "end",
"type": "HTMLSlotElement"
},
{
"name": "endContainer",
"type": "HTMLSpanElement"
}
]
},
{
"name": "natgen-button",
"path": "./src\\components\\button\\button.ts",
"properties": [
{
"name": "appearance",
"description": "The appearance the button should have.",
"type": "ButtonAppearance"
},
{
"name": "autofocus",
"description": "Determines if the element should receive document focus on page load.",
"type": "boolean"
},
{
"name": "formId",
"description": "The id of a form to associate the element to.",
"type": "string"
},
{
"name": "formaction",
"description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element} for more details.",
"type": "string"
},
{
"name": "formenctype",
"description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element} for more details.",
"type": "string"
},
{
"name": "formmethod",
"description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element} for more details.",
"type": "string"
},
{
"name": "formnovalidate",
"description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element} for more details.",
"type": "boolean"
},
{
"name": "formtarget",
"description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element} for more details.",
"type": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
},
{
"name": "type",
"description": "The button type.",
"type": "\"submit\" | \"reset\" | \"button\""
},
{
"name": "defaultSlottedContent",
"description": "Default slotted content",
"type": "HTMLElement[]"
},
{
"name": "control",
"type": "HTMLButtonElement"
},
{
"name": "proxy",
"type": "HTMLInputElement"
},
{
"name": "ariaExpanded",
"description": "See {@link https://www.w3.org/WAI/PF/aria/roles#button} for more information",
"type": "\"true\" | \"false\" | undefined"
},
{
"name": "ariaPressed",
"description": "See {@link https://www.w3.org/WAI/PF/aria/roles#button} for more information",
"type": "\"true\" | \"false\" | \"mixed\" | undefined"
},
{
"name": "ariaAtomic",
"description": "Indicates whether assistive technologies will present all, or only parts of,\r\nthe changed region based on the change notifications defined by the aria-relevant attribute.\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-atomic}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaBusy",
"description": "Indicates an element is being modified and that assistive technologies MAY want to wait\r\nuntil the modifications are complete before exposing them to the user.\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-busy}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaControls",
"description": "Identifies the element (or elements) whose contents or presence are controlled by the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-controls}",
"type": "string"
},
{
"name": "ariaCurrent",
"description": "Indicates the element that represents the current item within a container or set of related elements.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-current}",
"type": "string"
},
{
"name": "ariaDescribedby",
"description": "Identifies the element (or elements) that describes the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-describedby}",
"type": "string"
},
{
"name": "ariaDetails",
"description": "Identifies the element that provides a detailed, extended description for the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-details}",
"type": "string"
},
{
"name": "ariaDisabled",
"description": "Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-disabled}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaErrormessage",
"description": "Identifies the element that provides an error message for the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-errormessage}",
"type": "string"
},
{
"name": "ariaFlowto",
"description": "Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,\r\nallows assistive technology to override the general default of reading in document source order.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-flowto}",
"type": "string"
},
{
"name": "ariaHaspopup",
"description": "Indicates the availability and type of interactive popup element,\r\nsuch as menu or dialog, that can be triggered by an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-haspopup}",
"type": "\"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\""
},
{
"name": "ariaHidden",
"description": "Indicates whether the element is exposed to an accessibility API\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-hidden}",
"type": "\"true\" | \"false\" | undefined"
},
{
"name": "ariaInvalid",
"description": "Indicates the entered value does not conform to the format expected by the application.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-invalid}",
"type": "\"true\" | \"false\" | \"grammar\" | \"spelling\""
},
{
"name": "ariaKeyshortcuts",
"description": "Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-keyshortcuts}",
"type": "string"
},
{
"name": "ariaLabel",
"description": "Defines a string value that labels the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-label}",
"type": "string"
},
{
"name": "ariaLabelledby",
"description": "Identifies the element (or elements) that labels the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-labelledby}",
"type": "string"
},
{
"name": "ariaLive",
"description": "Indicates that an element will be updated, and describes the types of updates the user agents,\r\nassistive technologies, and user can expect from the live region.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-live}",
"type": "\"assertive\" | \"off\" | \"polite\""
},
{
"name": "ariaOwns",
"description": "Identifies an element (or elements) in order to define a visual,\r\nfunctional, or contextual parent/child relationship between DOM elements\r\nwhere the DOM hierarchy cannot be used to represent the relationship.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-owns}",
"type": "string"
},
{
"name": "ariaRelevant",
"description": "Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-relevant}",
"type": "\"additions\" | \"additions text\" | \"all\" | \"removals\" | \"text\""
},
{
"name": "ariaRoledescription",
"description": "Defines a human-readable, author-localized description for the role of an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-roledescription}",
"type": "string"
},
{
"name": "start",
"type": "HTMLSlotElement"
},
{
"name": "startContainer",
"type": "HTMLSpanElement"
},
{
"name": "end",
"type": "HTMLSlotElement"
},
{
"name": "endContainer",
"type": "HTMLSpanElement"
}
]
},
{
"name": "natgen-card",
"path": "./src\\components\\card\\card.ts",
"properties": [
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
}
]
},
{
"name": "natgen-checkbox",
"path": "./src\\components\\checkbox\\checkbox.ts",
"properties": [
{
"name": "readOnly",
"description": "When true, the control will be immutable by user interaction. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute} for more information.",
"type": "boolean"
},
{
"name": "initialValue",
"description": "The element's value to be included in form submission when checked.\r\nDefault to \"on\" to reach parity with input[type=\"checkbox\"]",
"type": "string"
},
{
"name": "defaultSlottedNodes",
"type": "Node[]"
},
{
"name": "indeterminate",
"description": "The indeterminate state of the control",
"type": "boolean"
},
{
"name": "keypressHandler",
"type": "(e: KeyboardEvent) => void"
},
{
"name": "clickHandler",
"type": "(e: MouseEvent) => void"
},
{
"name": "proxy",
"type": "HTMLInputElement"
}
]
},
{
"name": "natgen-design-system-provider",
"path": "./src\\components\\design-system-provider\\design-system-provider.ts",
"properties": [
{
"name": "noPaint",
"description": "Used to instruct the NatGenDesignSystemProvider\nthat it should not set the CSS\nbackground-color and color properties",
"type": "boolean",
"default": "false"
},
{
"name": "useDefaultTypography",
"type": "boolean",
"default": "false"
},
{
"name": "fillColor",
"description": "Define design system property attributes",
"type": "Swatch"
},
{
"name": "neutralBaseColor",
"description": "Set the neutral color",
"type": "Swatch | undefined"
},
{
"name": "accentBaseColor",
"description": "Set the accent color",
"type": "Swatch | undefined"
},
{
"name": "secondaryBaseColor",
"description": "Set the accent color",
"type": "Swatch | undefined"
},
{
"name": "errorColor",
"description": "This color is used to grab the user's attention.",
"type": "string"
},
{
"name": "successColor",
"description": "This color is used to grab the user's attention.",
"type": "string"
},
{
"name": "neutralPalette",
"description": "Defines the palette that all neutral color recipes are derived from.\nThis is an array for hexadecimal color strings ordered from light to dark.",
"type": "Palette<Swatch>"
},
{
"name": "accentPalette",
"description": "Defines the palette that all accent color recipes are derived from.\nThis is an array for hexadecimal color strings ordered from light to dark.",
"type": "Palette<Swatch>"
},
{
"name": "secondaryPalette",
"description": "Defines the palette that all secondary accent color recipes are derived from.\nThis is an array for hexadecimal color strings ordered from light to dark.",
"type": "Palette<Swatch>"
},
{
"name": "density",
"description": "The density offset, used with designUnit to calculate height and spacing.",
"type": "number"
},
{
"name": "designUnit",
"description": "The grid-unit that UI dimensions are derived from in pixels.",
"type": "number"
},
{
"name": "baseHeightMultiplier",
"description": "The number of designUnits used for component height at the base density.",
"type": "number"
},
{
"name": "baseHorizontalSpacingMultiplier",
"description": "The number of designUnits used for horizontal spacing at the base density.",
"type": "number"
},
{
"name": "cornerRadius",
"description": "The corner radius applied to controls.",
"type": "number"
},
{
"name": "inputCornerRadius",
"description": "The corner radius applied to inputs.",
"type": "number"
},
{
"name": "buttonCornerRadius",
"description": "The corner radius applied to buttons.",
"type": "number"
},
{
"name": "strokeWidth",
"description": "The width of the standard stroke applied to stroke components in pixels.",
"type": "number"
},
{
"name": "focusStrokeWidth",
"description": "The width of the standard focus stroke in pixels.",
"type": "number"
},
{
"name": "disabledOpacity",
"description": "The opacity of a disabled control.",
"type": "number"
},
{
"name": "typeRampMinus3FontSize",
"description": "The font-size two steps below the base font-size",
"type": "string"
},
{
"name": "typeRampMinus3LineHeight",
"description": "The line-height two steps below the base line-height",
"type": "string"
},
{
"name": "typeRampMinus2FontSize",
"description": "The font-size two steps below the base font-size",
"type": "string"
},
{
"name": "typeRampMinus2LineHeight",
"description": "The line-height two steps below the base line-height",
"type": "string"
},
{
"name": "typeRampMinus1FontSize",
"description": "The font-size one step below the base font-size",
"type": "string"
},
{
"name": "typeRampMinus1LineHeight",
"description": "The line-height one step below the base line-height",
"type": "string"
},
{
"name": "typeRampBaseFontSize",
"description": "The base font-size of the relative type-ramp scale",
"type": "string"
},
{
"name": "typeRampBaseLineHeight",
"description": "The base line-height of the relative type-ramp scale",
"type": "string"
},
{
"name": "typeRampPlus1FontSize",
"description": "The font-size one step above the base font-size",
"type": "string"
},
{
"name": "typeRampPlus1LineHeight",
"description": "The line-height one step above the base line-height",
"type": "string"
},
{
"name": "typeRampPlus2FontSize",
"description": "The font-size two steps above the base font-size",
"type": "string"
},
{
"name": "typeRampPlus2LineHeight",
"description": "The line-height two steps above the base line-height",
"type": "string"
},
{
"name": "typeRampPlus3FontSize",
"description": "The font-size three steps above the base font-size",
"type": "string"
},
{
"name": "typeRampPlus3LineHeight",
"description": "The line-height three steps above the base line-height",
"type": "string"
},
{
"name": "typeRampPlus4FontSize",
"description": "The font-size four steps above the base font-size",
"type": "string"
},
{
"name": "typeRampPlus4LineHeight",
"description": "The line-height four steps above the base line-height",
"type": "string"
},
{
"name": "typeRampPlus5FontSize",
"description": "The font-size five steps above the base font-size",
"type": "string"
},
{
"name": "typeRampPlus5LineHeight",
"description": "The line-height five steps above the base line-height",
"type": "string"
},
{
"name": "typeRampPlus6FontSize",
"description": "The font-size six steps above the base font-size",
"type": "string"
},
{
"name": "typeRampPlus6LineHeight",
"description": "The line-height six steps above the base line-height",
"type": "string"
},
{
"name": "neutralFillRestDelta",
"description": "The distance from the resolved neutral fill color for the rest state of the neutral-fill recipe. See {@link @ngic/components#neutralFillRest} for usage in CSS.",
"type": "number"
},
{
"name": "neutralFillHoverDelta",
"description": "The distance from the resolved neutral fill color for the hover state of the neutral-fill recipe. See {@link @ngic/components#neutralFillHover} for usage in CSS.",
"type": "number"
},
{
"name": "neutralFillActiveDelta",
"description": "The distance from the resolved neutral fill color for the active state of the neutral-fill recipe. See {@link @ngic/components#neutralFillActive} for usage in CSS.",
"type": "number"
},
{
"name": "neutralFillFocusDelta",
"description": "The distance from the resolved neutral fill color for the focus state of the neutral-fill recipe. See {@link @ngic/components#neutralFillFocus} for usage in CSS.",
"type": "number"
},
{
"name": "neutralInputFillRestDelta",
"description": "The distance from the resolved neutral fill input color for the rest state of the neutral-input-fill recipe. See {@link @ngic/components#neutralInputFillRest} for usage in CSS.",
"type": "number"
},
{
"name": "neutralInputFillHoverDelta",
"description": "The distance from the resolved neutral fill input color for the hover state of the neutral-input-fill recipe. See {@link @ngic/components#neutralInputFillHover} for usage in CSS.",
"type": "number"
},
{
"name": "neutralInputFillActiveDelta",
"description": "The distance from the resolved neutral fill input color for the active state of the neutral-input-fill recipe. See {@link @ngic/components#neutralInputFillActive} for usage in CSS.",
"type": "number"
},
{
"name": "neutralInputFillFocusDelta",
"description": "The distance from the resolved neutral fill input color for the focus state of the neutral-input-fill recipe. See {@link @ngic/components#neutralInputFillFocus} for usage in CSS.",
"type": "number"
},
{
"name": "neutralStealthFillRestDelta",
"description": "The distance from the resolved neutral fill stealth color for the rest state of the neutral-stealth-fill recipe. See {@link @ngic/components#neutralStealthFillRest} for usage in CSS.",
"type": "number"
},
{
"name": "neutralStealthFillHoverDelta",
"description": "The distance from the resolved neutral fill stealth color for the hover state of the neutral-stealth-fill recipe. See {@link @ngic/components#neutralStealthFillHover} for usage in CSS.",
"type": "number"
},
{
"name": "neutralStealthFillActiveDelta",
"description": "The distance from the resolved neutral fill stealth color for the active state of the neutral-stealth-fill recipe. See {@link @ngic/components#neutralStealthFillActive} for usage in CSS.",
"type": "number"
},
{
"name": "neutralStealthFillFocusDelta",
"description": "The distance from the resolved neutral fill stealth color for the focus state of the neutral-stealth-fill recipe. See {@link @ngic/components#neutralStealthFillFocus} for usage in CSS.",
"type": "number"
},
{
"name": "accentFillRestDelta",
"description": "The distance from the resolved accent fill color for the rest state of the accent-fill recipe. See {@link @ngic/components#accentFillRest} for usage in CSS.",
"type": "number"
},
{
"name": "accentFillHoverDelta",
"description": "The distance from the resolved accent fill color for the hover state of the accent-fill recipe. See {@link @ngic/components#accentFillHover} for usage in CSS.",
"type": "number"
},
{
"name": "accentFillActiveDelta",
"description": "The distance from the resolved accent fill color for the active state of the accent-fill recipe. See {@link @ngic/components#accentFillActive} for usage in CSS.",
"type": "number"
},
{
"name": "accentFillFocusDelta",
"description": "The distance from the resolved accent fill color for the focus state of the accent-fill recipe. See {@link @ngic/components#accentFillFocus} for usage in CSS.",
"type": "number"
},
{
"name": "accentForegroundRestDelta",
"description": "The distance from the resolved accent foreground color for the rest state of the accent-foreground recipe. See {@link @ngic/components#accentForegroundRest} for usage in CSS.",
"type": "number"
},
{
"name": "accentForegroundHoverDelta",
"description": "The distance from the resolved accent foreground color for the hover state of the accent-foreground recipe. See {@link @ngic/components#accentForegroundHover} for usage in CSS.",
"type": "number"
},
{
"name": "accentForegroundActiveDelta",
"description": "The distance from the resolved accent foreground color for the active state of the accent-foreground recipe. See {@link @ngic/components#accentForegroundActive} for usage in CSS.",
"type": "number"
},
{
"name": "accentForegroundFocusDelta",
"description": "The distance from the resolved accent foreground color for the focus state of the accent-foreground recipe. See {@link @ngic/components#accentForegroundFocus} for usage in CSS.",
"type": "number"
},
{
"name": "secondaryFillRestDelta",
"description": "The distance from the resolved secondary fill color for the rest state of the secondary-fill recipe. See {@link @ngic/components#secondaryFillRest} for usage in CSS.",
"type": "number"
},
{
"name": "secondaryFillHoverDelta",
"description": "The distance from the resolved secondary fill color for the hover state of the secondary-fill recipe. See {@link @ngic/components#secondaryFillHover} for usage in CSS.",
"type": "number"
},
{
"name": "secondaryFillActiveDelta",
"description": "The distance from the resolved secondary fill color for the active state of the secondary-fill recipe. See {@link @ngic/components#secondaryFillActive} for usage in CSS.",
"type": "number"
},
{
"name": "secondaryFillFocusDelta",
"description": "The distance from the resolved secondary fill color for the focus state of the secondary-fill recipe. See {@link @ngic/components#secondaryFillFocus} for usage in CSS.",
"type": "number"
},
{
"name": "secondaryForegroundRestDelta",
"description": "The distance from the resolved secondary foreground color for the rest state of the secondary-foreground recipe. See {@link @ngic/components#secondaryForegroundRest} for usage in CSS.",
"type": "number"
},
{
"name": "secondaryForegroundHoverDelta",
"description": "The distance from the resolved secondary foreground color for the hover state of the secondary-foreground recipe. See {@link @ngic/components#secondaryForegroundHover} for usage in CSS.",
"type": "number"
},
{
"name": "secondaryForegroundActiveDelta",
"description": "The distance from the resolved secondary foreground color for the active state of the secondary-foreground recipe. See {@link @ngic/components#secondaryForegroundActive} for usage in CSS.",
"type": "number"
},
{
"name": "secondaryForegroundFocusDelta",
"description": "The distance from the resolved secondary foreground color for the focus state of the secondary-foreground recipe. See {@link @ngic/components#secondaryForegroundFocus} for usage in CSS.",
"type": "number"
},
{
"name": "baseLayerLuminance",
"description": "The {@link https://www.w3.org/WAI/GL/wiki/Relative_luminance#:~:text=WCAG%20definition%20of%20relative%20luminance,and%201%20for%20lightest%20white|relative luminance} of the base layer of the application.",
"type": "number"
},
{
"name": "neutralLayerFillRestDelta",
"description": "The distance from the background-color to resolve the card background. See {@link @ngic/components#neutralLayerFillRest} for usage in CSS.",
"type": "number"
},
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
}
]
},
{
"name": "natgen-dialog",
"path": "./src\\components\\dialog\\dialog.ts",
"properties": [
{
"name": "slottedActionNodes",
"type": "Node[]"
},
{
"name": "autoDismiss",
"type": "boolean"
},
{
"name": "modal",
"description": "Indicates the element is modal. When modal, user mouse interaction will be limited to the contents of the element by a modal\r\noverlay. Clicks on the overlay will cause the dialog to emit a \"dismiss\" event.",
"type": "boolean"
},
{
"name": "hidden",
"description": "The hidden state of the element.",
"type": "boolean"
},
{
"name": "trapFocus",
"description": "Indicates that the dialog should trap focus.",
"type": "boolean"
},
{
"name": "ariaDescribedby",
"description": "The id of the element describing the dialog.",
"type": "string"
},
{
"name": "ariaLabelledby",
"description": "The id of the element labeling the dialog.",
"type": "string"
},
{
"name": "ariaLabel",
"description": "The label surfaced to assistive technologies.",
"type": "string"
},
{
"name": "dialog",
"type": "HTMLDivElement"
},
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
}
]
},
{
"name": "natgen-flag",
"path": "./src\\components\\flag\\flag.ts",
"properties": [
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
}
]
},
{
"name": "natgen-hamburger-button",
"path": "./src\\components\\hamburger-button\\hamburger-button.ts",
"properties": [
{
"name": "opened",
"type": "boolean",
"default": "false"
},
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
}
]
},
{
"name": "natgen-loader",
"path": "./src\\components\\loader\\loader.ts",
"properties": [
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
}
]
},
{
"name": "natgen-nav-bar",
"path": "./src\\components\\nav-bar\\nav-bar.ts",
"properties": [
{
"name": "expand",
"type": "boolean",
"default": "true"
},
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
}
]
},
{
"name": "natgen-option",
"path": "./src\\components\\option\\option.ts",
"properties": [
{
"name": "proxy",
"type": "HTMLOptionElement"
},
{
"name": "defaultSelected",
"description": "The defaultSelected state of the option.",
"type": "boolean"
},
{
"name": "disabled",
"description": "The disabled state of the option.",
"type": "boolean"
},
{
"name": "selectedAttribute",
"description": "The selected attribute value. This sets the initial selected value.",
"type": "boolean"
},
{
"name": "selected",
"description": "The checked state of the control.",
"type": "boolean"
},
{
"name": "dirtyValue",
"description": "Track whether the value has been changed from the initial value",
"type": "boolean"
},
{
"name": "label",
"type": "string"
},
{
"name": "text",
"type": "string"
},
{
"name": "value",
"type": "string"
},
{
"name": "form",
"type": "HTMLFormElement | null"
},
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
},
{
"name": "ariaPosInSet",
"description": "See {@link https://www.w3.org/TR/wai-aria-1.2/#option} for more information.",
"type": "string"
},
{
"name": "ariaSelected",
"description": "See {@link https://www.w3.org/TR/wai-aria-1.2/#option} for more information.",
"type": "\"true\" | \"false\" | undefined"
},
{
"name": "ariaSetSize",
"description": "See {@link https://www.w3.org/TR/wai-aria-1.2/#option} for more information.",
"type": "string"
},
{
"name": "ariaAtomic",
"description": "Indicates whether assistive technologies will present all, or only parts of,\r\nthe changed region based on the change notifications defined by the aria-relevant attribute.\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-atomic}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaBusy",
"description": "Indicates an element is being modified and that assistive technologies MAY want to wait\r\nuntil the modifications are complete before exposing them to the user.\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-busy}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaControls",
"description": "Identifies the element (or elements) whose contents or presence are controlled by the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-controls}",
"type": "string"
},
{
"name": "ariaCurrent",
"description": "Indicates the element that represents the current item within a container or set of related elements.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-current}",
"type": "string"
},
{
"name": "ariaDescribedby",
"description": "Identifies the element (or elements) that describes the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-describedby}",
"type": "string"
},
{
"name": "ariaDetails",
"description": "Identifies the element that provides a detailed, extended description for the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-details}",
"type": "string"
},
{
"name": "ariaDisabled",
"description": "Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-disabled}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaErrormessage",
"description": "Identifies the element that provides an error message for the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-errormessage}",
"type": "string"
},
{
"name": "ariaFlowto",
"description": "Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,\r\nallows assistive technology to override the general default of reading in document source order.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-flowto}",
"type": "string"
},
{
"name": "ariaHaspopup",
"description": "Indicates the availability and type of interactive popup element,\r\nsuch as menu or dialog, that can be triggered by an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-haspopup}",
"type": "\"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\""
},
{
"name": "ariaHidden",
"description": "Indicates whether the element is exposed to an accessibility API\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-hidden}",
"type": "\"true\" | \"false\" | undefined"
},
{
"name": "ariaInvalid",
"description": "Indicates the entered value does not conform to the format expected by the application.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-invalid}",
"type": "\"true\" | \"false\" | \"grammar\" | \"spelling\""
},
{
"name": "ariaKeyshortcuts",
"description": "Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-keyshortcuts}",
"type": "string"
},
{
"name": "ariaLabel",
"description": "Defines a string value that labels the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-label}",
"type": "string"
},
{
"name": "ariaLabelledby",
"description": "Identifies the element (or elements) that labels the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-labelledby}",
"type": "string"
},
{
"name": "ariaLive",
"description": "Indicates that an element will be updated, and describes the types of updates the user agents,\r\nassistive technologies, and user can expect from the live region.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-live}",
"type": "\"assertive\" | \"off\" | \"polite\""
},
{
"name": "ariaOwns",
"description": "Identifies an element (or elements) in order to define a visual,\r\nfunctional, or contextual parent/child relationship between DOM elements\r\nwhere the DOM hierarchy cannot be used to represent the relationship.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-owns}",
"type": "string"
},
{
"name": "ariaRelevant",
"description": "Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-relevant}",
"type": "\"additions\" | \"additions text\" | \"all\" | \"removals\" | \"text\""
},
{
"name": "ariaRoledescription",
"description": "Defines a human-readable, author-localized description for the role of an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-roledescription}",
"type": "string"
},
{
"name": "start",
"type": "HTMLSlotElement"
},
{
"name": "startContainer",
"type": "HTMLSpanElement"
},
{
"name": "end",
"type": "HTMLSlotElement"
},
{
"name": "endContainer",
"type": "HTMLSpanElement"
}
]
},
{
"name": "natgen-popper",
"path": "./src\\components\\popper\\popper.ts",
"properties": [
{
"name": "selector",
"type": "string"
},
{
"name": "show",
"type": "boolean",
"default": "false"
},
{
"name": "event",
"type": "string",
"default": "\"click\""
},
{
"name": "placement",
"type": "Placement",
"default": "\"bottom\""
},
{
"name": "offset",
"type": "[number, number]"
},
{
"name": "flip",
"type": "boolean",
"default": "false"
},
{
"name": "matchTargetWidth",
"type": "boolean",
"default": "false"
},
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
}
]
},
{
"name": "natgen-radio-card",
"path": "./src\\components\\radio-card\\radio-card.ts",
"properties": [
{
"name": "readOnly",
"description": "When true, the control will be immutable by user interaction. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute} for more information.",
"type": "boolean"
},
{
"name": "name",
"description": "The name of the radio. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname | name attribute} for more info.",
"type": "string"
},
{
"name": "initialValue",
"description": "The element's value to be included in form submission when checked.\r\nDefault to \"on\" to reach parity with input[type=\"radio\"]",
"type": "string"
},
{
"name": "defaultSlottedNodes",
"type": "Node[]"
},
{
"name": "keypressHandler",
"type": "(e: KeyboardEvent) => boolean | void"
},
{
"name": "proxy",
"type": "HTMLInputElement"
}
]
},
{
"name": "natgen-radio-group",
"path": "./src\\components\\radio-group\\radio-group.ts",
"properties": [
{
"name": "readOnly",
"description": "When true, the child radios will be immutable by user interaction. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute} for more information.",
"type": "boolean"
},
{
"name": "disabled",
"description": "Disables the radio group and child radios.",
"type": "boolean"
},
{
"name": "name",
"description": "The name of the radio group. Setting this value will set the name value\r\nfor all child radio elements.",
"type": "string"
},
{
"name": "value",
"description": "The value of the checked radio",
"type": "string"
},
{
"name": "orientation",
"description": "The orientation of the group",
"type": "Orientation"
},
{
"name": "childItems",
"type": "HTMLElement[]"
},
{
"name": "slottedRadioButtons",
"type": "HTMLElement[]"
},
{
"name": "focusOutHandler",
"type": "(e: FocusEvent) => boolean | void"
},
{
"name": "clickHandler",
"type": "(e: MouseEvent) => void"
},
{
"name": "keydownHandler",
"description": "keyboard handling per https://w3c.github.io/aria-practices/#for-radio-groups-not-contained-in-a-toolbar\r\nnavigation is different when there is an ancestor with role='toolbar'",
"type": "(e: KeyboardEvent) => boolean | void"
},
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
}
]
},
{
"name": "natgen-radio",
"path": "./src\\components\\radio\\radio.ts",
"properties": [
{
"name": "readOnly",
"description": "When true, the control will be immutable by user interaction. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute} for more information.",
"type": "boolean"
},
{
"name": "name",
"description": "The name of the radio. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname | name attribute} for more info.",
"type": "string"
},
{
"name": "initialValue",
"description": "The element's value to be included in form submission when checked.\r\nDefault to \"on\" to reach parity with input[type=\"radio\"]",
"type": "string"
},
{
"name": "defaultSlottedNodes",
"type": "Node[]"
},
{
"name": "keypressHandler",
"type": "(e: KeyboardEvent) => boolean | void"
},
{
"name": "proxy",
"type": "HTMLInputElement"
}
]
},
{
"name": "natgen-select",
"path": "./src\\components\\select\\select.ts",
"properties": [
{
"name": "appearance",
"description": "The appearance of the element.",
"type": "NatGenTextFieldAppearance"
},
{
"name": "open",
"description": "The open attribute.",
"type": "boolean"
},
{
"name": "value",
"description": "The value property.",
"type": "string"
},
{
"name": "positionAttribute",
"description": "Reflects the placement for the listbox when the select is open.",
"type": "SelectPosition"
},
{
"name": "position",
"description": "Holds the current state for the calculated position of the listbox.",
"type": "SelectPosition"
},
{
"name": "listbox",
"description": "Reference to the internal listbox element.",
"type": "HTMLDivElement"
},
{
"name": "maxHeight",
"description": "The max height for the listbox when opened.",
"type": "number"
},
{
"name": "displayValue",
"description": "The value displayed on the button.",
"type": "string"
},
{
"name": "proxy",
"type": "HTMLSelectElement"
},
{
"name": "ariaActiveDescendant",
"description": "See {@link https://www.w3.org/TR/wai-aria-1.2/#listbox} for more information",
"type": "string"
},
{
"name": "ariaExpanded",
"description": "See {@link https://www.w3.org/TR/wai-aria-1.2/#listbox} for more information",
"type": "\"true\" | \"false\" | undefined"
},
{
"name": "ariaAtomic",
"description": "Indicates whether assistive technologies will present all, or only parts of,\r\nthe changed region based on the change notifications defined by the aria-relevant attribute.\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-atomic}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaBusy",
"description": "Indicates an element is being modified and that assistive technologies MAY want to wait\r\nuntil the modifications are complete before exposing them to the user.\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-busy}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaControls",
"description": "See {@link https://www.w3.org/TR/wai-aria-1.2/#combobox} for more information",
"type": "string"
},
{
"name": "ariaCurrent",
"description": "Indicates the element that represents the current item within a container or set of related elements.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-current}",
"type": "string"
},
{
"name": "ariaDescribedby",
"description": "Identifies the element (or elements) that describes the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-describedby}",
"type": "string"
},
{
"name": "ariaDetails",
"description": "Identifies the element that provides a detailed, extended description for the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-details}",
"type": "string"
},
{
"name": "ariaDisabled",
"description": "See {@link https://www.w3.org/TR/wai-aria-1.2/#listbox} for more information",
"type": "\"true\" | \"false\""
},
{
"name": "ariaErrormessage",
"description": "Identifies the element that provides an error message for the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-errormessage}",
"type": "string"
},
{
"name": "ariaFlowto",
"description": "Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,\r\nallows assistive technology to override the general default of reading in document source order.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-flowto}",
"type": "string"
},
{
"name": "ariaHaspopup",
"description": "Indicates the availability and type of interactive popup element,\r\nsuch as menu or dialog, that can be triggered by an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-haspopup}",
"type": "\"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\""
},
{
"name": "ariaHidden",
"description": "Indicates whether the element is exposed to an accessibility API\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-hidden}",
"type": "\"true\" | \"false\" | undefined"
},
{
"name": "ariaInvalid",
"description": "Indicates the entered value does not conform to the format expected by the application.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-invalid}",
"type": "\"true\" | \"false\" | \"grammar\" | \"spelling\""
},
{
"name": "ariaKeyshortcuts",
"description": "Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-keyshortcuts}",
"type": "string"
},
{
"name": "ariaLabel",
"description": "Defines a string value that labels the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-label}",
"type": "string"
},
{
"name": "ariaLabelledby",
"description": "Identifies the element (or elements) that labels the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-labelledby}",
"type": "string"
},
{
"name": "ariaLive",
"description": "Indicates that an element will be updated, and describes the types of updates the user agents,\r\nassistive technologies, and user can expect from the live region.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-live}",
"type": "\"assertive\" | \"off\" | \"polite\""
},
{
"name": "ariaOwns",
"description": "Identifies an element (or elements) in order to define a visual,\r\nfunctional, or contextual parent/child relationship between DOM elements\r\nwhere the DOM hierarchy cannot be used to represent the relationship.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-owns}",
"type": "string"
},
{
"name": "ariaRelevant",
"description": "Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-relevant}",
"type": "\"additions\" | \"additions text\" | \"all\" | \"removals\" | \"text\""
},
{
"name": "ariaRoledescription",
"description": "Defines a human-readable, author-localized description for the role of an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-roledescription}",
"type": "string"
},
{
"name": "start",
"type": "HTMLSlotElement"
},
{
"name": "startContainer",
"type": "HTMLSpanElement"
},
{
"name": "end",
"type": "HTMLSlotElement"
},
{
"name": "endContainer",
"type": "HTMLSpanElement"
}
]
},
{
"name": "natgen-side-bar",
"path": "./src\\components\\side-bar\\side-bar.ts",
"properties": [
{
"name": "$presentation",
"description": "A property which resolves the ComponentPresentation instance\r\nfor the current component.",
"type": "ComponentPresentation | null"
},
{
"name": "template",
"description": "Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementViewTemplate | null"
},
{
"name": "styles",
"description": "Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.",
"type": "void | ElementStyles | null"
},
{
"name": "$fastController",
"description": "The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
"type": "Controller"
}
]
},
{
"name": "natgen-text-field",
"path": "./src\\components\\text-field\\text-field.ts",
"properties": [
{
"name": "appearance",
"description": "The appearance of the element.",
"type": "NatGenTextFieldAppearance"
},
{
"name": "labelAppearance",
"description": "The appearance the anchor should have.",
"type": "NatGenLabelAppearance"
},
{
"name": "max",
"description": "The maximum value a user can enter.",
"type": "string"
},
{
"name": "min",
"description": "The minimum value a user can enter.",
"type": "string"
},
{
"name": "mask",
"type": "string"
},
{
"name": "maskSettings",
"type": "AnyMaskedOptions"
},
{
"name": "isPasswordType",
"type": "boolean",
"default": "false"
},
{
"name": "autoTab",
"type": "string"
},
{
"name": "readOnly",
"description": "When true, the control will be immutable by user interaction. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute} for more information.",
"type": "boolean"
},
{
"name": "autofocus",
"description": "Indicates that this element should get focus after the page finishes loading. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefautofocus | autofocus HTML attribute} for more information.",
"type": "boolean"
},
{
"name": "placeholder",
"description": "Sets the placeholder value of the element, generally used to provide a hint to the user.",
"type": "string"
},
{
"name": "type",
"description": "Allows setting a type or mode of text.",
"type": "TextFieldType"
},
{
"name": "list",
"description": "Allows associating a {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/datalist | datalist} to the element by {@link https://developer.mozilla.org/en-US/docs/Web/API/Element/id}.",
"type": "string"
},
{
"name": "maxlength",
"description": "The maximum number of characters a user can enter.",
"type": "number"
},
{
"name": "minlength",
"description": "The minimum number of characters a user can enter.",
"type": "number"
},
{
"name": "pattern",
"description": "A regular expression that the value must match to pass validation.",
"type": "string"
},
{
"name": "size",
"description": "Sets the width of the element to a specified number of characters.",
"type": "number"
},
{
"name": "spellcheck",
"description": "Controls whether or not to enable spell checking for the input field, or if the default spell checking configuration should be used.",
"type": "boolean"
},
{
"name": "defaultSlottedNodes",
"type": "Node[]"
},
{
"name": "control",
"description": "A reference to the internal input element",
"type": "HTMLInputElement"
},
{
"name": "proxy",
"type": "HTMLInputElement"
},
{
"name": "ariaAtomic",
"description": "Indicates whether assistive technologies will present all, or only parts of,\r\nthe changed region based on the change notifications defined by the aria-relevant attribute.\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-atomic}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaBusy",
"description": "Indicates an element is being modified and that assistive technologies MAY want to wait\r\nuntil the modifications are complete before exposing them to the user.\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-busy}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaControls",
"description": "Identifies the element (or elements) whose contents or presence are controlled by the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-controls}",
"type": "string"
},
{
"name": "ariaCurrent",
"description": "Indicates the element that represents the current item within a container or set of related elements.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-current}",
"type": "string"
},
{
"name": "ariaDescribedby",
"description": "Identifies the element (or elements) that describes the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-describedby}",
"type": "string"
},
{
"name": "ariaDetails",
"description": "Identifies the element that provides a detailed, extended description for the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-details}",
"type": "string"
},
{
"name": "ariaDisabled",
"description": "Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-disabled}",
"type": "\"true\" | \"false\""
},
{
"name": "ariaErrormessage",
"description": "Identifies the element that provides an error message for the object.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-errormessage}",
"type": "string"
},
{
"name": "ariaFlowto",
"description": "Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,\r\nallows assistive technology to override the general default of reading in document source order.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-flowto}",
"type": "string"
},
{
"name": "ariaHaspopup",
"description": "Indicates the availability and type of interactive popup element,\r\nsuch as menu or dialog, that can be triggered by an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-haspopup}",
"type": "\"true\" | \"false\" | \"menu\" | \"listbox\" | \"tree\" | \"grid\" | \"dialog\""
},
{
"name": "ariaHidden",
"description": "Indicates whether the element is exposed to an accessibility API\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-hidden}",
"type": "\"true\" | \"false\" | undefined"
},
{
"name": "ariaInvalid",
"description": "Indicates the entered value does not conform to the format expected by the application.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-invalid}",
"type": "\"true\" | \"false\" | \"grammar\" | \"spelling\""
},
{
"name": "ariaKeyshortcuts",
"description": "Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-keyshortcuts}",
"type": "string"
},
{
"name": "ariaLabel",
"description": "Defines a string value that labels the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-label}",
"type": "string"
},
{
"name": "ariaLabelledby",
"description": "Identifies the element (or elements) that labels the current element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-labelledby}",
"type": "string"
},
{
"name": "ariaLive",
"description": "Indicates that an element will be updated, and describes the types of updates the user agents,\r\nassistive technologies, and user can expect from the live region.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-live}",
"type": "\"assertive\" | \"off\" | \"polite\""
},
{
"name": "ariaOwns",
"description": "Identifies an element (or elements) in order to define a visual,\r\nfunctional, or contextual parent/child relationship between DOM elements\r\nwhere the DOM hierarchy cannot be used to represent the relationship.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-owns}",
"type": "string"
},
{
"name": "ariaRelevant",
"description": "Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-relevant}",
"type": "\"additions\" | \"additions text\" | \"all\" | \"removals\" | \"text\""
},
{
"name": "ariaRoledescription",
"description": "Defines a human-readable, author-localized description for the role of an element.\r\n\r\n{@link https://www.w3.org/TR/wai-aria-1.1/#aria-roledescription}",
"type": "string"
},
{
"name": "start",
"type": "HTMLSlotElement"
},
{
"name": "startContainer",
"type": "HTMLSpanElement"
},
{
"name": "end",
"type": "HTMLSlotElement"
},
{
"name": "endContainer",
"type": "HTMLSpanElement"
}
]
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment