1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/xizon-Uix-Kit

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
README_CN.md 22 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 30.11.2024 03:17 c6eff72

Uix Kit — это набор инструментов для разработки, который помогает разработчикам быстро создавать полноценные интерактивные веб-сайты. Это не фреймворк, и все модули, скрипты и стили полностью контролируются разработчиком!

Это инструмент для создания веб-приложений без использования фреймворков. Можно импортировать любые внешние библиотеки, фреймворки или собственные модули ES для производства. Файлы в каталоге dist могут быть использованы отдельно на любом сайте. Они часто используются для создания полностью статических сайтов (HTML-шаблоны или для интеграции с динамическими языками).

Демонстрация зависит от jQuery (вы можете полностью переписать скрипт, если необходимо). И каталог dist не содержит никаких сторонних скриптов и библиотек стилей, сторонние библиотеки загружаются из внешних файлов HTML.



  • Документация на английском языке (README.md)
  • Китайская версия документации (README_CN.md)

Демонстрация

GitHub pages предоставляет доступ только к статическому контенту, AJAX и PHP запросы не могут быть предварительно просмотрены, вы можете использовать онлайн-сервер для полного предварительного просмотра.

https://uiux.cc/uix-kit

Содержание

  • Почему стоит использовать его?
  • Структура каталога
  • Основные операции для разработчика
  • Руководство по началу работы
  • Шаблоны HTML
  • Как создать новый пользовательский модуль?
  • Совместимость
  • Поддерживаемые среды разработки
  • Лицензия

Почему стоит использовать Uix Kit?

  • Каталог dist не связывает никакие сторонние скрипты и библиотеки стилей, сторонние библиотеки загружаются из HTML-файлов.
  • Это не многоразовая структура компонентов.
  • Это не JavaScript-фреймворк.
  • Используется для создания полностью статических веб-сайтов (HTML-шаблонов или для интеграции с динамическими языками).
  • Подходит для разработки визуально интерактивных веб-сайтов и шаблонов WordPress.
  • Соответствует стандартам W3C и оптимизирован для SEO.
  • Использует BEM-именование, поэтому основной проект Uix Kit не конфликтует с другими проектами.
  • Автоматически генерирует комментарии для каждого модуля.
  • Каждый модуль включает SASS/SCSS, JavaScript и HTML файлы.
  • Встроенные стратегии проверки для TypeScript и React (эти скрипты встроены в страницу, а не во весь проект).
  • Совместим с Bootstrap 5.x (можно также удалить стили Bootstrap).
  • Предоставляет общие компоненты и макеты веб-страниц, повышая эффективность разработки и стандарты качества страниц.
  • Полную демонстрацию можно использовать для разработки адаптивных веб-сайтов без среды Node.js.
  • Демонстрация зависит от jQuery (если необходимо, вы можете полностью переписать скрипты).

Структура каталога


