@topvisor/ui/web-types.json

Topvisor UI-kit Vue

{
	"name": "@topvisor/ui",
	"version": "1.0.0",
	"js-types-syntax": "typescript",
	"description-markup": "markdown",
	"contributions": {
		"html": {
			"vue-directives": [
				{
					"name": "top-data",
					"source": {
						"module": "@topvisor/ui/core/directives/data",
						"symbol": "default"
					},
					"description": "Сохранить данные в элементе",
					"doc-url": "https://ui.topvisor.com/?path=/docs/core-directives-data--docs",
					"argument": {
						"name": "name",
						"description": "Имя для сохранения данных"
					},
					"attribute-value": {
						"kind": "plain",
						"type": "object"
					}
				},
				{
					"name": "top-focus",
					"source": {
						"module": "@topvisor/ui/core/directives/focus",
						"symbol": "default"
					},
					"modifiers": [
						{
							"name": "onupdate",
							"description": "Выполнять фокусировку при динамической установке значения",
							"type": "boolean"
						}
					],
					"description": "Фокусировка на элементе сразу после его отображения",
					"doc-url": "https://ui.topvisor.com/?path=/docs/core-directives-focus--docs",
					"attribute-value": {
						"kind": "plain",
						"type": "boolean",
						"default": true
					}
				},
				{
					"name": "top-scroll-into-view",
					"source": {
						"module": "@topvisor/ui/core/directives/scrollIntoView",
						"symbol": "default"
					},
					"modifiers": [
						{
							"name": "immediate",
							"description": "При использовании скролл будет произведен сразу, иначе скролл будет произведен при после смены видимости элемента, например через v-show",
							"type": "boolean"
						}
					],
					"description": "Произвести автоскролл к элементу",
					"doc-url": "https://ui.topvisor.com/?path=/docs/core-directives-scrollIntoView--docs",
					"attribute-value": {
						"kind": "plain",
						"type": "object"
					}
				},
				{
					"name": "top-scroll-shadow",
					"source": {
						"module": "@topvisor/ui/core/directives/scrollShadow",
						"symbol": "default"
					},
					"description": "Добавить отображение тени при появлении скролла у элемента",
					"doc-url": "https://ui.topvisor.com/?path=/docs/core-directives-scrollshadow--docs",
					"attribute-value": {
						"kind": "plain",
						"type": "object"
					}
				},
				{
					"name": "top-sticky",
					"source": {
						"module": "@topvisor/ui/core/directives/sticky",
						"symbol": "default"
					},
					"description": "Добавлять элементу класс-модификатор, если он перейдет в режим sticky",
					"doc-url": "https://ui.topvisor.com/?path=/docs/core-directives-sticky--docs",
					"modifiers": [
						{
							"name": "bottom",
							"description": "Когда область видимости будет ниже элемента, дополнительный класс удалится",
							"type": "boolean"
						}
					],
					"attribute-value": {
						"kind": "plain",
						"type": "string",
						"default": "top-sticky"
					}
				},
				{
					"name": "top-swim-up",
					"source": {
						"module": "@topvisor/ui/core/directives/swimUp",
						"symbol": "default"
					},
					"description": "Реализует анимацию подплытия блоков при скролле",
					"doc-url": "https://ui.topvisor.com/?path=/docs/core-directives-swimup--docs",
					"attribute-value": {
						"kind": "plain",
						"type": "object"
					}
				},
				{
					"name": "top-tooltip",
					"source": {
						"module": "@topvisor/ui/core/directives/tooltip",
						"symbol": "default"
					},
					"description": "Добавление всплывающей подсказки к элементу",
					"doc-url": "https://ui.topvisor.com/?path=/docs/core-directives-tooltip--docs",
					"attribute-value": {
						"kind": "expression",
						"type": "object"
					}
				}
			]
		}
	}
}