Skip to content

Commit e97fa2f

Browse files
authored
Merge pull request #813 from modx-pro/minishop3
Сменил нейминг modxprovuecore - vuetools
2 parents 4f6a6ee + 25f9799 commit e97fa2f

File tree

5 files changed

+56
-52
lines changed

5 files changed

+56
-52
lines changed

docs/components/minishop3/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ MiniShop3 разработан специально для MODX Revolution 3.x
8989

9090
- **REST API** — полноценный API для headless-интеграций
9191
- **Service Container** — зависимости через DI-контейнер MODX
92-
- **Vue 3 + PrimeVue** — современный интерфейс админки через [ModxProVueCore](/components/modxprovuecore/)
92+
- **Vue 3 + PrimeVue** — современный интерфейс админки через [VueTools](/components/vuetools/)
9393
- **Современный фронтенд** — без jQuery, нативный JavaScript
9494

9595
### Совместимость
@@ -111,11 +111,11 @@ MiniShop3 сохраняет обратную совместимость с mini
111111
### Зависимости MODX
112112

113113
- **pdoTools 3.x** — для работы сниппетов и шаблонизатора Fenom
114-
- **[ModxProVueCore](/components/modxprovuecore/)** — Vue 3 и PrimeVue для административного интерфейса
114+
- **[VueTools](/components/vuetools/)** — Vue 3 и PrimeVue для административного интерфейса
115115
- **[Scheduler](/components/scheduler/)** *(опционально)* — для фоновых задач (импорт, уведомления, очистка)
116116

117-
::: warning ModxProVueCore
118-
MiniShop3 использует Vue 3 для современного интерфейса админки. Пакет **[ModxProVueCore](/components/modxprovuecore/)** должен быть установлен до или вместе с MiniShop3. При отсутствии пакета будет показано сообщение с инструкцией по установке.
117+
::: warning VueTools
118+
MiniShop3 использует Vue 3 для современного интерфейса админки. Пакет **[VueTools](/components/vuetools/)** должен быть установлен до или вместе с MiniShop3. При отсутствии пакета будет показано сообщение с инструкцией по установке.
119119
:::
120120

