Skip to content

Commit b99e370

Browse files
committed
docs(header): update comment
1 parent cff6814 commit b99e370

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

core/src/utils/transition/index.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -296,18 +296,22 @@ const setZIndex = (
296296
};
297297

298298
/**
299-
* Add a class to ensure that the inactive header (if any)
299+
* Add a class to ensure that the header (if any)
300300
* does not flicker during the transition. By adding the
301301
* transitioning class, we ensure that the header has
302302
* the necessary styles to prevent the following flickers:
303303
* 1. When entering a page with a condensed header, the
304-
* inactive header should never be visible. However,
304+
* header should never be visible. However,
305305
* it briefly renders the background color while
306306
* the transition is occurring.
307307
* 2. When leaving a page with a condensed header, the
308-
* inactive header has an opacity of 0 and the pages
308+
* header has an opacity of 0 and the pages
309309
* have a z-index which causes the entering page to
310310
* briefly show it's content underneath the leaving page.
311+
* 3. When entering a page or leaving a page with a fade
312+
* header, the header should not have a background color.
313+
* However, it briefly shows the background color while
314+
* the transition is occurring.
311315
*
312316
* @param header The header element to modify.
313317
* @param isTransitioning Whether the transition is occurring.

0 commit comments

Comments
 (0)