[BREAKING CHANGE][Epic]: синхронизировать названия параметров с дизайном

[inomdzhon]

Описание

Необходимо проанализировать дизайн в Figma и найти расхождения в именование параметров.

Note

Задачу упростит вот 🔗 этот документ, который @BlackySoul собрала с помощью самописного скрипта.

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

Логика разрешения расхождения в именовании

⚠️ IMPORTANT 1

По поводу под-компонента есть нюанс, что одно дело если это некий сервисный компонент, как в случае с компонентом Group это Group.Expanded или как с Snackbar это Snackbar.Basic, другое если под-компонент мог бы выступать как параметр компонента, например, <Button after={} /> ➡️ <Button.After /> – в этом случае мы должны позаботиться о синхронизации названий.

⚠️ IMPORTANT 2

Исключением являются логические свойства под RTL. С @VKCOM/vkui-design договорились переводить следующим образом:

Свойства

• left → before
• right → after
• horizontal → inline (пример, #7166#discussion_r1732347433)
• vertical → block (пример, #7166#discussion_r1732347433)

Значения

• 1 кейс. Если речь про положение в одной плоскости.
  • left → start
  • right → end
  • ❓(решается) horizontal → inline или row
  • ❓(решается) vertical → block или column
• 2 кейс. Если речь про координаты
  • top → block-start
  • right → inline-end
  • bottom → block-end
  • left → inline-start

Дизайн по возможности должен переименовать в Figma.

⚠️ IMPORTANT 3

В коде значения размерностей 's' | 'm' | 'l'. Дизайн может оставить полные названия.

• [Feature][7.0.0]: Привести значения size к единому виду #6474

flowchart TD
    A[Нашли расхождение в именовании] -->
    B{"Это особенность реализации в React?<br><br>Например, использование под-компонента или размерность (см. #6474) или логического синонима названия или антоним названия свойства (ex, в дизайне <code>enable</code>, в коде <code>disable</code>)"}
    B -->|Да| D["Пропускаем<br><br>По возможности смотрим можем ли добавить комментарий в документации"]
    B -->|Нет| E{"Справшиваем у дизайна могут ли они переименовать в Figma?<br><br>"}
    E -->|Да| F["Дизайн решает проблему у себя"]
    E -->|"Нет<br><br>либо техническая особенность Figma, либо iOS/Android разработка уже завязалась на текущее именование"| G["Добавляем в список в этой Epic задаче"]

Loading

Текущие задачи

• UsersStack – заменить использование direction на avatarsPosition как это сделано в дизайне  #7665
  • (a) добавить комментарий, что в дизайне direction это Avatar Position
  • (b) переименовать в рамках direction в avatarsPosition
• [BREAKING CHANGE][Bug]: Несогласованность параметров компонентов #7646

  ⚠️ в этой задаче нужно в первую очередь исходить из дизайн-файла: если в дизайне нет той проблему, что описана в задаче, то нужно взять задачу, иначе задачу закрываем.

• [BREAKING CHANGE] ContentCard: переименовать свойство subtitle -> subhead #7693
• [BREAKING CHANGE] Banner: переименовать text -> extraSubhead #7721
• [BREAKING CHANGE]Banner: переименовать свойство subheader -> subhead #7691
• [BREAKING CHANGE] RichCell: переименовать свойства text -> subtitle, caption -> extraSubtitle, subhead -> overtitle #7716
• [BREAKING CHANGE] HorizontalCell: переименовать свойство header -> title #7697
• [BREAKING CHANGE] Banner: переименовать asideMode -> after #7755
• [BREAKING CHANGE] CardScroll: переименовать noSpaces -> padding #7756
• [BREAKING CHANGE] Header: переименовать aside -> after #7757
• [BREAKING CHANGE] Tooltip: переименовать header -> title, text -> description #7758
• [BREAKING CHANGE] Placeholder: переименовать header -> title, text -> description #7759
• [Separator]: значения direction переименовать с 'inline' | 'block' на 'horizontal' | 'vertical' #7760
• [BREAKING CHANGE] Alert: переименовать header -> title, text -> description #7768
• [BREAKING CHANGE] ContentCard: переименовать header -> title, subhead -> overTitle, text ->description #7770
• [BREAKING CHANGE] Banner: переименовать header -> title, subhead -> title, extraSubhead -> extraSubtitle #7772
• [BREAKING CHANGE] Group: переименовать header -> title и подкомпонент #7776
• [BREAKING CHANGE] PanelHeaderContent: переименовать status -> subtitle #7777
• [BREAKING CHANGE] ActionSheet: переименовать header -> title, text -> description #7778
• [BREAKING CHANGE] ModalCard: переименовать header -> title, subheader -> description #7779
• [BREAKING CHANGE] TabbarItem: переименовать text -> label #7780
• [BREAKING CHANGE] SimpleCell: переименовать expandable -> chevron #7786
• [BREAKING CHANGE] ScreenSpinner: переименовать caption -> label #7789
• [BREAKING CHANGE] SubnavigationBar: переименовать mode -> fixed(boolean флаг) #7791
• [BREAKING CHANGE] CardGrid: рассмотреть возможность задепрекейтить компонент #7803

[Kritolan]

SimpleCell: переименовать expandable -> chevrone
MiniInfoCell: переименовать expandable → chevron

А почему разные итоговые имена?

[EldarMuhamethanov]

А почему разные итоговые имена?

Опечатка, поправил

[EldarMuhamethanov]

На данный момент все пункты выполнены - задачу закрываю

[vkcom-publisher]

✅ v7.0.0-beta.1 🎉