wt.core assets source

is a dependency wt.core

Предназначен для асинхронной работы с ресурсами на веб-проектах.

Термины и определения в контексте фреймворка

Плагин - сущность включающая в себя модуль, js-, css-файлы, шрифты.

Модуль - составляющая плагина, определяемая как основной файл плагина (его наличие не обязательно в плагине)

PluginManager - класс для работы с плагинами

Базовые принципы

Основные этапы работы с плагином:

этап	метод
Регистрация	registerPlugin(`pluginId`, `config`) или registerPlugins(`object`)
Загрузка	load(`pluginId`, `callback`)
Установка	install(`pluginId`, `callback`)
Запрос	require(`pluginId`, `callback`)

Пример конфигурации

kit.PluginManager.registerPlugin('menu', {
        path: kit.config.defaultPath + '/menu',
        module: '/menu.js',
        type: 'loader',
        css: [
            '/menu.css'
        ],
        deps: ['lib', 'align', 'utils']
    }
);

Использование

Запуск исполняемого кода после установки зависимостей:

PluginManager.exec(deps, callback, argArr, context)

Запуск исполняемого кода после установки зависимостей и при загруженной странице:

PluginManager.ready(deps, callback)

kit.config.requiredDependencies определяет зависимости (deps) по умолчанию

Глобальный конфиг

Параметры определяются в плагине config

Параметры допустимо определять до загрузки PluginManager

name	default	description
defaultPath	/local/templater.dev/kit/assets
requiredDependencies	['bsCore', 'toolkit']	дополнительно определяет список зависимостей для любого колбека вызванного функциями `exec` и `ready`
autoloadPluginList	['tooltip']	Автоматически загрузит ресурсы указанных плагинов. В случае модуля с типом `loader` код не будет исполнен сразу после загрузки. Исполнение бдует определятся функций `install`
debug	false	Расширит список выводимой в консоль информации

z-index map

z-index	plugin	selector
100	flex-kit	.flex-card:hover .flex-card__content

✨ Magic ✨

The overriding design goal for Markdown's formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions.

Установка

License

MIT

3.8 KiB Raw Blame History