VKUI icon indicating copy to clipboard operation
VKUI copied to clipboard

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

Open inomdzhon opened this issue 1 year ago • 2 comments

Описание

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

[!NOTE]

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

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

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

⚠️ IMPORTANT 1

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

⚠️ IMPORTANT 2

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

Свойства

Значения

  • 1 кейс. Если речь про положение в одной плоскости.
    • leftstart
    • rightend
    • ❓(решается) horizontalinline или row
    • ❓(решается) verticalblock или column
  • 2 кейс. Если речь про координаты
    • topblock-start
    • rightinline-end
    • bottomblock-end
    • leftinline-start

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

⚠️ IMPORTANT 3

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

  • #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 задаче"]

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

  • [x] #7665
    • (a) добавить комментарий, что в дизайне direction это Avatar Position
    • (b) переименовать в рамках direction в avatarsPosition
  • [x] #7646

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

  • [x] #7693
  • [x] #7721
  • [x] #7691
  • [x] #7716
  • [x] #7697
  • [ ] #7755
  • [x] #7756
  • [x] #7757
  • [x] #7758
  • [x] #7759
  • [x] #7760
  • [x] #7768
  • [x] #7770
  • [x] #7772
  • [x] #7776
  • [x] #7777
  • [x] #7778
  • [x] #7779
  • [x] #7780
  • [x] #7786
  • [x] #7789
  • [x] #7791
  • [ ] #7803

inomdzhon avatar Sep 25 '24 13:09 inomdzhon

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

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

Kritolan avatar Oct 15 '24 17:10 Kritolan

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

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

EldarMuhamethanov avatar Oct 15 '24 18:10 EldarMuhamethanov

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

EldarMuhamethanov avatar Oct 22 '24 15:10 EldarMuhamethanov

v7.0.0-beta.1 🎉

vkcom-publisher avatar Oct 23 '24 14:10 vkcom-publisher

v7.0.0 🎉

vkcom-publisher avatar Dec 02 '24 16:12 vkcom-publisher