121121
### Composer библиотеки
@@ -138,7 +138,7 @@ MiniShop3 использует следующие PHP библиотеки (вк
138138

139139
1. Перейдите в **Extras → Installer**
140140
2. Нажмите **Download Extras**
141-
3. Установите **[ModxProVueCore](/components/modxprovuecore/)** (если ещё не установлен)
141+
3. Установите **[VueTools](/components/vuetools/)** (если ещё не установлен)
142142
4. Найдите **MiniShop3** в списке доступных пакетов
143143
5. Нажмите **Download** и затем **Install**
144144

@@ -159,7 +159,7 @@ MiniShop3 использует следующие PHP библиотеки (вк
159159
Этот способ подходит для разработчиков, которым нужны самые свежие наработки:
160160

161161
::: tip Предварительные требования
162-
Перед установкой MiniShop3 убедитесь, что на сайте установлен пакет **[ModxProVueCore](/components/modxprovuecore/)**. Он предоставляет Vue 3 и PrimeVue через import maps.
162+
Перед установкой MiniShop3 убедитесь, что на сайте установлен пакет **[VueTools](/components/vuetools/)**. Он предоставляет Vue 3 и PrimeVue через import maps.
163163
:::
164164

165165
```bash

docs/components/minishop3/interface/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ title: Интерфейс
5757
| **ExtJS 3.4** | Основные панели (заказы, клиенты, ExtJS-формы) |
5858
| **Vue 3 + PrimeVue** | Современные компоненты (таблицы категорий, настройки, утилиты) |
5959

60-
Vue-компоненты интегрированы в ExtJS через точки монтирования и требуют пакет [ModxProVueCore](/components/modxprovuecore/).
60+
Vue-компоненты интегрированы в ExtJS через точки монтирования и требуют пакет [VueTools](/components/vuetools/).
6161

6262
## Расширение интерфейса
6363

docs/components/modxprovuecore/composables.md renamed to docs/components/vuetools/composables.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# API Composables
22

3-
ModxProVueCore предоставляет готовые composables (хелперы) для работы с MODX из Vue компонентов.
3+
VueTools предоставляет готовые composables (хелперы) для работы с MODX из Vue компонентов.
44

55
## useLexicon
66

@@ -9,7 +9,7 @@ ModxProVueCore предоставляет готовые composables (хелпе
99
### Импорт
1010

1111
```javascript
12-
import { useLexicon } from '@modxprovuecore/useLexicon'
12+
import { useLexicon } from '@vuetools/useLexicon'
1313
```
1414

1515
### API
@@ -66,7 +66,7 @@ public function getLanguageTopics()
6666
### Импорт
6767

6868
```javascript
69-
import { useModx } from '@modxprovuecore/useModx'
69+
import { useModx } from '@vuetools/useModx'
7070
```
7171

7272
### API
@@ -121,7 +121,7 @@ modx.msg.confirm({
121121
### Импорт
122122

123123
```javascript
124-
import { usePermission } from '@modxprovuecore/usePermission'
124+
import { usePermission } from '@vuetools/usePermission'
125125
```
126126

127127
### API
@@ -162,7 +162,7 @@ if (hasAllPermissions(['view', 'edit'])) {
162162
```vue
163163
<script setup>
164164
import { computed } from 'vue'
165-
import { usePermission } from '@modxprovuecore/usePermission'
165+
import { usePermission } from '@vuetools/usePermission'
166166
167167
const { hasPermission } = usePermission()
168168
@@ -183,7 +183,7 @@ HTTP клиент для **стандартного** MODX connector API.
183183
### Импорт
184184

185185
```javascript
186-
import { useApi } from '@modxprovuecore/useApi'
186+
import { useApi } from '@vuetools/useApi'
187187
```
188188

189189
### API
@@ -242,10 +242,10 @@ POST /connectors/index.php?action=security/user/getlist
242242
```vue
243243
<script setup>
244244
import { ref, computed, onMounted } from 'vue'
245-
import { useLexicon } from '@modxprovuecore/useLexicon'
246-
import { useModx } from '@modxprovuecore/useModx'
247-
import { usePermission } from '@modxprovuecore/usePermission'
248-
import { useApi } from '@modxprovuecore/useApi'
245+
import { useLexicon } from '@vuetools/useLexicon'
246+
import { useModx } from '@vuetools/useModx'
247+
import { usePermission } from '@vuetools/usePermission'
248+
import { useApi } from '@vuetools/useApi'
249249
250250
import DataTable from 'primevue/datatable'
251251
import Column from 'primevue/column'
Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: ModxProVueCore
2+
title: VueTools
33
description: Базовый пакет Vue 3 стека для компонентов MODX 3
4-
logo: https://modstore.pro/assets/extras/modxprovuecore/logo-lg.png
4+
logo: https://modstore.pro/assets/extras/vuetools/logo-lg.png
55
author: modx-pro
6-
repository: https://github.com/modx-pro/modxprovuecore
6+
repository: https://github.com/modx-pro/vuetools
77

88
items:
99
- text: Интеграция
@@ -12,13 +12,13 @@ items:
1212
link: composables
1313
---
1414

15-
# ModxProVueCore
15+
# VueTools
1616

1717
Базовый пакет, предоставляющий **Vue 3 стек** для компонентов MODX 3.x через ES Modules Import Map.
1818

1919
## Назначение
2020

21-
ModxProVueCore решает проблему **дублирования библиотек** при использовании Vue 3 в нескольких компонентах MODX. Вместо того чтобы каждый компонент включал свою копию Vue, Pinia и PrimeVue, все они используют **общие библиотеки** из ModxProVueCore.
21+
VueTools решает проблему **дублирования библиотек** при использовании Vue 3 в нескольких компонентах MODX. Вместо того чтобы каждый компонент включал свою копию Vue, Pinia и PrimeVue, все они используют **общие библиотеки** из VueTools.
2222

2323
### Преимущества
2424

@@ -27,6 +27,10 @@ ModxProVueCore решает проблему **дублирования библ
2727
- **Изолированные стили** — PrimeVue стили не конфликтуют с ExtJS админки MODX
2828
- **Готовые composables** — useLexicon, useApi, useModx, usePermission для работы с MODX
2929

30+
::: info Переименование
31+
Ранее пакет назывался **ModxProVueCore**. С версии 2.0 он переименован в **VueTools** для краткости.
32+
:::
33+
3034
## Состав пакета
3135

3236
| Библиотека | Версия | Назначение |
@@ -59,7 +63,7 @@ ModxProVueCore решает проблему **дублирования библ
5963

6064
1. Перейдите в **Extras → Installer**
6165
2. Нажмите **Download Extras**
62-
3. Найдите **ModxProVueCore** в списке
66+
3. Найдите **VueTools** в списке
6367
4. Нажмите **Download** и затем **Install**
6468

6569
::: info Автоматическая активация
@@ -70,28 +74,28 @@ ModxProVueCore решает проблему **дублирования библ
7074

7175
### Import Map
7276

73-
ModxProVueCore использует [Import Map](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap) — стандартную технологию браузера для разрешения ES Module импортов.
77+
VueTools использует [Import Map](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap) — стандартную технологию браузера для разрешения ES Module импортов.
7478

75-
Плагин `VueCoreManager` срабатывает на событие `OnManagerPageInit` и регистрирует Import Map в `<head>` страницы:
79+
Плагин `VueToolsManager` срабатывает на событие `OnManagerPageInit` и регистрирует Import Map в `<head>` страницы:
7680

7781
```json
7882
{
7983
"imports": {
80-
"vue": "/assets/components/modxprovuecore/vendor/vue.min.js",
81-
"pinia": "/assets/components/modxprovuecore/vendor/pinia.min.js",
82-
"primevue": "/assets/components/modxprovuecore/vendor/primevue.min.js",
83-
"@modxprovuecore/useApi": "/assets/components/modxprovuecore/composables/useApi.min.js",
84-
"@modxprovuecore/useLexicon": "/assets/components/modxprovuecore/composables/useLexicon.min.js",
85-
"@modxprovuecore/useModx": "/assets/components/modxprovuecore/composables/useModx.min.js",
86-
"@modxprovuecore/usePermission": "/assets/components/modxprovuecore/composables/usePermission.min.js"
84+
"vue": "/assets/components/vuetools/vendor/vue.min.js",
85+
"pinia": "/assets/components/vuetools/vendor/pinia.min.js",
86+
"primevue": "/assets/components/vuetools/vendor/primevue.min.js",
87+
"@vuetools/useApi": "/assets/components/vuetools/composables/useApi.min.js",
88+
"@vuetools/useLexicon": "/assets/components/vuetools/composables/useLexicon.min.js",
89+
"@vuetools/useModx": "/assets/components/vuetools/composables/useModx.min.js",
90+
"@vuetools/usePermission": "/assets/components/vuetools/composables/usePermission.min.js"
8791
}
8892
}
8993
```
9094

9195
### Как это работает
9296

9397
```
94-
1. Плагин VueCoreManager (OnManagerPageInit)
98+
1. Плагин VueToolsManager (OnManagerPageInit)
9599
96100
2. Регистрирует Import Map в <head> (до ES modules)
97101
@@ -119,7 +123,7 @@ PrimeVue стили изолированы с помощью CSS префикс
119123
Без класса `vueApp` стили PrimeVue не применятся к вашим компонентам.
120124
:::
121125

122-
## Компоненты, использующие ModxProVueCore
126+
## Компоненты, использующие VueTools
123127

124128
- **[MiniShop3](/components/minishop3/)** — современный интернет-магазин для MODX 3
125129

@@ -132,4 +136,4 @@ PrimeVue стили изолированы с помощью CSS префикс
132136

133137
## Поддержка
134138

135-
- GitHub Issues: [modx-pro/modxprovuecore](https://github.com/modx-pro/modxprovuecore/issues)
139+
- GitHub Issues: [modx-pro/vuetools](https://github.com/modx-pro/vuetools/issues)

docs/components/modxprovuecore/integration.md renamed to docs/components/vuetools/integration.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Интеграция в компонент
22

3-
Пошаговое руководство по интеграции Vue 3 + PrimeVue в компонент MODX 3 с использованием ModxProVueCore.
3+
Пошаговое руководство по интеграции Vue 3 + PrimeVue в компонент MODX 3 с использованием VueTools.
44

55
## Настройка Vite
66

@@ -20,10 +20,10 @@ export default defineConfig({
2020
'vue',
2121
'pinia',
2222
'primevue',
23-
'@modxprovuecore/useApi',
24-
'@modxprovuecore/useLexicon',
25-
'@modxprovuecore/useModx',
26-
'@modxprovuecore/usePermission'
23+
'@vuetools/useApi',
24+
'@vuetools/useLexicon',
25+
'@vuetools/useModx',
26+
'@vuetools/usePermission'
2727
],
2828
output: {
2929
format: 'es',
@@ -47,7 +47,7 @@ export default defineConfig({
4747
```
4848

4949
::: info Ключевой момент
50-
Массив `external` указывает Vite **НЕ включать** эти зависимости в бандл. Браузер загрузит их из Import Map, зарегистрированного ModxProVueCore.
50+
Массив `external` указывает Vite **НЕ включать** эти зависимости в бандл. Браузер загрузит их из Import Map, зарегистрированного VueTools.
5151
:::
5252

5353
### Установка зависимостей
@@ -102,9 +102,9 @@ $this->modx->regClientStartupHTMLBlock('
102102
');
103103
```
104104

105-
## Проверка наличия ModxProVueCore
105+
## Проверка наличия VueTools
106106

107-
При отсутствии ModxProVueCore на сайте Vue модули не загрузятся, а в консоли появятся ошибки. Рекомендуется реализовать проверку и показывать понятное сообщение пользователю.
107+
При отсутствии VueTools на сайте Vue модули не загрузятся, а в консоли появятся ошибки. Рекомендуется реализовать проверку и показывать понятное сообщение пользователю.
108108

109109
### Метод addVueModule()
110110

@@ -147,8 +147,8 @@ class MyComponentManagerController extends modExtraManagerController
147147
protected function registerVueCoreCheck(): void
148148
{
149149
$alertTitle = $this->modx->lexicon('mycomponent_error') ?: 'Error';
150-
$alertMessage = $this->modx->lexicon('mycomponent_modxprovuecore_required')
151-
?: 'ModxProVueCore package is required. Please install it from Package Manager.';
150+
$alertMessage = $this->modx->lexicon('mycomponent_vuetools_required')
151+
?: 'VueTools package is required. Please install it from Package Manager.';
152152

153153
$script = <<<JS
154154
<script>
@@ -226,11 +226,11 @@ public function loadCustomCssJs()
226226
```php
227227
// lexicon/ru/default.inc.php
228228
$_lang['mycomponent_error'] = 'Ошибка';
229-
$_lang['mycomponent_modxprovuecore_required'] = 'Для работы требуется пакет ModxProVueCore. Установите его через Менеджер пакетов.';
229+
$_lang['mycomponent_vuetools_required'] = 'Для работы требуется пакет VueTools. Установите его через Менеджер пакетов.';
230230

231231
// lexicon/en/default.inc.php
232232
$_lang['mycomponent_error'] = 'Error';
233-
$_lang['mycomponent_modxprovuecore_required'] = 'ModxProVueCore package is required. Please install it via Package Manager.';
233+
$_lang['mycomponent_vuetools_required'] = 'VueTools package is required. Please install it via Package Manager.';
234234
```
235235

236236
### Результат
@@ -256,10 +256,10 @@ import Button from 'primevue/button'
256256
import DataTable from 'primevue/datatable'
257257
import Column from 'primevue/column'
258258
259-
// Composables из ModxProVueCore
260-
import { useLexicon } from '@modxprovuecore/useLexicon'
261-
import { useModx } from '@modxprovuecore/useModx'
262-
import { usePermission } from '@modxprovuecore/usePermission'
259+
// Composables из VueTools
260+
import { useLexicon } from '@vuetools/useLexicon'
261+
import { useModx } from '@vuetools/useModx'
262+
import { usePermission } from '@vuetools/usePermission'
263263
264264
const { _ } = useLexicon()
265265
const { modx, config } = useModx()
@@ -468,7 +468,7 @@ await request.post('/api/products', { name: 'New Product' })
468468
469469
## Чеклист интеграции
470470
471-
- [ ] Добавить `modxprovuecore` в зависимости пакета (setup options)
471+
- [ ] Добавить `vuetools` в зависимости пакета (setup options)
472472
- [ ] Настроить `external` в vite.config.js
473473
- [ ] Настроить postcss prefix selector для изоляции стилей
474474
- [ ] Реализовать `addVueModule()` с проверкой зависимости

0 commit comments

Comments
 (0)