diff --git a/README.md b/README.md index 251658a..3c5320a 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ Предназначен для асинхронной работы с ресурсами на веб-проектах. +## Установка + +В директории [php:wt.core] `app()->config()->get('templater.path') . '/kit'` (по умолчанию `/local/templater.dev/kit`) выполнить клонирование проекта + +```bash +git clone https://bellord@bitbucket.org/bellord13/kit.git ./ +``` + ## Термины и определения в контексте фреймворка `Плагин` - сущность включающая в себя модуль, js-, css-файлы, шрифты. @@ -16,7 +24,7 @@ ✨ Инициализация -> Выдержка из плагина `core` +Выдержка из плагина `core`: ```js manager = new PluginManager(global, plugins = {}); @@ -43,7 +51,7 @@ kit.jquery | этап | метод | | ------ | ------ | -| Регистрация | registerPlugin(`pluginId`, `config`) или registerPlugins(`object`) | +| Регистрация | register(`pluginId`, `config`) или registerPlugins(`object`) | | Загрузка | load(`pluginId`, `callback`) | | Установка | install(`pluginId`, `callback`) | | Запрос | require(`pluginId`, `callback`) | @@ -53,7 +61,7 @@ kit.jquery ```js kit.PluginManager.register('menu', { - path: kit.config.defaultPath + '/menu', + path: kit.config.assetsPath + '/menu', module: '/menu.js', type: 'loader', css: [ @@ -105,7 +113,7 @@ PluginManager.ready(deps, callback) | name | default | description | | --- | --- | --- | -| defaultPath | /local/templater.dev/kit/assets | | +| assetsPath | /local/templater.dev/kit/assets | | | requiredDependencies | ['bsCore', 'toolkit'] | дополнительно определяет список зависимостей для любого колбека вызванного функциями `exec` и `ready` | | autoloadPluginList | ['tooltip'] | Автоматически загрузит ресурсы указанных плагинов. В случае модуля с типом `loader` код не будет исполнен сразу после загрузки. Исполнение бдует определятся функций `install` | | debug | false | Расширит список выводимой в консоль информации | @@ -119,15 +127,6 @@ PluginManager.ready(deps, callback) | 100 | flex-kit | .flex-card:hover .flex-card__content | - -## Установка - -В директории определенной в `config.defaultPath` выполнить -```bash -git clone https://bellord@bitbucket.org/bellord13/kit.git ./ -``` - - ## License MIT diff --git a/assets/config/config.js b/assets/config/config.js index 5b22620..fd0f539 100644 --- a/assets/config/config.js +++ b/assets/config/config.js @@ -1,7 +1,7 @@ window.kit = window.kit || {}; kit.config = kit.config || {}; -kit.config.defaultPath = '/local/templater.dev/kit/assets'; +kit.config.assetsPath = '/local/templater.dev/kit/assets'; kit.config.requiredDependencies = ['bsCore', 'toolkit']; kit.config.autoloadPluginList = ['tooltip']; kit.config.debug = true; \ No newline at end of file diff --git a/assets/core/core.js b/assets/core/core.js index db75bbd..393f3b2 100644 --- a/assets/core/core.js +++ b/assets/core/core.js @@ -563,7 +563,7 @@ window.kit = window.kit || {}; }; var defaultConfig = { - defaultPath: '', + assetsPath: '', requiredDependencies: [], autoloadPluginList: [], debug: false, diff --git a/assets/core/core.register.js b/assets/core/core.register.js index da5468c..5262750 100644 --- a/assets/core/core.register.js +++ b/assets/core/core.register.js @@ -1,6 +1,6 @@ __PluginManager__.registerPlugins({ menu: { - path: __pmConfig__.defaultPath + '/menu', + path: __pmConfig__.assetsPath + '/menu', module: '/menu.js', css: [ '/menu.css' @@ -9,28 +9,28 @@ __PluginManager__.registerPlugins({ deps: ['lib', 'align', 'utils'] }, lib: { - path: __pmConfig__.defaultPath + '/lib', + path: __pmConfig__.assetsPath + '/lib', module: '/lib.js', type: 'loader', }, align: { - path: __pmConfig__.defaultPath + '/align', + path: __pmConfig__.assetsPath + '/align', module: '/align.js', type: 'loader', }, utils: { - path: __pmConfig__.defaultPath + '/utils', + path: __pmConfig__.assetsPath + '/utils', module: '/utils.js', type: 'loader', }, jquery: { - path: __pmConfig__.defaultPath + '/jquery', + path: __pmConfig__.assetsPath + '/jquery', module: '/jquery.min.js', type: 'loader', alias: '$', }, tooltip: { - path: __pmConfig__.defaultPath + '/tooltip', + path: __pmConfig__.assetsPath + '/tooltip', module: '/tooltip.js', type: 'loader', css: '/tooltip.css', @@ -40,13 +40,13 @@ __PluginManager__.registerPlugins({ deps: ['popper', 'bsCore'], }, popper: { - path: __pmConfig__.defaultPath + '/popper', + path: __pmConfig__.assetsPath + '/popper', alias: 'popper.js', module: '/popper.js', type: 'loader', }, bsCore: { - path: __pmConfig__.defaultPath + '/bsCore', + path: __pmConfig__.assetsPath + '/bsCore', module: '/bsCore.js', type: 'loader', css: [ @@ -54,20 +54,20 @@ __PluginManager__.registerPlugins({ ] }, mask: { - path: __pmConfig__.defaultPath + '/mask', + path: __pmConfig__.assetsPath + '/mask', module: '/mask.js', type: 'loader', deps: ['jquery'], }, toolkit: { - path: __pmConfig__.defaultPath + '/toolkit', + path: __pmConfig__.assetsPath + '/toolkit', module: '/toolkit.js', type: 'loader', css: ['/toolkit.css'], deps: ['jquery', 'mask'], }, modal: { - path: __pmConfig__.defaultPath + '/modal', + path: __pmConfig__.assetsPath + '/modal', module: '/modal.js', type: 'loader', css: [ @@ -92,7 +92,7 @@ __PluginManager__.registerPlugins({ }, }, collapse: { - path: __pmConfig__.defaultPath + '/collapse', + path: __pmConfig__.assetsPath + '/collapse', module: '/collapse.js', type: 'loader', css: [ @@ -106,7 +106,7 @@ __PluginManager__.registerPlugins({ }, }, datepicker: { - path: __pmConfig__.defaultPath + '/datepicker', + path: __pmConfig__.assetsPath + '/datepicker', module: '/js/datepicker.js', type: 'loader', css: [