@procore/core-react 10.20.0-rc.93 → 10.20.0

package/dist/typedoc/components/Modal/Modal.types.json

@@ -0,0 +1,302 @@
+{
+  "ConfirmModalProps": {
+    "name": "ConfirmModalProps",
+    "properties": [
+      {
+        "name": "children",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "description": "Instead of using the default children, you can pass in your own.",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L40"
+      },
+      {
+        "name": "className",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "description": "Additional classNames",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L45"
+      },
+      {
+        "name": "headline",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "description": "Headline message",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Headline message</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L36"
+      },
+      {
+        "name": "open",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "description": "Modal open state",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Modal open state</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>false</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L15"
+      },
+      {
+        "name": "placement",
+        "required": false,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalPlacement</a>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;top&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;center&quot;</span>",
+        "description": "Vertical placement of the modal",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Vertical placement of the modal</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>center</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L20"
+      },
+      {
+        "name": "style",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">CSSProperties</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">CSSProperties</span>",
+        "description": "Additional CSS styles",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L50"
+      },
+      {
+        "name": "width",
+        "required": false,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalWidth</a>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;sm&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;md&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;lg&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;xl&quot;</span>",
+        "description": "Sets a width on the container and uses next centering. Future will default to `md`",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Sets a width on the container and uses next centering. Future will default to <code>md</code></p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L24"
+      },
+      {
+        "name": "onClickOverlay",
+        "required": false,
+        "type": "Function",
+        "typeDetail": "on<wbr/>Click<wbr/>Overlay<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLDivElement</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&gt;</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
+        "description": "Callback for clicking the overlay",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback for clicking the overlay</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L10"
+      },
+      {
+        "name": "onClose",
+        "required": false,
+        "type": "Function",
+        "typeDetail": "on<wbr/>Close<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLButtonElement</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&gt;</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
+        "description": "The dismiss onClick callback",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The dismiss onClick callback</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L41"
+      }
+    ],
+    "description": ""
+  },
+  "ModalBodyProps": {
+    "name": "ModalBodyProps",
+    "properties": [
+      {
+        "name": "noSideSpacing",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "description": "Removes left, right paddings from the modal body when true",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Removes left, right paddings from the modal body when true</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>false</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L54"
+      }
+    ],
+    "description": ""
+  },
+  "ModalCloseableHeaderProps": {
+    "name": "ModalCloseableHeaderProps",
+    "properties": [
+      {
+        "name": "children",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "description": "Instead of using the default children, you can pass in your own.",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L40"
+      },
+      {
+        "name": "className",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "description": "Additional classNames",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L45"
+      },
+      {
+        "name": "qa",
+        "required": false,
+        "type": "<span class=\"tsd-signature-symbol\">{ </span>closeButton<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> }</span>",
+        "typeDetail": "<span class=\"tsd-signature-symbol\">{ </span>closeButton<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> }</span>",
+        "description": "",
+        "descriptionHtml": "",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L46"
+      },
+      {
+        "name": "style",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">CSSProperties</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">CSSProperties</span>",
+        "description": "Additional CSS styles",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L50"
+      },
+      {
+        "name": "onClose",
+        "required": false,
+        "type": "Function",
+        "typeDetail": "on<wbr/>Close<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLButtonElement</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&gt;</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
+        "description": "",
+        "descriptionHtml": "",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L45"
+      }
+    ],
+    "description": ""
+  },
+  "ModalContainerProps": {
+    "name": "ModalContainerProps",
+    "properties": [
+      {
+        "name": "children",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "description": "Instead of using the default children, you can pass in your own.",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L40"
+      },
+      {
+        "name": "className",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "description": "Additional classNames",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L45"
+      },
+      {
+        "name": "placement",
+        "required": true,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalPlacement</a>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;top&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;center&quot;</span>",
+        "description": "",
+        "descriptionHtml": "",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L28"
+      },
+      {
+        "name": "style",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">CSSProperties</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">CSSProperties</span>",
+        "description": "Additional CSS styles",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L50"
+      },
+      {
+        "name": "width",
+        "required": false,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalWidth</a>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;sm&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;md&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;lg&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;xl&quot;</span>",
+        "description": "",
+        "descriptionHtml": "",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L29"
+      }
+    ],
+    "description": ""
+  },
+  "ModalProps": {
+    "name": "ModalProps",
+    "properties": [
+      {
+        "name": "children",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "description": "Instead of using the default children, you can pass in your own.",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L40"
+      },
+      {
+        "name": "className",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "description": "Additional classNames",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L45"
+      },
+      {
+        "name": "open",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "description": "Modal open state",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Modal open state</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>false</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L15"
+      },
+      {
+        "name": "placement",
+        "required": false,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalPlacement</a>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;top&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;center&quot;</span>",
+        "description": "Vertical placement of the modal",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Vertical placement of the modal</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>center</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L20"
+      },
+      {
+        "name": "style",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">CSSProperties</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">CSSProperties</span>",
+        "description": "Additional CSS styles",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L50"
+      },
+      {
+        "name": "width",
+        "required": false,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalWidth</a>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;sm&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;md&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;lg&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;xl&quot;</span>",
+        "description": "Sets a width on the container and uses next centering. Future will default to `md`",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Sets a width on the container and uses next centering. Future will default to <code>md</code></p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L24"
+      },
+      {
+        "name": "onClickOverlay",
+        "required": false,
+        "type": "Function",
+        "typeDetail": "on<wbr/>Click<wbr/>Overlay<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLDivElement</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&gt;</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
+        "description": "Callback for clicking the overlay",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback for clicking the overlay</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/components/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Modal/Modal.types.ts#L10"
+      }
+    ],
+    "description": ""
+  }
+}