uix-kit/
├── README.md   --------------------------- # Основная документация
├── CHANGELOG.md   ------------------------ # Журнал изменений
├── CONTRIBUTING.md   --------------------- # Ресурсы для цитирования
├── LICENSE     --------------------------- # Лицензия
├── webpack.config.js  -------------------- # Конфигурация веб-пакета
├── server.js  ---------------------------- # Конфигурация локального сервера
├── package.json  ------------------------- # Файл конфигурации проекта [информация о комментариях к продукту, скомпилированному веб-сайтом, может быть изменена здесь]
├── package-lock.json
├── dist/
│   ├── css/
│   │   ├── uix-kit.css  ------------------ # Основные стили сайта (скомпилированные)
│   │   ├── uix-kit.css.map
│   │   ├── uix-kit.min.css  -------------- # Сжатая версия основных стилей сайта, вызывается по умолчанию (скомпилированная)
│   │   ├── uix-kit.min.css.map
│   │   ├── uix-kit-rtl.css   ------------- # Основные стили RTL сайта (скомпилированные)
│   │   ├── uix-kit-rtl.css.map
│   │   ├── uix-kit-rtl.min.css   --------- # Сжатая версия основных стилей RTL сайта, вызываемая по умолчанию (скомпилированная)
│   │   └── uix-kit-rtl.min.css.map
│   └── js/
│   │   ├── uix-kit.js   ------------------ # Основные сценарии сайта (скомпилированы)
│   │   ├── uix-kit.js.map
│   │   ├── uix-kit.min.js  --------------- # Сжатая версия основного сценария сайта, вызываемого по умолчанию (скомпилирована)
│   │   ├── uix-kit.min.js.map
│   │   ├── uix-kit-rtl.js
│   │   ├── uix-kit-rtl.js.map
│   │   ├── uix-kit-rtl.min.js
│   │   └── uix-kit-rtl.min.js.map
├── misc/                
│   ├── screenshots/  --------------------- # Скриншоты
│   └── grid/ ----------------------------- # Система сетки PSD, вспомогательная для UI-дизайна
├── src/
│   ├── components/
│   │   ├── _app-load.ts  ------------- # Модули, необходимые для импорта на сайт
│   │   ├── _app-load-rtl.ts  --------- # Модули RTL, необходимые для импорта на сайт
│   │   ├── _global/ ------------------ # Общий код сайта
│   │   ├── _main/  ------------------- # Каталог индивидуальной настройки сайта [используется для вторичной разработки или разработки новых сайтов. Новые HTML-шаблоны и другие скрипты для сайтов можно размещать непосредственно в этой папке]
│   │   ├── _third-party-plugins/  ---- # Плагины сторонних производителей
│   │   └── */  ----------------------- # Общие функциональные модули сайта [обычно не требуют модификации, но их стиль и сценарии могут быть изменены в зависимости от ситуации]
├── examples/                                
│   ├── *.html ## Компиляция после чистого HTML-шаблона для последующей интеграции с серверной частью или демонстрации
|   └── assets/  

