Глоссарий
Глоссарий определяет термины SIMAI Framework, которые используются в руководстве. Для каждого термина указаны английское название или имя в коде, краткое определение и глава, где термин объяснён подробно. Латинские имена, у которых нет русского названия, собраны в конце таблицы.
| Термин | Англ. / в коде | Что это | Где |
|---|---|---|---|
| Адаптивная ступень | --sf-space-1, --sf-text--size-1 |
Ступень шкалы с парой значений: для мобильного и для настольного режима | Адаптивные размеры |
| Блок | block | Пример компоновки на определённую тему, который проект хранит и повторно использует как шаблон Recipe; не тип Framework и не отдельный уровень, своей схемы нет | Макеты и блоки, Блок |
| Браузерная проба | browser probe | Проверка, которая открывает страницу в настоящем браузере и измеряет нарисованное | Браузерные пробы |
| Версия стандарта | version |
Полная версия издания стандарта <старшая>.<младшая>.<исправление>, записана отдельно от id |
Конверт, Имена и версии |
| Версия формата | schema_version |
Старшая версия формата данных, целое число; совместимое добавление её не меняет | Имена и версии |
| Вертикальный контракт | simai.vertical-sizing |
Машиночитаемый контракт кегля, высоты строки, высоты контролов и интервалов | Вертикальный контракт |
| Выпуск | release | Одна проверенная сборка поставки, которую проект закрепляет целиком | Выпуск, Выпуск и запись о выпуске |
| Высота (ступень высоты) | elevation, --sf-elevation-N--surface, --sf-elevation-N--shadow |
Пара «поверхность + тень» для элемента, который парит над страницей | Высота: поверхность и тень, Высота над страницей |
| Гейт владельца | owner gate | Все слои проверок, через которые проходит изменение Framework; ядро — npm test |
Гейт владельца |
| Гейт документации | docs gate | Правило: изменение публичного контракта обновляет документацию в той же поставке | Гейт документации |
| Граница контрола | --sf-outline |
Роль границы элемента, который человек должен найти; держит 3 : 1 | Границы, Границы |
| Граница области | --sf-outline-variant |
Тихая роль края области и линий внутри неё | Границы, Границы |
| Дизайн-токен | design token, --sf-* |
Именованная CSS-переменная, хранящая одно дизайнерское решение | Дизайн-токены |
| Динамический составной компонент | simai.dynamic-composite-component |
Составной компонент, который работает с данными приложения через намерения | Динамический составной компонент, Динамический составной компонент (simai.dynamic-composite-component) |
| Документ композиции | Document, simai.composition.document |
Готовое проверенное дерево страницы: варианты выбраны, данные подставлены | Три представления страницы: Recipe, Document и HTML |
| Жизненный цикл изменений | simai.change-lifecycle |
Порядок ухода публичного имени: совместимость, затем удаление по календарю | Жизненный цикл изменений и совместимость, Жизненный цикл изменений (simai.change-lifecycle) |
| Журнал изменений | contracts/changes/journal.json |
Машиночитаемый список изменений, которые требуют действий потребителя | Журнал изменений |
| Запись о выпуске | release lock, ui-<ревизия>.lock.json |
Машиночитаемый файл выпуска: ревизии, исходники, сборщик, контрольные суммы | Выпуск и запись о выпуске |
| Идентификатор выпуска | release id, ui-<ревизия> |
Имя выпуска: первые 12 знаков коммита сборки | Выпуск, Выпуск и запись о выпуске |
| Имя формата | schema |
Имя формата данных без версии, вида simai.<имя> |
Имена и версии |
| Каскадный слой | cascade layer, @layer sf.* |
Именованный слой CSS с заранее заданным приоритетом | Каскадные слои |
| Каталог эффектов | effects catalogue, simai/ui-effects, SF_BOOT_CONFIG.effects |
Набор готовых фоновых эффектов, закреплённый коммитом; каждый файл сверяется с SHA-256 из индекса каталога | Каталог эффектов |
| Квитанция пакета | package receipt | Машиночитаемый файл сборки пакета продукта: контрольные суммы файлов и выпуск Framework, поверх которого пакет собран и проверен | Пакеты компонентов продуктов, Версии: как закрепить выпуск |
| Кольцо фокуса | focus ring, --sf-focus--* |
Единый контур outline, показывающий клавиатурный фокус: сплошная линия 2 px с зазором 1 px, в пикселях |
Фокус |
| Компонент | component, .sf-* |
Повторяемый элемент с устойчивой HTML-структурой и готовым оформлением | Что такое компонент |
| Контейнер (часть роли) | -container |
Спокойная полупрозрачная заливка в тоне роли | Система: роль, on-роль, контейнер |
| Контрактный тест | contract test | Тест, который проверяет механизм по исходнику или контракту | Гейт владельца |
| Контрольная точка | breakpoint, sm: … xxl: |
Ширина окна, начиная с которой действует адаптивная утилита | Ширина экрана: контрольные точки |
| Лестница размеров | size ladder, size |
Одна шкала ступеней 1/3, 1/2, 1, 2, 3 для всех компонентов |
Одна лестница размеров, Размер: одна лестница для всех компонентов |
| Логическая сторона | logical side, inline-start, inline-end |
Начало и конец строки вместо левого и правого | Направление текста |
| Макет | layout, composition | Описание страницы в виде проверяемого JSON | Что такое макет и зачем он |
| Манифест Smart-компонента | smart.manifest.json, стандарт simai.smart-component-manifest |
Машиночитаемое описание компонента: свойства, события, состояния, готовность | Манифест |
| Манифест типа | type manifest, simai.composition.type-manifest |
Контракт типа узла макета: данные, настройки, слоты, рендерер | Манифест типа |
| Место вставки | insertSlot | Точка в шаблоне Recipe, куда вызывающий передаёт содержимое | Словарь Recipe |
| Модификатор компонента | sf-<компонент>--<значение> |
Класс, выбирающий вариант компонента | Анатомия: корень, части, модификаторы, состояния |
| Намерение | intent | Сообщение компонента о том, что попросил человек; решает приложение | Динамический составной компонент, Принцип: намерения, а не правка |
| Набор проверок | conformance kit | Образцы данных, намерений и ожидаемых ответов для версии порта хоста | Набор проверок |
| Область страницы | layout.regions, layout.region |
Постоянная зона страницы с ориентиром доступности | Области страницы |
| Общая основа Smart-компонентов | shared Smart runtime, core/js/smart-base.js |
Один на страницу файл с Lit, базовым классом Smart-компонентов и общими модулями; ядро загружает его с первым Smart-элементом, модули Smart-компонентов его не содержат | Общая основа Smart-компонентов |
| On-роль | --sf-on-* |
Цвет текста и иконки поверх фона своей роли | Система: роль, on-роль, контейнер |
| Отложенная зависимость | lazy relation, {name, lazy: true} |
Связь правила, которую Loader загружает после sf-loader-ready, когда браузер свободен, или сразу по запросу |
Зависимости |
| Пакет компонентов | component package, SF_BOOT_CONFIG.packages |
Набор Smart-компонентов со своим каталогом и своим файлом правил, который Loader подключает по объявлению на странице; так подключается, например, пакет продукта. Соответствует стандарту simai.component-package; действующее издание 1.1.1 закрепляет схему манифеста 2.5.0 (с издания 1.1.0), издание 1.0.0 (схема 2.2.0) — история |
Пакеты компонентов, Пакет компонентов (simai.component-package) |
| Пакет продукта | product package, SF_BOOT_CONFIG.packages.<имя> |
Smart-компоненты одного продукта, в том числе составные: исходник в UI-репозитории продукта закреплён за ревизией исходников Framework, собирается инструментом sf-build и поставляется в поставке продукта с квитанцией пакета; лицензия — лицензия продукта. Пример — пакет larena из simai/larena-ui |
Пакеты компонентов продуктов, Пакеты компонентов |
| Палитра | palette | Шестнадцать тонов одного цвета от почти белого до почти чёрного | Цветовые примитивы и палитры |
| Перечень зависимостей | simai.composition.dependencies |
Всё, что действительно участвовало в сборке документа | Перечень зависимостей и кеш |
| Плотность | spacing |
Сколько воздуха по вертикали вокруг содержимого контрола | Плотность: spacing |
| Поверхность | surface, --sf-surface-0 … --sf-surface-5 |
Нейтральный фон страницы, областей и панелей | Поверхности и содержимое на них |
| Порт хоста | host port, simai.composite-host-port |
Объявленный и версионированный стык компонента и приложения | Порт хоста, Порты и наборы проверок |
| Порт маршрутизации | routing port | Типизированный вход или выход компонента для связи в композиции | Связь компонентов без кода проекта, Составной компонент и связь компонентов |
| Поставка | distribution, ui |
Готовые собранные файлы Framework, которые подключает проект, в сжатой и читаемой форме; пакет продукта приходит в поставке продукта | Что такое поставка, Пакеты компонентов продуктов |
| Правила взаимодействия | simai.interaction-rules |
Стандарт о том, как любой Smart-компонент загружается, говорит с соседями и рисует | Правила взаимодействия компонентов |
| Прежнее имя | alias | Старое имя атрибута, значения, класса или события в совместимости | Два этапа, Канонические имена и совместимость |
| Примитив | primitive, --sf-primary-40, --sf-a4 |
Токен с конкретным значением, не зависящим от темы | Три уровня: примитив → роль → токен компонента, Базовая единица и шкала примитивов |
| Прозрачность (шкала) | alpha scale | Одиннадцать ступеней непрозрачности в трёх семействах | Прозрачность |
| Публичная переменная компонента | public variable, --sf-button-radius |
Переменная, которую компонент предлагает для настройки; один дефис после блока, имя стабильно и меняется только через журнал изменений | Переменные компонента |
| Реестр типов | type registry | Набор манифестов типов композиции с рендерерами | Тип узла |
| Режим окон | windows mode, data-sf-effect-windows, capabilities: ["windows"] |
Один фоновый эффект за группой карточек, видный только сквозь карточки-окна | Режим окон |
| Режим темы (эффекта) | theme mode, data-sf-effect-theme |
auto, dark или light: в какой схеме рисуется размещённый эффект |
Режим темы |
| Рендерер | renderer | Функция типа, которая превращает узел документа в разметку | Путь страницы |
| Роль (цветовая) | colour role, --sf-primary, --sf-on-surface |
Токен, который называет назначение цвета и зависит от темы | Цветовые роли |
| Секция | layout.section |
Смысловая часть страницы в макете | Секция |
| Слот (макета) | slot | Именованное место узла для дочерних узлов; список задаёт манифест типа | Слоты и порядок |
| Слот (Smart-компонента) | slot="…" |
Именованное место для содержимого, которое передаёт пользователь тега | Содержимое и слоты |
| Снимок входов | simai.composition.inputs |
Зафиксированные на всю сборку настройки и содержимое | Снимок входов |
| Составной Smart-компонент | composite smart component, kind: "composite" |
Smart-компонент из других Smart-компонентов с общей логикой | Составные Smart-компоненты, Составные компоненты |
| Стандарт | standard, Standard Contract | Записанные требования «что обязано быть правдой», закреплённые по хешу | Что такое стандарт, Форма стандарта: Standard Contract |
| Стандарт геометрии | geometry standard | Правила одной лестницы, отступа и общих осей с проверкой замером | Геометрия: стандарт и проверка |
| Тема | theme, theme-light, theme-dark |
Класс, задающий color-scheme и тем самым сторону light-dark() у ролей |
Темы |
| Тип значения | value type, record-ids |
Тип значения, которое ходит по маршруту layout.scope, из закрытого перечня; у каждого схема и проверка |
Типы значений маршрутов |
| Токен компонента | component token, --sf-button--background-color |
Внутренняя переменная одной части компонента, через которую варианты и состояния меняют вид; не поверхность настройки проекта | Три уровня: примитив → роль → токен компонента, Переменные компонента, Как менять дизайн |
| Уровень готовности | readiness | Насколько проверен Smart-компонент: от inventoried до accepted; host-required — работает только с портом хоста |
Уровни готовности |
| Условие (утилиты) | condition, md:, hover:, cq-md: |
Префикс, который говорит, когда действует утилита | Условия действия |
| Условие контейнера | container condition, query-container, cq-* |
Условие по ширине контейнера, а не окна | Ширина контейнера |
| Утилита | utility | Класс одного свойства без префикса, значение берёт из токена | Утилиты, Что такое утилита и зачем она нужна |
| Фоновый эффект | background effect, simai.effect, effect.json, SF.Effects |
Анимированный фон в одной области страницы: манифест и модуль с mount; рисует в своих схемах, область получает тему нарисованной схемы |
Фоновые эффекты, Схемы, цвет и контраст |
| Фрагмент | fragment | Повторно используемая часть Recipe без параметров и мест вставки | Словарь Recipe |
| Фрагмент интерфейса | interface fragment, simai.interface-fragment |
Составной компонент в именованной области страницы с описанием: области, порт, выходы и входы, доступ, ключи адреса, бюджет; не путать с фрагментом Recipe | Фрагменты интерфейса, Фрагмент интерфейса (simai.interface-fragment) |
| Шаблон (Recipe) | template | Общая форма страницы или секции с параметрами и местами вставки | Словарь Recipe |
| Шаблон (Smart-компонента) | template, templateContext() |
Функция, которая получает разрешённые значения и возвращает разметку Lit | Шаблоны |
| Эталонный хост | reference host | Реализация хоста в тестах компонента для прохождения набора проверок | Эталонный хост |
| Язык интерфейса | lang, page-language.js |
Правило выбора языка собственных слов компонентов | Язык интерфейса |
| Core | distr/core |
Ядро Framework: стили, токены, темы, Loader, основа Smart-компонентов | Дизайн-токены и Core, Исходники и поставки |
| Loader | SF.Loader |
Модуль Core, который подключает модули по классам и тегам в разметке | Loader, Как работает Loader |
| Recipe | simai.composition.recipe, стандарт simai.composition-recipe |
Правила сборки страницы: шаблоны, выбор вариантов, входы | Зачем три представления, Шаблоны, вставки и варианты, Recipe (simai.composition-recipe) |
| Smart-компонент | smart component, <sf-*> |
Элемент в виде собственного тега с поведением, состоянием и событиями | Smart-компоненты, Что это и что даёт |
change |
событие | Единое событие подтверждённого изменения значения у всех контролов | Запись с механической заменой, Соглашение change |
SF.deprecations |
— | Список прежних имён, которые Smart-компоненты прочитали на странице | Что устарело на работающей странице, Имена для совместимости на странице |
sf-upgrade |
scripts/sf-upgrade.mjs |
Инструмент обновления проекта по журналу изменений | Инструмент sf-upgrade |
sf-build |
ui-builder/bin/sf-build.js, libs/api.js |
Инструмент сборки Framework и пакетов компонентов: две побайтно совпадающие сборки, квитанция пакета, выходной каталог --out |
Сборка пакета: sf-build |