{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.34.4", "schemaVersion": 1011, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true }, "reportUnsupportedHtmlElements": false } }, "kind": "Package", "canonicalReference": "@adaptive-web/adaptive-ui!", "docComment": "", "name": "@adaptive-web/adaptive-ui", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "@adaptive-web/adaptive-ui!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette:class", "docComment": "/**\n * A base {@link Palette} with a common implementation of the interface. Use PaletteRGB for an implementation of a palette generation algorithm that is ready to be used directly, or extend this class to generate custom swatches.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class BasePalette implements " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/palette-base.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "isAbstract": false, "name": "BasePalette", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette:constructor(1)", "docComment": "/**\n * Creates a new Palette.\n *\n * @param source - The source color for the Palette\n *\n * @param swatches - All swatches in the Palette\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(source: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ", swatches: " }, { "kind": "Reference", "text": "ReadonlyArray", "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "swatches", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette#closestIndexCache:member", "docComment": "/**\n * Cache from `relativeLuminance` to swatch index in the `Palette`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly closestIndexCache: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "closestIndexCache", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette#closestIndexOf:member(1)", "docComment": "/**\n * Returns the index of the Palette that most closely matches the provided relative luminance.\n *\n * @param reference - The relative luminance of the reference\n *\n * @returns The index\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closestIndexOf(reference: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "closestIndexOf" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette#colorContrast:member(1)", "docComment": "/**\n * Returns a Color from the Palette that most closely meets the `minContrast` ratio for to the `reference`.\n *\n * @param reference - The relative luminance of the reference\n *\n * @param minContrast - The minimum amount of contrast from the `reference`\n *\n * @param initialIndex - Optional starting point for the search\n *\n * @param direction - Optional control for the direction of the search\n *\n * @returns The Color that meets the provided contrast\n */\n", "excerptTokens": [ { "kind": "Content", "text": "colorContrast(reference: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": ", contrastTarget: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", initialSearchIndex?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", direction?: " }, { "kind": "Reference", "text": "PaletteDirection", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "contrastTarget", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "initialSearchIndex", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true }, { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "colorContrast" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette#delta:member(1)", "docComment": "/**\n * Returns a Color from the Palette that's the specified position and direction away from the `reference`.\n *\n * @param reference - The relative luminance of the reference\n *\n * @param delta - The number of swatches away from `reference`\n *\n * @param direction - The direction to go from `reference`, 1 goes darker, -1 goes lighter\n */\n", "excerptTokens": [ { "kind": "Content", "text": "delta(reference: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": ", delta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", direction: " }, { "kind": "Reference", "text": "PaletteDirection", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "delta", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "delta" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette#get:member(1)", "docComment": "/**\n * Gets a Color by index. Index is clamped to the limits of the Palette so a Color will always be returned.\n *\n * @param index - The index\n *\n * @returns The Color\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "get" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette#lastIndex:member", "docComment": "/**\n * An index pointer to the end of the palette.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly lastIndex: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "lastIndex", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette#reversedSwatches:member", "docComment": "/**\n * A copy of the swatches in reverse order, used for optimized searching.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly reversedSwatches: " }, { "kind": "Reference", "text": "ReadonlyArray", "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "reversedSwatches", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette#source:member", "docComment": "/**\n * The Color used to create the full palette.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly source: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "source", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette#swatches:member", "docComment": "/**\n * The array of all Colors from light to dark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly swatches: " }, { "kind": "Reference", "text": "ReadonlyArray", "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "swatches", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [ { "startIndex": 5, "endIndex": 7 } ] }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!blackOrWhiteByContrast:function(1)", "docComment": "/**\n * Gets a black or white Color based on the reference color and minimum contrast.\n *\n * @remarks\n *\n * If neither black nor white meet the requested contrast the highest contrasting color is returned.\n *\n * @param reference - The reference color\n *\n * @param minContrast - The minimum contrast required for black or white from `reference`\n *\n * @param defaultBlack - True to default to black if both black and white meet contrast\n *\n * @returns A black or white Color\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function blackOrWhiteByContrast(reference: " }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ", minContrast: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", defaultBlack: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipes/black-or-white-by-contrast.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "minContrast", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "defaultBlack", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "blackOrWhiteByContrast" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!blackOrWhiteByContrastSet:function(1)", "docComment": "/**\n * Gets an interactive set of black or white Colors based on the reference color for each state and minimum contrast.\n *\n * This is commonly used for something like foreground color on an accent-filled Button.\n *\n * This algorithm ignores the contrast check for active state if rest and hover produce the same color, and uses that color directly. This is because many times something like a Button has slight luminance variation between rest, hover, and active states, but generally flipping the text color produces a flash and is more unexpected.\n *\n * @param restReference - The rest state reference color\n *\n * @param hoverReference - The hover state reference color\n *\n * @param activeReference - The active state reference color\n *\n * @param focusReference - The focus state reference color\n *\n * @param minContrast - The minimum contrast required for black or white from each reference color\n *\n * @param defaultBlack - True to default to black if both black or white meet contrast\n *\n * @returns The interactive set of black or white Colors.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function blackOrWhiteByContrastSet(set: " }, { "kind": "Reference", "text": "InteractivePaintSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivePaintSet:interface" }, { "kind": "Content", "text": ", minContrast: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", defaultBlack: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "InteractiveColorSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorSet:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipes/black-or-white-by-contrast-set.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "set", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "minContrast", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "defaultBlack", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "blackOrWhiteByContrastSet" }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!BooleanCondition:type", "docComment": "/**\n * The selector for a true/false condition.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type BooleanCondition = " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "name": "BooleanCondition", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!BorderFill:var", "docComment": "/**\n * @deprecated\n *\n * Use StylePropertyShorthand instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "BorderFill: " }, { "kind": "Content", "text": "{\n all: (value: " }, { "kind": "Reference", "text": "StyleValue", "canonicalReference": "@adaptive-web/adaptive-ui!StyleValue:type" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ";\n}" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "BorderFill", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!BorderStyle:var", "docComment": "/**\n * @deprecated\n *\n * Use StylePropertyShorthand instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "BorderStyle: " }, { "kind": "Content", "text": "{\n all: (value: " }, { "kind": "Reference", "text": "StyleValue", "canonicalReference": "@adaptive-web/adaptive-ui!StyleValue:type" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ";\n}" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "BorderStyle", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!BorderThickness:var", "docComment": "/**\n * @deprecated\n *\n * Use StylePropertyShorthand instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "BorderThickness: " }, { "kind": "Content", "text": "{\n all: (value: " }, { "kind": "Reference", "text": "StyleValue", "canonicalReference": "@adaptive-web/adaptive-ui!StyleValue:type" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ";\n}" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "BorderThickness", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!calculateOverlayColor:function(1)", "docComment": "/**\n * Calculate an overlay color that uses rgba (rgb + alpha) that matches the appearance of a given solid color when placed on the same background.\n *\n * @param match - The solid color the overlay should match in appearance when placed over the rgbBackground\n *\n * @param background - The background on which the overlay rests\n *\n * @returns The rgba (rgb + alpha) color of the overlay\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function calculateOverlayColor(match: " }, { "kind": "Reference", "text": "CuloriColor", "canonicalReference": "@types/culori!Color:type" }, { "kind": "Content", "text": ", background: " }, { "kind": "Reference", "text": "CuloriColor", "canonicalReference": "@types/culori!Color:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Rgb", "canonicalReference": "@types/culori!Rgb:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/utilities/opacity.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "match", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "background", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "calculateOverlayColor" }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class", "docComment": "/**\n * Represents a color.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Color extends " }, { "kind": "Reference", "text": "PaintBase", "canonicalReference": "@adaptive-web/adaptive-ui!PaintBase:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/color.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "Color", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Color#_intendedColor:member", "docComment": "/**\n * The opaque value this Color represents if opacity is used.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected readonly _intendedColor?: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": true, "releaseTag": "Public", "name": "_intendedColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!Color:constructor(1)", "docComment": "/**\n * Creates a new Color.\n *\n * @param color - The underlying color value.\n *\n * @param intendedColor - If `color.alpha` < 1 this tracks the intended opaque color value for dependent calculations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(color: " }, { "kind": "Reference", "text": "CuloriColor", "canonicalReference": "@types/culori!Color:type" }, { "kind": "Content", "text": ", intendedColor?: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "intendedColor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Color.asOverlay:member(1)", "docComment": "/**\n * Creates a new Color as an overlay representation of the `intendedColor` over `reference`.\n *\n * Currently the overlay will only be black or white, so this works best with a plain grey neutral palette. Otherwise it will attempt to match the luminance value of the Color, so it will likely be close, but not an exact match to the color from another palette.\n *\n * @param intendedColor - The Color the overlay should look like over the `reference` Color.\n *\n * @param reference - The Color under the overlay color.\n *\n * @returns A semitransparent Color that represents the `intendedColor` over the `reference` Color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static asOverlay(intendedColor: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ", reference: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "intendedColor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "asOverlay" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Color#color:member", "docComment": "/**\n * The underlying Color value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly color: " }, { "kind": "Reference", "text": "CuloriColor", "canonicalReference": "@types/culori!Color:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Color#createCSS:member", "docComment": "/**\n * Gets this color value as a string for use in css.\n *\n * @returns The color value in a valid css string format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createCSS: " }, { "kind": "Content", "text": "() => string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "createCSS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Color.from:member(1)", "docComment": "/**\n * Creates a new Color from an object with R, G, and B values expressed as a number between 0 to 1.\n *\n * @param obj - An object with `r`, `g`, and `b`, and optional `alpha` values expressed as a number between 0 and 1.\n *\n * @returns A new Color\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static from(obj: " }, { "kind": "Content", "text": "{\n r: number;\n g: number;\n b: number;\n alpha?: number;\n }" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "obj", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "from" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Color.fromRgb:member(1)", "docComment": "/**\n * Creates a new Color from R, G, and B values expressed as a number between 0 to 1.\n *\n * @param r - Red channel expressed as a number between 0 and 1.\n *\n * @param g - Green channel expressed as a number between 0 and 1.\n *\n * @param b - Blue channel expressed as a number between 0 and 1.\n *\n * @param alpha - Alpha channel expressed as a number between 0 and 1.\n *\n * @returns A new Color\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static fromRgb(r: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", g: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", b: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", alpha?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "r", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "g", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "b", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "alpha", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "fromRgb" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Color.isTransparent:member(1)", "docComment": "/**\n * Checks if a color is transparent.\n *\n * @param color - The color to check.\n *\n * @returns True if the color is transparent, false otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static isTransparent(color: " }, { "kind": "Reference", "text": "CuloriColor", "canonicalReference": "@types/culori!Color:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "isTransparent" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Color.parse:member(1)", "docComment": "/**\n * Creates a new Color from a parsable string.\n *\n * @param color - A string representation of the Color.\n *\n * @returns The Color object or undefined.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static parse(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "parse" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Color#toColorString:member", "docComment": "/**\n * Gets this color value as a string.\n *\n * @deprecated\n *\n * Use toString\n *\n * @returns The color value in string format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toColorString: " }, { "kind": "Content", "text": "() => string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "toColorString", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Color#toString:member(1)", "docComment": "/**\n * Gets this color value as a string.\n *\n * @returns The color value in string format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toString(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "toString" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Color.transparent:member", "docComment": "/**\n * A Color representing the full transparent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static transparent: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "transparent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Color.unsafeOpacity:member(1)", "docComment": "/**\n * Creates a new Color from another Color and the target opacity.\n *\n * @remarks\n *\n * It's \"unsafe\" because it can't be used for contrast calculations.\n *\n * @param color - A Color object without opacity.\n *\n * @param alpha - The opacity expressed as a number between 0 and 1.\n *\n * @returns A new Color\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static unsafeOpacity(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ", alpha: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "alpha", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "unsafeOpacity" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipe:type", "docComment": "/**\n * A recipe that evaluates based on {@link ColorRecipeParams}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ColorRecipe = " }, { "kind": "Reference", "text": "RecipeOptional", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeOptional:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorRecipeParams", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeParams:type" }, { "kind": "Content", "text": ", T>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "ColorRecipe", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeBySet:type", "docComment": "/**\n * A recipe that evaluates based on an interactive set of color values.\n *\n * @remarks\n *\n * This offers more control than {@link ColorRecipe} for cases where the recipe needs to take the full set into consideration.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ColorRecipeBySet = " }, { "kind": "Reference", "text": "Recipe", "canonicalReference": "@adaptive-web/adaptive-ui!Recipe:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractivePaintSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivePaintSet:interface" }, { "kind": "Content", "text": ", T>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "ColorRecipeBySet", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeBySetEvaluate:type", "docComment": "/**\n * The type of the `evaluate` function for {@link ColorRecipeBySet}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ColorRecipeBySetEvaluate = " }, { "kind": "Reference", "text": "RecipeEvaluate", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeEvaluate:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractivePaintSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivePaintSet:interface" }, { "kind": "Content", "text": ", T>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "ColorRecipeBySetEvaluate", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeEvaluate:type", "docComment": "/**\n * The type of the `evaluate` function for {@link ColorRecipe}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ColorRecipeEvaluate = " }, { "kind": "Reference", "text": "RecipeEvaluateOptional", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeEvaluateOptional:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorRecipeParams", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeParams:type" }, { "kind": "Content", "text": ", T>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "ColorRecipeEvaluate", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipePalette:type", "docComment": "/**\n * A recipe that evaluates based on {@link ColorRecipePaletteParams}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ColorRecipePalette = " }, { "kind": "Reference", "text": "Recipe", "canonicalReference": "@adaptive-web/adaptive-ui!Recipe:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorRecipePaletteParams", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipePaletteParams:type" }, { "kind": "Content", "text": ", T>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "ColorRecipePalette", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipePaletteEvaluate:type", "docComment": "/**\n * The type of the `evaluate` function for {@link ColorRecipePalette}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ColorRecipePaletteEvaluate = " }, { "kind": "Reference", "text": "RecipeEvaluate", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeEvaluate:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorRecipePaletteParams", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipePaletteParams:type" }, { "kind": "Content", "text": ", T>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "ColorRecipePaletteEvaluate", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipePaletteParams:type", "docComment": "/**\n * Parameters provided to {@link ColorRecipePalette}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ColorRecipePaletteParams = " }, { "kind": "Reference", "text": "ColorRecipeParams", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeParams:type" }, { "kind": "Content", "text": " & {\n palette: " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "ColorRecipePaletteParams", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeParams:type", "docComment": "/**\n * Parameters provided to {@link ColorRecipe}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ColorRecipeParams = " }, { "kind": "Content", "text": "{\n reference: " }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": " | null;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "ColorRecipeParams", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!ComponentAnatomy:interface", "docComment": "/**\n * Structure describing component anatomy for modular styling.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ComponentAnatomy " } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "TConditions", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TParts", "constraintTokenRange": { "startIndex": 3, "endIndex": 4 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "ComponentAnatomy", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!ComponentAnatomy#conditions:member", "docComment": "/**\n * List of conditions a component supports, like being selected or changing orientation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "conditions: " }, { "kind": "Content", "text": "TConditions" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "conditions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!ComponentAnatomy#context:member", "docComment": "/**\n * The context element selector. Implementation defaults to `:host` if not provided.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "context?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!ComponentAnatomy#focus:member", "docComment": "/**\n * Description of the focus structure of the component.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus?: " }, { "kind": "Reference", "text": "FocusDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!FocusDefinition:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "focus", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!ComponentAnatomy#interactivity:member", "docComment": "/**\n * Description of the conditions for when the component is interactive or not.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interactivity?: " }, { "kind": "Reference", "text": "InteractivityDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivityDefinition:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "interactivity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!ComponentAnatomy#name:member", "docComment": "/**\n * The name of the component.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!ComponentAnatomy#parts:member", "docComment": "/**\n * List of parts exposed by the component.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parts: " }, { "kind": "Content", "text": "TParts" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "parts", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ComponentConditions:type", "docComment": "/**\n * Type of the `conditions` for component {@link ComponentAnatomy}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ComponentConditions = " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "name": "ComponentConditions", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ComponentParts:type", "docComment": "/**\n * Type of the `parts` for component {@link ComponentAnatomy}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ComponentParts = " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "name": "ComponentParts", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!Condition:type", "docComment": "/**\n * A condition associated with a component.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Condition = " }, { "kind": "Reference", "text": "BooleanCondition", "canonicalReference": "@adaptive-web/adaptive-ui!BooleanCondition:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StringCondition", "canonicalReference": "@adaptive-web/adaptive-ui!StringCondition:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "name": "Condition", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!ConicGradient:class", "docComment": "/**\n * Represents a conic gradient.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ConicGradient extends " }, { "kind": "Reference", "text": "Gradient", "canonicalReference": "@adaptive-web/adaptive-ui!Gradient:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/gradient.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ConicGradient", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!ConicGradient:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `ConicGradient` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(stops: " }, { "kind": "Reference", "text": "GradientStop", "canonicalReference": "@adaptive-web/adaptive-ui!GradientStop:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", angle?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "stops", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "angle", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!ConicGradient#angle:member", "docComment": "/**\n * The angle of the gradient in degrees.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly angle: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "angle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!ConicGradient#toString:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "toString(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "toString" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!ConicGradient#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly type: " }, { "kind": "Reference", "text": "GradientType", "canonicalReference": "@adaptive-web/adaptive-ui!GradientType:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!contrast:function(1)", "docComment": "/**\n * Gets the contrast ratio between two colors expressed as relative luminance values.\n *\n * For example, the contrast between #FFFFFF and #767676 is 4.5:1\n *\n * @param a - One color relative luminance, for example, 1 for white\n *\n * @param b - Another color relative luminance, for example, 0.18116 for #767676\n *\n * @returns The contrast between the two luminance values, for example, 4.54\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function contrast(a: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": ", b: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/utilities/relative-luminance.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "a", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "b", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "contrast" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!contrastAndDeltaSwatchSet:function(1)", "docComment": "/**\n * Gets an interactive set of {@link Color}s using contrast from the reference color, then deltas for each state.\n *\n * Since this is based on contrast it tries to do the right thing for accessibility. Ideally the `restDelta` and `hoverDelta` should be greater than or equal to zero, because that will ensure those colors meet or exceed the `minContrast`.\n *\n * This algorithm will maintain the difference between the rest and hover deltas, but may slide them on the Palette to maintain accessibility.\n *\n * @param palette - The Palette used to find the Colors\n *\n * @param reference - The reference color\n *\n * @param minContrast - The desired minimum contrast from `reference`, which determines the base color\n *\n * @param restDelta - The rest state offset from the base color\n *\n * @param hoverDelta - The hover state offset from the base color\n *\n * @param activeDelta - The active state offset from the base color\n *\n * @param focusDelta - The focus state offset from the base color\n *\n * @param disabledDelta - The disabled state offset from the base color\n *\n * @param disabledPalette - The Palette for the disabled color\n *\n * @param direction - The direction the deltas move on the `palette`, defaults to {@link directionByIsDark} based on `reference`\n *\n * @param zeroAsTransparent - Treat a zero offset as transparent, defaults to true\n *\n * @returns The interactive set of Colors\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function contrastAndDeltaSwatchSet(palette: " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ", reference: " }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ", minContrast: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", restDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", hoverDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", activeDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", focusDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", disabledDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", disabledPalette?: " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ", direction?: " }, { "kind": "Reference", "text": "PaletteDirection", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type" }, { "kind": "Content", "text": ", zeroAsTransparent?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "InteractiveColorSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorSet:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipes/contrast-and-delta-swatch-set.d.ts", "returnTypeTokenRange": { "startIndex": 23, "endIndex": 24 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "palette", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "minContrast", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "restDelta", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "hoverDelta", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "activeDelta", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false }, { "parameterName": "focusDelta", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "isOptional": false }, { "parameterName": "disabledDelta", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 }, "isOptional": false }, { "parameterName": "disabledPalette", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 18 }, "isOptional": true }, { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 19, "endIndex": 20 }, "isOptional": true }, { "parameterName": "zeroAsTransparent", "parameterTypeTokenRange": { "startIndex": 21, "endIndex": 22 }, "isOptional": true } ], "name": "contrastAndDeltaSwatchSet" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!contrastSwatch:function(1)", "docComment": "/**\n * Gets a Color meeting the minimum contrast from the reference color.\n *\n * @param palette - The Palette used to find the Color\n *\n * @param reference - The reference color\n *\n * @param minContrast - The desired minimum contrast\n *\n * @param direction - The direction the delta moves on the `palette`, defaults to {@link directionByIsDark} based on `reference`\n *\n * @returns The Color\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function contrastSwatch(palette: " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ", reference: " }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ", minContrast: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", direction?: " }, { "kind": "Reference", "text": "PaletteDirection", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipes/contrast-swatch.d.ts", "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "palette", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "minContrast", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "contrastSwatch" }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!convertStylesToFocusState:var", "docComment": "/**\n * Converts `Styles` to focus-only state. This allows styles to be constructed as usual, using interactive sets or simple values, but convert the styles specifically to focus state to the necessary structure.\n *\n * @param styles - The input `Styles` to convert to focus-only styles.\n *\n * @returns Converted `Styles`.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "convertStylesToFocusState: " }, { "kind": "Content", "text": "(styles: " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "convertStylesToFocusState", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!CornerRadius:var", "docComment": "/**\n * @deprecated\n *\n * Use StylePropertyShorthand instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "CornerRadius: " }, { "kind": "Content", "text": "{\n all: (value: " }, { "kind": "Reference", "text": "StyleValue", "canonicalReference": "@adaptive-web/adaptive-ui!StyleValue:type" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ";\n}" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "CornerRadius", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createForegroundSet:function(1)", "docComment": "/**\n * Creates an {@link InteractiveTokenGroup} from the `rest` state of the foreground set to be applied over the interactive background tokens.\n *\n * @param foregroundRecipe - The recipe for the foreground.\n *\n * @param background - The interactive token group for the background.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createForegroundSet(foregroundRecipe: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractiveColorRecipe", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorRecipe:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", background: " }, { "kind": "Reference", "text": "InteractiveTokenGroup", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveTokenGroup:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "InteractiveTokenGroup", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveTokenGroup:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers-color.d.ts", "returnTypeTokenRange": { "startIndex": 11, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "foregroundRecipe", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false }, { "parameterName": "background", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "isOptional": false } ], "name": "createForegroundSet" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createForegroundSetBySet:function(1)", "docComment": "/**\n * Creates a TokenGroup of a set of interactive foreground tokens to be applied over the interactive background tokens.\n *\n * @param foregroundRecipe - The recipe for the foreground.\n *\n * @param background - The interactive token group for the background.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createForegroundSetBySet(foregroundRecipe: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractiveColorRecipeBySet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorRecipeBySet:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", background: " }, { "kind": "Reference", "text": "InteractiveTokenGroup", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveTokenGroup:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "InteractiveTokenGroup", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveTokenGroup:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers-color.d.ts", "returnTypeTokenRange": { "startIndex": 11, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "foregroundRecipe", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false }, { "parameterName": "background", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "isOptional": false } ], "name": "createForegroundSetBySet" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenColor:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for color value.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @param intendedFor - The style properties where this token is intended to be used.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenColor(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 8, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isOptional": true } ], "name": "createTokenColor" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenColorRecipe:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for a color recipe, optionally referencing a context color.\n *\n * @param baseName - The base token name in `dotted.camelCase` casing.\n *\n * @param intendedFor - The style properties where this token is intended to be used.\n *\n * @param evaluate - The function to call when the derived token needs to be evaluated.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenColorRecipe(baseName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", intendedFor: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", evaluate: " }, { "kind": "Reference", "text": "ColorRecipeEvaluate", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeEvaluate:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorRecipe", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipe:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers-color.d.ts", "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "baseName", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "isOptional": false }, { "parameterName": "evaluate", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "createTokenColorRecipe" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenColorRecipeBySet:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for a color recipe, referencing an interactive color set for context.\n *\n * @param baseName - The base token name in `dotted.camelCase` casing.\n *\n * @param intendedFor - The style properties where this token is intended to be used.\n *\n * @param evaluate - The function to call when the derived token needs to be evaluated.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenColorRecipeBySet(baseName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", intendedFor: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", evaluate: " }, { "kind": "Reference", "text": "ColorRecipeBySetEvaluate", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeBySetEvaluate:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorRecipeBySet", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeBySet:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers-color.d.ts", "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "baseName", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "isOptional": false }, { "parameterName": "evaluate", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "createTokenColorRecipeBySet" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenColorRecipeForPalette:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for a color recipe that works with different {@link Palette}s. Use in conjunction with {@link createTokenColorRecipeWithPalette}.\n *\n * @param baseName - The base token name in `dotted.camelCase` casing.\n *\n * @param intendedFor - The style properties where this token is intended to be used.\n *\n * @param evaluate - The function to call when the derived token needs to be evaluated.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenColorRecipeForPalette(baseName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", intendedFor: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", evaluate: " }, { "kind": "Reference", "text": "ColorRecipePaletteEvaluate", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipePaletteEvaluate:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorRecipePalette", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipePalette:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers-color.d.ts", "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "baseName", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "isOptional": false }, { "parameterName": "evaluate", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "createTokenColorRecipeForPalette" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenColorRecipeValue:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for the resulting color value from a recipe in styles.\n *\n * @param recipeToken - The color recipe token.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenColorRecipeValue(recipeToken: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorRecipe", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipe:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers-color.d.ts", "returnTypeTokenRange": { "startIndex": 8, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "recipeToken", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 7 }, "isOptional": false } ], "name": "createTokenColorRecipeValue" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenColorRecipeWithPalette:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for a specific {@link Palette} configuration of a shared color recipe.\n *\n * @param recipeToken - The shared token, typically from {@link createTokenColorRecipeForPalette}.\n *\n * @param paletteToken - The {@link Palette} token.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenColorRecipeWithPalette(recipeToken: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Recipe", "canonicalReference": "@adaptive-web/adaptive-ui!Recipe:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorRecipePaletteParams", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipePaletteParams:type" }, { "kind": "Content", "text": ", T>>" }, { "kind": "Content", "text": ", paletteToken: " }, { "kind": "Reference", "text": "DesignToken", "canonicalReference": "@microsoft/fast-foundation!DesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RecipeOptional", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeOptional:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorRecipeParams", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeParams:type" }, { "kind": "Content", "text": ", T>>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers-color.d.ts", "returnTypeTokenRange": { "startIndex": 15, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "recipeToken", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isOptional": false }, { "parameterName": "paletteToken", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "createTokenColorRecipeWithPalette" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenColorSet:function(1)", "docComment": "/**\n * Creates a TokenGroup that can be used for the evaluated value of an interactive color recipe.\n *\n * @param recipeToken - The interactive color recipe token.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenColorSet(recipeToken: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractiveColorRecipe", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorRecipe:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "InteractiveTokenGroup", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveTokenGroup:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers-color.d.ts", "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "recipeToken", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "name": "createTokenColorSet" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenDelta:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for interactive color recipe deltas.\n *\n * @param baseName - The base token name in `dotted.camelCase` casing.\n *\n * @param state - The state for the recipe delta value, or a custom identifier in camelCase.\n *\n * @param value - The value for the recipe delta.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenDelta(baseName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", state: " }, { "kind": "Reference", "text": "InteractiveState", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveState:enum" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "number | " }, { "kind": "Reference", "text": "DesignToken", "canonicalReference": "@microsoft/fast-foundation!DesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers-color.d.ts", "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "baseName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "state", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 9 }, "isOptional": false } ], "name": "createTokenDelta" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenDimension:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for thickness, sizes, and other dimension values in styles.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @param intendedFor - The style properties where this token is intended to be used.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenDimension(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isOptional": true } ], "name": "createTokenDimension" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenFontFamily:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for typography font family in styles.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenFontFamily(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createTokenFontFamily" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenFontSize:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for typography font size in styles.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenFontSize(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createTokenFontSize" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenFontStyle:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for typography font style (normal, italic) in styles.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenFontStyle(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createTokenFontStyle" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenFontVariations:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for typography font variations in styles.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenFontVariations(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createTokenFontVariations" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenFontWeight:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for typography font weight in styles.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenFontWeight(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createTokenFontWeight" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenLineHeight:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for typography line height in styles.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenLineHeight(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createTokenLineHeight" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenMinContrast:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for color recipe minimum contrast.\n *\n * @param baseName - The base token name in `dotted.camelCase` casing.\n *\n * @param value - The value for the recipe minimum contrast.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenMinContrast(baseName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", value: " }, { "kind": "Content", "text": "number | " }, { "kind": "Reference", "text": "DesignToken", "canonicalReference": "@microsoft/fast-foundation!DesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers-color.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "baseName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "isOptional": false } ], "name": "createTokenMinContrast" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenNonCss:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used by other DesignTokens, but not directly in styles.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @param type - The allowed types for the token value.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenNonCss(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type: " }, { "kind": "Reference", "text": "DesignTokenType", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenType:type" }, { "kind": "Content", "text": ", intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "isOptional": true } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "createTokenNonCss" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenNumber:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for number value.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @param intendedFor - The style properties where this token is intended to be used.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenNumber(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isOptional": true } ], "name": "createTokenNumber" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenNumberNonStyling:function(1)", "docComment": "/**\n * Creates a DesignToken for number values that can be used by other DesignTokens, but not directly in styles.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @param intendedFor - The style properties where this token is intended to be used.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenNumberNonStyling(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isOptional": true } ], "name": "createTokenNumberNonStyling" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenPaint:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used as a paint treatment (background, foreground, border, etc.) in styles.\n *\n * @remarks\n *\n * This is a token type allowing either `color` or `gradient` values.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @param intendedFor - The style properties where this token is intended to be used.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenPaint(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 8, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isOptional": true } ], "name": "createTokenPaint" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenRecipe:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used for a recipe.\n *\n * @param baseName - The base token name in `dotted.camelCase` casing.\n *\n * @param intendedFor - The style properties where this token is intended to be used.\n *\n * @param evaluate - The function to call when the derived token needs to be evaluated.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenRecipe(baseName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", intendedFor: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", evaluate: " }, { "kind": "Reference", "text": "RecipeEvaluate", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeEvaluate:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Recipe", "canonicalReference": "@adaptive-web/adaptive-ui!Recipe:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 11, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "baseName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isOptional": false }, { "parameterName": "evaluate", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "TParam", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TResult", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "createTokenRecipe" }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenShadow:var", "docComment": "/**\n * Creates a DesignToken that can be used for Shadow value.\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createTokenShadow: " }, { "kind": "Content", "text": "(name: string) => import(\"../adaptive-design-tokens.js\")." }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ShadowValue", "canonicalReference": "@adaptive-web/adaptive-ui!ShadowValue:type" }, { "kind": "Content", "text": ">" } ], "fileUrlPath": "dist/dts/core/shadow/index.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "createTokenShadow", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!createTokenSwatch:function(1)", "docComment": "/**\n * Creates a DesignToken that can be used as a color in styles.\n *\n * @deprecated\n *\n * Use createTokenColor or createTokenPaint\n *\n * @param name - The token name in `dotted.camelCase` casing.\n *\n * @param intendedFor - The style properties where this token is intended to be used.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createTokenSwatch(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Swatch", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 8, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isOptional": true } ], "name": "createTokenSwatch" }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!createTyped:var", "docComment": "/**\n * Creates a typed design token of a custom type. Use one of `createTokenX` if exists instead.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createTyped: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "TypedCSSDesignToken.createTyped", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken.createTyped:member" } ], "fileUrlPath": "dist/dts/core/token-helpers.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "createTyped", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!deltaSwatch:function(1)", "docComment": "/**\n * Color algorithm to get the Color a specified position away from the reference color.\n *\n * @param palette - The Palette used to find the Color\n *\n * @param reference - The reference color\n *\n * @param delta - The offset from the `reference`\n *\n * @param direction - The direction the delta moves on the `palette`, defaults to {@link directionByIsDark} based on `reference`\n *\n * @returns The Color\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function deltaSwatch(palette: " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ", reference: " }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ", delta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", direction?: " }, { "kind": "Reference", "text": "PaletteDirection", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipes/delta-swatch.d.ts", "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "palette", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "delta", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "deltaSwatch" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!deltaSwatchSet:function(1)", "docComment": "/**\n * Gets an interactive set of Colors the specified positions away from the reference color.\n *\n * @param palette - The Palette used to find the Colors\n *\n * @param reference - The reference color\n *\n * @param restDelta - The rest state offset from `reference`\n *\n * @param hoverDelta - The hover state offset from `reference`\n *\n * @param activeDelta - The active state offset from `reference`\n *\n * @param focusDelta - The focus state offset from `reference`\n *\n * @param disabledDelta - The disabled state offset from the base color\n *\n * @param disabledPalette - The Palette for the disabled color\n *\n * @param direction - The direction the deltas move on the `palette`, defaults to {@link directionByIsDark} based on `reference`\n *\n * @param zeroAsTransparent - Treat a zero offset as transparent, defaults to true\n *\n * @returns The interactive set of Colors\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function deltaSwatchSet(palette: " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ", reference: " }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ", restDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", hoverDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", activeDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", focusDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", disabledDelta?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", disabledPalette?: " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ", direction?: " }, { "kind": "Reference", "text": "PaletteDirection", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type" }, { "kind": "Content", "text": ", zeroAsTransparent?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "InteractiveColorSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorSet:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipes/delta-swatch-set.d.ts", "returnTypeTokenRange": { "startIndex": 21, "endIndex": 22 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "palette", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "restDelta", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "hoverDelta", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "activeDelta", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "focusDelta", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false }, { "parameterName": "disabledDelta", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "isOptional": true }, { "parameterName": "disabledPalette", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 }, "isOptional": true }, { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 18 }, "isOptional": true }, { "parameterName": "zeroAsTransparent", "parameterTypeTokenRange": { "startIndex": 19, "endIndex": 20 }, "isOptional": true } ], "name": "deltaSwatchSet" }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!densityAdjustmentUnits:var", "docComment": "/**\n * The adjustment (plus or minus) to density unit values.\n *\n * @remarks\n *\n * Ex: `-1` to reduce all density values. Positive or negative values, may be fractional. Note that _this_ value is additive, not a multiplier, thus `0` has no effect, while `1` adds a unit.\n *\n * @defaultValue\n *\n * 0\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "densityAdjustmentUnits: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" } ], "fileUrlPath": "dist/dts/core/density/index.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "densityAdjustmentUnits", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup:class", "docComment": "/**\n * A model for defining component density using padding (spaced around the inside of the component bounds) and gap (space between elements within a component).\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class DensityPaddingAndGapTokenGroup implements " }, { "kind": "Reference", "text": "TokenGroup", "canonicalReference": "@adaptive-web/adaptive-ui!TokenGroup:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/density/index.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "DensityPaddingAndGapTokenGroup", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup:constructor(1)", "docComment": "/**\n * Creates a new token group with the specified unit values and default calculations.\n *\n * @param name - The base name of the token group.\n *\n * @param horizontalPaddingUnits - The initial value, ex: `3`.\n *\n * @param horizontalGapUnits - The initial value, ex: `1`.\n *\n * @param verticalPaddingUnits - The initial value, ex: `2`.\n *\n * @param verticalGapUnits - The initial value, ex: `1`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", horizontalPaddingUnits: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", horizontalGapUnits: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", verticalPaddingUnits: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", verticalGapUnits: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", designUnit: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "DesignToken", "canonicalReference": "@microsoft/fast-foundation!DesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ", borderThickness: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "DesignToken", "canonicalReference": "@microsoft/fast-foundation!DesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "horizontalPaddingUnits", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "horizontalGapUnits", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "verticalPaddingUnits", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "verticalGapUnits", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "designUnit", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 14 }, "isOptional": false }, { "parameterName": "borderThickness", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 18 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup#borderThickness:member", "docComment": "/**\n * The dimension of the border for density calculation.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly borderThickness: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "borderThickness", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup#designUnit:member", "docComment": "/**\n * The dimension of a design unit for density calculation.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly designUnit: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "designUnit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup#horizontalGap:member", "docComment": "/**\n * The calculated measurement for the horizontal gap between elements within a control.\n *\n * @remarks\n *\n * This is useful as a `gap` for `flex` layouts or as a `margin` on elements next to other elements.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly horizontalGap: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "horizontalGap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup#horizontalGapUnits:member", "docComment": "/**\n * The design unit multiplier for control density horizontal gap between elements.\n *\n * @remarks\n *\n * Ex: `2` to set the gap to 2 units. May be fractional.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly horizontalGapUnits: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "horizontalGapUnits", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup#horizontalPadding:member", "docComment": "/**\n * The calculated measurement for control horizontal padding, adjusted for border thickness.\n *\n * @remarks\n *\n * Calculated from `horizontalPaddingUnits`, `designUnit`, and `strokeThickness`.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly horizontalPadding: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "horizontalPadding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup#horizontalPaddingUnits:member", "docComment": "/**\n * The design unit multiplier for control density horizontal padding.\n *\n * @remarks\n *\n * Ex: `3` to set the padding to 3 units. Positive values, may be fractional.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly horizontalPaddingUnits: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "horizontalPaddingUnits", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup#padding:member", "docComment": "/**\n * Convenience accessor for vertical and horizontal padding, adjusted for border thickness.\n *\n * @remarks\n *\n * Convenience combination of `verticalPadding` and `horizontalPadding`.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get padding(): " }, { "kind": "Reference", "text": "CSSDirective", "canonicalReference": "@microsoft/fast-element!CSSDirective:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "padding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup#verticalGap:member", "docComment": "/**\n * The calculated measurement for the vertical gap between elements within a control.\n *\n * @remarks\n *\n * This is useful as a `gap` for `flex` layouts or as a `margin` on elements next to other elements.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly verticalGap: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "verticalGap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup#verticalGapUnits:member", "docComment": "/**\n * The design unit multiplier for control density vertical gap between elements.\n *\n * @remarks\n *\n * Ex: `2` to set the gap to 2 units. May be fractional.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly verticalGapUnits: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "verticalGapUnits", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup#verticalPadding:member", "docComment": "/**\n * The calculated measurement for control vertical padding, adjusted for border thickness.\n *\n * @remarks\n *\n * Calculated from `verticalPaddingUnits`, `designUnit`, and `strokeThickness`.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly verticalPadding: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "verticalPadding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DensityPaddingAndGapTokenGroup#verticalPaddingUnits:member", "docComment": "/**\n * The design unit multiplier for control density vertical padding.\n *\n * @remarks\n *\n * Ex: `2` to set the padding to 2 units. May be fractional.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly verticalPaddingUnits: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "verticalPaddingUnits", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenMetadata:type", "docComment": "/**\n * Metadata describing the value type and intended styling uses of a DesignToken.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type DesignTokenMetadata = " }, { "kind": "Content", "text": "{\n readonly type: " }, { "kind": "Reference", "text": "DesignTokenType", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenType:type" }, { "kind": "Content", "text": ";\n readonly intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[];\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/adaptive-design-tokens.d.ts", "releaseTag": "Public", "name": "DesignTokenMetadata", "typeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenMultiValue:class", "docComment": "/**\n * A design token value for css properties which can have multiple values, like `box-shadow`.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class DesignTokenMultiValue extends " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": " implements " }, { "kind": "Reference", "text": "CSSDirective", "canonicalReference": "@microsoft/fast-element!CSSDirective:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/adaptive-design-tokens.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 3 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isAbstract": false, "name": "DesignTokenMultiValue", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenMultiValue#createCSS:member(1)", "docComment": "/**\n * {@inheritdoc @microsoft/fast-element#CSSDirective.createCSS}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createCSS(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "createCSS" } ], "extendsTokenRange": { "startIndex": 4, "endIndex": 6 }, "implementsTokenRanges": [ { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenMultiValuePaint:class", "docComment": "/**\n * A design token value for paint purposes which can have multiple values, like `background`.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class DesignTokenMultiValuePaint extends " }, { "kind": "Reference", "text": "DesignTokenMultiValue", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenMultiValue:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PaintBase", "canonicalReference": "@adaptive-web/adaptive-ui!PaintBase:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " implements " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/paint.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "DesignTokenMultiValuePaint", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenMultiValuePaint#contrast:member(1)", "docComment": "/**\n * Gets the contrast between this relative luminance and another.\n *\n * @returns The contrast between the two luminance values, for example, 4.54\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contrast(b: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "b", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "contrast" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenMultiValuePaint#relativeLuminance:member", "docComment": "/**\n * A number between 0 and 1, calculated by {@link https://www.w3.org/WAI/GL/wiki/Relative_luminance}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get relativeLuminance(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "relativeLuminance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 5 }, "implementsTokenRanges": [ { "startIndex": 6, "endIndex": 7 } ] }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenRegistry:class", "docComment": "/**\n * A global registry for looking up Design Tokens by ID.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare abstract class DesignTokenRegistry " } ], "fileUrlPath": "dist/dts/core/adaptive-design-tokens.d.ts", "releaseTag": "Public", "isAbstract": true, "name": "DesignTokenRegistry", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenRegistry.Groups:member", "docComment": "/**\n * The Design Token Group registry.\n *\n * @remarks\n *\n * Currently only Interactive Token Groups are meaningful and supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static Groups: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Groups", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenRegistry.Shared:member", "docComment": "/**\n * The shared Design Token registry.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static Shared: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Shared", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isStatic": true, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenType:type", "docComment": "/**\n * A design token data type, either from the community group, Adaptive UI, or custom.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type DesignTokenType = " }, { "kind": "Reference", "text": "ValuesOf", "canonicalReference": "@microsoft/fast-foundation!ValuesOf:type" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/adaptive-design-tokens.d.ts", "releaseTag": "Public", "name": "DesignTokenType", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenType:var", "docComment": "/**\n * Standard design token types from the community group and new types defined in Adaptive UI.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "DesignTokenType: " }, { "kind": "Content", "text": "{\n readonly color: \"color\";\n readonly dimension: \"dimension\";\n readonly fontFamily: \"fontFamily\";\n readonly fontWeight: \"fontWeight\";\n readonly duration: \"duration\";\n readonly cubicBezier: \"cubicBezier\";\n readonly number: \"number\";\n readonly strokeStyle: \"strokeStyle\";\n readonly border: \"border\";\n readonly transition: \"transition\";\n readonly shadow: \"shadow\";\n readonly gradient: \"gradient\";\n readonly typography: \"typography\";\n readonly boolean: \"boolean\";\n readonly fontStyle: \"fontStyle\";\n readonly fontVariations: \"fontVariations\";\n readonly palette: \"palette\";\n readonly recipe: \"recipe\";\n readonly paint: \"paint\";\n readonly string: \"string\";\n}" } ], "fileUrlPath": "dist/dts/core/adaptive-design-tokens.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "DesignTokenType", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!directionByIsDark:function(1)", "docComment": "/**\n * Gets an inverse directional multiplier based on whether the `color` is dark or light.\n *\n * @param color - The color to check\n *\n * @returns `darker` if the `color` is light, `lighter` if the `color` is dark\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function directionByIsDark(color: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PaletteDirectionValue", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirectionValue:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/utilities/direction-by-is-dark.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "directionByIsDark" }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!EffectiveStylePropertiesMap:type", "docComment": "/**\n * A `Map` of style definitions, where the key is a string and the value is the token or final value.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type EffectiveStylePropertiesMap = " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "releaseTag": "Public", "name": "EffectiveStylePropertiesMap", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!ElementStylesRenderer:class", "docComment": "/**\n * Renders Adaptive UI Styles as ElementStyles.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ElementStylesRenderer " } ], "fileUrlPath": "dist/dts/core/modules/element-styles-renderer.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ElementStylesRenderer", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!ElementStylesRenderer:constructor(1)", "docComment": "/**\n * Creates a new ElementStylesRenderer.\n *\n * @param styles - A collection of individual styling properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(styles: " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "styles", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!ElementStylesRenderer.disabledStyles:member", "docComment": "/**\n * Styles to merge in for any `ComponentAnatomy` which defines a `disabled` state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static disabledStyles: " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "disabledStyles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!ElementStylesRenderer.focusResetStyles:member", "docComment": "/**\n * Styles to merge in for any `ComponentAnatomy` which defines a `focus` reset target.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static get focusResetStyles(): " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": ";\n\nstatic set focusResetStyles(styles: " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": ");" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "focusResetStyles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!ElementStylesRenderer.focusStateStyles:member", "docComment": "/**\n * Styles to merge in for any `ComponentAnatomy` which defines a `focus` state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static get focusStateStyles(): " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": ";\n\nstatic set focusStateStyles(styles: " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": ");" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "focusStateStyles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!ElementStylesRenderer#render:member(1)", "docComment": "/**\n * Convert style definitions to `ElementStyles`.\n *\n * @param target - Parameters for creating the selectors for component states.\n *\n * @param interactivity - The interactivity configuration for the component.\n *\n * @returns The rendered `ElementStyles`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "render(target: " }, { "kind": "Reference", "text": "StyleModuleTarget", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleTarget:interface" }, { "kind": "Content", "text": ", interactivity?: " }, { "kind": "Reference", "text": "InteractivityDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivityDefinition:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElementStyles", "canonicalReference": "@microsoft/fast-element!ElementStyles:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "interactivity", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "render" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!ElementStylesRenderer.renderStyleRules:member(1)", "docComment": "/**\n * Convert style rule definitions to `ElementStyles`.\n *\n * @param baseStyles - Any base styles to append style rules to.\n *\n * @param styleRules - Adaptive UI style rules.\n *\n * @param anatomy - Optional component anatomy for features including interactivity and focus definition.\n *\n * @returns The rendered `ElementStyles`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static renderStyleRules(baseStyles: " }, { "kind": "Reference", "text": "ComposableStyles", "canonicalReference": "@microsoft/fast-element!ComposableStyles:type" }, { "kind": "Content", "text": "[] | undefined" }, { "kind": "Content", "text": ", styleRules: " }, { "kind": "Reference", "text": "StyleRules", "canonicalReference": "@adaptive-web/adaptive-ui!StyleRules:type" }, { "kind": "Content", "text": ", anatomy?: " }, { "kind": "Reference", "text": "ComponentAnatomy", "canonicalReference": "@adaptive-web/adaptive-ui!ComponentAnatomy:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ElementStyles", "canonicalReference": "@microsoft/fast-element!ElementStyles:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "baseStyles", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "styleRules", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false }, { "parameterName": "anatomy", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "renderStyleRules" } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ElevationRecipe:type", "docComment": "/**\n * A recipe that evaluates to an elevation treatment, commonly, but not limited to, a box shadow.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ElevationRecipe = " }, { "kind": "Reference", "text": "Recipe", "canonicalReference": "@adaptive-web/adaptive-ui!Recipe:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/elevation/recipe.d.ts", "releaseTag": "Public", "name": "ElevationRecipe", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ElevationRecipeEvaluate:type", "docComment": "/**\n * The type of the `evaluate` function for {@link ElevationRecipe}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ElevationRecipeEvaluate = " }, { "kind": "Reference", "text": "RecipeEvaluate", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeEvaluate:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/elevation/recipe.d.ts", "releaseTag": "Public", "name": "ElevationRecipeEvaluate", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!Fill:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Fill: " }, { "kind": "Content", "text": "{\n backgroundAndForeground: (background: " }, { "kind": "Reference", "text": "InteractiveTokenGroup", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveTokenGroup:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">, foregroundRecipe: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractiveColorRecipe", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorRecipe:type" }, { "kind": "Content", "text": ">) => " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ";\n backgroundAndForegroundBySet: (background: " }, { "kind": "Reference", "text": "InteractiveTokenGroup", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveTokenGroup:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">, foregroundRecipe: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractiveColorRecipeBySet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorRecipeBySet:type" }, { "kind": "Content", "text": ">) => " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ";\n backgroundNonInteractive: (background: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">, disabled?: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">) => " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ";\n foregroundNonInteractive: (foreground: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">, disabled?: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ">) => " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ";\n}" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "Fill", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 42 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!Focus:var", "docComment": "/**\n * Common patterns for {@link FocusDefinition}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Focus: " }, { "kind": "Content", "text": "{\n readonly contextFocused: () => " }, { "kind": "Reference", "text": "FocusDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!FocusDefinition:interface" }, { "kind": "Content", "text": ";\n readonly contextChildFocused: (indicatorPart: keyof TParts & string) => " }, { "kind": "Reference", "text": "FocusDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!FocusDefinition:interface" }, { "kind": "Content", "text": ";\n readonly partFocused: (part: keyof TParts_1 & string) => " }, { "kind": "Reference", "text": "FocusDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!FocusDefinition:interface" }, { "kind": "Content", "text": ";\n readonly partWithin: (indicatorPart: keyof TParts_2 & string, focusablePart: keyof TParts_2 & string) => " }, { "kind": "Reference", "text": "FocusDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!FocusDefinition:interface" }, { "kind": "Content", "text": ";\n}" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "Focus", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 10 } }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!FocusDefinition:interface", "docComment": "/**\n * Defines the focus indicator structure for the component, including which part will naturally receive focus and which part should indicate it.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FocusDefinition " } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "TParts", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "FocusDefinition", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!FocusDefinition#focusTarget:member", "docComment": "/**\n * The focus indication element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focusTarget: " }, { "kind": "Reference", "text": "StyleModuleTarget", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleTarget:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "focusTarget", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!FocusDefinition#resetTarget:member", "docComment": "/**\n * The focusable element to reset browser default styles, for instance, a native input element or an element with a `tabindex`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resetTarget?: " }, { "kind": "Reference", "text": "StyleModuleTarget", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleTarget:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "resetTarget", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!Gradient:class", "docComment": "/**\n * Represents a gradient.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare abstract class Gradient extends " }, { "kind": "Reference", "text": "PaintBase", "canonicalReference": "@adaptive-web/adaptive-ui!PaintBase:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/gradient.d.ts", "releaseTag": "Public", "isAbstract": true, "name": "Gradient", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!Gradient:constructor(1)", "docComment": "/**\n * Creates a new Gradient.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(stops: " }, { "kind": "Reference", "text": "GradientStop", "canonicalReference": "@adaptive-web/adaptive-ui!GradientStop:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "stops", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Gradient#createCSS:member", "docComment": "/**\n * Gets this gradient value as a string for use in css.\n *\n * @returns The gradient value in a valid css string format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createCSS: " }, { "kind": "Content", "text": "() => string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "createCSS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Gradient#stops:member", "docComment": "/**\n * The stops on the gradient.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly stops: " }, { "kind": "Reference", "text": "GradientStop", "canonicalReference": "@adaptive-web/adaptive-ui!GradientStop:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "stops", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Gradient#stopsListCSS:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected get stopsListCSS(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "stopsListCSS", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Gradient#toString:member(1)", "docComment": "/**\n * Gets this gradient value as a string.\n *\n * @returns The gradient value in string format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "abstract toString(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": true, "name": "toString" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Gradient#type:member", "docComment": "/**\n * The type of gradient.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "abstract readonly type: " }, { "kind": "Reference", "text": "GradientType", "canonicalReference": "@adaptive-web/adaptive-ui!GradientType:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": true } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!GradientStop:type", "docComment": "/**\n * Represents a single {@link Color} stop on a {@link Gradient}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type GradientStop = " }, { "kind": "Content", "text": "{\n color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";\n position: " }, { "kind": "Reference", "text": "GradientStopPosition", "canonicalReference": "@adaptive-web/adaptive-ui!GradientStopPosition:type" }, { "kind": "Content", "text": ";\n endPosition?: " }, { "kind": "Reference", "text": "GradientStopPosition", "canonicalReference": "@adaptive-web/adaptive-ui!GradientStopPosition:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/gradient.d.ts", "releaseTag": "Public", "name": "GradientStop", "typeTokenRange": { "startIndex": 1, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!GradientStopPosition:type", "docComment": "/**\n * Represents the position of a single {@link GradientStop}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type GradientStopPosition = " }, { "kind": "Content", "text": "{\n value: number;\n unit: \"%\" | \"px\" | \"deg\";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/gradient.d.ts", "releaseTag": "Public", "name": "GradientStopPosition", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!GradientType:type", "docComment": "/**\n * Supported gradient types.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type GradientType = " }, { "kind": "Content", "text": "\"conic\" | \"linear\" | \"radial\"" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/gradient.d.ts", "releaseTag": "Public", "name": "GradientType", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!hueShiftGradient:function(1)", "docComment": "/**\n * Color algorithm for a gradient with the source palette in the middle and the hue shifted for the start and end.\n *\n * @param palette - The Palette used for the base of the hue shift\n *\n * @param reference - The reference color\n *\n * @param delta - The offset from the `reference`\n *\n * @param angle - The angle of the gradient\n *\n * @param startShift - The amount and direction of the hue shift at the start\n *\n * @param endShift - The amount and direction of the hue shift at the end\n *\n * @param direction - The direction the delta moves on the palettes, defaults to {@link directionByIsDark} based on `reference`\n *\n * @returns The Gradient\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function hueShiftGradient(palette: " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ", reference: " }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ", delta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", angle?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", startShift?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", endShift?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", direction?: " }, { "kind": "Reference", "text": "PaletteDirection", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Gradient", "canonicalReference": "@adaptive-web/adaptive-ui!Gradient:class" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipes/hue-shift-gradient.d.ts", "returnTypeTokenRange": { "startIndex": 15, "endIndex": 16 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "palette", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "delta", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "angle", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true }, { "parameterName": "startShift", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true }, { "parameterName": "endShift", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": true }, { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "isOptional": true } ], "name": "hueShiftGradient" }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!idealColorDeltaSwatchSet:function(1)", "docComment": "/**\n * Gets an interactive set of {@link Color}s using contrast from the reference color. If the ideal color meets contrast it is used for the base color, if not it's adjusted until contrast is met. Then deltas from that color are used for each state.\n *\n * This algorithm is similar to {@link contrastAndDeltaSwatchSet}, with the addition of `idealColor`. This is often preferable for brand colors, like for an accent-filled Button.\n *\n * Since this is based on contrast it tries to do the right thing for accessibility. Ideally the `restDelta` and `hoverDelta` should be greater than or equal to zero, because that will ensure those colors meet or exceed the `minContrast`.\n *\n * This algorithm will maintain the difference between the rest and hover deltas, but may slide them on the Palette to maintain accessibility.\n *\n * @param palette - The Palette used to find the Colors\n *\n * @param reference - The reference color\n *\n * @param idealColor - The color to use as the base color if it meets `minContrast` from `reference`\n *\n * @param minContrast - The desired minimum contrast from `reference`, which determines the base color\n *\n * @param restDelta - The rest state offset from the base color\n *\n * @param hoverDelta - The hover state offset from the base color\n *\n * @param activeDelta - The active state offset from the base color\n *\n * @param focusDelta - The focus state offset from the base color\n *\n * @param disabledDelta - The disabled state offset from the base color\n *\n * @param disabledPalette - The Palette for the disabled color\n *\n * @param direction - The direction the deltas move on the `palette`, defaults to {@link directionByIsDark} based on `reference`\n *\n * @returns The interactive set of Colors\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function idealColorDeltaSwatchSet(palette: " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ", reference: " }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ", minContrast: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", idealColor: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ", restDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", hoverDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", activeDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", focusDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", disabledDelta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", disabledPalette?: " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ", direction?: " }, { "kind": "Reference", "text": "PaletteDirection", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "InteractiveColorSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorSet:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipes/ideal-color-delta-swatch-set.d.ts", "returnTypeTokenRange": { "startIndex": 23, "endIndex": 24 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "palette", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "minContrast", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "idealColor", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "restDelta", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "hoverDelta", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false }, { "parameterName": "activeDelta", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "isOptional": false }, { "parameterName": "focusDelta", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 }, "isOptional": false }, { "parameterName": "disabledDelta", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 18 }, "isOptional": false }, { "parameterName": "disabledPalette", "parameterTypeTokenRange": { "startIndex": 19, "endIndex": 20 }, "isOptional": true }, { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 21, "endIndex": 22 }, "isOptional": true } ], "name": "idealColorDeltaSwatchSet" }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorRecipe:type", "docComment": "/**\n * A recipe that evaluates a color value for rest, hover, active, and focus states.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type InteractiveColorRecipe = " }, { "kind": "Reference", "text": "ColorRecipe", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipe:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractivePaintSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivePaintSet:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "InteractiveColorRecipe", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorRecipeBySet:type", "docComment": "/**\n * A recipe that evaluates a color value for rest, hover, active, and focus states.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type InteractiveColorRecipeBySet = " }, { "kind": "Reference", "text": "ColorRecipeBySet", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeBySet:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractivePaintSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivePaintSet:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "InteractiveColorRecipeBySet", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorRecipeBySetEvaluate:type", "docComment": "/**\n * The type of the `evaluate` function for {@link InteractiveColorRecipeBySet}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type InteractiveColorRecipeBySetEvaluate = " }, { "kind": "Reference", "text": "ColorRecipeBySetEvaluate", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeBySetEvaluate:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractivePaintSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivePaintSet:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "InteractiveColorRecipeBySetEvaluate", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorRecipeEvaluate:type", "docComment": "/**\n * The type of the `evaluate` function for {@link InteractiveColorRecipe}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type InteractiveColorRecipeEvaluate = " }, { "kind": "Reference", "text": "ColorRecipeEvaluate", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipeEvaluate:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractivePaintSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivePaintSet:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "InteractiveColorRecipeEvaluate", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorRecipePalette:type", "docComment": "/**\n * A recipe that evaluates a color value for rest, hover, active, and focus states using the provided Palette.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type InteractiveColorRecipePalette = " }, { "kind": "Reference", "text": "ColorRecipePalette", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipePalette:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractivePaintSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivePaintSet:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "InteractiveColorRecipePalette", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorRecipePaletteEvaluate:type", "docComment": "/**\n * The type of the `evaluate` function for {@link InteractiveColorRecipePalette}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type InteractiveColorRecipePaletteEvaluate = " }, { "kind": "Reference", "text": "ColorRecipePaletteEvaluate", "canonicalReference": "@adaptive-web/adaptive-ui!ColorRecipePaletteEvaluate:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "InteractivePaintSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivePaintSet:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "InteractiveColorRecipePaletteEvaluate", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorSet:interface", "docComment": "/**\n * A set of {@link Color}s to use for an interactive control's states.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InteractiveColorSet extends " }, { "kind": "Reference", "text": "InteractiveValues", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveValues:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": " | null>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "InteractiveColorSet", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivePaintSet:interface", "docComment": "/**\n * A set of {@link Paint}s to use for an interactive control's states.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InteractivePaintSet extends " }, { "kind": "Reference", "text": "InteractiveValues", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveValues:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": " | null>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/recipe.d.ts", "releaseTag": "Public", "name": "InteractivePaintSet", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Enum", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveState:enum", "docComment": "/**\n * An interactive element's states.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum InteractiveState " } ], "fileUrlPath": "dist/dts/core/types.d.ts", "releaseTag": "Public", "name": "InteractiveState", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveState.active:member", "docComment": "/**\n * The active state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "active = " }, { "kind": "Content", "text": "\"active\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "active" }, { "kind": "EnumMember", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveState.disabled:member", "docComment": "/**\n * The disabled state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disabled = " }, { "kind": "Content", "text": "\"disabled\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "disabled" }, { "kind": "EnumMember", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveState.focus:member", "docComment": "/**\n * The focus state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "focus = " }, { "kind": "Content", "text": "\"focus\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "focus" }, { "kind": "EnumMember", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveState.hover:member", "docComment": "/**\n * The hover state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hover = " }, { "kind": "Content", "text": "\"hover\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "hover" }, { "kind": "EnumMember", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveState.rest:member", "docComment": "/**\n * The rest state.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rest = " }, { "kind": "Content", "text": "\"rest\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "rest" } ] }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!interactiveSwatchSetAsOverlay:function(1)", "docComment": "/**\n * Returns an interactive set of opaque {@link Color}s or {@link Color}s with opacity relative to the reference color.\n *\n * @param set - The swatch set for which to make overlay.\n *\n * @param reference - The reference color for a semitransparent swatch.\n *\n * @param asOverlay - True to return a semitransparent representation of `swatch` relative to `reference`.\n *\n * @returns The requested representation of a `swatch` set.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function interactiveSwatchSetAsOverlay(set: " }, { "kind": "Reference", "text": "InteractiveColorSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorSet:interface" }, { "kind": "Content", "text": ", reference: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ", asOverlay: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "InteractiveColorSet", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveColorSet:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/utilities/opacity.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "set", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "asOverlay", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "interactiveSwatchSetAsOverlay" }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveTokenGroup:interface", "docComment": "/**\n * A group of tokens to use for an interactive element's states.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface InteractiveTokenGroup extends " }, { "kind": "Reference", "text": "MakePropertyRequired", "canonicalReference": "@adaptive-web/adaptive-ui!MakePropertyRequired:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TokenGroup", "canonicalReference": "@adaptive-web/adaptive-ui!TokenGroup:interface" }, { "kind": "Content", "text": ", \"type\">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "InteractiveValues", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveValues:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/types.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "InteractiveTokenGroup", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 }, { "startIndex": 6, "endIndex": 10 } ] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveValues:type", "docComment": "/**\n * Values for an interactive element's states.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type InteractiveValues = " }, { "kind": "Content", "text": "{\n [key in " }, { "kind": "Reference", "text": "InteractiveState", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveState:enum" }, { "kind": "Content", "text": "]: T;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/types.d.ts", "releaseTag": "Public", "name": "InteractiveValues", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!Interactivity:var", "docComment": "/**\n * Common patterns for {@link InteractivityDefinition}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Interactivity: " }, { "kind": "Content", "text": "{\n readonly disabledAttribute: " }, { "kind": "Reference", "text": "InteractivityDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivityDefinition:type" }, { "kind": "Content", "text": ";\n readonly disabledClass: " }, { "kind": "Reference", "text": "InteractivityDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivityDefinition:type" }, { "kind": "Content", "text": ";\n readonly hrefAttribute: " }, { "kind": "Reference", "text": "InteractivityDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivityDefinition:type" }, { "kind": "Content", "text": ";\n readonly always: " }, { "kind": "Reference", "text": "InteractivityDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivityDefinition:type" }, { "kind": "Content", "text": ";\n readonly never: " }, { "kind": "Reference", "text": "InteractivityDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivityDefinition:type" }, { "kind": "Content", "text": ";\n}" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "Interactivity", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 12 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivityDefinition:type", "docComment": "/**\n * Conditions supported by a component to inform the style rules of its interactivity configuration.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type InteractivityDefinition = " }, { "kind": "Content", "text": "{\n [key in " }, { "kind": "Reference", "text": "InteractiveState", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveState:enum" }, { "kind": "Content", "text": "]?: string;\n} & {\n interactive?: string;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "name": "InteractivityDefinition", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!isDark:function(1)", "docComment": "/**\n * Determines if a `color` is dark according to relative luminance. That is, from a contrast perspective, whether it has more contrast against white than black. In grey, dark is #757575 and darker.\n *\n * @param color - The color to check\n *\n * @returns True when the `color` is dark\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isDark(color: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/utilities/is-dark.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isDark" }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!LinearGradient:class", "docComment": "/**\n * Represents a linear gradient.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class LinearGradient extends " }, { "kind": "Reference", "text": "Gradient", "canonicalReference": "@adaptive-web/adaptive-ui!Gradient:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/gradient.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "LinearGradient", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!LinearGradient:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `LinearGradient` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(stops: " }, { "kind": "Reference", "text": "GradientStop", "canonicalReference": "@adaptive-web/adaptive-ui!GradientStop:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", angle?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "stops", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "angle", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!LinearGradient#angle:member", "docComment": "/**\n * The angle of the gradient in degrees.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly angle: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "angle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!LinearGradient#toString:member(1)", "docComment": "/**\n * Gets this gradient value as a string.\n *\n * @returns The gradient value in string format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toString(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "toString" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!LinearGradient#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly type: " }, { "kind": "Reference", "text": "GradientType", "canonicalReference": "@adaptive-web/adaptive-ui!GradientType:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!luminanceSwatch:function(1)", "docComment": "/**\n * Create a grey {@link Color} for the specified `luminance`. Note this is absolute luminance not 'relative' luminance.\n *\n * @param luminance - A value between 0 and 1 representing the desired luminance, for example, 0.5 for middle grey, 0 = black, 1 = white\n *\n * @returns A swatch for the specified grey value\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function luminanceSwatch(luminance: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/utilities/luminance-swatch.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "luminance", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "luminanceSwatch" }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!MakePropertyOptional:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type MakePropertyOptional = " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": " & {\n [P in K]?: T[P];\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/types.d.ts", "releaseTag": "Public", "name": "MakePropertyOptional", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!MakePropertyRequired:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type MakePropertyRequired = " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "Required", "canonicalReference": "!Required:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Pick", "canonicalReference": "!Pick:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/types.d.ts", "releaseTag": "Public", "name": "MakePropertyRequired", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 9 } }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!makeSelector:function(1)", "docComment": "/**\n * Creates a single css selector for the provided `params` and `state`.\n *\n * @param params - Parameters for the selector.\n *\n * @param state - The interactive state.\n *\n * @returns A css selector string.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function makeSelector(params: " }, { "kind": "Reference", "text": "StyleModuleEvaluateParameters", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleEvaluateParameters:type" }, { "kind": "Content", "text": ", state: " }, { "kind": "Reference", "text": "InteractiveState", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveState:enum" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/selector.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "state", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "makeSelector" }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!Padding:var", "docComment": "/**\n * @deprecated\n *\n * Use StylePropertyShorthand instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Padding: " }, { "kind": "Content", "text": "{\n all: (value: " }, { "kind": "Reference", "text": "StyleValue", "canonicalReference": "@adaptive-web/adaptive-ui!StyleValue:type" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ";\n verticalHorizontal: (valueVertical: " }, { "kind": "Reference", "text": "StyleValue", "canonicalReference": "@adaptive-web/adaptive-ui!StyleValue:type" }, { "kind": "Content", "text": ", valueHorizontal: " }, { "kind": "Reference", "text": "StyleValue", "canonicalReference": "@adaptive-web/adaptive-ui!StyleValue:type" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ";\n}" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "Padding", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 12 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type", "docComment": "/**\n * The type of a Paint token value.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Paint = " }, { "kind": "Reference", "text": "PaintBase", "canonicalReference": "@adaptive-web/adaptive-ui!PaintBase:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "DesignTokenMultiValuePaint", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenMultiValuePaint:class" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/paint.d.ts", "releaseTag": "Public", "name": "Paint", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!PaintBase:class", "docComment": "/**\n * Abstract representation of a value which can be used to paint a style like a fill or border.\n *\n * See {@link Color} of {@link Gradient} for concrete implementations.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare abstract class PaintBase implements " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "CSSDirective", "canonicalReference": "@microsoft/fast-element!CSSDirective:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/paint.d.ts", "releaseTag": "Public", "isAbstract": true, "name": "PaintBase", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!PaintBase:constructor(1)", "docComment": "/**\n * Creates a new Color.\n *\n * @param color - The underlying Color value\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected constructor(relativeLuminance: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [ { "parameterName": "relativeLuminance", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!PaintBase#contrast:member(1)", "docComment": "/**\n * Gets the contrast between this relative luminance and another.\n *\n * @returns The contrast between the two luminance values, for example, 4.54\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contrast(b: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "b", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "contrast" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!PaintBase#createCSS:member(1)", "docComment": "/**\n * Creates a CSS fragment to interpolate into the CSS document.\n *\n * @returns - the string to interpolate into CSS\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createCSS(add: " }, { "kind": "Reference", "text": "AddBehavior", "canonicalReference": "@microsoft/fast-element!AddBehavior:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ComposableStyles", "canonicalReference": "@microsoft/fast-element!ComposableStyles:type" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "add", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "createCSS" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!PaintBase#relativeLuminance:member", "docComment": "/**\n * A number between 0 and 1, calculated by {@link https://www.w3.org/WAI/GL/wiki/Relative_luminance}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get relativeLuminance(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "relativeLuminance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface", "docComment": "/**\n * A collection of {@link Color}s that form a luminance gradient from light (index 0) to dark.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Palette " } ], "fileUrlPath": "dist/dts/core/color/palette.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "Palette", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "@adaptive-web/adaptive-ui!Palette#closestIndexOf:member(1)", "docComment": "/**\n * Returns the index of the Palette that most closely matches the provided relative luminance.\n *\n * @param reference - The relative luminance of the reference\n *\n * @returns The index\n */\n", "excerptTokens": [ { "kind": "Content", "text": "closestIndexOf(reference: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "closestIndexOf" }, { "kind": "MethodSignature", "canonicalReference": "@adaptive-web/adaptive-ui!Palette#colorContrast:member(1)", "docComment": "/**\n * Returns a Color from the Palette that most closely meets the `minContrast` ratio for to the `reference`.\n *\n * @param reference - The relative luminance of the reference\n *\n * @param minContrast - The minimum amount of contrast from the `reference`\n *\n * @param initialIndex - Optional starting point for the search\n *\n * @param direction - Optional control for the direction of the search\n *\n * @returns The Color that meets the provided contrast\n */\n", "excerptTokens": [ { "kind": "Content", "text": "colorContrast(reference: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": ", minContrast: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", initialIndex?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", direction?: " }, { "kind": "Reference", "text": "PaletteDirection", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "minContrast", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "initialIndex", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true }, { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "colorContrast" }, { "kind": "MethodSignature", "canonicalReference": "@adaptive-web/adaptive-ui!Palette#delta:member(1)", "docComment": "/**\n * Returns a Color from the Palette that's the specified position and direction away from the `reference`.\n *\n * @param reference - The relative luminance of the reference\n *\n * @param delta - The number of swatches away from `reference`\n *\n * @param direction - The direction to go from `reference`, 1 goes darker, -1 goes lighter\n */\n", "excerptTokens": [ { "kind": "Content", "text": "delta(reference: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": ", delta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", direction: " }, { "kind": "Reference", "text": "PaletteDirection", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "delta", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "delta" }, { "kind": "MethodSignature", "canonicalReference": "@adaptive-web/adaptive-ui!Palette#get:member(1)", "docComment": "/**\n * Gets a Color by index. Index is clamped to the limits of the Palette so a Color will always be returned.\n *\n * @param index - The index\n *\n * @returns The Color\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get(index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "get" }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!Palette#source:member", "docComment": "/**\n * The Color used to create the full palette.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly source: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "source", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!Palette#swatches:member", "docComment": "/**\n * The array of all Colors from light to dark.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly swatches: " }, { "kind": "Reference", "text": "ReadonlyArray", "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "swatches", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type", "docComment": "/**\n * Convenience type to allow a fixed {@link (PaletteDirectionValue:variable)} or a function that resolves to one.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type PaletteDirection = " }, { "kind": "Reference", "text": "PaletteDirectionValue", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirectionValue:type" }, { "kind": "Content", "text": " | (() => " }, { "kind": "Reference", "text": "PaletteDirectionValue", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirectionValue:type" }, { "kind": "Content", "text": ")" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/palette.d.ts", "releaseTag": "Public", "name": "PaletteDirection", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirectionValue:type", "docComment": "/**\n * Directional values for navigating swatches in {@link Palette}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type PaletteDirectionValue = " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "PaletteDirectionValue", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirectionValue:var" }, { "kind": "Content", "text": "[keyof typeof " }, { "kind": "Reference", "text": "PaletteDirectionValue", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirectionValue:var" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/palette.d.ts", "releaseTag": "Public", "name": "PaletteDirectionValue", "typeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirectionValue:var", "docComment": "/**\n * Directional values for navigating swatches in {@link Palette}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "PaletteDirectionValue: " }, { "kind": "Reference", "text": "Readonly", "canonicalReference": "!Readonly:type" }, { "kind": "Content", "text": "<{\n readonly darker: 1;\n readonly lighter: -1;\n}>" } ], "fileUrlPath": "dist/dts/core/color/palette.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "PaletteDirectionValue", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteOkhsl:class", "docComment": "/**\n * An implementation of a {@link Palette} that uses the okhsl color model. This is useful for UI as it means the difference between swatches is perceptually equal.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class PaletteOkhsl extends " }, { "kind": "Reference", "text": "BasePalette", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/palette-okhsl.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "PaletteOkhsl", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteOkhsl.from:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static from(source: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PaletteOkhslOptions", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteOkhslOptions:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PaletteOkhsl", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteOkhsl:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "from" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteOkhslOptions:interface", "docComment": "/**\n * Options to tailor the generation of PaletteOkhsl.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PaletteOkhslOptions " } ], "fileUrlPath": "dist/dts/core/color/palette-okhsl.d.ts", "releaseTag": "Public", "name": "PaletteOkhslOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteOkhslOptions#darkEndSaturation:member", "docComment": "/**\n * The saturation of the color at the dark end of the palette.\n *\n * @remarks\n *\n * Decimal value between 0 and 1; 0 means no change.\n *\n * @defaultValue\n *\n * 0\n */\n", "excerptTokens": [ { "kind": "Content", "text": "darkEndSaturation: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "darkEndSaturation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteOkhslOptions#lightEndSaturation:member", "docComment": "/**\n * The saturation of the color at the light end of the palette.\n *\n * @remarks\n *\n * Decimal value between 0 and 1; 0 means no change.\n *\n * @defaultValue\n *\n * 0\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lightEndSaturation: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lightEndSaturation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteOkhslOptions#stepCount:member", "docComment": "/**\n * The number of steps in the generated palette.\n *\n * @defaultValue\n *\n * 66\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stepCount: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "stepCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteRGB:class", "docComment": "/**\n * An implementation of a {@link Palette} that has a consistent minimum contrast value between swatches. This is useful for UI as it means the perception of the difference between colors the same distance apart in the Palette will be consistent whether the colors are light yellow or dark red. It generates its curve using the LAB color space and maintains the saturation of the source color throughout.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class PaletteRGB extends " }, { "kind": "Reference", "text": "BasePalette", "canonicalReference": "@adaptive-web/adaptive-ui!BasePalette:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/palette-rgb.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "PaletteRGB", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteRGB.from:member(1)", "docComment": "/**\n * Creates a PaletteRGB from a source Color with options.\n *\n * @param source - The source Color to create a Palette from\n *\n * @param options - Options to specify details of palette generation\n *\n * @returns The PaletteRGB with swatches based on `source`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static from(source: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PaletteRGBOptions", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteRGBOptions:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PaletteRGB", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteRGB:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "source", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "from" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteRGBOptions:interface", "docComment": "/**\n * Options to tailor the generation of PaletteRGB.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PaletteRGBOptions " } ], "fileUrlPath": "dist/dts/core/color/palette-rgb.d.ts", "releaseTag": "Public", "name": "PaletteRGBOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteRGBOptions#preserveSource:member", "docComment": "/**\n * Whether to keep the exact source color in the target palette. - Default false\n *\n * Only recommended when the exact color is required and used in stateful interaction recipes like hover.\n *\n * Note that custom recipes can still access the source color even if it's not in the ramp, but turning this on will potentially increase the contrast between steps toward the ends of the palette.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preserveSource: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "preserveSource", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteRGBOptions#stepContrast:member", "docComment": "/**\n * The minimum amount of contrast between steps in the palette. - Default 1.05 - Greater than 1 - Recommended increments by hundredths\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stepContrast: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "stepContrast", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteRGBOptions#stepContrastRamp:member", "docComment": "/**\n * Multiplier for increasing step contrast as the swatches darken. - Default 0. - Greater than or equal to 0 - Recommended increments by hundredths\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stepContrastRamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "stepContrastRamp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!RadialGradient:class", "docComment": "/**\n * Represents a radial gradient.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class RadialGradient extends " }, { "kind": "Reference", "text": "Gradient", "canonicalReference": "@adaptive-web/adaptive-ui!Gradient:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/gradient.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "RadialGradient", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!RadialGradient:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `RadialGradient` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(stops: " }, { "kind": "Reference", "text": "GradientStop", "canonicalReference": "@adaptive-web/adaptive-ui!GradientStop:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "stops", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!RadialGradient#toString:member(1)", "docComment": "/**\n * Gets this gradient value as a string.\n *\n * @returns The gradient value in string format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toString(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "toString" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!RadialGradient#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly type: " }, { "kind": "Reference", "text": "GradientType", "canonicalReference": "@adaptive-web/adaptive-ui!GradientType:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!Recipe:interface", "docComment": "/**\n * A `Recipe` is a derived `DesignToken` value that enables reusable _and_ customizable design logic.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Recipe " } ], "fileUrlPath": "dist/dts/core/recipes.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "TParam", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TResult", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "Recipe", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!Recipe#evaluate:member", "docComment": "/**\n * Evaluate a recipe.\n *\n * @param resolver - A function that resolves design tokens.\n *\n * @param params - Any params that are needed to evaluate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "evaluate: " }, { "kind": "Reference", "text": "RecipeEvaluate", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeEvaluate:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "evaluate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeEvaluate:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type RecipeEvaluate = " }, { "kind": "Content", "text": "(resolver: " }, { "kind": "Reference", "text": "DesignTokenResolver", "canonicalReference": "@microsoft/fast-foundation!DesignTokenResolver:type" }, { "kind": "Content", "text": ", params: TParam) => TResult" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/recipes.d.ts", "releaseTag": "Public", "name": "RecipeEvaluate", "typeParameters": [ { "typeParameterName": "TParam", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TResult", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeEvaluateOptional:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type RecipeEvaluateOptional = " }, { "kind": "Content", "text": "(resolver: " }, { "kind": "Reference", "text": "DesignTokenResolver", "canonicalReference": "@microsoft/fast-foundation!DesignTokenResolver:type" }, { "kind": "Content", "text": ", params?: TParam) => TResult" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/recipes.d.ts", "releaseTag": "Public", "name": "RecipeEvaluateOptional", "typeParameters": [ { "typeParameterName": "TParam", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TResult", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeOptional:interface", "docComment": "/**\n * A `Recipe` is a derived `DesignToken` value that enables reusable _and_ customizable design logic.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RecipeOptional " } ], "fileUrlPath": "dist/dts/core/recipes.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "TParam", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TResult", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "RecipeOptional", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeOptional#evaluate:member", "docComment": "/**\n * Evaluate a recipe.\n *\n * @param resolver - A function that resolves design tokens.\n *\n * @param params - Any params that are optional for evaluation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "evaluate: " }, { "kind": "Reference", "text": "RecipeEvaluateOptional", "canonicalReference": "@adaptive-web/adaptive-ui!RecipeEvaluateOptional:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "evaluate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface", "docComment": "/**\n * An interface for storing the relative luminance value of a color to aid in contrast calculations.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RelativeLuminance " } ], "fileUrlPath": "dist/dts/core/color/utilities/relative-luminance.d.ts", "releaseTag": "Public", "name": "RelativeLuminance", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance#contrast:member", "docComment": "/**\n * Gets the contrast between this relative luminance and another.\n *\n * @returns The contrast between the two luminance values, for example, 4.54\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contrast: " }, { "kind": "Content", "text": "(a: " }, { "kind": "Reference", "text": "RelativeLuminance", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance:interface" }, { "kind": "Content", "text": ") => number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contrast", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!RelativeLuminance#relativeLuminance:member", "docComment": "/**\n * A number between 0 and 1, calculated by {@link https://www.w3.org/WAI/GL/wiki/Relative_luminance}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly relativeLuminance: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "relativeLuminance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!resolvePaletteDirection:function(1)", "docComment": "/**\n * Gets a fixed {@link (PaletteDirectionValue:variable)} from {@link PaletteDirection} which may be a function that needs to be resolved.\n *\n * @param direction - A fixed palette direction value or a function that resolves to one\n *\n * @returns A fixed palette direction value\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function resolvePaletteDirection(direction: " }, { "kind": "Reference", "text": "PaletteDirection", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PaletteDirectionValue", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirectionValue:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/palette.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "resolvePaletteDirection" }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableAnatomy:interface", "docComment": "/**\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SerializableAnatomy " } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Beta", "name": "SerializableAnatomy", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableAnatomy#conditions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "conditions: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Beta", "name": "conditions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableAnatomy#context:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "context: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Beta", "name": "context", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableAnatomy#focus:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "focus?: " }, { "kind": "Reference", "text": "FocusDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!FocusDefinition:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Beta", "name": "focus", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableAnatomy#interactivity:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "interactivity?: " }, { "kind": "Reference", "text": "InteractivityDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivityDefinition:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Beta", "name": "interactivity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableAnatomy#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Beta", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableAnatomy#parts:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "parts: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Beta", "name": "parts", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableAnatomy#styleRules:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "styleRules: " }, { "kind": "Reference", "text": "SerializableStyleRule", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableStyleRule:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Beta", "name": "styleRules", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableAnatomyWithImports:interface", "docComment": "/**\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SerializableAnatomyWithImports extends " }, { "kind": "Reference", "text": "SerializableAnatomy", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableAnatomy:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Beta", "name": "SerializableAnatomyWithImports", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableAnatomyWithImports#imports:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "imports?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Beta", "name": "imports", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableBooleanCondition:type", "docComment": "/**\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type SerializableBooleanCondition = " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Beta", "name": "SerializableBooleanCondition", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableCondition:type", "docComment": "/**\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type SerializableCondition = " }, { "kind": "Reference", "text": "SerializableBooleanCondition", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableBooleanCondition:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "SerializableStringCondition", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableStringCondition:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Beta", "name": "SerializableCondition", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableStringCondition:type", "docComment": "/**\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type SerializableStringCondition = " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Beta", "name": "SerializableStringCondition", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableStyleRule:interface", "docComment": "/**\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SerializableStyleRule " } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Beta", "name": "SerializableStyleRule", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableStyleRule#contextCondition:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "contextCondition?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Beta", "name": "contextCondition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableStyleRule#part:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "part?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Beta", "name": "part", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableStyleRule#properties:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "properties?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Beta", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableStyleRule#stateOnContext:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "stateOnContext?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Beta", "name": "stateOnContext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!SerializableStyleRule#styles:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "styles?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Beta", "name": "styles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!Shadow:class", "docComment": "/**\n * The definition of a shadow for `box-shadow`, `text-shadow`, or `drop-shadow` values.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Shadow implements " }, { "kind": "Reference", "text": "CSSDirective", "canonicalReference": "@microsoft/fast-element!CSSDirective:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/shadow/index.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "Shadow", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!Shadow:constructor(1)", "docComment": "/**\n * Creates a new Shadow.\n *\n * @param color - The color of the shadow.\n *\n * @param xOffset - The x offset in `px`.\n *\n * @param yOffset - The y offset in `px`.\n *\n * @param blurRadius - The blur radius in `px`.\n *\n * @param spread - The spread in `px`. This is not supported in all potential uses of Shadow (text or drop).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ", xOffset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", yOffset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", blurRadius?: " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ", spread?: " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "xOffset", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "yOffset", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "blurRadius", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true }, { "parameterName": "spread", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Shadow#blurRadius:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "blurRadius?: " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "blurRadius", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Shadow#color:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Shadow#createCSS:member(1)", "docComment": "/**\n * {@inheritdoc @microsoft/fast-element#CSSDirective.createCSS}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createCSS(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "createCSS" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Shadow#spread:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "spread?: " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "spread", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Shadow#xOffset:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "xOffset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "xOffset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Shadow#yOffset:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "yOffset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "yOffset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!ShadowValue:type", "docComment": "/**\n * The type of a Shadow token value.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ShadowValue = " }, { "kind": "Reference", "text": "Shadow", "canonicalReference": "@adaptive-web/adaptive-ui!Shadow:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "DesignTokenMultiValue", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenMultiValue:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Shadow", "canonicalReference": "@adaptive-web/adaptive-ui!Shadow:class" }, { "kind": "Content", "text": "> | string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/shadow/index.d.ts", "releaseTag": "Public", "name": "ShadowValue", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!StringCondition:type", "docComment": "/**\n * The state and selector for a multiple value condition.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StringCondition = " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "name": "StringCondition", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!StyleDeclaration:type", "docComment": "/**\n * The properties and values for a {@link StyleRule} definition.\n *\n * A declaration should have `styles` and/or `properties` - `styles` are applied before `properties`.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StyleDeclaration = " }, { "kind": "Content", "text": "{\n styles?: " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Iterable", "canonicalReference": "!Iterable:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": ">;\n properties?: " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "releaseTag": "Public", "name": "StyleDeclaration", "typeTokenRange": { "startIndex": 1, "endIndex": 10 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!StyleKey:type", "docComment": "/**\n * Key for a style property, a {@link (StyleProperty:type)}, {@link (StylePropertyShorthand:type)}, or a string for any other CSS property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StyleKey = " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StylePropertyShorthand", "canonicalReference": "@adaptive-web/adaptive-ui!StylePropertyShorthand:type" }, { "kind": "Content", "text": " | (string & " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ")" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "releaseTag": "Public", "name": "StyleKey", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleEvaluateParameters:type", "docComment": "/**\n * Parameters used to evaluate style modules for a component.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StyleModuleEvaluateParameters = " }, { "kind": "Reference", "text": "StyleModuleTarget", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleTarget:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "InteractivityDefinition", "canonicalReference": "@adaptive-web/adaptive-ui!InteractivityDefinition:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "name": "StyleModuleEvaluateParameters", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleTarget:interface", "docComment": "/**\n * Parameters used to apply style modules to components.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StyleModuleTarget " } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "name": "StyleModuleTarget", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleTarget#context:member", "docComment": "/**\n * The selector for the context element. Implementation defaults to `:host` if not provided.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "context?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleTarget#contextCondition:member", "docComment": "/**\n * The condition to match on the context element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contextCondition?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "contextCondition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleTarget#ignoreInteractivity:member", "docComment": "/**\n * Informs the style generator to ignore the interactivity configuration of the component.\n *\n * @remarks\n *\n * The `StyleModuleTarget` and `InteractivityDefinition` together makeup the evaluation parameters for generating the styles. In some edge case scenarios the default behavior of considering both of these together is not desireable (ex: Menu items which should show focus when disabled). This is an exploration into a way to describe this, but perhaps there's a more extensible pattern.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ignoreInteractivity?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Beta", "name": "ignoreInteractivity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleTarget#part:member", "docComment": "/**\n * The component part name to apply this style module.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "part?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "part", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleTarget#partCondition:member", "docComment": "/**\n * The condition to match on the part element.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "partCondition?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "partCondition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleTarget#stateOnContext:member", "docComment": "/**\n * Normally the state applies to the context element, or if specified, the part. This option forces the state to the apply to the context element, useful for styling the context element state in only a portion of the child elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stateOnContext?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "stateOnContext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type", "docComment": "/**\n * An object of style definitions, where the key is the {@link (StyleKey:type)} and the value is the token or final value.\n *\n * @remarks\n *\n * The `Record` format is a convenience for manual authoring of style modules (instead of a `Map`).\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StyleProperties = " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "StyleKey", "canonicalReference": "@adaptive-web/adaptive-ui!StyleKey:type" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "StyleValue", "canonicalReference": "@adaptive-web/adaptive-ui!StyleValue:type" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "releaseTag": "Public", "name": "StyleProperties", "typeTokenRange": { "startIndex": 1, "endIndex": 9 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!StylePropertiesMap:type", "docComment": "/**\n * A `Map` of style definitions, where the key is the {@link (StyleKey:type)} and the value is the token or final value.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StylePropertiesMap = " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "StyleKey", "canonicalReference": "@adaptive-web/adaptive-ui!StyleKey:type" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "StyleValue", "canonicalReference": "@adaptive-web/adaptive-ui!StyleValue:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "releaseTag": "Public", "name": "StylePropertiesMap", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type", "docComment": "/**\n * Supported style properties for design-to-code with Adaptive UI.\n *\n * Generalizes CSS properties which are also commonly supported in design tools (Figma) so the recipes can be applied in tooling or in the browser.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StyleProperty = " }, { "kind": "Reference", "text": "ValuesOf", "canonicalReference": "@microsoft/fast-foundation!ValuesOf:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "name": "StyleProperty", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:var", "docComment": "/**\n * Supported style properties for design-to-code with Adaptive UI.\n *\n * Generalizes CSS properties which are also commonly supported in design tools (Figma) so the recipes can be applied in tooling or in the browser.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "StyleProperty: " }, { "kind": "Content", "text": "{\n readonly backgroundFill: \"backgroundFill\";\n readonly foregroundFill: \"foregroundFill\";\n readonly borderFillTop: \"borderFillTop\";\n readonly borderFillRight: \"borderFillRight\";\n readonly borderFillBottom: \"borderFillBottom\";\n readonly borderFillLeft: \"borderFillLeft\";\n readonly borderThicknessTop: \"borderThicknessTop\";\n readonly borderThicknessRight: \"borderThicknessRight\";\n readonly borderThicknessBottom: \"borderThicknessBottom\";\n readonly borderThicknessLeft: \"borderThicknessLeft\";\n readonly borderStyleTop: \"borderStyleTop\";\n readonly borderStyleRight: \"borderStyleRight\";\n readonly borderStyleBottom: \"borderStyleBottom\";\n readonly borderStyleLeft: \"borderStyleLeft\";\n readonly cornerRadiusTopLeft: \"cornerRadiusTopLeft\";\n readonly cornerRadiusTopRight: \"cornerRadiusTopRight\";\n readonly cornerRadiusBottomRight: \"cornerRadiusBottomRight\";\n readonly cornerRadiusBottomLeft: \"cornerRadiusBottomLeft\";\n readonly fontFamily: \"fontFamily\";\n readonly fontSize: \"fontSize\";\n readonly fontWeight: \"fontWeight\";\n readonly fontStyle: \"fontStyle\";\n readonly fontVariationSettings: \"fontVariationSettings\";\n readonly letterSpacing: \"letterSpacing\";\n readonly lineHeight: \"lineHeight\";\n readonly marginTop: \"marginTop\";\n readonly marginRight: \"marginRight\";\n readonly marginBottom: \"marginBottom\";\n readonly marginLeft: \"marginLeft\";\n readonly paddingTop: \"paddingTop\";\n readonly paddingRight: \"paddingRight\";\n readonly paddingBottom: \"paddingBottom\";\n readonly paddingLeft: \"paddingLeft\";\n readonly gap: \"gap\";\n readonly height: \"height\";\n readonly minHeight: \"minHeight\";\n readonly maxHeight: \"maxHeight\";\n readonly width: \"width\";\n readonly minWidth: \"minWidth\";\n readonly maxWidth: \"maxWidth\";\n readonly layoutInner: \"layoutInner\";\n readonly layoutDirection: \"layoutDirection\";\n readonly layoutMainAxisAlignItems: \"layoutMainAxisAlignItems\";\n readonly layoutCrossAxisAlignItems: \"layoutCrossAxisAlignItems\";\n readonly layoutWrap: \"layoutWrap\";\n readonly opacity: \"opacity\";\n readonly cursor: \"cursor\";\n readonly outlineColor: \"outlineColor\";\n readonly outlineOffset: \"outlineOffset\";\n readonly outlineStyle: \"outlineStyle\";\n readonly outlineThickness: \"outlineThickness\";\n readonly outlineWidth: \"outlineWidth\";\n readonly shadow: \"shadow\";\n}" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "StyleProperty", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!stylePropertyBorderFillAll:var", "docComment": "/**\n * A convenience shorthand for all border fill {@link (StyleProperty:type)} values.\n *\n * @deprecated\n *\n * Use StylePropertyShorthand instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stylePropertyBorderFillAll: " }, { "kind": "Content", "text": "(\"borderFillTop\" | \"borderFillRight\" | \"borderFillBottom\" | \"borderFillLeft\")[]" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "stylePropertyBorderFillAll", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!stylePropertyBorderStyleAll:var", "docComment": "/**\n * A convenience shorthand for all border style {@link (StyleProperty:type)} values.\n *\n * @deprecated\n *\n * Use StylePropertyShorthand instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stylePropertyBorderStyleAll: " }, { "kind": "Content", "text": "(\"borderStyleTop\" | \"borderStyleRight\" | \"borderStyleBottom\" | \"borderStyleLeft\")[]" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "stylePropertyBorderStyleAll", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!stylePropertyBorderThicknessAll:var", "docComment": "/**\n * A convenience shorthand for all border thickness {@link (StyleProperty:type)} values.\n *\n * @deprecated\n *\n * Use StylePropertyShorthand instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stylePropertyBorderThicknessAll: " }, { "kind": "Content", "text": "(\"borderThicknessTop\" | \"borderThicknessRight\" | \"borderThicknessBottom\" | \"borderThicknessLeft\")[]" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "stylePropertyBorderThicknessAll", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!stylePropertyCornerRadiusAll:var", "docComment": "/**\n * A convenience shorthand for all corner radius {@link (StyleProperty:type)} values.\n *\n * @deprecated\n *\n * Use StylePropertyShorthand instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stylePropertyCornerRadiusAll: " }, { "kind": "Content", "text": "(\"cornerRadiusTopLeft\" | \"cornerRadiusTopRight\" | \"cornerRadiusBottomRight\" | \"cornerRadiusBottomLeft\")[]" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "stylePropertyCornerRadiusAll", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!StylePropertyCss:type", "docComment": "/**\n * Any style property, either an {@link (StyleProperty:type)} or a string for any other CSS property.\n *\n * @deprecated\n *\n * Use StyleKey instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StylePropertyCss = " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | (string & " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ")" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "name": "StylePropertyCss", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!stylePropertyPaddingAll:var", "docComment": "/**\n * A convenience shorthand for all padding {@link (StyleProperty:type)} values.\n *\n * @deprecated\n *\n * Use StylePropertyShorthand instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "stylePropertyPaddingAll: " }, { "kind": "Content", "text": "(\"paddingTop\" | \"paddingRight\" | \"paddingBottom\" | \"paddingLeft\")[]" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "stylePropertyPaddingAll", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!StylePropertyShorthand:type", "docComment": "/**\n * Supported style property shorthands for design-to-code with Adaptive UI.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StylePropertyShorthand = " }, { "kind": "Content", "text": "keyof typeof " }, { "kind": "Reference", "text": "StylePropertyShorthand", "canonicalReference": "@adaptive-web/adaptive-ui!StylePropertyShorthand:var" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "name": "StylePropertyShorthand", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Variable", "canonicalReference": "@adaptive-web/adaptive-ui!StylePropertyShorthand:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "StylePropertyShorthand: " }, { "kind": "Content", "text": "{\n borderFill: (\"borderFillTop\" | \"borderFillRight\" | \"borderFillBottom\" | \"borderFillLeft\")[];\n borderThickness: (\"borderThicknessTop\" | \"borderThicknessRight\" | \"borderThicknessBottom\" | \"borderThicknessLeft\")[];\n borderStyle: (\"borderStyleTop\" | \"borderStyleRight\" | \"borderStyleBottom\" | \"borderStyleLeft\")[];\n cornerRadius: (\"cornerRadiusTopLeft\" | \"cornerRadiusTopRight\" | \"cornerRadiusBottomRight\" | \"cornerRadiusBottomLeft\")[];\n margin: (\"marginTop\" | \"marginRight\" | \"marginBottom\" | \"marginLeft\")[];\n marginHorizontal: (\"marginRight\" | \"marginLeft\")[];\n marginVertical: (\"marginTop\" | \"marginBottom\")[];\n padding: (\"paddingTop\" | \"paddingRight\" | \"paddingBottom\" | \"paddingLeft\")[];\n paddingHorizontal: (\"paddingRight\" | \"paddingLeft\")[];\n paddingVertical: (\"paddingTop\" | \"paddingBottom\")[];\n}" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "StylePropertyShorthand", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!StyleRule:type", "docComment": "/**\n * Definition for a single Adaptive UI style rule, which maps to a rule in a normal CSS style sheet.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StyleRule = " }, { "kind": "Content", "text": "{\n target?: " }, { "kind": "Reference", "text": "StyleModuleTarget", "canonicalReference": "@adaptive-web/adaptive-ui!StyleModuleTarget:interface" }, { "kind": "Content", "text": ";\n} & " }, { "kind": "Reference", "text": "StyleDeclaration", "canonicalReference": "@adaptive-web/adaptive-ui!StyleDeclaration:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "releaseTag": "Public", "name": "StyleRule", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!StyleRules:type", "docComment": "/**\n * A list of {@link StyleRule}s in the context of a component.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StyleRules = " }, { "kind": "Reference", "text": "Array", "canonicalReference": "!Array:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "StyleRule", "canonicalReference": "@adaptive-web/adaptive-ui!StyleRule:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/types.d.ts", "releaseTag": "Public", "name": "StyleRules", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class", "docComment": "/**\n * A composable definition of style properties, either an alias to another style or a collection of style properties.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Styles " } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "Styles", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Styles#appendComposed:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "appendComposed(styles: " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "styles", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "appendComposed" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Styles#clearComposed:member(1)", "docComment": "/**\n * Clears the array of composed styles.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "clearComposed(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "clearComposed" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Styles.compose:member(1)", "docComment": "/**\n * Creates a new Styles object for the composed styles.\n *\n * @param styles - An array of styles to compose.\n *\n * @param properties - Individual properties to append to the styles.\n *\n * @param name - A name for the styles used for lookup.\n *\n * @returns A new Styles object representing the composed styles.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static compose(styles: " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", properties?: " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ", name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "styles", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "properties", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": true }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "compose" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Styles#composed:member", "docComment": "/**\n * Gets the array of composed styles.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get composed(): " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": "[] | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "composed", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Styles#effectiveAdaptiveProperties:member", "docComment": "/**\n * Gets the set of effective properties that support Adaptive UI design-to-code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get effectiveAdaptiveProperties(): " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "StyleValue", "canonicalReference": "@adaptive-web/adaptive-ui!StyleValue:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "effectiveAdaptiveProperties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Styles#effectiveProperties:member", "docComment": "/**\n * Gets the full effective set of properties, from composed styles and local properties as applicable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get effectiveProperties(): " }, { "kind": "Reference", "text": "EffectiveStylePropertiesMap", "canonicalReference": "@adaptive-web/adaptive-ui!EffectiveStylePropertiesMap:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "effectiveProperties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Styles.fromDeclaration:member(1)", "docComment": "/**\n * Creates a new Styles object for the declared styles.\n *\n * @param declaration - The style declaration\n *\n * @param name - A name for the styles used for lookup.\n *\n * @returns A new Styles object representing the declared styles.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static fromDeclaration(declaration: " }, { "kind": "Reference", "text": "StyleDeclaration", "canonicalReference": "@adaptive-web/adaptive-ui!StyleDeclaration:type" }, { "kind": "Content", "text": ", name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "declaration", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "fromDeclaration" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Styles.fromProperties:member(1)", "docComment": "/**\n * Creates a new Styles object for the individual properties.\n *\n * @param properties - Individual properties for the new style module.\n *\n * @param name - A name for the styles used for lookup.\n *\n * @returns A new Styles object representing the properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static fromProperties(properties: " }, { "kind": "Reference", "text": "StyleProperties", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperties:type" }, { "kind": "Content", "text": ", name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Styles", "canonicalReference": "@adaptive-web/adaptive-ui!Styles:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "properties", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "fromProperties" }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Styles#name:member", "docComment": "/**\n * The style module name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly name: " }, { "kind": "Content", "text": "string | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Styles#properties:member", "docComment": "/**\n * The local properties or composition overrides.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get properties(): " }, { "kind": "Reference", "text": "Readonly", "canonicalReference": "!Readonly:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "StylePropertiesMap", "canonicalReference": "@adaptive-web/adaptive-ui!StylePropertiesMap:type" }, { "kind": "Content", "text": "> | undefined" }, { "kind": "Content", "text": ";\n\nset properties(properties: " }, { "kind": "Reference", "text": "StylePropertiesMap", "canonicalReference": "@adaptive-web/adaptive-ui!StylePropertiesMap:type" }, { "kind": "Content", "text": " | undefined);" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!Styles.Shared:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static Shared: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "Shared", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isStatic": true, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@adaptive-web/adaptive-ui!StyleValue:type", "docComment": "/**\n * Supported values for a style property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StyleValue = " }, { "kind": "Reference", "text": "CSSDesignToken", "canonicalReference": "@microsoft/fast-foundation!CSSDesignToken:class" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "InteractiveValues", "canonicalReference": "@adaptive-web/adaptive-ui!InteractiveValues:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "CSSDirective", "canonicalReference": "@microsoft/fast-element!CSSDirective:interface" }, { "kind": "Content", "text": " | string | number" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/modules/styles.d.ts", "releaseTag": "Public", "name": "StyleValue", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch:class", "docComment": "/**\n * Legacy equivalent of Color.\n *\n * @deprecated\n *\n * Use {@link Color}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Swatch extends " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/color/swatch.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "Swatch", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch.asOverlay:member(1)", "docComment": "/**\n * Creates a new Swatch as an overlay representation of the `intendedColor` over `reference`.\n *\n * Currently the overlay will only be black or white, so this works best with a plain grey neutral palette. Otherwise it will attempt to match the luminance value of the Swatch, so it will likely be close, but not an exact match to the color from another palette.\n *\n * @param intendedColor - The Swatch the overlay should look like over the `reference` Swatch.\n *\n * @param reference - The Swatch under the overlay color.\n *\n * @returns A semitransparent Swatch that represents the `intendedColor` over the `reference` Swatch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static asOverlay(intendedColor: " }, { "kind": "Reference", "text": "Swatch", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch:class" }, { "kind": "Content", "text": ", reference: " }, { "kind": "Reference", "text": "Swatch", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Swatch", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "intendedColor", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "asOverlay" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch.from:member(1)", "docComment": "/**\n * Creates a new Swatch from and object with R, G, and B values expressed as a number between 0 to 1.\n *\n * @param obj - An object with `r`, `g`, and `b`, and optional `alpha` values expressed as a number between 0 and 1.\n *\n * @returns A new Swatch\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static from(obj: " }, { "kind": "Content", "text": "{\n r: number;\n g: number;\n b: number;\n alpha?: number;\n }" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Swatch", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "obj", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "from" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch.fromColor:member(1)", "docComment": "/**\n * Creates a new Swatch from a Color.\n *\n * @param color - A Color\n *\n * @returns A new Swatch\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static fromColor(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Swatch", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "fromColor" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch.fromRgb:member(1)", "docComment": "/**\n * Creates a new Swatch from R, G, and B values expressed as a number between 0 to 1.\n *\n * @param r - Red channel expressed as a number between 0 and 1.\n *\n * @param g - Green channel expressed as a number between 0 and 1.\n *\n * @param b - Blue channel expressed as a number between 0 and 1.\n *\n * @param alpha - Alpha channel expressed as a number between 0 and 1.\n *\n * @returns A new Swatch\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static fromRgb(r: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", g: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", b: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", alpha?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Swatch", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch:class" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "r", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "g", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "b", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "alpha", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "fromRgb" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch.parse:member(1)", "docComment": "/**\n * Creates a new Swatch from a parsable string.\n *\n * @param color - A string representation of the Swatch.\n *\n * @returns The Swatch object or undefined.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static parse(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Swatch", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch:class" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "parse" }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch#toTransparent:member(1)", "docComment": "/**\n * Gets this color with transparency.\n *\n * @deprecated\n *\n * Use Color.unsafeOpacity\n *\n * @returns The color with full transparency\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toTransparent(alpha?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Swatch", "canonicalReference": "@adaptive-web/adaptive-ui!Swatch:class" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "alpha", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "toTransparent" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!swatchAsOverlay:function(1)", "docComment": "/**\n * Returns an opaque {@link Color} or a {@link Color} with opacity relative to the reference color.\n *\n * @param color - The opaque intended swatch color.\n *\n * @param reference - The reference color for a semitransparent swatch.\n *\n * @param asOverlay - True to return a semitransparent representation of `swatch` relative to `reference`.\n *\n * @returns The requested representation of `swatch`.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function swatchAsOverlay(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ", reference: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": ", asOverlay: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "@adaptive-web/adaptive-ui!Color:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/utilities/opacity.d.ts", "returnTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false }, { "parameterName": "asOverlay", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": false } ], "name": "swatchAsOverlay" }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!TokenGroup:interface", "docComment": "/**\n * A group of tokens.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TokenGroup extends " }, { "kind": "Reference", "text": "MakePropertyOptional", "canonicalReference": "@adaptive-web/adaptive-ui!MakePropertyOptional:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DesignTokenMetadata", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenMetadata:type" }, { "kind": "Content", "text": ", \"type\">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/types.d.ts", "releaseTag": "Public", "name": "TokenGroup", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!TokenGroup#intendedFor:member", "docComment": "/**\n * The style properties where tokens within this group are intended to be used.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "intendedFor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!TokenGroup#name:member", "docComment": "/**\n * The name of the token group. Contained tokens should extend this name like `groupName` -\\> `groupName.child`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!TokenGroup#type:member", "docComment": "/**\n * The default type for any tokens within this group.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type?: " }, { "kind": "Reference", "text": "DesignTokenType", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenType:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Function", "canonicalReference": "@adaptive-web/adaptive-ui!twoPaletteGradient:function(1)", "docComment": "/**\n * Color algorithm for a gradient between two colors.\n *\n * @param startPalette - The Palette used for the start of the gradient\n *\n * @param endPalette - The Palette used for the end of the gradient\n *\n * @param reference - The reference color\n *\n * @param delta - The offset from the `reference`\n *\n * @param angle - The angle of the gradient\n *\n * @param direction - The direction the delta moves on the palettes, defaults to {@link directionByIsDark} based on `reference`\n *\n * @returns The Gradient\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function twoPaletteGradient(startPalette: " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ", endPalette: " }, { "kind": "Reference", "text": "Palette", "canonicalReference": "@adaptive-web/adaptive-ui!Palette:interface" }, { "kind": "Content", "text": ", reference: " }, { "kind": "Reference", "text": "Paint", "canonicalReference": "@adaptive-web/adaptive-ui!Paint:type" }, { "kind": "Content", "text": ", delta: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", angle?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", direction?: " }, { "kind": "Reference", "text": "PaletteDirection", "canonicalReference": "@adaptive-web/adaptive-ui!PaletteDirection:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Gradient", "canonicalReference": "@adaptive-web/adaptive-ui!Gradient:class" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/dts/core/color/recipes/two-palette-gradient.d.ts", "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "startPalette", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "endPalette", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "reference", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "delta", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "angle", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true }, { "parameterName": "direction", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": true } ], "name": "twoPaletteGradient" }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class", "docComment": "/**\n * A CSSDesignToken with value type and intended styling uses.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class TypedCSSDesignToken extends " }, { "kind": "Reference", "text": "CSSDesignToken", "canonicalReference": "@microsoft/fast-foundation!CSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": " implements " }, { "kind": "Reference", "text": "DesignTokenMetadata", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenMetadata:type" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/adaptive-design-tokens.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isAbstract": false, "name": "TypedCSSDesignToken", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `TypedCSSDesignToken` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type: " }, { "kind": "Reference", "text": "DesignTokenType", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenType:type" }, { "kind": "Content", "text": ", intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken.createTyped:member(1)", "docComment": "/**\n * Factory to create a DesignToken with value type and intended styling uses.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static createTyped(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type: " }, { "kind": "Reference", "text": "DesignTokenType", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenType:type" }, { "kind": "Content", "text": ", intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "createTyped" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 3 }, "implementsTokenRanges": [ { "startIndex": 4, "endIndex": 5 } ] }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class", "docComment": "/**\n * A DesignToken with value type and intended styling uses.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class TypedDesignToken extends " }, { "kind": "Reference", "text": "DesignToken", "canonicalReference": "@microsoft/fast-foundation!DesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": " implements " }, { "kind": "Reference", "text": "DesignTokenMetadata", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenMetadata:type" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/adaptive-design-tokens.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isAbstract": false, "name": "TypedDesignToken", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `TypedDesignToken` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type: " }, { "kind": "Reference", "text": "DesignTokenType", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenType:type" }, { "kind": "Content", "text": ", intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "isOptional": true } ] }, { "kind": "Method", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken.createTyped:member(1)", "docComment": "/**\n * Factory to create a DesignToken with value type and intended styling uses.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static createTyped(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", type: " }, { "kind": "Reference", "text": "DesignTokenType", "canonicalReference": "@adaptive-web/adaptive-ui!DesignTokenType:type" }, { "kind": "Content", "text": ", intendedFor?: " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "StyleProperty", "canonicalReference": "@adaptive-web/adaptive-ui!StyleProperty:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "intendedFor", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "createTyped" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 3 }, "implementsTokenRanges": [ { "startIndex": 4, "endIndex": 5 } ] }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition:class", "docComment": "/**\n * Represents a single position on the type ramp with font size, line height, and font variations.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class TypeRampPosition " } ], "fileUrlPath": "dist/dts/core/typography/type-ramp.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "TypeRampPosition", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition:constructor(1)", "docComment": "/**\n * Creates a new type ramp position.\n *\n * @param baseName - The base name of the type ramp.\n *\n * @param position - The position on the type ramp.\n *\n * @param config - The configuration for this type ramp position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(baseName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", position: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", config: " }, { "kind": "Reference", "text": "TypeRampPositionConfig", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "baseName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "position", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition#fontSize:member", "docComment": "/**\n * The font size for this type ramp position.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly fontSize: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "fontSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition#fontVariations:member", "docComment": "/**\n * The font variations for this type ramp position.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly fontVariations: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "fontVariations", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition#lineHeight:member", "docComment": "/**\n * The line height for this type ramp position (optimized for single-line UI elements).\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly lineHeight: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "lineHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition#lineHeightMultiline:member", "docComment": "/**\n * The line height for multiline text that wraps (optimized for readability).\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly lineHeightMultiline: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "lineHeightMultiline", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig:interface", "docComment": "/**\n * Configuration for a single position on the type ramp.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TypeRampPositionConfig " } ], "fileUrlPath": "dist/dts/core/typography/type-ramp.d.ts", "releaseTag": "Public", "name": "TypeRampPositionConfig", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig#fontSize:member", "docComment": "/**\n * The font size for this position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fontSize: " }, { "kind": "Reference", "text": "DesignTokenValue", "canonicalReference": "@microsoft/fast-foundation!DesignTokenValue:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fontSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig#lineHeight:member", "docComment": "/**\n * The line height for single-line UI elements.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineHeight: " }, { "kind": "Reference", "text": "DesignTokenValue", "canonicalReference": "@microsoft/fast-foundation!DesignTokenValue:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lineHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig#lineHeightMultiline:member", "docComment": "/**\n * The line height for multiline text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "lineHeightMultiline: " }, { "kind": "Reference", "text": "DesignTokenValue", "canonicalReference": "@microsoft/fast-foundation!DesignTokenValue:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lineHeightMultiline", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup:class", "docComment": "/**\n * A complete type ramp with all positions from minus2 to plus6.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class TypeRampTokenGroup implements " }, { "kind": "Reference", "text": "TokenGroup", "canonicalReference": "@adaptive-web/adaptive-ui!TokenGroup:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/typography/type-ramp.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "TypeRampTokenGroup", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup:constructor(1)", "docComment": "/**\n * Creates a new type ramp token group with all positions.\n *\n * @param name - The base name of the token group (e.g., \"typography.ramp\").\n *\n * @param minus2 - Configuration for the minus2 position.\n *\n * @param minus1 - Configuration for the minus1 position.\n *\n * @param base - Configuration for the base position.\n *\n * @param plus1 - Configuration for the plus1 position.\n *\n * @param plus2 - Configuration for the plus2 position.\n *\n * @param plus3 - Configuration for the plus3 position.\n *\n * @param plus4 - Configuration for the plus4 position.\n *\n * @param plus5 - Configuration for the plus5 position.\n *\n * @param plus6 - Configuration for the plus6 position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", minus2: " }, { "kind": "Reference", "text": "TypeRampPositionConfig", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig:interface" }, { "kind": "Content", "text": ", minus1: " }, { "kind": "Reference", "text": "TypeRampPositionConfig", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig:interface" }, { "kind": "Content", "text": ", base: " }, { "kind": "Reference", "text": "TypeRampPositionConfig", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig:interface" }, { "kind": "Content", "text": ", plus1: " }, { "kind": "Reference", "text": "TypeRampPositionConfig", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig:interface" }, { "kind": "Content", "text": ", plus2: " }, { "kind": "Reference", "text": "TypeRampPositionConfig", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig:interface" }, { "kind": "Content", "text": ", plus3: " }, { "kind": "Reference", "text": "TypeRampPositionConfig", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig:interface" }, { "kind": "Content", "text": ", plus4: " }, { "kind": "Reference", "text": "TypeRampPositionConfig", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig:interface" }, { "kind": "Content", "text": ", plus5: " }, { "kind": "Reference", "text": "TypeRampPositionConfig", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig:interface" }, { "kind": "Content", "text": ", plus6: " }, { "kind": "Reference", "text": "TypeRampPositionConfig", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPositionConfig:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "minus2", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "minus1", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "base", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": false }, { "parameterName": "plus1", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": false }, { "parameterName": "plus2", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": false }, { "parameterName": "plus3", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "isOptional": false }, { "parameterName": "plus4", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 }, "isOptional": false }, { "parameterName": "plus5", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 18 }, "isOptional": false }, { "parameterName": "plus6", "parameterTypeTokenRange": { "startIndex": 19, "endIndex": 20 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup#base:member", "docComment": "/**\n * The base position on the type ramp.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly base: " }, { "kind": "Reference", "text": "TypeRampPosition", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "base", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup#minus1:member", "docComment": "/**\n * The minus1 position on the type ramp.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly minus1: " }, { "kind": "Reference", "text": "TypeRampPosition", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "minus1", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup#minus2:member", "docComment": "/**\n * The minus2 position on the type ramp.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly minus2: " }, { "kind": "Reference", "text": "TypeRampPosition", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "minus2", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup#plus1:member", "docComment": "/**\n * The plus1 position on the type ramp.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly plus1: " }, { "kind": "Reference", "text": "TypeRampPosition", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "plus1", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup#plus2:member", "docComment": "/**\n * The plus2 position on the type ramp.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly plus2: " }, { "kind": "Reference", "text": "TypeRampPosition", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "plus2", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup#plus3:member", "docComment": "/**\n * The plus3 position on the type ramp.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly plus3: " }, { "kind": "Reference", "text": "TypeRampPosition", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "plus3", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup#plus4:member", "docComment": "/**\n * The plus4 position on the type ramp.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly plus4: " }, { "kind": "Reference", "text": "TypeRampPosition", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "plus4", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup#plus5:member", "docComment": "/**\n * The plus5 position on the type ramp.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly plus5: " }, { "kind": "Reference", "text": "TypeRampPosition", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "plus5", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup#plus6:member", "docComment": "/**\n * The plus6 position on the type ramp.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly plus6: " }, { "kind": "Reference", "text": "TypeRampPosition", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampPosition:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "plus6", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Class", "canonicalReference": "@adaptive-web/adaptive-ui!TypeScaleTokenGroup:class", "docComment": "/**\n * A type ramp generated from a base size and multiplier (type scale).\n *\n * In this model, the base.fontSize is the primary token that should be edited, and all other positions are derived from it using calc() expressions with the multiplier.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class TypeScaleTokenGroup extends " }, { "kind": "Reference", "text": "TypeRampTokenGroup", "canonicalReference": "@adaptive-web/adaptive-ui!TypeRampTokenGroup:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/dts/core/typography/type-ramp.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "TypeScaleTokenGroup", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@adaptive-web/adaptive-ui!TypeScaleTokenGroup:constructor(1)", "docComment": "/**\n * Creates a new type scale token group.\n *\n * @param name - The base name of the token group (e.g., \"typography.ramp.scale\").\n *\n * @param baseSize - The base font size as a string value (e.g., \"16px\").\n *\n * @param multiplier - The multiplier for the type scale (e.g., 1.25).\n *\n * @param lineHeightRatio - The line height ratio for single-line UI (default: 1.4).\n *\n * @param lineHeightSnap - The line height snap value for rounding line heights (default: \"2px\").\n *\n * @param lineHeightMultilineRatio - The line height ratio for multiline text (default: 1.5).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", baseSize: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", multiplier: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", lineHeightRatio?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", lineHeightMultilineRatio?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", lineHeightSnap?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "baseSize", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "multiplier", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "lineHeightRatio", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true }, { "parameterName": "lineHeightMultilineRatio", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "isOptional": true }, { "parameterName": "lineHeightSnap", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "isOptional": true } ] }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeScaleTokenGroup#lineHeightMultilineRatio:member", "docComment": "/**\n * The line height ratio token for multiline text (for better readability).\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly lineHeightMultilineRatio: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "lineHeightMultilineRatio", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeScaleTokenGroup#lineHeightRatio:member", "docComment": "/**\n * The line height ratio token for the type scale (for single-line UI).\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly lineHeightRatio: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "lineHeightRatio", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeScaleTokenGroup#lineHeightSnap:member", "docComment": "/**\n * The line height snap token for rounding line heights.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly lineHeightSnap: " }, { "kind": "Reference", "text": "TypedCSSDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedCSSDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "lineHeightSnap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@adaptive-web/adaptive-ui!TypeScaleTokenGroup#multiplier:member", "docComment": "/**\n * The multiplier token for the type scale.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly multiplier: " }, { "kind": "Reference", "text": "TypedDesignToken", "canonicalReference": "@adaptive-web/adaptive-ui!TypedDesignToken:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "multiplier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] } ] } ] }