## Основные операции разработчика
1. Настройте среду Node.js на своём компьютере.
2. После загрузки ресурсов перейдите в каталог uix-kit и выполните команду npm run build, чтобы перейти в режим разработки.
3. Если вам нужно настроить каркас и базовую информацию и структуру сайта, отредактируйте файл package.json напрямую.
4. Функции модуля настройки сайта находятся в src/components/_global и src/components/_main. Другие модули в src/components/* являются универсальными функциональными модулями. Файлы HTML будут автоматически упакованы в папку examples/, а основные файлы JavaScript и CSS будут автоматически упакованы в папку dist/.

Не рекомендуется пропускать режим разработки и изменять файлы непосредственно в папке examples/, так как объём кода очень велик, и трудно поддерживать и настраивать различные анимации, взаимодействия и структуры.

## Руководство по началу работы

**Шаг 1.** Используйте NPM (найдите текущий каталог проекта и введите следующую команду) или загрузите последнюю версию с Github (https://github.com/xizon/uix-kit).
```sh
$ npm install uix-kit

Or clone the repo to get all source files including build scripts:

$ git clone git://github.com/xizon/uix-kit.git

Шаг 2. Введите команду cd /{your_directory}/uix-kit, чтобы войти в каталог uix-kit/. {your_directory} следует заменить на путь к вашему каталогу.

$ cd /{your_directory}/uix-kit

Шаг 3. Прежде чем приступить ко всем разработкам, убедитесь, что у вас установлена версия Node 10+. Затем запустите следующий код в корневом каталоге для установки зависимостей модулей узлов.

$ npm install

В настоящее время тестовая среда — это Node 18+ и npm 9+. Если установка зависимостей не удалась (обычно из-за обновления версии Nodejs), возможно, это конфликт между новой версией npm и старой версией npm. В этом случае используйте следующую команду для установки зависимостей:

$ npm install --legacy-peer-deps

Если установка по-прежнему не удаётся, попробуйте удалить devDependencies из package.json, удалить файл package-lock.json и переустановить зависимости:

$ npm install --save-dev @babel/core @babel/plugin-proposal-class-properties @babel/plugin-transform-runtime @babel/polyfill @babel/preset-env @babel/preset-flow @babel/preset-react @babel/preset-typescript babel-loader babel-plugin-module-resolver clean-webpack-plugin cross-env css-loader css-minimizer-webpack-plugin express file-loader glslify-loader html-loader include-file-webpack-plugin json-loader log-timestamp mini-css-extract-plugin moment sass postcss prettier prettier-loader random-string raw-loader react react-dom sass-loader style-loader tar terser-webpack-plugin webpack webpack-cli webpack-concat-files-plugin webpack-dev-middleware webpack-dev-server

Шаг 4. Запустите следующий код для разработки проекта в реальном времени и изменения функций модулей.

$ npm run build

Чтобы остановить упаковку, используйте Ctrl + C. Вы можете получить доступ к веб-сайту через http://localhost:8080/examples/, но рекомендуется использовать локальный сервер, поскольку следующий URL-адрес является статическим доступом и не выполняет AJAX-запросы. Некоторые модули требуют асинхронного тестирования.

Шаг 5. Чтобы просмотреть страницу без компиляции упаковки, запустите следующую команду:

$ npm run preview

Вы можете просматривать все страницы через http://localhost:3000. Однако вы не сможете запускать PHP или получать AJAX-запросы на странице. Вам необходимо получить доступ к серверу или создать сервер с помощью MAMP. Затем вы можете получить доступ к аналогичному URL-адресу: http://localhost:{port}/uix-kit/examples/.

Часто задаваемые вопросы:

a) Как использовать модуль?

Вы можете настроить модули для импорта в src/components/_app-load.ts и src/components/_app-load-rtl.ts. Если импортируется слишком много модулей, вам может потребоваться подождать не менее 5,5 секунд (по умолчанию, в зависимости от количества модулей). Вы можете установить время ожидания компиляции в webpack.config.js.

b) Изменение конфигурации сайта

Измените файл package.json следующим образом:

{
  "author": "UIUX Lab",
  "name": "uix-kit",
  "email": "uiuxlab@gmail.com",
  "version": "1.0.0",
  "projectName": "Uix Kit",
  "createdInfo": "UIUX Lab (https://uiux.cc)",
  "projectURL": "https://uiux.cc",
  "description": "A free web kits for fast web design and development, compatible with Bootstrap v5.",
  ...
}

c) ОШИБКА: проверка обновления npm не удалась.

Если возникает такая ошибка, это может быть связано с проблемами среды или прав доступа nodejs. Вы можете решить эту проблему, выполнив следующую команду, заменив {username} на имя вашего устройства.

$ sudo chown -R $USER:$(id -gn $USER) /Users/{username}/.config

d) ОШИБКА: версия узла sass 6.x.x несовместима с ^ 4.x.x.

Если появляется такая ошибка, измените версию node-sass:

$ npm install node-sass@4.14.1

e) Если вы обновляете версию узла, выполните следующие команды:

$ npm install
$ npm rebuild node-sass
``` **Конечно, вот перевод текста на русский язык:**

    <!-- Basic  -->
    <link rel="stylesheet" href="assets/css/bootstrap.min.css?ver=5.2.3" media="all"/>
    <link rel="stylesheet" href="assets/css/video.min.css?ver=7.4.1" media="all"/>


    <!-- Icons  -->
    <link rel="stylesheet" href="assets/fonts/fontawesome/css/all.min.css?ver=5.7.0">
    <link rel="stylesheet" href="assets/fonts/fontawesome/css/v4-shims.min.css?ver=5.7.0">


    <!-- Theme  -->
    <link rel="stylesheet" href="../dist/css/uix-kit.min.css?ver=1.0.0"/>



    <!-- Overwrite Font Files 
        *
        * The fonts extracted with `mini-css-extract-plugin` may not load correctly
        * Font files in `dist/fonts/` are fetched automatically by `file-loader`, you can configure webpack.config.js to name them.
    ============================================= --> 
    <!--
    <style>
    @font-face {
        font-family: '...';
        font-style: normal;
        font-weight: 900;
        font-display: $fa-font-display;
        src: url('../dist/fonts/...eot');
        src: url('../dist/fonts/...eot?#iefix') format('embedded-opentype'),
        url('../dist/fonts/...woff2') format('woff2'),
        url('../dist/fonts/...woff') format('woff'),
        url('../dist/fonts/...ttf') format('truetype'),
        url('../dist/fonts/...svg#fontawesome') format('svg');
    }
    </style>
    -->
    <!-- Overwrite Font Files   end -->



    <!--[if lt IE 10]>
    <link rel="stylesheet" href="assets/css/IE.css?ver=1.0.0" />
    <![endif]-->


    <!-- Core & Theme CSS  end -->
    <!-- Vendor
    ============================================= -->
    <script src="assets/js/min/jquery.min.js?ver=3.6.1"></script>
    <script src="assets/js/min/modernizr.min.js?ver=3.5.0"></script>
    <!-- Vendor  end -->

    <!-- Break free from CSS prefix hell!
    ============================================= -->
    <script src="assets/js/min/prefixfree.min.js?ver=1.0.7"></script>

</head> 

<body> 
    
    {your_html_codes_here}
    
    
    <!-- Vendor -->
    <script src="assets/js/min/axios.min.js?ver=0.19.2"></script>
    <script src="assets/js/min/jquery.waitforimages.min.js?ver=1.0"></script>
    <script src="assets/js/min/video.min.js?ver=7.4.1"></script>
    <script src="assets/js/min/TweenMax.min.js?ver=2.0.2"></script>
    <script src="assets/js/min/pixi.min.js?ver=4.8.4"></script>
    <script src="assets/js/min/three.min.js?ver=r99"></script>
    <script src="assets/js/min/anime.min.js?ver=2.2.0"></script>
    <script src="assets/js/min/hammer.min.js?ver=2.0.8"></script>

    <!-- Your Plugins & Theme Scripts
    ============================================= -->
    <script>
        /*
        * Some global vars. DO NOT change these variables names. 
        * These variables are being used in `uix-kit.min.js`.
        *    
        */ 
        var REVISION     = "1.0.0",
            APP_ROOTPATH = {
                "templateUrl" : "", //If the file is in the root directory, you can leave it empty. If in another directory, you can write: "/blog"
                "homeUrl"     : "",  //Eg. https://uiux.cc
                "ajaxUrl"     : ""   //Eg. https://uiux.cc/wp-admin/admin-ajax.php
            };
        

        /*
        * Fixed a bug that Cannot read property 'fn' of undefined for jQuery 1.xx.x.
        *    
        */
        window.$ = window.jQuery;
    </script>
    <script src="../dist/js/uix-kit.min.js?ver=1.0.0"></script>
    
