refactor(floating): mv all floating components to same API #6212
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
size-limit report 📦
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 42744a7:
|
e2e tests |
👀 Docs deployed
Commit 42744a7 |
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #6212 +/- ##
==========================================
+ Coverage 80.68% 81.07% +0.38%
==========================================
Files 325 324 -1
Lines 10103 10090 -13
Branches 3398 3385 -13
==========================================
+ Hits 8152 8180 +28
+ Misses 1951 1910 -41
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
inomdzhon
force-pushed
the
imirdzhamolov/issue2769/refactor-tooltips
branch
from
bfe42ed to
7120ffb
Compare
SevereCloud
previously approved these changes
Dec 5, 2023
BlackySoul
reviewed
Dec 5, 2023
mendrew
reviewed
Dec 6, 2023
...ts/OnboardingTooltip/__image_snapshots__/onboardingtooltip-android-chromium-light-1-snap.png
Outdated
Show resolved
Hide resolved
inomdzhon
force-pushed
the
imirdzhamolov/issue2769/refactor-tooltips
branch
from
c35af97 to
e06d78e
Compare
SevereCloud
previously approved these changes
Dec 6, 2023
BlackySoul
previously approved these changes
Dec 6, 2023
h2. ~~`Tooltip`~~ -> [OnboardingTooltip](#/OnboardingTooltip)
```diff
<OnboardingTooltip
- isShown
+ isShown
- alignX="bottom"
- alignY="left"
+ placement="bottom-start"
- offsetX={0}
+ offsetByCrossAxis={0}
- offsetY={0}
+ offsetByMainAxis={0}
- cornerOffset={0}
- cornerAbsoluteOffset={0}
+ arrowCornerOffset={0}
+ arrowCornerAbsoluteOffset={0}
>
<div>Target</div>
</OnboardingTooltip>
```
h2. ~~`TextTooltip`~~ -> [Tooltip](#/Tooltip)
```diff
<Tooltip
- autoUpdateOnTargetResize
- customMiddlewares
- renderContent
- getRef
- offsetSkidding={0}
+ offsetByCrossAxis={0}
- offsetDistance={0}
+ offsetByMainAxis={0}
- shownDelay={0}
- hideDelay={10}
+ hoverDelay={[0, 10]}
- forcePortal
+ usePortal
- portalRoot={someHTMLElement}
+ usePortal={someHTMLElement}
>
<div>Target</div>
</Tooltip>
```
h1. ⚠️ Поправить в migration_v6.md
h2. [Popper](#/Popper)
```diff
<Popper
- renderContent
- arrowClassName=""
+ arrowProps={{ iconClassName: "" }}
- offsetDistance={0}
+ offsetByMainAxis={0}
- offsetSkidding={0}
+ offsetByCrossAxis={0}
- onPlacementChange={({ placement }) => {}}
+ onPlacementChange={(placement) => {}}
- forcePortal
+ usePortal
- portalRoot={someHTMLElement}
+ usePortal={someHTMLElement}
/>
<div>Target</div>
</Popper>
```
- `onPlacementChange` теперь вызывается только в случае, если `Popper` подобрал оптимальный
`placement` вместо пользовательского.
- `renderContent` удалён в пользу `children`. Раньше из `renderContent` можно было получить
`className`, который задаёт `Popper`, сейчас этот `className` пустой.
- `targetRef` теперь умеет принимать `VirtualElement`.
- `arrowProps` принимает атрибуты `HTMLDivElement`, а также `iconStyle` и `iconClassName`.
- Заменил `arrowCornerOffset` на `arrowOffset`. - Заменил `arrowCornerAbsoluteOffset` на `isStaticArrowOffset`. - Переименовал PopperArrow на FloatingArrow - Заменил UseFloatingMiddleware для смещения стрелки на параметр в FloatingArrow.
inomdzhon
dismissed stale reviews from BlackySoul, SevereCloud, and mendrew
via
42744a7
inomdzhon
force-pushed
the
imirdzhamolov/issue2769/refactor-tooltips
branch
from
e06d78e to
42744a7
Compare
mendrew
approved these changes
Dec 6, 2023
SevereCloud
approved these changes
Dec 6, 2023
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note
Юниты и e2e будут позже отдельным PR.
Описание
TooltipпереименовываемOnboardingTooltip.TextTooltipделаем стабильным и переименовываем вTooltip. Используем стили отTooltipBase.Подробности в migration_v6.md
TooltipTextTooltipPopper
onPlacementChangeтеперь вызывается только в случае, еслиPopperподобрал оптимальныйplacementвместо пользовательского.renderContentудалён в пользуchildren. Раньше изrenderContentможно было получитьclassName, который задаётPopper, сейчас этотclassNameпустой.targetRefтеперь умеет приниматьVirtualElement.arrowPropsпринимает атрибутыHTMLDivElement, а такжеiconStyleиiconClassName.Изменения
Popper,PopoverиTooltipиспользуемAppRootPortal.lib/floating/types– теперь это папкаtypes/с файлами, на данный момент,common.tsиcomponent.ts.lib/floating/types/componentвыносим общие св-ва и их описание. ВPopper,Popover,TooltipиOnboardingTooltipвыбираем самое необходимое.TootlipBasewithArrow,arrowCoords,arrowPlacement,getArrowRef,getRootRef– объединил вarrowProps.floatingStyle– используемstyle. В рамках этого изменения, удалил обёртку, на которую вешалсяfloatingStyle.review: fix arrow offset property
PopperArrowнаFloatingArrow. Расширил API сoffsetиisStaticOffset.OnboardingTooltipUseFloatingMiddlewareдля смещения стрелки на параметры в FloatingArrow.arrowCornerOffsetнаarrowOffset.arrowCornerAbsoluteOffsetнаisStaticArrowOffset.