SusCore — документация

Пакет: com.sharq-it.sus.coreФундамент UI-системы SUS — аналог Vue.js: реактивность, SFC-компилятор, директивы, слоты, CSS scoped

Содержание

#	Документ	Содержимое
0	Интеграция с нуля 🆕	Установка, сцена, первый .sharq, SusApp, sus.config.json, генерация Sharq
1	Быстрый старт	Минимальный компонент, bootstrap, установка, конфигурация
2	.sharq и директивы	SFC-формат, $using, $MainElement, v-if/v-show/v-for/:text/@click/style
3	Реактивность	Prop<T>, Computed<T>, Watch<T>, DependencyTracker, P/C-хелперы
4	Слоты	Именованные слоты, слот по умолчанию, SlotPropMap
5	CSS Scoping	scoped/global, hash-классы, ограничения Sharq
6	Адаптивная вёрстка	SusBreakpointService, breakpoint-классы, Watch
7	OverlayHost и порталы	Портальный контейнер, OverlayCategory, z-order
8	События	Emit/On, коммуникация через Prop<T>
9	Компиляция и генерация	Pipeline, инкрементальная компиляция, SharqValidator
10	Конфигурация	sus.config.json
11	API Reference	SusApp, SusComponent, Bind-хелперы, SusBootstrap
12	Запуск примеров	Примеры SusBootstrap + SusKeepAlive из Samples~
13	Встроенные аудиты (Debug / QA)	ClickAudit, BoundsAudit, CallbackAudit, OverlayAudit, StateAudit, LifecycleAudit, …
18	MCP / AI probe	JSON-фасад SusUiProbe (tree/props/health), фазы MCP
17	Dev-консоль	SusConsoleService, горячая клавиша ~, OverlayCategory.Console
—	Дизайн-токены	Шрифты, цвета, иконки, темы
—	快速入门（中文）	Быстрый старт на китайском (сайт, переведено; копия в пакете: GETTING_STARTED.zh-CN.md в этой папке)

Быстрый старт

<!-- HelloWorld.sharq -->
<template>
<ui:Label $MainElement :text="Message" class="greeting"
          style="font-size: 24px; -unity-text-align: middle-center; color: white;" />
</template>

<script>
public string Message = "Hello SUS!";
</script>

// MonoBehaviour on stage — prefer SusApp.
// Mount the component you defined above (HelloWorld); its .g.cs must be generated first.
public class AppEntry : MonoBehaviour
{
    public UIDocument uiDocument;
    void Start() => SusApp.Create(uiDocument).UseTheme(SusTheme.Dark).Mount<HelloWorld>();
}

Где что искать

• Хочу начать с нуля → 00-integration.md
• Хочу разобраться в синтаксисе .sharq → 02-sharq-format.md
• Хочу понять Prop<T> и Computed<T> → 03-reactivity.md
• Хочу сделать модалку/tooltip → 07-overlayhost.md · документация нижестоящих UI-пакетов
• Хочу полный API → 11-api-reference.md
• Хочу запустить пример → 12-examples.md
• Хочу узнать про встроенные аудиты (Debug/QA) → 13-audits.md
• Хочу настроить компилятор → 10-configuration.md
• Хочу темы / токены / иконки → DESIGN_TOKENS.md (шрифты, цвета, иконки, темы)
• Хочу игровую консоль → 17-console.md

Связанные документы

• sus-router — навигация и модалки (MIT, open-core компаньон)
• Интеграция с нуля - установка и первый экран
• Дизайн-токены - шрифты, цвета, иконки, темы
• OverlayHost и порталы - оверлеи: tooltips, попапы, модалки