</body>

</html>

2. PSD网格模版

Вы можете использовать соответствующие файлы .PSD с сеткой.

  • misc/grid/bootstrap3_1170_grid_web.psd (Default Container: 1170px)
  • misc/grid/bootstrap3_1278_grid_web.psd (XL Container: 1278px)
  • misc/grid/bootstrap3_1410_grid_web.psd (XXL Container: 1410px)

Как создать новый пользовательский модуль?

Предположим, что вы скачали файл в корневую директорию и хотите создать модуль в каталоге src/components/. Вы можете создать новую папку и назвать её demo-module.

👇👇👇

Вот пример структуры каталога для пользовательского модуля:


uix-kit/
├── src/
│   ├── components/
│   │     ├── _app-load.ts
│   │     ├── _app-load-rtl.ts
│   │     └── demo-module/
│   │              ├── scss/*.scss
│   │              ├──

**Примечание**: *В тексте запроса могут быть неточности или ошибки, которые не были исправлены при переводе.* **Модуль Заголовок**



**Содержание**  
======================================================

Раздел с классом «uix-spacing--s» без нижнего отступа:  

Контейнер:  
  Ряд:  
    Колонка 12:




**Вызов указанного модуля скрипта, который обычно используется для обратного вызова асинхронного запроса AJAX**

Демонстрационный код:
```sh
import { UixModuleInstance } from '@uixkit/core/_global/js';

if (UixModuleInstance.DEMO_MODULE) UixModuleInstance.DEMO_MODULE.pageLoaded();
if (UixModuleInstance.DEMO_MODULE) UixModuleInstance.DEMO_INSTANCE.documentReady($);

Поскольку Uix Kit не является JavaScript-фреймворком, вы можете использовать любую стороннюю библиотеку для создания пользовательских стилей модулей и сценариев анимации наиболее интуитивно понятным способом.

Совместимость

Chrome Firefox Edge IE Safari Opera iOS Android
>= 49 >= 45 >=14 >=11 >= 9 >= 30 >=10 >=4.4

Поддерживаемые среды разработки

  • React 18 +
  • TypeScript 4.x.x +
  • Babel 7.x.x +
  • Webpack 5.x.x
  • Express 4.x.x

Лицензия На основе MIT.

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/xizon-Uix-Kit.git
git@api.gitlife.ru:oschina-mirror/xizon-Uix-Kit.git
oschina-mirror
xizon-Uix-Kit
xizon-Uix-Kit
master