{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.29.2", "schemaVersion": 1009, "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": "@thematic/react!", "docComment": "", "name": "@thematic/react", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "@thematic/react!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "Function", "canonicalReference": "@thematic/react!application2style:function(1)", "docComment": "/**\n * Converts basic Application config to a CSS-compatible object suitable for merging with other styles that will be added to a component.\n *\n * @param config - the application configuration\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function application2style(config: " }, { "kind": "Reference", "text": "Application", "canonicalReference": "@thematic/core!Application:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CSSProperties", "canonicalReference": "@types/react!~React.CSSProperties:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "application2style" }, { "kind": "Variable", "canonicalReference": "@thematic/react!ApplicationStyles:var", "docComment": "/**\n * This component applies root-level styles to your application using the theme defaults.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ApplicationStyles: " }, { "kind": "Reference", "text": "FC", "canonicalReference": "@types/react!~React.FC:type" } ], "isReadonly": true, "releaseTag": "Public", "name": "ApplicationStyles", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@thematic/react!defaultTheme:var", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "defaultTheme: " }, { "kind": "Reference", "text": "Theme", "canonicalReference": "@thematic/core!Theme:interface" } ], "isReadonly": true, "releaseTag": "Public", "name": "defaultTheme", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Function", "canonicalReference": "@thematic/react!mark2style:function(1)", "docComment": "/**\n * Converts a basic mark config to CSS-compatible object suitable for merging with other styles that will be added to a component. The main function here really is to convert fill and stroke colors to use the opacity def. Note that we return the style attrs as using the deconstructed form, not the CSS shorthand.\n *\n * @param config - the mark configuration\n *\n * @param datum - optional data item if the theme has been configured with underlying scales.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function mark2style(config: " }, { "kind": "Reference", "text": "SVGMark", "canonicalReference": "@thematic/core!SVGMark:interface" }, { "kind": "Content", "text": ", datum?: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "CSSProperties", "canonicalReference": "@types/react!~React.CSSProperties:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "datum", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "mark2style" }, { "kind": "Variable", "canonicalReference": "@thematic/react!ThematicContext:var", "docComment": "/**\n * Thematic context object for use in React apps\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ThematicContext: " }, { "kind": "Reference", "text": "React.Context", "canonicalReference": "@types/react!~React.Context:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Theme", "canonicalReference": "@thematic/core!Theme:interface" }, { "kind": "Content", "text": ">" } ], "isReadonly": true, "releaseTag": "Public", "name": "ThematicContext", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Variable", "canonicalReference": "@thematic/react!ThematicProvider:var", "docComment": "/**\n * Provider component from the default context for Thematic\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ThematicProvider: " }, { "kind": "Reference", "text": "FC", "canonicalReference": "@types/react!~React.FC:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ThematicProviderProps", "canonicalReference": "@thematic/react!ThematicProviderProps:interface" }, { "kind": "Content", "text": ">" } ], "isReadonly": true, "releaseTag": "Public", "name": "ThematicProvider", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Interface", "canonicalReference": "@thematic/react!ThematicProviderProps:interface", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface ThematicProviderProps " } ], "releaseTag": "Public", "name": "ThematicProviderProps", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@thematic/react!ThematicProviderProps#children:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "children?: " }, { "kind": "Reference", "text": "ReactNode", "canonicalReference": "@types/react!~React.ReactNode:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@thematic/react!ThematicProviderProps#theme:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "theme?: " }, { "kind": "Reference", "text": "Theme", "canonicalReference": "@thematic/core!Theme:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "theme", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "@thematic/react!useThematic:function(1)", "docComment": "/**\n * Hook to retrieve the thematic theme directly.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function useThematic(dark?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Theme", "canonicalReference": "@thematic/core!Theme:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "dark", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "useThematic" } ] } ] }