useZIndex.js 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.useZIndex = exports.containerBaseZIndexOffset = exports.consumerBaseZIndexOffset = exports.CONTAINER_MAX_OFFSET = void 0;
  7. var _react = _interopRequireDefault(require("react"));
  8. var _useToken = _interopRequireDefault(require("../../theme/useToken"));
  9. var _warning = require("../warning");
  10. var _zindexContext = _interopRequireDefault(require("../zindexContext"));
  11. // Z-Index control range
  12. // Container: 1000 + offset 100 (max base + 10 * offset = 2000)
  13. // Popover: offset 50
  14. // Notification: Container Max zIndex + componentOffset
  15. const CONTAINER_OFFSET = 100;
  16. const CONTAINER_OFFSET_MAX_COUNT = 10;
  17. const CONTAINER_MAX_OFFSET = exports.CONTAINER_MAX_OFFSET = CONTAINER_OFFSET * CONTAINER_OFFSET_MAX_COUNT;
  18. /**
  19. * Static function will default be the `CONTAINER_MAX_OFFSET`.
  20. * But it still may have children component like Select, Dropdown.
  21. * So the warning zIndex should exceed the `CONTAINER_MAX_OFFSET`.
  22. */
  23. const CONTAINER_MAX_OFFSET_WITH_CHILDREN = CONTAINER_MAX_OFFSET + CONTAINER_OFFSET;
  24. const containerBaseZIndexOffset = exports.containerBaseZIndexOffset = {
  25. Modal: CONTAINER_OFFSET,
  26. Drawer: CONTAINER_OFFSET,
  27. Popover: CONTAINER_OFFSET,
  28. Popconfirm: CONTAINER_OFFSET,
  29. Tooltip: CONTAINER_OFFSET,
  30. Tour: CONTAINER_OFFSET,
  31. FloatButton: CONTAINER_OFFSET
  32. };
  33. const consumerBaseZIndexOffset = exports.consumerBaseZIndexOffset = {
  34. SelectLike: 50,
  35. Dropdown: 50,
  36. DatePicker: 50,
  37. Menu: 50,
  38. ImagePreview: 1
  39. };
  40. function isContainerType(type) {
  41. return type in containerBaseZIndexOffset;
  42. }
  43. const useZIndex = (componentType, customZIndex) => {
  44. const [, token] = (0, _useToken.default)();
  45. const parentZIndex = _react.default.useContext(_zindexContext.default);
  46. const isContainer = isContainerType(componentType);
  47. let result;
  48. if (customZIndex !== undefined) {
  49. result = [customZIndex, customZIndex];
  50. } else {
  51. let zIndex = parentZIndex !== null && parentZIndex !== void 0 ? parentZIndex : 0;
  52. if (isContainer) {
  53. zIndex +=
  54. // Use preset token zIndex by default but not stack when has parent container
  55. (parentZIndex ? 0 : token.zIndexPopupBase) +
  56. // Container offset
  57. containerBaseZIndexOffset[componentType];
  58. } else {
  59. zIndex += consumerBaseZIndexOffset[componentType];
  60. }
  61. result = [parentZIndex === undefined ? customZIndex : zIndex, zIndex];
  62. }
  63. if (process.env.NODE_ENV !== 'production') {
  64. const warning = (0, _warning.devUseWarning)(componentType);
  65. const maxZIndex = token.zIndexPopupBase + CONTAINER_MAX_OFFSET_WITH_CHILDREN;
  66. const currentZIndex = result[0] || 0;
  67. process.env.NODE_ENV !== "production" ? warning(customZIndex !== undefined || currentZIndex <= maxZIndex, 'usage', '`zIndex` is over design token `zIndexPopupBase` too much. It may cause unexpected override.') : void 0;
  68. }
  69. return result;
  70. };
  71. exports.useZIndex = useZIndex;