NODEDC_DESIGN_GUIDELINE/README.md

77 lines
4.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# NODE.DC Design Guideline
Единый источник компонентов и правил интерфейса NODE.DC.
Это не архив скриншотов и не описание того, как разные приложения когда-то стилизовали одинаковый контрол. Репозиторий содержит реальные переиспользуемые пакеты, машинный реестр и живой каталог. Новые приложения должны подключать эти пакеты, выбирать тему/акцент и собирать предметный интерфейс из готовых элементов.
На том же каталоге развивается **NDC Module Foundry**: контур создания экземпляров готовых приложений из `Page Library`. Foundry не заменяет Design Guideline: он использует его как каноническую визуальную библиотеку и runtime-правило для будущих модулей.
## Что здесь является каноном
- общая геометрия приложения и верхней панели;
- glass-материал, поверхности и слои;
- кнопки, поля, чекеры, range, select и dropdown;
- модальные окна, подтверждения и боковые окна;
- segmented navigation и статусы;
- Hub header и левая admin navigation panel;
- launcher-style ApplicationShell без обязательной нижней витрины;
- единый state-controller открытия navigation/content окон;
- CMS/Launcher media field: файл, URL, превью и storage-adapter;
- Engine workflow sharing и BIM share-link modal;
- каталог form/confirmation/action/detail/history modal-паттернов;
- аудированный общий набор иконок;
- инспектор/панель настроек нового поколения;
- поведение portal-слоёв, Escape, outside click и фокуса;
- контракт темы: приложения меняют цветовую схему, а не геометрию компонентов.
## Что не является каноном
- старые инспекторы и старые плашки Engine;
- legacy dropdown/menu реализации Task Manager;
- доменная логика нод, BIM-моделей, SEO pipeline или задач;
- локальные копии компонентов внутри приложений.
## Пакеты
- `@nodedc/tokens` — JSON и CSS custom properties.
- `@nodedc/ui-core` — общие стили, тема, контраст и расчёт floating-layer.
- `@nodedc/ui-react` — React-компоненты.
- `@nodedc/ui-dom` — JS/DOM-контроллеры для BIM Viewer, CMS и других приложений без React.
- `@nodedc/ui-catalog` — живой стенд всех канонических компонентов.
## Быстрый запуск каталога
```bash
npm install
npm run dev
```
Полная проверка:
```bash
npm run check
npm run build
```
## Статус
Версия `0.5.x` — розовый NODE.DC accent, runtime MP4 stage media, workflow/BIM sharing modals и полная карта оконных паттернов. Исходные приложения на первом этапе не изменяются.
Подробности:
- [Архитектура](docs/ARCHITECTURE.md)
- [Компоненты](docs/COMPONENTS.md)
- [Шаблон приложения](docs/APPLICATION_TEMPLATE.md)
- [Иконки](docs/ICONS.md)
- [Темы](docs/THEMING.md)
- [Окна и слои](docs/WINDOWS_AND_LAYERS.md)
- [Границы исходного аудита](docs/SOURCE_BASELINE.md)
- [Правила развития](docs/GOVERNANCE.md)
- [План подключения приложений](docs/ADOPTION.md)
- [Как подключать пакеты в новый проект](docs/CONSUMPTION.md)
- [Инвентарь следующих компонентов](docs/CANDIDATES.md)
- [NDC Module Foundry](docs/MODULE_STUDIO.md)
- [Production-канон Foundry Map Page, Cesium, TileCache и AMD egress](docs/FOUNDRY_MAP_CESIUM_CANON.md)
- [Базовый MCP-контур Foundry](docs/MODULE_FOUNDRY_MCP.md)
- [Привязки Data Product к Foundry](docs/FOUNDRY_DATA_PRODUCT_BINDINGS.md)