@formkit/themes
Version:
FormKit base themes
593 lines (592 loc) • 18.6 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.36.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": "@formkit/themes!",
"docComment": "/**\n * This package contains the official themes for FormKit. Read the {@link https://formkit.com/getting-started/installation | installation documentation} for more information.\n *\n * @packageDocumentation\n */\n",
"name": "@formkit/themes",
"preserveMemberOrder": false,
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@formkit/themes!",
"name": "",
"preserveMemberOrder": false,
"members": [
{
"kind": "Function",
"canonicalReference": "@formkit/themes!createIconHandler:function(1)",
"docComment": "/**\n * Returns a function responsible for loading an icon by name.\n *\n * @param iconLoader - a function for loading an icon when it's not found in the iconRegistry.\n *\n * @param iconLoaderUrl - a function that returns a remote URL for retrieving an SVG icon by name.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createIconHandler(iconLoader?: "
},
{
"kind": "Reference",
"text": "FormKitIconLoader",
"canonicalReference": "@formkit/themes!FormKitIconLoader:interface"
},
{
"kind": "Content",
"text": ", iconLoaderUrl?: "
},
{
"kind": "Reference",
"text": "FormKitIconLoaderUrl",
"canonicalReference": "@formkit/themes!FormKitIconLoaderUrl:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FormKitIconLoader",
"canonicalReference": "@formkit/themes!FormKitIconLoader:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/packages/themes/src/index.d.ts",
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "iconLoader",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": true
},
{
"parameterName": "iconLoaderUrl",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": true
}
],
"name": "createIconHandler"
},
{
"kind": "Function",
"canonicalReference": "@formkit/themes!createThemePlugin:function(1)",
"docComment": "/**\n * Creates the theme plugin based on a given theme name.\n *\n * @param theme - The name or id of the theme to apply.\n *\n * @param icons - Icons you want to add to the global icon registry.\n *\n * @param iconLoaderUrl - A function that returns a remote url for retrieving an SVG icon by name.\n *\n * @param iconLoader - A function that handles loading an icon when it is not found in the registry.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createThemePlugin(theme?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", icons?: "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<string, string | undefined>"
},
{
"kind": "Content",
"text": ", iconLoaderUrl?: "
},
{
"kind": "Reference",
"text": "FormKitIconLoaderUrl",
"canonicalReference": "@formkit/themes!FormKitIconLoaderUrl:interface"
},
{
"kind": "Content",
"text": ", iconLoader?: "
},
{
"kind": "Reference",
"text": "FormKitIconLoader",
"canonicalReference": "@formkit/themes!FormKitIconLoader:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "(node: "
},
{
"kind": "Reference",
"text": "FormKitNode",
"canonicalReference": "@formkit/core!FormKitNode:type"
},
{
"kind": "Content",
"text": ") => any"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/packages/themes/src/index.d.ts",
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "theme",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": true
},
{
"parameterName": "icons",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"isOptional": true
},
{
"parameterName": "iconLoaderUrl",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"isOptional": true
},
{
"parameterName": "iconLoader",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
},
"isOptional": true
}
],
"name": "createThemePlugin"
},
{
"kind": "Interface",
"canonicalReference": "@formkit/themes!FormKitIconLoader:interface",
"docComment": "/**\n * A function that returns an icon SVG string.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface FormKitIconLoader "
}
],
"fileUrlPath": "dist/packages/themes/src/index.d.ts",
"releaseTag": "Public",
"name": "FormKitIconLoader",
"preserveMemberOrder": false,
"members": [
{
"kind": "CallSignature",
"canonicalReference": "@formkit/themes!FormKitIconLoader:call(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "(iconName: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string | undefined | "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<string | undefined>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "iconName",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
]
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@formkit/themes!FormKitIconLoaderUrl:interface",
"docComment": "/**\n * A function that returns a remote URL for retrieving an SVG icon by name.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface FormKitIconLoaderUrl "
}
],
"fileUrlPath": "dist/packages/themes/src/index.d.ts",
"releaseTag": "Public",
"name": "FormKitIconLoaderUrl",
"preserveMemberOrder": false,
"members": [
{
"kind": "CallSignature",
"canonicalReference": "@formkit/themes!FormKitIconLoaderUrl:call(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "(iconName: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "iconName",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
]
}
],
"extendsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@formkit/themes!generateClasses:function(1)",
"docComment": "/**\n * A function to generate FormKit class functions from a JavaScript object.\n *\n * @param classes - An object of input types with nested objects of sectionKeys and class lists.\n *\n * @returns An object of sectionKeys with class functions.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function generateClasses(classes: "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<string, string>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<string, string | "
},
{
"kind": "Reference",
"text": "FormKitClasses",
"canonicalReference": "@formkit/core!FormKitClasses:interface"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<string, boolean>>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/packages/themes/src/index.d.ts",
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "classes",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"isOptional": false
}
],
"name": "generateClasses"
},
{
"kind": "Variable",
"canonicalReference": "@formkit/themes!iconRegistry:var",
"docComment": "/**\n * The FormKit icon Registry - a global record of loaded icons.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "iconRegistry: "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<string, string | undefined>"
}
],
"fileUrlPath": "dist/packages/themes/src/index.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "iconRegistry",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
}
]
}
]
}