ui-library-starter-2

Vue Components UI Library Starter 2

Стартовый пример для быстрого создания переиспользуемых модулей-библиотек с состоянием, темезацией, локализацией, документацией и режимом разработки (на Vue3+TS/Vuex4/VuePress2/i18n)

В отличии от более примитивной первой версии этот модуль:

• Использует хранилище, то есть содержит состояние

• Может запускаться в полноценном режиме разработки, как будто это собственно уже сам конечный проект

• Поддерживает темизацию и локализацию

Пример модуля содержит совсем немного компонент и документация на новой версии VuePress, в отличии от первой версии, не кастомизируется под фирменный стиль который предоставляет библиотека. Так сделано не только по причине лени и экономии времени, но, прежде всего, потому что кажется излишним - то что призваны продемонстрировать примеры - этого совсем не требует.

Package on NPM

Documentation

Пример использующего модуль проекта - репо

Пример использующего модуль проекта - демостенд

Project setup

$ npm install

Development documentation

$ npm run docs:dev

Build documentation

$ npm run docs:build

Use the sandbox (not documentation)

Используйте специальный режим для разработки и тестирования модуля-библиотеки. Для того чтобы переключиться в него - выставите флаг isDevelopmentModuleMode в значение true главном файле проекта @/src/main.ts:

// ATTENTION! Set to true if you want
// to develop a module (not documentation)
// and false before publishing for use in projects
const isDevelopmentModuleMode = true;
if (isDevelopmentModuleMode) {
  console.log('Start development module!');
  ...
}

$ npm run serve

Compiles and minifies for production

$ npm run build

Publish to NPM

$ npm version patch
$ npm publish