@primer/components 29.1.0 → 29.1.1-rc.cea79543

package/lib/stories/useAnchoredPosition.stories.js

@@ -0,0 +1,351 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.WithPortal = exports.ComplexAncestry = exports.CenteredOnScreen = exports.UseAnchoredPosition = exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _ = require("..");
+
+var _hooks = require("../hooks");
+
+var _styledComponents = _interopRequireDefault(require("styled-components"));
+
+var _constants = require("../constants");
+
+var _Portal = _interopRequireWildcard(require("../Portal"));
+
+var _Button = _interopRequireDefault(require("../Button"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _default = {
+  title: 'Hooks/useAnchoredPosition',
+  decorators: [// Note: For some reason, if you use <BaseStyles><Story /></BaseStyles>,
+  // the component gets unmounted from the root every time a control changes!
+  Story => {
+    return /*#__PURE__*/_react.default.createElement(_.ThemeProvider, null, /*#__PURE__*/_react.default.createElement(_.BaseStyles, null, Story()));
+  }],
+  argTypes: {
+    anchorX: {
+      control: {
+        type: 'range',
+        min: 0,
+        max: 500
+      }
+    },
+    anchorY: {
+      control: {
+        type: 'range',
+        min: 0,
+        max: 500
+      }
+    },
+    anchorWidth: {
+      control: {
+        type: 'range',
+        min: 50,
+        max: 500
+      }
+    },
+    anchorHeight: {
+      control: {
+        type: 'range',
+        min: 50,
+        max: 500
+      }
+    },
+    floatWidth: {
+      control: {
+        type: 'range',
+        min: 50,
+        max: 500
+      }
+    },
+    floatHeight: {
+      control: {
+        type: 'range',
+        min: 50,
+        max: 500
+      }
+    },
+    anchorPosition: {
+      control: {
+        type: 'inline-radio',
+        options: ['inside', 'outside']
+      }
+    },
+    anchorSide: {
+      control: {
+        type: 'inline-radio',
+        options: ['top', 'bottom', 'left', 'right', 'center']
+      },
+      description: 'note'
+    },
+    anchorAlignment: {
+      control: {
+        type: 'inline-radio',
+        options: ['first', 'center', 'last']
+      }
+    },
+    anchorOffset: {
+      control: {
+        type: 'range',
+        min: -100,
+        max: 100
+      }
+    },
+    alignmentOffset: {
+      control: {
+        type: 'range',
+        min: -100,
+        max: 100
+      }
+    },
+    allowOutOfBounds: {
+      control: {
+        type: 'boolean'
+      }
+    }
+  }
+};
+exports.default = _default;
+const Float = (0, _styledComponents.default)(_.Box).withConfig({
+  displayName: "useAnchoredPositionstories__Float",
+  componentId: "sc-18cdzou-0"
+})(["position:absolute;border:1px solid ", ";border-radius:", ";background-color:", ";display:flex;flex-direction:column;text-align:center;font-size:", ";font-weight:", ";padding:", ";"], (0, _constants.get)('colors.black'), (0, _constants.get)('radii.2'), (0, _constants.get)('colors.orange.3'), (0, _constants.get)('fontSizes.3'), (0, _constants.get)('fontWeights.bold'), (0, _constants.get)('space.3'));
+const Anchor = (0, _styledComponents.default)(_.Box).withConfig({
+  displayName: "useAnchoredPositionstories__Anchor",
+  componentId: "sc-18cdzou-1"
+})(["position:absolute;border:1px solid ", ";border-radius:", ";background-color:", ";display:flex;flex-direction:column;text-align:center;font-size:", ";font-weight:", ";padding:", ";"], (0, _constants.get)('colors.black'), (0, _constants.get)('radii.2'), (0, _constants.get)('colors.blue.3'), (0, _constants.get)('fontSizes.3'), (0, _constants.get)('fontWeights.bold'), (0, _constants.get)('space.3')); // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+const UseAnchoredPosition = args => {
+  var _args$anchorPosition, _args$anchorSide, _args$anchorAlignment, _args$allowOutOfBound, _args$anchorY, _args$anchorX, _position$top, _position$left, _args$floatWidth, _args$floatHeight;
+
+  const {
+    floatingElementRef,
+    anchorElementRef,
+    position
+  } = (0, _hooks.useAnchoredPosition)({
+    side: `${(_args$anchorPosition = args.anchorPosition) !== null && _args$anchorPosition !== void 0 ? _args$anchorPosition : 'outside'}-${(_args$anchorSide = args.anchorSide) !== null && _args$anchorSide !== void 0 ? _args$anchorSide : 'bottom'}`,
+    align: (_args$anchorAlignment = args.anchorAlignment) !== null && _args$anchorAlignment !== void 0 ? _args$anchorAlignment : 'start',
+    anchorOffset: args.anchorOffset && parseInt(args.anchorOffset, 10),
+    alignmentOffset: args.alignmentOffset && parseInt(args.alignmentOffset, 10),
+    allowOutOfBounds: (_args$allowOutOfBound = args.allowOutOfBounds) !== null && _args$allowOutOfBound !== void 0 ? _args$allowOutOfBound : undefined
+  }, [args]);
+  return /*#__PURE__*/_react.default.createElement(_.Box, {
+    position: "relative",
+    m: 2
+  }, /*#__PURE__*/_react.default.createElement(Anchor, {
+    top: (_args$anchorY = args.anchorY) !== null && _args$anchorY !== void 0 ? _args$anchorY : 0,
+    left: (_args$anchorX = args.anchorX) !== null && _args$anchorX !== void 0 ? _args$anchorX : 0,
+    width: args.anchorWidth,
+    height: args.anchorHeight,
+    ref: anchorElementRef
+  }, "Anchor Element"), /*#__PURE__*/_react.default.createElement(Float, {
+    top: (_position$top = position === null || position === void 0 ? void 0 : position.top) !== null && _position$top !== void 0 ? _position$top : 0,
+    left: (_position$left = position === null || position === void 0 ? void 0 : position.left) !== null && _position$left !== void 0 ? _position$left : 0,
+    width: (_args$floatWidth = args.floatWidth) !== null && _args$floatWidth !== void 0 ? _args$floatWidth : 150,
+    height: (_args$floatHeight = args.floatHeight) !== null && _args$floatHeight !== void 0 ? _args$floatHeight : 150,
+    ref: floatingElementRef
+  }, "Floating element"));
+};
+
+exports.UseAnchoredPosition = UseAnchoredPosition;
+UseAnchoredPosition.displayName = "UseAnchoredPosition";
+
+const CenteredOnScreen = () => {
+  var _position$top2, _position$left2;
+
+  const {
+    floatingElementRef,
+    anchorElementRef,
+    position
+  } = (0, _hooks.useAnchoredPosition)({
+    side: 'inside-center',
+    align: 'center'
+  }); // The outer Position element simply fills all available space
+
+  return /*#__PURE__*/_react.default.createElement(_.Box, {
+    ref: anchorElementRef,
+    position: "absolute",
+    top: 0,
+    bottom: 0,
+    left: 0,
+    right: 0
+  }, /*#__PURE__*/_react.default.createElement(Float, {
+    ref: floatingElementRef,
+    top: (_position$top2 = position === null || position === void 0 ? void 0 : position.top) !== null && _position$top2 !== void 0 ? _position$top2 : 0,
+    left: (_position$left2 = position === null || position === void 0 ? void 0 : position.left) !== null && _position$left2 !== void 0 ? _position$left2 : 0
+  }, /*#__PURE__*/_react.default.createElement("p", null, "Screen-Centered Floating Element "), /*#__PURE__*/_react.default.createElement("p", null, /*#__PURE__*/_react.default.createElement("small", null, /*#__PURE__*/_react.default.createElement("em", null, "(Controls are ignored for this story)")))));
+};
+
+exports.CenteredOnScreen = CenteredOnScreen;
+CenteredOnScreen.displayName = "CenteredOnScreen";
+
+const ComplexAncestry = () => {
+  var _position$top3, _position$left3;
+
+  const [recalculateSignal, setRecalculateSignal] = _react.default.useState(0);
+
+  const {
+    floatingElementRef,
+    anchorElementRef,
+    position
+  } = (0, _hooks.useAnchoredPosition)({
+    side: 'outside-bottom',
+    align: 'start'
+  }, [recalculateSignal]);
+
+  const onRecalculateClick = _react.default.useCallback(() => {
+    setRecalculateSignal(recalculateSignal + 1);
+  }, [recalculateSignal]); // The outer Position element simply fills all available space
+
+
+  const space = 2;
+  return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_.Box, {
+    m: space,
+    p: space,
+    sx: {
+      border: '1px solid #000',
+      backgroundColor: 'blue.1',
+      height: '440px',
+      overflow: 'auto',
+      position: 'relative'
+    }
+  }, "Clipping container - this element has ", /*#__PURE__*/_react.default.createElement("code", null, "overflow"), " set to something other than ", /*#__PURE__*/_react.default.createElement("code", null, "visible"), /*#__PURE__*/_react.default.createElement(_.Box, {
+    m: space,
+    p: space,
+    sx: {
+      border: '1px solid #000',
+      backgroundColor: 'blue.2',
+      position: 'relative'
+    }
+  }, "Relatively positioned parent, but fluid height, so not the clipping parent.", /*#__PURE__*/_react.default.createElement(_.Box, {
+    m: space,
+    p: space,
+    sx: {
+      border: '1px solid #000',
+      backgroundColor: 'blue.3',
+      position: 'static',
+      overflow: 'hidden'
+    }
+  }, "Floating element container. Position=static and overflow=hidden to show that overflow-hidden on a statically-positioned element will not have any effect.", /*#__PURE__*/_react.default.createElement(Float, {
+    top: (_position$top3 = position === null || position === void 0 ? void 0 : position.top) !== null && _position$top3 !== void 0 ? _position$top3 : 0,
+    left: (_position$left3 = position === null || position === void 0 ? void 0 : position.left) !== null && _position$left3 !== void 0 ? _position$left3 : 0,
+    width: 150,
+    height: 220,
+    ref: floatingElementRef
+  }, "Floating element"))), /*#__PURE__*/_react.default.createElement(_.Box, {
+    m: space,
+    p: space,
+    backgroundColor: "blue.3",
+    sx: {
+      border: '1px solid #000',
+      height: '2000px'
+    }
+  }, "Anchor element container. This element is really tall to demonstrate behavior within a scrollable clipping container.", /*#__PURE__*/_react.default.createElement(_.Box, {
+    width: "200px",
+    backgroundColor: "orange.3",
+    height: 60,
+    ref: anchorElementRef,
+    sx: {
+      border: '1px solid #000'
+    },
+    m: space,
+    p: space
+  }, "Anchor Element"))), /*#__PURE__*/_react.default.createElement(_Button.default, {
+    onClick: onRecalculateClick
+  }, "Click to recalculate floating position"));
+};
+
+exports.ComplexAncestry = ComplexAncestry;
+const Nav = (0, _styledComponents.default)('nav').withConfig({
+  displayName: "useAnchoredPositionstories__Nav",
+  componentId: "sc-18cdzou-2"
+})(["width:300px;padding:", ";position:relative;overflow:hidden;border-right:1px solid ", ";"], (0, _constants.get)('space.3'), (0, _constants.get)('colors.border.gray'));
+const Main = (0, _styledComponents.default)('main').withConfig({
+  displayName: "useAnchoredPositionstories__Main",
+  componentId: "sc-18cdzou-3"
+})(["display:flex;position:absolute;top:0;left:0;right:0;bottom:0;"]);
+/*
+
+There are a few "gotchas" to take note of from this example. See the
+documentation for more info.
+
+1. The portal's root (<Main> in this example) needs to be large enough
+   to include ANY space that the overlay might need to take. By default,
+   elements are not rendered at full height! Notice how <Main> uses
+   top, left, right, and bottom all set to 0 to achieve a full-size box.
+
+2. The positioning routine needs to know the size of the overlay before
+   calculating its position! Therefore, we use visibility: hidden to
+   prevent showing a single frame of the overlay being positioned at
+   (0, 0).
+
+*/
+
+const WithPortal = () => {
+  var _position$top4, _position$left4;
+
+  const [showMenu, setShowMenu] = _react.default.useState(false);
+
+  const mainRef = _react.default.useRef(null); // Calculate the position of the menu
+
+
+  const {
+    floatingElementRef,
+    anchorElementRef,
+    position
+  } = (0, _hooks.useAnchoredPosition)({
+    side: 'outside-bottom',
+    align: 'start'
+  }, [showMenu]); // Register <Main> as the Portal root
+
+  _react.default.useEffect(() => {
+    if (mainRef.current) {
+      (0, _Portal.registerPortalRoot)(mainRef.current);
+    }
+  }, [mainRef]); // Toggles rendering the menu when the button is clicked
+
+
+  const toggleMenu = _react.default.useCallback(() => {
+    setShowMenu(!showMenu);
+  }, [showMenu]);
+
+  return /*#__PURE__*/_react.default.createElement(Main, {
+    ref: mainRef
+  }, /*#__PURE__*/_react.default.createElement(Nav, null, /*#__PURE__*/_react.default.createElement("h2", null, "The nav bar!"), /*#__PURE__*/_react.default.createElement("p", null, "This \u201Cnav bar\u201D has a width of 300px and is ", /*#__PURE__*/_react.default.createElement("code", null, "position:relative"), " with", ' ', /*#__PURE__*/_react.default.createElement("code", null, "overflow:hidden"), ", meaning that its children cannot overflow this container. Using <Portal> with ", /*#__PURE__*/_react.default.createElement("code", null, "useAnchoredPosition"), ", we can break out of this contraint."), /*#__PURE__*/_react.default.createElement(_.Box, {
+    sx: {
+      textAlign: 'right'
+    }
+  }, /*#__PURE__*/_react.default.createElement(_.ButtonPrimary, {
+    onClick: toggleMenu,
+    ref: anchorElementRef
+  }, "Show the overlay!"), showMenu ? /*#__PURE__*/_react.default.createElement(_Portal.default, null, /*#__PURE__*/_react.default.createElement(Float, {
+    ref: floatingElementRef,
+    style: {
+      top: `${(_position$top4 = position === null || position === void 0 ? void 0 : position.top) !== null && _position$top4 !== void 0 ? _position$top4 : 0}px`,
+      left: `${(_position$left4 = position === null || position === void 0 ? void 0 : position.left) !== null && _position$left4 !== void 0 ? _position$left4 : 0}px`
+    },
+    width: 250,
+    height: 400,
+    sx: {
+      visibility: position ? 'visible' : 'hidden'
+    }
+  }, "An un-constrained overlay!")) : null)), /*#__PURE__*/_react.default.createElement(_.Box, {
+    sx: {
+      flexGrow: 1
+    },
+    p: 3
+  }, /*#__PURE__*/_react.default.createElement("h1", null, "The body!"), /*#__PURE__*/_react.default.createElement("p", null, /*#__PURE__*/_react.default.createElement("em", null, "Note: The controls below have no effect in this story."))));
+};
+
+exports.WithPortal = WithPortal;
+WithPortal.displayName = "WithPortal";