@procore/core-react 12.42.0 → 12.43.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +49 -1
- package/dist/AnchorNavigation/AnchorNavigation.js +11 -5
- package/dist/AnchorNavigation/AnchorNavigation.js.map +1 -1
- package/dist/AnchorNavigation/AnchorNavigation.styles.d.ts +1 -0
- package/dist/AnchorNavigation/AnchorNavigation.styles.js +7 -3
- package/dist/AnchorNavigation/AnchorNavigation.styles.js.map +1 -1
- package/dist/AnchorNavigation/AnchorNavigation.types.d.ts +7 -1
- package/dist/AnchorNavigation/AnchorNavigation.types.js.map +1 -1
- package/dist/Avatar/Avatar.styles.js +5 -5
- package/dist/AvatarStack/AvatarStack.styles.d.ts +74 -74
- package/dist/AvatarStack/AvatarStack.styles.js +7 -7
- package/dist/Badge/Badge.styles.js +2 -2
- package/dist/BadgePill/BadgePill.styles.js +4 -4
- package/dist/Banner/Banner.styles.js +10 -10
- package/dist/Box/Box.styles.js +1 -1
- package/dist/Breadcrumbs/Breadcrumbs.styles.js +4 -4
- package/dist/Button/Button.styles.js +5 -5
- package/dist/Button/Button.types.d.ts +1 -4
- package/dist/Button/Button.types.js.map +1 -1
- package/dist/Button/index.d.ts +1 -1
- package/dist/Button/index.js.map +1 -1
- package/dist/Calendar/Calendar.styles.js +9 -9
- package/dist/Card/Card.styles.js +1 -1
- package/dist/Checkbox/Checkbox.js +1 -0
- package/dist/Checkbox/Checkbox.js.map +1 -1
- package/dist/Checkbox/Checkbox.styles.js +6 -6
- package/dist/ContactItem/ContactItem.styles.js +5 -5
- package/dist/Content/Content.styles.js +2 -2
- package/dist/DateInput/DateInput.js +9 -0
- package/dist/DateInput/DateInput.js.map +1 -1
- package/dist/DateInput/DateInput.styles.js +6 -6
- package/dist/DetailPage/DetailPage.styles.js +7 -7
- package/dist/Dropdown/Dropdown.styles.js +3 -3
- package/dist/DropdownFlyout/DropdownFlyout.styles.js +4 -4
- package/dist/Dropzone/Dropzone.js +1 -1
- package/dist/Dropzone/Dropzone.styles.js +9 -9
- package/dist/EmptyState/EmptyState.styles.js +6 -6
- package/dist/Field/Field.styles.js +3 -3
- package/dist/FileList/FileList.styles.js +3 -3
- package/dist/FileSelect/FileExplorer/FileExplorer.styles.js +9 -9
- package/dist/FileSelect/FileExplorer/FileExplorerSidebar.styles.js +3 -3
- package/dist/FileSelect/FileSelect.styles.js +2 -2
- package/dist/FileSelect/FileSelectDropzone/FileSelectDropzone.styles.js +3 -3
- package/dist/FileSelect/FileTokenList/FileTokenList.styles.js +2 -2
- package/dist/FileSelect/GridSource/GridSource.styles.js +6 -6
- package/dist/FileSelect/LocalSource/LocalSource.styles.js +4 -4
- package/dist/FileSelect/SourceItem/SourceItem.styles.js +3 -3
- package/dist/FileSelect/ThumbnailList/ThumbnailList.styles.d.ts +1 -1
- package/dist/FileSelect/ThumbnailList/ThumbnailList.styles.js +6 -6
- package/dist/FileSelect/TreeSource/TreeSource.styles.js +1 -1
- package/dist/FileToken/FileToken.styles.js +6 -6
- package/dist/FileToken/FileTokenInner.js +1 -3
- package/dist/FileToken/FileTokenInner.js.map +1 -1
- package/dist/FilterToken/FilterToken.styles.js +5 -5
- package/dist/FlexList/FlexList.styles.js +1 -1
- package/dist/Form/Form.styles.js +13 -13
- package/dist/Form/StyledFormikForm.styles.d.ts +2 -2
- package/dist/Form/StyledFormikForm.styles.js +2 -2
- package/dist/GhostPlaceholder/GhostPlaceholder.styles.js +2 -2
- package/dist/Grid/Grid.styles.js +2 -2
- package/dist/GroupSelect/GroupSelect.styles.js +1 -1
- package/dist/Input/Input.styles.js +1 -1
- package/dist/Link/Link.styles.js +1 -1
- package/dist/ListPage/ListPage.styles.js +8 -8
- package/dist/Loader/Loader.styles.js +2 -2
- package/dist/MenuImperative/MenuImperative.styles.js +11 -11
- package/dist/Modal/Modal.js +8 -2
- package/dist/Modal/Modal.js.map +1 -1
- package/dist/Modal/Modal.styles.js +13 -13
- package/dist/MultiSelect/MultiSelect.js +7 -5
- package/dist/MultiSelect/MultiSelect.js.map +1 -1
- package/dist/MultiSelect/MultiSelect.styles.js +8 -8
- package/dist/NextMenu/NextMenu.styles.js +3 -3
- package/dist/Notation/Notation.js +1 -1
- package/dist/NumberInput/NumberInput.styles.js +7 -7
- package/dist/Overlay/OverlayArrow.styles.js +1 -1
- package/dist/OverlayTrigger/a11yPresets.d.ts +6 -6
- package/dist/PageLayout/PageLayout.styles.d.ts +1 -1
- package/dist/PageLayout/PageLayout.styles.js +16 -16
- package/dist/PageTemplate/PageFooterTemplate/PageFooterTemplate.styles.js +1 -1
- package/dist/PageTemplate/PageHeaderTemplate/PageHeaderTemplate.styles.js +3 -3
- package/dist/PageTemplate/PagePaneTemplate/PagePaneTemplate.styles.js +2 -2
- package/dist/PageTemplate/PageTemplate/PageTemplate.styles.js +3 -3
- package/dist/Pagination/Pagination.styles.js +5 -5
- package/dist/Panel/Panel.styles.js +11 -11
- package/dist/Pill/Pill.styles.js +3 -3
- package/dist/PillSelect/PillSelect.styles.js +4 -4
- package/dist/Popover/Popover.styles.js +2 -2
- package/dist/Portal/Portal.styles.js +1 -1
- package/dist/ProgressBar/ProgressBar.styles.js +2 -2
- package/dist/RadioButton/RadioButton.styles.js +3 -3
- package/dist/Required/Required.styles.js +3 -3
- package/dist/Search/Search.styles.js +5 -5
- package/dist/Section/Section.styles.js +7 -7
- package/dist/SegmentedController/SegmentedController.styles.js +4 -4
- package/dist/Select/Select.js +3 -2
- package/dist/Select/Select.js.map +1 -1
- package/dist/Select/Select.styles.js +8 -8
- package/dist/Semantic/Semantic.styles.d.ts +74 -74
- package/dist/Semantic/Semantic.styles.js +9 -9
- package/dist/Slider/Slider.styles.js +5 -5
- package/dist/Spinner/Spinner.styles.js +7 -7
- package/dist/SplitViewCard/SplitViewCard.styles.js +8 -8
- package/dist/SuperSelect/SuperSelect.components.js +35 -22
- package/dist/SuperSelect/SuperSelect.components.js.map +1 -1
- package/dist/SuperSelect/SuperSelect.presets.styles.js +1 -1
- package/dist/SuperSelect/SuperSelect.styles.d.ts +4 -2
- package/dist/SuperSelect/SuperSelect.styles.js +49 -42
- package/dist/SuperSelect/SuperSelect.styles.js.map +1 -1
- package/dist/SuperSelect/SuperSelect.types.d.ts +3 -4
- package/dist/SuperSelect/SuperSelect.types.js.map +1 -1
- package/dist/SuperSelect/presets/filterPreset.js +7 -2
- package/dist/SuperSelect/presets/filterPreset.js.map +1 -1
- package/dist/SuperSelect/useSuperSelect.d.ts +1 -1
- package/dist/SuperSelect/useSuperSelect.js +115 -88
- package/dist/SuperSelect/useSuperSelect.js.map +1 -1
- package/dist/Switch/Switch.styles.js +4 -4
- package/dist/Table/Table.styles.js +28 -28
- package/dist/TableShelf/TableShelf.styles.js +5 -5
- package/dist/Tabs/Tabs.js +1 -1
- package/dist/Tabs/Tabs.js.map +1 -1
- package/dist/Tabs/Tabs.styles.js +15 -15
- package/dist/Tearsheet/Tearsheet.styles.js +5 -5
- package/dist/TextArea/TextArea.styles.js +1 -1
- package/dist/TextEditorOutput/TextEditorOutput.styles.js +1 -1
- package/dist/Thumbnail/Thumbnail.hooks.d.ts +58 -58
- package/dist/Thumbnail/Thumbnail.styles.js +17 -17
- package/dist/ThumbnailGrid/ThumbnailGrid.styles.d.ts +1 -1
- package/dist/ThumbnailGrid/ThumbnailGrid.styles.js +7 -7
- package/dist/TieredSelect/TieredSelect.styles.d.ts +1 -1
- package/dist/TieredSelect/TieredSelect.styles.js +9 -9
- package/dist/Tile/Tile.styles.js +8 -8
- package/dist/Title/Title.styles.js +7 -7
- package/dist/Toast/Toast.styles.js +3 -3
- package/dist/ToggleButton/ToggleButton.styles.js +1 -1
- package/dist/Token/Token.js +1 -1
- package/dist/Token/Token.js.map +1 -1
- package/dist/Token/Token.styles.js +3 -3
- package/dist/ToolHeader/ToolHeader.styles.js +6 -6
- package/dist/ToolLandingPage/ToolLandingPage.styles.js +3 -3
- package/dist/ToolLandingPageTemplate/ToolLandingPageTemplate.d.ts +1 -1
- package/dist/Tooltip/Tooltip.styles.js +3 -3
- package/dist/Tree/Tree.js +1 -1
- package/dist/Tree/Tree.styles.js +10 -10
- package/dist/Typeahead/Typeahead.js +7 -3
- package/dist/Typeahead/Typeahead.js.map +1 -1
- package/dist/Typeahead/Typeahead.styles.js +3 -3
- package/dist/Typography/Typography.styles.js +1 -1
- package/dist/Typography/Typography.table.story.js +2 -2
- package/dist/Typography/Typography.types.d.ts +1 -0
- package/dist/Typography/Typography.types.js.map +1 -1
- package/dist/_hooks/I18n.d.ts +14 -0
- package/dist/_locales/en.json +7 -0
- package/dist/_locales/pseudo.json +7 -0
- package/dist/_storyHelpers_/components/Deprecation.styles.js +1 -1
- package/dist/_storyHelpers_/components/StoryGrid.js +3 -3
- package/dist/_typedoc/AnchorNavigation/AnchorNavigation.types.json +13 -3
- package/dist/_typedoc/Avatar/Avatar.types.json +20 -20
- package/dist/_typedoc/AvatarStack/AvatarStack.types.json +25 -25
- package/dist/_typedoc/Badge/Badge.types.json +6 -6
- package/dist/_typedoc/Banner/Banner.types.json +15 -15
- package/dist/_typedoc/Box/Box.types.json +72 -72
- package/dist/_typedoc/Breadcrumbs/Breadcrumbs.types.json +10 -10
- package/dist/_typedoc/Button/Button.types.json +17 -17
- package/dist/_typedoc/Calendar/Calendar.types.json +80 -80
- package/dist/_typedoc/Card/Card.types.json +6 -6
- package/dist/_typedoc/Checkbox/Checkbox.types.json +8 -8
- package/dist/_typedoc/ContactItem/ContactItem.types.json +9 -9
- package/dist/_typedoc/DateInput/DateInput.types.json +35 -35
- package/dist/_typedoc/DateSelect/DateSelect.types.json +13 -13
- package/dist/_typedoc/DetailPage/DetailPage.types.json +5 -5
- package/dist/_typedoc/Dropdown/Dropdown.types.json +39 -39
- package/dist/_typedoc/DropdownFlyout/DropdownFlyout.types.json +31 -31
- package/dist/_typedoc/Dropzone/Dropzone.types.json +44 -44
- package/dist/_typedoc/EmptyState/EmptyState.types.json +16 -16
- package/dist/_typedoc/FileList/FileList.types.json +9 -9
- package/dist/_typedoc/FileSelect/FileSelect.types.json +27 -27
- package/dist/_typedoc/FileSelect/GridSource/GridSource.types.json +20 -20
- package/dist/_typedoc/FileSelect/LocalSource/LocalSource.types.json +14 -14
- package/dist/_typedoc/FileSelect/TreeSource/TreeSource.types.json +9 -9
- package/dist/_typedoc/Flex/Flex.types.json +27 -27
- package/dist/_typedoc/FlexList/FlexList.types.json +30 -30
- package/dist/_typedoc/Form/Form.types.json +832 -832
- package/dist/_typedoc/GhostPlaceholder/GhostPlaceholder.types.json +12 -12
- package/dist/_typedoc/Grid/Grid.types.json +8 -8
- package/dist/_typedoc/GroupSelect/GroupSelect.types.json +54 -54
- package/dist/_typedoc/Input/Input.types.json +2 -2
- package/dist/_typedoc/Link/Link.types.json +1 -1
- package/dist/_typedoc/ListPage/ListPage.types.json +13 -13
- package/dist/_typedoc/Menu/Menu.types.json +62 -62
- package/dist/_typedoc/MenuImperative/MenuImperative.types.json +84 -84
- package/dist/_typedoc/Modal/Modal.types.json +48 -48
- package/dist/_typedoc/MultiSelect/MultiSelect.types.json +33 -33
- package/dist/_typedoc/NextTile/NextTile.types.json +32 -32
- package/dist/_typedoc/Notation/Notation.types.json +4 -4
- package/dist/_typedoc/NumberInput/NumberInput.types.json +54 -54
- package/dist/_typedoc/OverlayTrigger/OverlayTrigger.types.json +33 -33
- package/dist/_typedoc/PageLayout/PageLayout.types.json +28 -28
- package/dist/_typedoc/Pagination/Pagination.types.json +7 -7
- package/dist/_typedoc/Panel/Panel.types.json +27 -27
- package/dist/_typedoc/Pill/Pill.types.json +2 -2
- package/dist/_typedoc/PillSelect/PillSelect.types.json +49 -49
- package/dist/_typedoc/Popover/Popover.types.json +15 -15
- package/dist/_typedoc/ProgressBar/ProgressBar.types.json +7 -7
- package/dist/_typedoc/RadioButton/RadioButton.types.json +6 -6
- package/dist/_typedoc/Required/Required.types.json +5 -5
- package/dist/_typedoc/Search/Search.types.json +18 -18
- package/dist/_typedoc/Section/Section.types.json +15 -15
- package/dist/_typedoc/SegmentedController/SegmentedController.types.json +21 -21
- package/dist/_typedoc/Select/Select.types.json +69 -69
- package/dist/_typedoc/SettingsPage/SettingsPage.types.json +10 -10
- package/dist/_typedoc/Slider/Slider.types.json +6 -6
- package/dist/_typedoc/Spinner/Spinner.types.json +9 -9
- package/dist/_typedoc/SplitViewCard/SplitViewCard.types.json +14 -14
- package/dist/_typedoc/Table/Table.types.json +102 -102
- package/dist/_typedoc/Tabs/Tabs.types.json +21 -21
- package/dist/_typedoc/Tearsheet/Tearsheet.types.json +17 -17
- package/dist/_typedoc/TextArea/TextArea.types.json +3 -3
- package/dist/_typedoc/TextEditor/TextEditor.types.json +11 -11
- package/dist/_typedoc/TextEditorOutput/TextEditorOutput.types.json +4 -4
- package/dist/_typedoc/Thumbnail/Thumbnail.types.json +19 -19
- package/dist/_typedoc/TieredDropdown/TieredDropdown.types.json +43 -43
- package/dist/_typedoc/TieredSelect/TieredSelect.types.json +29 -29
- package/dist/_typedoc/Tile/Tile.types.json +8 -8
- package/dist/_typedoc/Title/Title.types.json +3 -3
- package/dist/_typedoc/Toast/Toast.types.json +4 -4
- package/dist/_typedoc/ToggleButton/ToggleButton.types.json +4 -4
- package/dist/_typedoc/Token/Token.types.json +7 -7
- package/dist/_typedoc/ToolHeader/ToolHeader.types.json +10 -10
- package/dist/_typedoc/ToolLandingPage/ToolLandingPage.types.json +10 -10
- package/dist/_typedoc/Tooltip/Tooltip.types.json +15 -15
- package/dist/_typedoc/Tree/Tree.types.json +90 -90
- package/dist/_typedoc/Typeahead/Typeahead.types.json +2 -2
- package/dist/_typedoc/Typography/Typography.types.json +12 -11
- package/dist/_typedoc/_utils/types.json +3 -3
- package/package.json +2 -2
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"description": "",
|
|
11
11
|
"descriptionHtml": "",
|
|
12
12
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
13
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
13
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L46"
|
|
14
14
|
},
|
|
15
15
|
{
|
|
16
16
|
"name": "aria-details",
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"description": "",
|
|
21
21
|
"descriptionHtml": "",
|
|
22
22
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
23
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
23
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L47"
|
|
24
24
|
},
|
|
25
25
|
{
|
|
26
26
|
"name": "aria-label",
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p><code>role='dialog'</code> MUST be labelled. Prefer <code>aria-labelledby</code> over <code>aria-label</code>.\nIf using an <code>aria-label</code> instead of a node, be sure give the modal an <code>id</code> so\nother regions can reference it.</p>\n</dd><dt>since</dt><dd><p>11.12.0</p>\n</dd></dl></div>",
|
|
32
32
|
"a11y": "`role='dialog'` MUST be labelled. Prefer `aria-labelledby` over `aria-label`.\nIf using an `aria-label` instead of a node, be sure give the modal an `id` so\nother regions can reference it.",
|
|
33
33
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
34
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
34
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L59"
|
|
35
35
|
},
|
|
36
36
|
{
|
|
37
37
|
"name": "aria-labelledby",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p>Automatially created when using <code>Modal.Heading</code>. The <code>role='dialog'</code> MUST be labelled. Prefer <code>aria-labelledby</code> over <code>aria-label</code>.</p>\n</dd><dt>since</dt><dd><p>11.12.0</p>\n</dd></dl></div>",
|
|
43
43
|
"a11y": "Automatially created when using `Modal.Heading`. The `role='dialog'` MUST be labelled. Prefer `aria-labelledby` over `aria-label`.",
|
|
44
44
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
45
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
45
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L52"
|
|
46
46
|
},
|
|
47
47
|
{
|
|
48
48
|
"name": "aria-modal",
|
|
@@ -53,7 +53,7 @@
|
|
|
53
53
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p>Recommended to use. When using alertdialog should be a <code>aria-modal</code> because of their urgent nature. <strong>Cannot open nested modals.</strong></p>\n</dd><dt>since</dt><dd><p>12.42.0</p>\n</dd></dl></div>",
|
|
54
54
|
"a11y": "Recommended to use. When using alertdialog should be a `aria-modal` because of their urgent nature. **Cannot open nested modals.**",
|
|
55
55
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
56
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
56
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L169"
|
|
57
57
|
},
|
|
58
58
|
{
|
|
59
59
|
"name": "children",
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
"description": "",
|
|
64
64
|
"descriptionHtml": "",
|
|
65
65
|
"sourceFile": "packages/core-react/src/_utils/types.ts",
|
|
66
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
66
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L42"
|
|
67
67
|
},
|
|
68
68
|
{
|
|
69
69
|
"name": "className",
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
"description": "Additional classNames",
|
|
74
74
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
|
|
75
75
|
"sourceFile": "packages/core-react/src/_utils/types.ts",
|
|
76
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
76
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L47"
|
|
77
77
|
},
|
|
78
78
|
{
|
|
79
79
|
"name": "compact",
|
|
@@ -85,7 +85,7 @@
|
|
|
85
85
|
"defaultValue": "false",
|
|
86
86
|
"deprecated": "@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY",
|
|
87
87
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
88
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
88
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L71"
|
|
89
89
|
},
|
|
90
90
|
{
|
|
91
91
|
"name": "headline",
|
|
@@ -95,7 +95,7 @@
|
|
|
95
95
|
"description": "Headline message",
|
|
96
96
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Headline message</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
97
97
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
98
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
98
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L147"
|
|
99
99
|
},
|
|
100
100
|
{
|
|
101
101
|
"name": "howToClose",
|
|
@@ -106,7 +106,7 @@
|
|
|
106
106
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>This adds additional UI or UX to close. Escape key will always close a dialog, see <code>onClose</code>.</p>\n</div><div><p>NOTE 'footer-button': Footer Cancel button still requires at least a rendered self closing <code>Modal.FooterButtons</code>.</p>\n<p>NOTE 'x': The X button still requires a rendered <code>Modal.Header</code> component.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>[]</p>\n</dd><dt>since</dt><dd><p>11.12.0</p>\n</dd></dl></div>",
|
|
107
107
|
"defaultValue": "[]",
|
|
108
108
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
109
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
109
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L81"
|
|
110
110
|
},
|
|
111
111
|
{
|
|
112
112
|
"name": "id",
|
|
@@ -116,7 +116,7 @@
|
|
|
116
116
|
"description": "Aligns with `role` and `ref` location.",
|
|
117
117
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Aligns with <code>role</code> and <code>ref</code> location.</p>\n</div></div>",
|
|
118
118
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
119
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
119
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L85"
|
|
120
120
|
},
|
|
121
121
|
{
|
|
122
122
|
"name": "onClose",
|
|
@@ -127,7 +127,7 @@
|
|
|
127
127
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback when the ConfirmModal is dismissed.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p><strong>Accessible pattern (recommended):</strong> Use with <code>role="dialog"</code> and <code>howToClose={['x']}</code>.\nThis enables focus management, Escape key support, and proper dialog semantics.\nThe callback signature is <code>(event, how) => void</code>.</p>\n<p><strong>Legacy pattern:</strong> <code>(event: MouseEvent<HTMLButtonElement>) => void</code> — only handles X button click,\nno focus management or Escape key support.</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
128
128
|
"a11y": "**Accessible pattern (recommended):** Use with `role=\"dialog\"` and `howToClose={['x']}`.\nThis enables focus management, Escape key support, and proper dialog semantics.\nThe callback signature is `(event, how) => void`.\n\n**Legacy pattern:** `(event: MouseEvent<HTMLButtonElement>) => void` — only handles X button click,\nno focus management or Escape key support.\n",
|
|
129
129
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
130
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
130
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L161"
|
|
131
131
|
},
|
|
132
132
|
{
|
|
133
133
|
"name": "open",
|
|
@@ -138,7 +138,7 @@
|
|
|
138
138
|
"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><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
139
139
|
"defaultValue": "false",
|
|
140
140
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
141
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
141
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L104"
|
|
142
142
|
},
|
|
143
143
|
{
|
|
144
144
|
"name": "placement",
|
|
@@ -149,7 +149,7 @@
|
|
|
149
149
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Vertical placement of the modal.\nPositioning modal at the top ensures that variable height modal won't shift position during content loading,\nproviding a more stable user experience.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>center</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
150
150
|
"defaultValue": "center",
|
|
151
151
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
152
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
152
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L116"
|
|
153
153
|
},
|
|
154
154
|
{
|
|
155
155
|
"name": "role",
|
|
@@ -159,7 +159,7 @@
|
|
|
159
159
|
"description": "Enable dialog props. REQUIRES `onClose` to enable Escape key and focus management. MUST be labelled, prefer `aria-labelledby` over `aria-label`.",
|
|
160
160
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Enable dialog props. REQUIRES <code>onClose</code> to enable Escape key and focus management. MUST be labelled, prefer <code>aria-labelledby</code> over <code>aria-label</code>.</p>\n</div></div>",
|
|
161
161
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
162
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
162
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L108"
|
|
163
163
|
},
|
|
164
164
|
{
|
|
165
165
|
"name": "style",
|
|
@@ -169,7 +169,7 @@
|
|
|
169
169
|
"description": "Additional CSS styles",
|
|
170
170
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
|
|
171
171
|
"sourceFile": "packages/core-react/src/_utils/types.ts",
|
|
172
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
172
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L52"
|
|
173
173
|
},
|
|
174
174
|
{
|
|
175
175
|
"name": "width",
|
|
@@ -179,7 +179,7 @@
|
|
|
179
179
|
"description": "Sets a width on the container and uses next centering.\nFuture will default to `md`",
|
|
180
180
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Sets a width on the container and uses next centering.\nFuture will default to <code>md</code></p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
181
181
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
182
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
182
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L122"
|
|
183
183
|
},
|
|
184
184
|
{
|
|
185
185
|
"name": "onClickOverlay",
|
|
@@ -189,7 +189,7 @@
|
|
|
189
189
|
"description": "",
|
|
190
190
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p>Use <code>howToClose={['scrim']}</code> with <code>onClose</code> instead.</p>\n</dd><dt>deprecatedsince</dt><dd><p>12.41.0</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
191
191
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
192
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
192
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L91"
|
|
193
193
|
}
|
|
194
194
|
],
|
|
195
195
|
"description": ""
|
|
@@ -207,7 +207,7 @@
|
|
|
207
207
|
"defaultValue": "false",
|
|
208
208
|
"deprecated": "@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY",
|
|
209
209
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
210
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
210
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L195"
|
|
211
211
|
},
|
|
212
212
|
{
|
|
213
213
|
"name": "noSideSpacing",
|
|
@@ -218,7 +218,7 @@
|
|
|
218
218
|
"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><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
219
219
|
"defaultValue": "false",
|
|
220
220
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
221
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
221
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L201"
|
|
222
222
|
}
|
|
223
223
|
],
|
|
224
224
|
"description": ""
|
|
@@ -234,7 +234,7 @@
|
|
|
234
234
|
"description": "Escape key will always close a dialog. This adds additional UI or UX to close.",
|
|
235
235
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Escape key will always close a dialog. This adds additional UI or UX to close.</p>\n</div></div>",
|
|
236
236
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
237
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
237
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L30"
|
|
238
238
|
},
|
|
239
239
|
{
|
|
240
240
|
"name": "onClose",
|
|
@@ -244,7 +244,7 @@
|
|
|
244
244
|
"description": "",
|
|
245
245
|
"descriptionHtml": "",
|
|
246
246
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
247
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
247
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L31"
|
|
248
248
|
}
|
|
249
249
|
],
|
|
250
250
|
"description": ""
|
|
@@ -262,7 +262,7 @@
|
|
|
262
262
|
"defaultValue": "false",
|
|
263
263
|
"deprecated": "@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY",
|
|
264
264
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
265
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
265
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L41"
|
|
266
266
|
},
|
|
267
267
|
{
|
|
268
268
|
"name": "qa",
|
|
@@ -272,7 +272,7 @@
|
|
|
272
272
|
"description": "",
|
|
273
273
|
"descriptionHtml": "",
|
|
274
274
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
275
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
275
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L42"
|
|
276
276
|
},
|
|
277
277
|
{
|
|
278
278
|
"name": "onClose",
|
|
@@ -282,7 +282,7 @@
|
|
|
282
282
|
"description": "",
|
|
283
283
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p>Use <code>Modal onClose</code> with <code>howToClose={['x']}</code> instead.</p>\n</dd><dt>deprecatedsince</dt><dd><p>12.41.0</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
284
284
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
285
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
285
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L182"
|
|
286
286
|
}
|
|
287
287
|
],
|
|
288
288
|
"description": ""
|
|
@@ -298,7 +298,7 @@
|
|
|
298
298
|
"description": "",
|
|
299
299
|
"descriptionHtml": "",
|
|
300
300
|
"sourceFile": "packages/core-react/src/_utils/types.ts",
|
|
301
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
301
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L42"
|
|
302
302
|
},
|
|
303
303
|
{
|
|
304
304
|
"name": "className",
|
|
@@ -308,7 +308,7 @@
|
|
|
308
308
|
"description": "Additional classNames",
|
|
309
309
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
|
|
310
310
|
"sourceFile": "packages/core-react/src/_utils/types.ts",
|
|
311
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
311
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L47"
|
|
312
312
|
},
|
|
313
313
|
{
|
|
314
314
|
"name": "compact",
|
|
@@ -320,7 +320,7 @@
|
|
|
320
320
|
"defaultValue": "false",
|
|
321
321
|
"deprecated": "@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY",
|
|
322
322
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
323
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
323
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L131"
|
|
324
324
|
},
|
|
325
325
|
{
|
|
326
326
|
"name": "placement",
|
|
@@ -330,7 +330,7 @@
|
|
|
330
330
|
"description": "",
|
|
331
331
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
332
332
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
333
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
333
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L135"
|
|
334
334
|
},
|
|
335
335
|
{
|
|
336
336
|
"name": "style",
|
|
@@ -340,7 +340,7 @@
|
|
|
340
340
|
"description": "Additional CSS styles",
|
|
341
341
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
|
|
342
342
|
"sourceFile": "packages/core-react/src/_utils/types.ts",
|
|
343
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
343
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L52"
|
|
344
344
|
},
|
|
345
345
|
{
|
|
346
346
|
"name": "width",
|
|
@@ -350,7 +350,7 @@
|
|
|
350
350
|
"description": "",
|
|
351
351
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
352
352
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
353
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
353
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L139"
|
|
354
354
|
}
|
|
355
355
|
],
|
|
356
356
|
"description": ""
|
|
@@ -366,7 +366,7 @@
|
|
|
366
366
|
"description": "",
|
|
367
367
|
"descriptionHtml": "",
|
|
368
368
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
369
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
369
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L46"
|
|
370
370
|
},
|
|
371
371
|
{
|
|
372
372
|
"name": "aria-details",
|
|
@@ -376,7 +376,7 @@
|
|
|
376
376
|
"description": "",
|
|
377
377
|
"descriptionHtml": "",
|
|
378
378
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
379
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
379
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L47"
|
|
380
380
|
},
|
|
381
381
|
{
|
|
382
382
|
"name": "aria-label",
|
|
@@ -387,7 +387,7 @@
|
|
|
387
387
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p><code>role='dialog'</code> MUST be labelled. Prefer <code>aria-labelledby</code> over <code>aria-label</code>.\nIf using an <code>aria-label</code> instead of a node, be sure give the modal an <code>id</code> so\nother regions can reference it.</p>\n</dd><dt>since</dt><dd><p>11.12.0</p>\n</dd></dl></div>",
|
|
388
388
|
"a11y": "`role='dialog'` MUST be labelled. Prefer `aria-labelledby` over `aria-label`.\nIf using an `aria-label` instead of a node, be sure give the modal an `id` so\nother regions can reference it.",
|
|
389
389
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
390
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
390
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L59"
|
|
391
391
|
},
|
|
392
392
|
{
|
|
393
393
|
"name": "aria-labelledby",
|
|
@@ -398,7 +398,7 @@
|
|
|
398
398
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p>Automatially created when using <code>Modal.Heading</code>. The <code>role='dialog'</code> MUST be labelled. Prefer <code>aria-labelledby</code> over <code>aria-label</code>.</p>\n</dd><dt>since</dt><dd><p>11.12.0</p>\n</dd></dl></div>",
|
|
399
399
|
"a11y": "Automatially created when using `Modal.Heading`. The `role='dialog'` MUST be labelled. Prefer `aria-labelledby` over `aria-label`.",
|
|
400
400
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
401
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
401
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L52"
|
|
402
402
|
},
|
|
403
403
|
{
|
|
404
404
|
"name": "aria-modal",
|
|
@@ -409,7 +409,7 @@
|
|
|
409
409
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p>Should be used for a single true modal. Cannot open nested modals.</p>\n</dd><dt>experimental</dt><dd><p>Core-React does not support multiple or nested <code>aria-modal</code>s for Tearsheets, Modals, or ConfirmModals.</p>\n</dd><dt>since</dt><dd><p>12.42.0</p>\n</dd></dl></div>",
|
|
410
410
|
"a11y": "Should be used for a single true modal. Cannot open nested modals.",
|
|
411
411
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
412
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
412
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L65"
|
|
413
413
|
},
|
|
414
414
|
{
|
|
415
415
|
"name": "children",
|
|
@@ -419,7 +419,7 @@
|
|
|
419
419
|
"description": "",
|
|
420
420
|
"descriptionHtml": "",
|
|
421
421
|
"sourceFile": "packages/core-react/src/_utils/types.ts",
|
|
422
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
422
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L42"
|
|
423
423
|
},
|
|
424
424
|
{
|
|
425
425
|
"name": "className",
|
|
@@ -429,7 +429,7 @@
|
|
|
429
429
|
"description": "Additional classNames",
|
|
430
430
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
|
|
431
431
|
"sourceFile": "packages/core-react/src/_utils/types.ts",
|
|
432
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
432
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L47"
|
|
433
433
|
},
|
|
434
434
|
{
|
|
435
435
|
"name": "compact",
|
|
@@ -441,7 +441,7 @@
|
|
|
441
441
|
"defaultValue": "false",
|
|
442
442
|
"deprecated": "@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY",
|
|
443
443
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
444
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
444
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L71"
|
|
445
445
|
},
|
|
446
446
|
{
|
|
447
447
|
"name": "howToClose",
|
|
@@ -452,7 +452,7 @@
|
|
|
452
452
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>This adds additional UI or UX to close. Escape key will always close a dialog, see <code>onClose</code>.</p>\n</div><div><p>NOTE 'footer-button': Footer Cancel button still requires at least a rendered self closing <code>Modal.FooterButtons</code>.</p>\n<p>NOTE 'x': The X button still requires a rendered <code>Modal.Header</code> component.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>[]</p>\n</dd><dt>since</dt><dd><p>11.12.0</p>\n</dd></dl></div>",
|
|
453
453
|
"defaultValue": "[]",
|
|
454
454
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
455
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
455
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L81"
|
|
456
456
|
},
|
|
457
457
|
{
|
|
458
458
|
"name": "id",
|
|
@@ -462,7 +462,7 @@
|
|
|
462
462
|
"description": "Aligns with `role` and `ref` location.",
|
|
463
463
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Aligns with <code>role</code> and <code>ref</code> location.</p>\n</div></div>",
|
|
464
464
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
465
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
465
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L85"
|
|
466
466
|
},
|
|
467
467
|
{
|
|
468
468
|
"name": "onClose",
|
|
@@ -473,7 +473,7 @@
|
|
|
473
473
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>When a user closes the Modal by some approved <code>howToClose</code> method or the Escape key. This also opts-in to dialog focus management.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p>Future default! Moves focus into and cycles focus in the Modal, and returning focus\nto the trigger when closed. Also enables the Escape key to close the Modal.</p>\n</dd><dt>since</dt><dd><p>11.6.0</p>\n</dd></dl></div>",
|
|
474
474
|
"a11y": "Future default! Moves focus into and cycles focus in the Modal, and returning focus\nto the trigger when closed. Also enables the Escape key to close the Modal.",
|
|
475
475
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
476
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
476
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L98"
|
|
477
477
|
},
|
|
478
478
|
{
|
|
479
479
|
"name": "open",
|
|
@@ -484,7 +484,7 @@
|
|
|
484
484
|
"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><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
485
485
|
"defaultValue": "false",
|
|
486
486
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
487
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
487
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L104"
|
|
488
488
|
},
|
|
489
489
|
{
|
|
490
490
|
"name": "placement",
|
|
@@ -495,7 +495,7 @@
|
|
|
495
495
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Vertical placement of the modal.\nPositioning modal at the top ensures that variable height modal won't shift position during content loading,\nproviding a more stable user experience.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>center</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
496
496
|
"defaultValue": "center",
|
|
497
497
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
498
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
498
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L116"
|
|
499
499
|
},
|
|
500
500
|
{
|
|
501
501
|
"name": "role",
|
|
@@ -505,7 +505,7 @@
|
|
|
505
505
|
"description": "Enable dialog props. REQUIRES `onClose` to enable Escape key and focus management. MUST be labelled, prefer `aria-labelledby` over `aria-label`.",
|
|
506
506
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Enable dialog props. REQUIRES <code>onClose</code> to enable Escape key and focus management. MUST be labelled, prefer <code>aria-labelledby</code> over <code>aria-label</code>.</p>\n</div></div>",
|
|
507
507
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
508
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
508
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L108"
|
|
509
509
|
},
|
|
510
510
|
{
|
|
511
511
|
"name": "style",
|
|
@@ -515,7 +515,7 @@
|
|
|
515
515
|
"description": "Additional CSS styles",
|
|
516
516
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
|
|
517
517
|
"sourceFile": "packages/core-react/src/_utils/types.ts",
|
|
518
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
518
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L52"
|
|
519
519
|
},
|
|
520
520
|
{
|
|
521
521
|
"name": "width",
|
|
@@ -525,7 +525,7 @@
|
|
|
525
525
|
"description": "Sets a width on the container and uses next centering.\nFuture will default to `md`",
|
|
526
526
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Sets a width on the container and uses next centering.\nFuture will default to <code>md</code></p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
527
527
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
528
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
528
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L122"
|
|
529
529
|
},
|
|
530
530
|
{
|
|
531
531
|
"name": "onClickOverlay",
|
|
@@ -535,7 +535,7 @@
|
|
|
535
535
|
"description": "",
|
|
536
536
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p>Use <code>howToClose={['scrim']}</code> with <code>onClose</code> instead.</p>\n</dd><dt>deprecatedsince</dt><dd><p>12.41.0</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
537
537
|
"sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
|
|
538
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
538
|
+
"sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L91"
|
|
539
539
|
}
|
|
540
540
|
],
|
|
541
541
|
"description": ""
|