@empathyco/x-components
Version:
Empathy X Components
1,450 lines (1,449 loc) • 3.24 MB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.39.0",
"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": "@empathyco/x-components!",
"docComment": "/**\n * X-Components is a library usable everywhere not only for search experiences.\n *\n * @packageDocumentation\n */\n",
"name": "@empathyco/x-components",
"preserveMemberOrder": false,
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@empathyco/x-components!",
"name": "",
"preserveMemberOrder": false,
"members": [
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-components!ActionNamesFor:type",
"docComment": "/**\n * Returns the action names for a given module. They are the namespaced actions.\n *\n * @param ModuleName - The {@link XModuleName | module name}.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type ActionNamesFor<ModuleName extends "
},
{
"kind": "Reference",
"text": "XModuleName",
"canonicalReference": "@empathyco/x-components!XModuleName:type"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "keyof "
},
{
"kind": "Reference",
"text": "ExtractActions",
"canonicalReference": "@empathyco/x-components!ExtractActions:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "XModulesTree",
"canonicalReference": "@empathyco/x-components!XModulesTree:interface"
},
{
"kind": "Content",
"text": "[ModuleName]>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/store/store.types.ts",
"releaseTag": "Public",
"name": "ActionNamesFor",
"typeParameters": [
{
"typeParameterName": "ModuleName",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 3,
"endIndex": 8
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-components!ActionsClass:type",
"docComment": "/**\n * Type for implementing actions for a module with a class.\n *\n * @param Module - The module this actions belong to.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type ActionsClass<Module extends "
},
{
"kind": "Reference",
"text": "AnyXStoreModule",
"canonicalReference": "@empathyco/x-components!AnyXStoreModule:type"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<Module['actions']>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/store/actions.types.ts",
"releaseTag": "Public",
"name": "ActionsClass",
"typeParameters": [
{
"typeParameterName": "Module",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 3,
"endIndex": 5
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-components!ActionsDictionary:type",
"docComment": "/**\n * Util type for being used on generic constraints which will only accept an object containing actions.\n *\n * @example\n *\n * Example constraint\n * ```typescript\n * // This function allows receiving any object who only contains actions;\n * function sampleFunction\\<Actions extends ActionsDictionary\\<Actions\\>\\>(actions: Actions): void;\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type ActionsDictionary<Actions> = "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<keyof Actions, (payload?: any) => any>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/store/actions.types.ts",
"releaseTag": "Public",
"name": "ActionsDictionary",
"typeParameters": [
{
"typeParameterName": "Actions",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-components!ActionsTree:type",
"docComment": "/**\n * Type-safe actions definition type. An object with this type is what it is needed to define {@link https://vuex.vuejs.org/ | Vuex} actions.\n *\n * @param State - The module state dictionary type definition.\n *\n * @param Getters - The module getters dictionary type definition.\n *\n * @param Mutations - The module mutation dictionary type definition.\n *\n * @param Actions - The module actions dictionary type definition.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type ActionsTree<State extends "
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@empathyco/x-utils!Dictionary:type"
},
{
"kind": "Content",
"text": ", Getters extends "
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@empathyco/x-utils!Dictionary:type"
},
{
"kind": "Content",
"text": ", Mutations extends "
},
{
"kind": "Reference",
"text": "MutationsDictionary",
"canonicalReference": "@empathyco/x-components!MutationsDictionary:type"
},
{
"kind": "Content",
"text": "<Mutations>"
},
{
"kind": "Content",
"text": ", Actions extends "
},
{
"kind": "Reference",
"text": "ActionsDictionary",
"canonicalReference": "@empathyco/x-components!ActionsDictionary:type"
},
{
"kind": "Content",
"text": "<Actions>"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "{\n [Key in keyof Actions]: (context: "
},
{
"kind": "Reference",
"text": "XActionContext",
"canonicalReference": "@empathyco/x-components!XActionContext:interface"
},
{
"kind": "Content",
"text": "<State, Getters, Mutations, Actions>, payload: "
},
{
"kind": "Reference",
"text": "ExtractPayload",
"canonicalReference": "@empathyco/x-components!ExtractPayload:type"
},
{
"kind": "Content",
"text": "<Actions[Key]>) => "
},
{
"kind": "Reference",
"text": "ReturnType",
"canonicalReference": "!ReturnType:type"
},
{
"kind": "Content",
"text": "<Actions[Key]> | "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ReturnType",
"canonicalReference": "!ReturnType:type"
},
{
"kind": "Content",
"text": "<Actions[Key]>>;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/store/actions.types.ts",
"releaseTag": "Public",
"name": "ActionsTree",
"typeParameters": [
{
"typeParameterName": "State",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Getters",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Mutations",
"constraintTokenRange": {
"startIndex": 5,
"endIndex": 7
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Actions",
"constraintTokenRange": {
"startIndex": 8,
"endIndex": 10
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 11,
"endIndex": 22
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!addQueryPreviewInstanceWire:var",
"docComment": "/**\n * Adds a new instance in a query preview.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "addQueryPreviewInstanceWire: "
},
{
"kind": "Content",
"text": "import(\"../..\")."
},
{
"kind": "Reference",
"text": "Wire",
"canonicalReference": "@empathyco/x-components!Wire:type"
},
{
"kind": "Content",
"text": "<string>"
}
],
"fileUrlPath": "src/x-modules/queries-preview/wiring.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "addQueryPreviewInstanceWire",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!addQueryToHistory:var",
"docComment": "/**\n * Default implementation for the {@link HistoryQueriesActions.addQueryToHistory}.\n *\n * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions, provided by Vuex.\n *\n * @param query - The query to try to add to the history.\n *\n * @returns A `void` promise that resolves when the history queries finishes updating.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "addQueryToHistory: "
},
{
"kind": "Content",
"text": "({ state, dispatch }: "
},
{
"kind": "Reference",
"text": "HistoryQueriesActionContext",
"canonicalReference": "@empathyco/x-components!HistoryQueriesActionContext:type"
},
{
"kind": "Content",
"text": ", query: string) => void | "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
}
],
"fileUrlPath": "src/x-modules/history-queries/store/actions/add-query-to-history.action.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "addQueryToHistory",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "Class",
"canonicalReference": "@empathyco/x-components!AddQueryToHistoryAction:class",
"docComment": "/**\n * Class implementation for the {@link HistoryQueriesActions.addQueryToHistory} action.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class AddQueryToHistoryAction implements "
},
{
"kind": "Reference",
"text": "ActionsClass",
"canonicalReference": "@empathyco/x-components!ActionsClass:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "HistoryQueriesXStoreModule",
"canonicalReference": "@empathyco/x-components!HistoryQueriesXStoreModule:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "src/x-modules/history-queries/store/actions/add-query-to-history.action.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "AddQueryToHistoryAction",
"preserveMemberOrder": false,
"members": [
{
"kind": "Method",
"canonicalReference": "@empathyco/x-components!AddQueryToHistoryAction#addQueryToHistory:member(1)",
"docComment": "/**\n * Default implementation for the {@link HistoryQueriesActions.addQueryToHistory}.\n *\n * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions, provided by Vuex.\n *\n * @param query - The query to try to add to the history.\n *\n * @returns A `void` promise that resolves when the history queries finishes updating.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "addQueryToHistory({ state, dispatch }: "
},
{
"kind": "Reference",
"text": "HistoryQueriesActionContext",
"canonicalReference": "@empathyco/x-components!HistoryQueriesActionContext:type"
},
{
"kind": "Content",
"text": ", query: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void | "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 8
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ state, dispatch }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "query",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "addQueryToHistory"
}
],
"implementsTokenRanges": [
{
"startIndex": 1,
"endIndex": 5
}
]
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!addQueryToHistoryQueries:var",
"docComment": "/**\n * Saves a new query into the history queries.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "addQueryToHistoryQueries: "
},
{
"kind": "Content",
"text": "import(\"../..\")."
},
{
"kind": "Reference",
"text": "Wire",
"canonicalReference": "@empathyco/x-components!Wire:type"
},
{
"kind": "Content",
"text": "<string>"
}
],
"fileUrlPath": "src/x-modules/history-queries/wiring.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "addQueryToHistoryQueries",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!addQueryToHistoryQueriesFromPreview:var",
"docComment": "/**\n * Saves the selectedQueryPreview query into the history queries.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "addQueryToHistoryQueriesFromPreview: "
},
{
"kind": "Content",
"text": "import(\"../..\")."
},
{
"kind": "Reference",
"text": "AnyWire",
"canonicalReference": "@empathyco/x-components!AnyWire:type"
}
],
"fileUrlPath": "src/x-modules/history-queries/wiring.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "addQueryToHistoryQueriesFromPreview",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!AllFilter:var",
"docComment": "/**\n * This component receives a required `facet` with {@link @empathyco/x-types#BooleanFilter} as prop and renders a button, which on clicked emits the {@link FacetsXEvents.UserClickedAllFilter} event. By default the rendered button displays a message with the facet label but this content is customizable through the default slot.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "_default: "
},
{
"kind": "Content",
"text": "import(\"vue\")."
},
{
"kind": "Reference",
"text": "DefineComponent",
"canonicalReference": "@vue/runtime-core!DefineComponent:type"
},
{
"kind": "Content",
"text": "<{\n facet: {\n type: "
},
{
"kind": "Reference",
"text": "PropType",
"canonicalReference": "@vue/runtime-core!PropType:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Facet",
"canonicalReference": "@empathyco/x-components!Facet:interface"
},
{
"kind": "Content",
"text": ">;\n required: true;\n };\n}, {\n clickEvent: "
},
{
"kind": "Reference",
"text": "ComputedRef",
"canonicalReference": "@vue/reactivity!ComputedRef:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "XEventsTypes",
"canonicalReference": "@empathyco/x-components!XEventsTypes:interface"
},
{
"kind": "Content",
"text": ">>;\n cssClasses: "
},
{
"kind": "Reference",
"text": "ComputedRef",
"canonicalReference": "@vue/reactivity!ComputedRef:interface"
},
{
"kind": "Content",
"text": "<{\n 'x-selected x-all-filter--is-selected': boolean;\n }>;\n isSelected: "
},
{
"kind": "Reference",
"text": "ComputedRef",
"canonicalReference": "@vue/reactivity!ComputedRef:interface"
},
{
"kind": "Content",
"text": "<boolean>;\n}, unknown, {}, {}, import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComponentOptionsMixin",
"canonicalReference": "@vue/runtime-core!ComponentOptionsMixin:type"
},
{
"kind": "Content",
"text": ", import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComponentOptionsMixin",
"canonicalReference": "@vue/runtime-core!ComponentOptionsMixin:type"
},
{
"kind": "Content",
"text": ", {}, string, import(\"vue\")."
},
{
"kind": "Reference",
"text": "PublicProps",
"canonicalReference": "@vue/runtime-core!PublicProps:type"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Readonly",
"canonicalReference": "!Readonly:type"
},
{
"kind": "Content",
"text": "<import(\"vue\")."
},
{
"kind": "Reference",
"text": "ExtractPropTypes",
"canonicalReference": "@vue/runtime-core!ExtractPropTypes:type"
},
{
"kind": "Content",
"text": "<{\n facet: {\n type: "
},
{
"kind": "Reference",
"text": "PropType",
"canonicalReference": "@vue/runtime-core!PropType:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Facet",
"canonicalReference": "@empathyco/x-components!Facet:interface"
},
{
"kind": "Content",
"text": ">;\n required: true;\n };\n}>>, {}, {}>"
}
],
"fileUrlPath": "dist/types/x-modules/facets/components/filters/all-filter.vue.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "AllFilter",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 32
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!animateClipPath:var",
"docComment": "/**\n * Returns a transition component to wrap an element passed in the default slot and animating its clip-path using inset and with the origin passed as parameter.\n *\n * @param animationOrigin - The origin of the animation. This means where the animation starts and ends. For example 'left' makes the element animate from the left and back; 'left-to-right' makes it animate from left to right. If not provided the default value is 'top'.\n *\n * @returns A Transition Component.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "animateClipPath: "
},
{
"kind": "Content",
"text": "(animationOrigin?: import(\"../create-directional-animation-factory\")."
},
{
"kind": "Reference",
"text": "AnimationOrigin",
"canonicalReference": "@empathyco/x-components!~AnimationOrigin:type"
},
{
"kind": "Content",
"text": " | undefined) => import(\"vue\")."
},
{
"kind": "Reference",
"text": "DefineComponent",
"canonicalReference": "@vue/runtime-core!DefineComponent:type"
},
{
"kind": "Content",
"text": "<{}, {}, {}, import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComputedOptions",
"canonicalReference": "@vue/runtime-core!ComputedOptions:type"
},
{
"kind": "Content",
"text": ", import(\"vue\")."
},
{
"kind": "Reference",
"text": "MethodOptions",
"canonicalReference": "@vue/runtime-core!MethodOptions:interface"
},
{
"kind": "Content",
"text": ", import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComponentOptionsMixin",
"canonicalReference": "@vue/runtime-core!ComponentOptionsMixin:type"
},
{
"kind": "Content",
"text": ", import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComponentOptionsMixin",
"canonicalReference": "@vue/runtime-core!ComponentOptionsMixin:type"
},
{
"kind": "Content",
"text": ", {}, string, import(\"vue\")."
},
{
"kind": "Reference",
"text": "PublicProps",
"canonicalReference": "@vue/runtime-core!PublicProps:type"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Readonly",
"canonicalReference": "!Readonly:type"
},
{
"kind": "Content",
"text": "<import(\"vue\")."
},
{
"kind": "Reference",
"text": "ExtractPropTypes",
"canonicalReference": "@vue/runtime-core!ExtractPropTypes:type"
},
{
"kind": "Content",
"text": "<{}>>, {}, {}>"
}
],
"fileUrlPath": "src/components/animations/animate-clip-path/animate-clip-path.factory.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "animateClipPath",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 20
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!animateScale:var",
"docComment": "/**\n * Returns a transition component to wrap an element passed in the default slot and animating its scale using transform and with the transform origin passed as parameter.\n *\n * @param animationOrigin - The origin of the transform animation. This means where the animation starts and ends. For example 'left' makes the element animate from the left and back; 'left-to-right' makes it animate from left to right. If not provided the default value is 'top'.\n *\n * @returns A Transition Component.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "animateScale: "
},
{
"kind": "Content",
"text": "(animationOrigin?: import(\"../create-directional-animation-factory\")."
},
{
"kind": "Reference",
"text": "AnimationOrigin",
"canonicalReference": "@empathyco/x-components!~AnimationOrigin:type"
},
{
"kind": "Content",
"text": " | undefined) => import(\"vue\")."
},
{
"kind": "Reference",
"text": "DefineComponent",
"canonicalReference": "@vue/runtime-core!DefineComponent:type"
},
{
"kind": "Content",
"text": "<{}, {}, {}, import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComputedOptions",
"canonicalReference": "@vue/runtime-core!ComputedOptions:type"
},
{
"kind": "Content",
"text": ", import(\"vue\")."
},
{
"kind": "Reference",
"text": "MethodOptions",
"canonicalReference": "@vue/runtime-core!MethodOptions:interface"
},
{
"kind": "Content",
"text": ", import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComponentOptionsMixin",
"canonicalReference": "@vue/runtime-core!ComponentOptionsMixin:type"
},
{
"kind": "Content",
"text": ", import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComponentOptionsMixin",
"canonicalReference": "@vue/runtime-core!ComponentOptionsMixin:type"
},
{
"kind": "Content",
"text": ", {}, string, import(\"vue\")."
},
{
"kind": "Reference",
"text": "PublicProps",
"canonicalReference": "@vue/runtime-core!PublicProps:type"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Readonly",
"canonicalReference": "!Readonly:type"
},
{
"kind": "Content",
"text": "<import(\"vue\")."
},
{
"kind": "Reference",
"text": "ExtractPropTypes",
"canonicalReference": "@vue/runtime-core!ExtractPropTypes:type"
},
{
"kind": "Content",
"text": "<{}>>, {}, {}>"
}
],
"fileUrlPath": "src/components/animations/animate-scale/animate-scale.factory.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "animateScale",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 20
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!animateTranslate:var",
"docComment": "/**\n * Returns a transition component to wrap an element passed in the default slot and animating its translate using transform and with the transform origin passed as parameter.\n *\n * @param animationOrigin - The origin of the transform animation. This means where the animation starts and ends. For example 'left' makes the element animate from the left and back; 'left-to-right' makes it animate from left to right. If not provided the default value is 'top'.\n *\n * @returns A Transition Component.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "animateTranslate: "
},
{
"kind": "Content",
"text": "(animationOrigin?: import(\"../create-directional-animation-factory\")."
},
{
"kind": "Reference",
"text": "AnimationOrigin",
"canonicalReference": "@empathyco/x-components!~AnimationOrigin:type"
},
{
"kind": "Content",
"text": " | undefined) => import(\"vue\")."
},
{
"kind": "Reference",
"text": "DefineComponent",
"canonicalReference": "@vue/runtime-core!DefineComponent:type"
},
{
"kind": "Content",
"text": "<{}, {}, {}, import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComputedOptions",
"canonicalReference": "@vue/runtime-core!ComputedOptions:type"
},
{
"kind": "Content",
"text": ", import(\"vue\")."
},
{
"kind": "Reference",
"text": "MethodOptions",
"canonicalReference": "@vue/runtime-core!MethodOptions:interface"
},
{
"kind": "Content",
"text": ", import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComponentOptionsMixin",
"canonicalReference": "@vue/runtime-core!ComponentOptionsMixin:type"
},
{
"kind": "Content",
"text": ", import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComponentOptionsMixin",
"canonicalReference": "@vue/runtime-core!ComponentOptionsMixin:type"
},
{
"kind": "Content",
"text": ", {}, string, import(\"vue\")."
},
{
"kind": "Reference",
"text": "PublicProps",
"canonicalReference": "@vue/runtime-core!PublicProps:type"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Readonly",
"canonicalReference": "!Readonly:type"
},
{
"kind": "Content",
"text": "<import(\"vue\")."
},
{
"kind": "Reference",
"text": "ExtractPropTypes",
"canonicalReference": "@vue/runtime-core!ExtractPropTypes:type"
},
{
"kind": "Content",
"text": "<{}>>, {}, {}>"
}
],
"fileUrlPath": "src/components/animations/animate-translate/animate-translate.factory.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "animateTranslate",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 20
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!AnimateWidth:var",
"docComment": "/**\n * Renders a transition wrapping an element passed in the default slot and animating its width.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "_default: "
},
{
"kind": "Content",
"text": "import(\"vue\")."
},
{
"kind": "Reference",
"text": "DefineComponent",
"canonicalReference": "@vue/runtime-core!DefineComponent:type"
},
{
"kind": "Content",
"text": "<{}, {}, {}, {}, {}, import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComponentOptionsMixin",
"canonicalReference": "@vue/runtime-core!ComponentOptionsMixin:type"
},
{
"kind": "Content",
"text": ", import(\"vue\")."
},
{
"kind": "Reference",
"text": "ComponentOptionsMixin",
"canonicalReference": "@vue/runtime-core!ComponentOptionsMixin:type"
},
{
"kind": "Content",
"text": ", {}, string, import(\"vue\")."
},
{
"kind": "Reference",
"text": "PublicProps",
"canonicalReference": "@vue/runtime-core!PublicProps:type"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Readonly",
"canonicalReference": "!Readonly:type"
},
{
"kind": "Content",
"text": "<import(\"vue\")."
},
{
"kind": "Reference",
"text": "ExtractPropTypes",
"canonicalReference": "@vue/runtime-core!ExtractPropTypes:type"
},
{
"kind": "Content",
"text": "<{}>>, {}, {}>"
}
],
"fileUrlPath": "dist/types/components/animations/animate-width.vue.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "AnimateWidth",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 14
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!AnimationProp:var",
"docComment": "/**\n * Type for animations props.\n *\n * @remarks\n *\n * String for 'ul' Object for `DefineComponent` type Function for `() => NoElement`\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "AnimationProp: "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "StringConstructor",
"canonicalReference": "!StringConstructor:interface"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "ObjectConstructor",
"canonicalReference": "!ObjectConstructor:interface"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "FunctionConstructor",
"canonicalReference": "!FunctionConstructor:interface"
},
{
"kind": "Content",
"text": ")[]"
}
],
"fileUrlPath": "src/types/animation-prop.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "AnimationProp",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-components!AnyActionsTree:type",
"docComment": "/**\n * Alias for any actions tree. Use only when you really don't care about the actions type.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type AnyActionsTree = "
},
{
"kind": "Reference",
"text": "ActionsTree",
"canonicalReference": "@empathyco/x-components!ActionsTree:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@empathyco/x-utils!Dictionary:type"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@empathyco/x-utils!Dictionary:type"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "MutationsDictionary",
"canonicalReference": "@empathyco/x-components!MutationsDictionary:type"
},
{
"kind": "Content",
"text": "<any>, "
},
{
"kind": "Reference",
"text": "ActionsDictionary",
"canonicalReference": "@empathyco/x-components!ActionsDictionary:type"
},
{
"kind": "Content",
"text": "<any>>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/store/actions.types.ts",
"releaseTag": "Public",
"name": "AnyActionsTree",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 11
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-components!AnyGettersTree:type",
"docComment": "/**\n * Alias for any getters tree. Use only when you don't care about the type.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type AnyGettersTree = "
},
{
"kind": "Reference",
"text": "GettersTree",
"canonicalReference": "@empathyco/x-components!GettersTree:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@empathyco/x-utils!Dictionary:type"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@empathyco/x-utils!Dictionary:type"
},
{
"kind": "Content",