@atlascommunity/atlas-ui

Документация

Мокинг запросов

Миграция с v2.2.3 на 2.2.4

• Для пропсов компонента <JiraUser> тип TJiraUser переименован в TJiraUserProps, чтобы не возникало конфликтов с новым типом TJiraUser

  До

  import type { TJiraUser } from '@atlascommunity/atlas-ui'

  После

  import type { TJiraUserProps } from '@atlascommunity/atlas-ui'

Миграция с v2.2.2 на 2.2.3

• Функция triggerJiraContentAdded теперь принимает лишь 1 аргумент (было 2), убрана часть функционала (см. пример ниже)

  До

  triggerJiraContentAdded('#tabsSelector', '#triggerSelector')

  После

  import Tabs from 'jira/viewissue/tabs'
  
  Tabs.domReady($('#tabsSelector'))
  triggerJiraContentAdded('#triggerSelector')

Миграция с v2.0.8 на 2.1.0

• AsyncSelect переехал с VKUI на react-select.
  • Проп value заменён на defaultValue (тип также поменялся)
  • Проп renderChip заменён на getCustomChip
  • Проп emptyText заменён на noOptionsMessage
  • Проп dropdownAutoWidth заменён на isDropdownAutoWidth
  • Проп hasClearButton заменён на isClearable
  • Добавлен проп inputId для корректной связи label с полем ввода
  • Проп onChange обновлён, в коллбэк добавлен второй параметр actionMeta, содержащий объект с информацией о последнем действии (прим.: action: 'select-option', action: 'remove-value' и т. п.)
  • Тип TAsyncSelectOption упрощён, удалено ранее обязательное свойство id, опциональные свойства children и isSelected
  • Удалены типы TAsyncSelectOptionSingle и TAsyncSelectValue

Миграция с v1 на v2

• Обновлено большинство зависимостей из peerDependencies до последних версий.
• Обновлен VKUI с v5 на v6 (о миграции тут).
• postcss-for: удален т. к. deprecated. Необходимо избавиться от использования директивы @for из PostCSS-файлов (.pcss).
• @tanstack/react-query: обновлен до 5-й версии. В конфигурации useQuery теперь нельзя использовать onSuccess. Аналогичную логику можно реализовать через useEffect с сущностями data и isSuccess в массиве зависимостей.

  До

  const { data } = useQuery({
    ...
    onSuccess: fn,
  })

  После

  const { data, isSuccess } = useQuery({
    ... 
  })
  
  useEffect(() => {
    if (isSuccess) {
      fn()
    }
  }, [data, isSuccess])

• TypeScript: заменены interface на type, обновлены имена типов, вместо имён IComponent теперь TComponent. Необходимо заменить префикс I на T у используемых типов.
• <Statuses> и useStatuses переработаны, заменена реализация с React Context API на Zustand. В аргументы addStatus теперь передается объект с полями label, appearance и duration (ранее duration передавался пропом в компонент <Statuses />).
• <UserPicker>: исправлена передача пропа emptyText во внутренний компонент селекта.
• Исправлен "эффект залипания" hover-эффекта. Все использования :hover заменены на одноименный миксин, который оборачивает свойства в медиазапрос (hover: hover), чтобы эффект срабатывал только на устройствах с тач-скрином. Для устройств с тач-скрином эффект hover-эффект будет отрабатывать как active-эффект (на мгновение при клике).