@procore/core-react 10.21.0-rc.27 → 10.21.0-rc.31
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/dist/esm/components/Avatar/Avatar.js +12 -0
- package/dist/esm/components/Avatar/Avatar.js.map +1 -1
- package/dist/esm/components/Avatar/Avatar.types.d.ts +4 -0
- package/dist/esm/components/AvatarStack/AvatarStack.d.ts +12 -0
- package/dist/esm/components/AvatarStack/AvatarStack.js +12 -0
- package/dist/esm/components/AvatarStack/AvatarStack.js.map +1 -1
- package/dist/esm/components/AvatarStack/AvatarStack.types.d.ts +38 -0
- package/dist/esm/components/Banner/Banner.js +19 -0
- package/dist/esm/components/Banner/Banner.js.map +1 -1
- package/dist/esm/components/Banner/Banner.types.d.ts +3 -0
- package/dist/esm/components/Breadcrumbs/Breadcrumbs.js +12 -0
- package/dist/esm/components/Breadcrumbs/Breadcrumbs.js.map +1 -1
- package/dist/esm/components/Breadcrumbs/Breadcrumbs.types.d.ts +3 -0
- package/dist/esm/components/Button/Button.d.ts +12 -0
- package/dist/esm/components/Button/Button.js +12 -0
- package/dist/esm/components/Button/Button.js.map +1 -1
- package/dist/esm/components/Button/Button.types.d.ts +6 -0
- package/dist/esm/components/Button__Prev.d.ts +36 -0
- package/dist/esm/components/Button__Prev.js.map +1 -1
- package/dist/esm/components/Calendar/Calendar.types.d.ts +68 -0
- package/dist/esm/components/Card/Card.d.ts +12 -0
- package/dist/esm/components/Card/Card.js +12 -0
- package/dist/esm/components/Card/Card.js.map +1 -1
- package/dist/esm/components/Card/Card.types.d.ts +3 -0
- package/dist/esm/components/Checkbox/Checkbox.d.ts +14 -0
- package/dist/esm/components/Checkbox/Checkbox.js +14 -0
- package/dist/esm/components/Checkbox/Checkbox.js.map +1 -1
- package/dist/esm/components/Checkbox/Checkbox.types.d.ts +6 -0
- package/dist/esm/components/ClickOutside.d.ts +12 -0
- package/dist/esm/components/ClickOutside.js.map +1 -1
- package/dist/esm/components/ContactItem/ContactItem.js +14 -0
- package/dist/esm/components/ContactItem/ContactItem.js.map +1 -1
- package/dist/esm/components/ContactItem/ContactItem.types.d.ts +5 -0
- package/dist/esm/components/DateInput/DateInput.js +1 -1
- package/dist/esm/components/DateInput/DateInput.js.map +1 -1
- package/dist/esm/components/DateInput/DateInput.types.d.ts +94 -0
- package/dist/esm/components/DateSelect/DateSelect.d.ts +12 -0
- package/dist/esm/components/DateSelect/DateSelect.js +12 -0
- package/dist/esm/components/DateSelect/DateSelect.js.map +1 -1
- package/dist/esm/components/DateSelect/DateSelect.types.d.ts +3 -0
- package/dist/esm/components/Dropdown/Dropdown.js +13 -0
- package/dist/esm/components/Dropdown/Dropdown.js.map +1 -1
- package/dist/esm/components/Dropdown/Dropdown.types.d.ts +63 -0
- package/dist/esm/components/DropdownFlyout/DropdownFlyout.d.ts +12 -0
- package/dist/esm/components/DropdownFlyout/DropdownFlyout.js +12 -0
- package/dist/esm/components/DropdownFlyout/DropdownFlyout.js.map +1 -1
- package/dist/esm/components/DropdownFlyout/DropdownFlyout.types.d.ts +89 -0
- package/dist/esm/components/Dropzone/Dropzone.js +12 -0
- package/dist/esm/components/Dropzone/Dropzone.js.map +1 -1
- package/dist/esm/components/Dropzone/Dropzone.types.d.ts +89 -0
- package/dist/esm/components/Dropzone/Dropzone.types.js.map +1 -1
- package/dist/esm/components/EmptyState/EmptyState.js +13 -0
- package/dist/esm/components/EmptyState/EmptyState.js.map +1 -1
- package/dist/esm/components/EmptyState/EmptyState.types.d.ts +4 -0
- package/dist/esm/components/FileList/FileList.d.ts +7 -0
- package/dist/esm/components/FileList/FileList.js +7 -0
- package/dist/esm/components/FileList/FileList.js.map +1 -1
- package/dist/esm/components/FileList/FileList.types.d.ts +16 -0
- package/dist/esm/components/FileSelect/FileExplorer/FileExplorer.types.d.ts +51 -0
- package/dist/esm/components/FileSelect/FileSelect.d.ts +12 -0
- package/dist/esm/components/FileSelect/FileSelect.js +12 -0
- package/dist/esm/components/FileSelect/FileSelect.js.map +1 -1
- package/dist/esm/components/FileSelect/FileSelect.types.d.ts +117 -2
- package/dist/esm/components/FileSelect/FileSelectDropzone/FileSelectDropzone.types.d.ts +69 -0
- package/dist/esm/components/FileSelect/FileTokenList/FileToken.types.d.ts +30 -0
- package/dist/esm/components/FileSelect/GridSource/GridSource.types.d.ts +32 -1
- package/dist/esm/components/FileSelect/LocalSource/LocalSource.types.d.ts +33 -0
- package/dist/esm/components/FileSelect/SourceItem/SourceItem.d.ts +22 -0
- package/dist/esm/components/FileSelect/SourceItem/SourceItem.js.map +1 -1
- package/dist/esm/components/FileSelect/ThumbnailList/ThumbnailList.types.d.ts +27 -0
- package/dist/esm/components/FileSelect/TreeSource/TreeSource.types.d.ts +17 -1
- package/dist/esm/components/FileToken/FileToken.types.d.ts +21 -0
- package/dist/esm/components/Font/Font.types.d.ts +4 -0
- package/dist/esm/components/Form/Form.types.d.ts +151 -1
- package/dist/esm/components/GroupSelect/GroupSelect.d.ts +12 -0
- package/dist/esm/components/GroupSelect/GroupSelect.js +12 -0
- package/dist/esm/components/GroupSelect/GroupSelect.js.map +1 -1
- package/dist/esm/components/GroupSelect/GroupSelect.types.d.ts +51 -0
- package/dist/esm/components/Icon/Icon.types.d.ts +15 -0
- package/dist/esm/components/Input/Input.types.d.ts +2 -0
- package/dist/esm/components/Link/Link.d.ts +15 -0
- package/dist/esm/components/Link/Link.js +15 -0
- package/dist/esm/components/Link/Link.js.map +1 -1
- package/dist/esm/components/Link/Link.types.d.ts +1 -0
- package/dist/esm/components/Loader/Loader.types.d.ts +6 -0
- package/dist/esm/components/Menu/Menu.d.ts +12 -0
- package/dist/esm/components/Menu/Menu.js +12 -0
- package/dist/esm/components/Menu/Menu.js.map +1 -1
- package/dist/esm/components/Menu/Menu.types.d.ts +111 -2
- package/dist/esm/components/MenuImperative/MenuImperative.types.d.ts +123 -0
- package/dist/esm/components/Modal/Modal.js +16 -0
- package/dist/esm/components/Modal/Modal.js.map +1 -1
- package/dist/esm/components/Modal/Modal.types.d.ts +21 -1
- package/dist/esm/components/MultiSelect/MultiSelect.js +14 -0
- package/dist/esm/components/MultiSelect/MultiSelect.js.map +1 -1
- package/dist/esm/components/MultiSelect/MultiSelect.types.d.ts +219 -1
- package/dist/esm/components/Notation/Notation.types.d.ts +1 -0
- package/dist/esm/components/NumberInput/NumberInput.d.ts +14 -0
- package/dist/esm/components/NumberInput/NumberInput.js +14 -0
- package/dist/esm/components/NumberInput/NumberInput.js.map +1 -1
- package/dist/esm/components/NumberInput/NumberInput.types.d.ts +45 -0
- package/dist/esm/components/Overlay.d.ts +6 -0
- package/dist/esm/components/Overlay.js.map +1 -1
- package/dist/esm/components/OverlayTrigger/OverlayTrigger.d.ts +8 -0
- package/dist/esm/components/OverlayTrigger/OverlayTrigger.js.map +1 -1
- package/dist/esm/components/Pagination/Pagination.d.ts +15 -0
- package/dist/esm/components/Pagination/Pagination.js +15 -0
- package/dist/esm/components/Pagination/Pagination.js.map +1 -1
- package/dist/esm/components/Pagination/Pagination.types.d.ts +83 -0
- package/dist/esm/components/Panel/Panel.js +15 -0
- package/dist/esm/components/Panel/Panel.js.map +1 -1
- package/dist/esm/components/Panel/Panel.types.d.ts +27 -0
- package/dist/esm/components/Pill/Pill.d.ts +12 -0
- package/dist/esm/components/Pill/Pill.js +12 -0
- package/dist/esm/components/Pill/Pill.js.map +1 -1
- package/dist/esm/components/Pill/Pill.types.d.ts +1 -0
- package/dist/esm/components/PillSelect/PillSelect.d.ts +13 -0
- package/dist/esm/components/PillSelect/PillSelect.js +13 -0
- package/dist/esm/components/PillSelect/PillSelect.js.map +1 -1
- package/dist/esm/components/PillSelect/PillSelect.types.d.ts +37 -0
- package/dist/esm/components/Popover/Popover.js +20 -0
- package/dist/esm/components/Popover/Popover.js.map +1 -1
- package/dist/esm/components/Popover/Popover.types.d.ts +10 -0
- package/dist/esm/components/Portal/Portal.types.d.ts +3 -0
- package/dist/esm/components/ProgressBar/ProgressBar.d.ts +12 -0
- package/dist/esm/components/ProgressBar/ProgressBar.js +12 -0
- package/dist/esm/components/ProgressBar/ProgressBar.js.map +1 -1
- package/dist/esm/components/RadioButton/RadioButton.d.ts +14 -0
- package/dist/esm/components/RadioButton/RadioButton.js +14 -0
- package/dist/esm/components/RadioButton/RadioButton.js.map +1 -1
- package/dist/esm/components/RadioButton/RadioButton.types.d.ts +3 -0
- package/dist/esm/components/Required/Required.types.d.ts +12 -3
- package/dist/esm/components/Search/Search.d.ts +12 -0
- package/dist/esm/components/Search/Search.js +12 -0
- package/dist/esm/components/Search/Search.js.map +1 -1
- package/dist/esm/components/Search/Search.types.d.ts +37 -0
- package/dist/esm/components/SegmentedController/SegmentedController.d.ts +12 -0
- package/dist/esm/components/SegmentedController/SegmentedController.js +12 -0
- package/dist/esm/components/SegmentedController/SegmentedController.js.map +1 -1
- package/dist/esm/components/SegmentedController/SegmentedController.types.d.ts +14 -0
- package/dist/esm/components/Select/Select.js +16 -0
- package/dist/esm/components/Select/Select.js.map +1 -1
- package/dist/esm/components/Select/Select.types.d.ts +140 -0
- package/dist/esm/components/Slider/Slider.d.ts +14 -0
- package/dist/esm/components/Slider/Slider.js +14 -0
- package/dist/esm/components/Slider/Slider.js.map +1 -1
- package/dist/esm/components/Slider/Slider.types.d.ts +6 -0
- package/dist/esm/components/Spinner/Spinner.d.ts +12 -0
- package/dist/esm/components/Spinner/Spinner.js +12 -0
- package/dist/esm/components/Spinner/Spinner.js.map +1 -1
- package/dist/esm/components/Spinner/Spinner.types.d.ts +7 -1
- package/dist/esm/components/Switch/Switch.d.ts +12 -0
- package/dist/esm/components/Switch/Switch.js +12 -0
- package/dist/esm/components/Switch/Switch.js.map +1 -1
- package/dist/esm/components/Table/Table.types.d.ts +32 -0
- package/dist/esm/components/Tabs/Tabs.d.ts +12 -0
- package/dist/esm/components/Tabs/Tabs.js +12 -0
- package/dist/esm/components/Tabs/Tabs.js.map +1 -1
- package/dist/esm/components/Tabs/Tabs.types.d.ts +21 -0
- package/dist/esm/components/TextArea/TextArea.d.ts +14 -0
- package/dist/esm/components/TextArea/TextArea.js +14 -0
- package/dist/esm/components/TextArea/TextArea.js.map +1 -1
- package/dist/esm/components/TextArea/TextArea.types.d.ts +3 -0
- package/dist/esm/components/TextEditor/TextEditor.d.ts +13 -0
- package/dist/esm/components/TextEditor/TextEditor.js +13 -0
- package/dist/esm/components/TextEditor/TextEditor.js.map +1 -1
- package/dist/esm/components/TextEditor/TextEditor.types.d.ts +13 -1
- package/dist/esm/components/Thumbnail/Thumbnail.js +14 -0
- package/dist/esm/components/Thumbnail/Thumbnail.js.map +1 -1
- package/dist/esm/components/Thumbnail/Thumbnail.types.d.ts +102 -0
- package/dist/esm/components/ThumbnailGrid/ThumbnailGrid.types.d.ts +66 -0
- package/dist/esm/components/TieredDropdown/TieredDropdown.types.d.ts +39 -0
- package/dist/esm/components/TieredSelect/TieredSelect.d.ts +14 -0
- package/dist/esm/components/TieredSelect/TieredSelect.js +14 -0
- package/dist/esm/components/TieredSelect/TieredSelect.js.map +1 -1
- package/dist/esm/components/TieredSelect/TieredSelect.types.d.ts +138 -1
- package/dist/esm/components/Tile/Tile.types.d.ts +13 -0
- package/dist/esm/components/Toast/Toast.d.ts +15 -0
- package/dist/esm/components/Toast/Toast.js +15 -0
- package/dist/esm/components/Toast/Toast.js.map +1 -1
- package/dist/esm/components/Toast/Toast.types.d.ts +1 -0
- package/dist/esm/components/ToggleButton/ToggleButton.d.ts +13 -0
- package/dist/esm/components/ToggleButton/ToggleButton.js +13 -0
- package/dist/esm/components/ToggleButton/ToggleButton.js.map +1 -1
- package/dist/esm/components/ToggleButton/ToggleButton.types.d.ts +3 -0
- package/dist/esm/components/Token/Token.d.ts +12 -0
- package/dist/esm/components/Token/Token.js +12 -0
- package/dist/esm/components/Token/Token.js.map +1 -1
- package/dist/esm/components/Token/Token.types.d.ts +9 -0
- package/dist/esm/components/Tooltip/Tooltip.js +17 -0
- package/dist/esm/components/Tooltip/Tooltip.js.map +1 -1
- package/dist/esm/components/Tooltip/Tooltip.types.d.ts +13 -0
- package/dist/esm/components/Tree/Tree.d.ts +12 -0
- package/dist/esm/components/Tree/Tree.js +12 -0
- package/dist/esm/components/Tree/Tree.js.map +1 -1
- package/dist/esm/components/Tree/Tree.types.d.ts +220 -0
- package/dist/esm/components/Typeahead/Typeahead.types.d.ts +6 -0
- package/dist/esm/components/Typography/Typography.types.d.ts +6 -0
- package/dist/esm/effects/Autofocus.d.ts +12 -0
- package/dist/esm/effects/Autofocus.js.map +1 -1
- package/dist/esm/effects/ClickOutside.d.ts +9 -0
- package/dist/esm/effects/ClickOutside.js.map +1 -1
- package/dist/esm/effects/DelayedToggle.d.ts +39 -0
- package/dist/esm/effects/DelayedToggle.js.map +1 -1
- package/dist/esm/effects/Deprecation.d.ts +12 -0
- package/dist/esm/effects/Deprecation.js.map +1 -1
- package/dist/esm/effects/EventListener.d.ts +24 -0
- package/dist/esm/effects/EventListener.js.map +1 -1
- package/dist/esm/effects/Hotkey.d.ts +21 -0
- package/dist/esm/effects/Hotkey.js.map +1 -1
- package/dist/esm/effects/OverflowObserver/OverflowObserver.types.d.ts +6 -0
- package/dist/esm/effects/Resize.d.ts +3 -0
- package/dist/esm/effects/Resize.js.map +1 -1
- package/dist/esm/effects/Scroll.d.ts +6 -0
- package/dist/esm/effects/Scroll.js.map +1 -1
- package/dist/esm/effects/useFileUploader.d.ts +30 -0
- package/dist/esm/effects/useFileUploader.js.map +1 -1
- package/dist/esm/effects/useFocusWithin.d.ts +6 -0
- package/dist/esm/effects/useFocusWithin.js.map +1 -1
- package/dist/esm/effects/useSet.d.ts +12 -0
- package/dist/esm/effects/useSet.js +1 -3
- package/dist/esm/effects/useSet.js.map +1 -1
- package/dist/esm/layouts/Box/Box.types.d.ts +147 -1
- package/dist/esm/layouts/DetailPage/DetailPage.d.ts +6 -0
- package/dist/esm/layouts/DetailPage/DetailPage.js +1 -0
- package/dist/esm/layouts/DetailPage/DetailPage.js.map +1 -1
- package/dist/esm/layouts/Flex/Flex.types.d.ts +23 -0
- package/dist/esm/layouts/FlexList/FlexList.types.d.ts +3 -0
- package/dist/esm/layouts/Grid/Grid.d.ts +10 -0
- package/dist/esm/layouts/Grid/Grid.js +1 -0
- package/dist/esm/layouts/Grid/Grid.js.map +1 -1
- package/dist/esm/layouts/IconLayout/IconLayout.d.ts +1 -0
- package/dist/esm/layouts/IconLayout/IconLayout.js.map +1 -1
- package/dist/esm/layouts/LegacyDetailPage/LegacyDetailPage.d.ts +11 -0
- package/dist/esm/layouts/LegacyDetailPage/LegacyDetailPage.js +1 -0
- package/dist/esm/layouts/LegacyDetailPage/LegacyDetailPage.js.map +1 -1
- package/dist/esm/layouts/ListPage/ListPage.types.d.ts +4 -0
- package/dist/esm/layouts/NextDetailPage/NextDetailPage.d.ts +12 -0
- package/dist/esm/layouts/NextDetailPage/NextDetailPage.js +12 -0
- package/dist/esm/layouts/NextDetailPage/NextDetailPage.js.map +1 -1
- package/dist/esm/layouts/NextDetailPage/NextDetailPage.types.d.ts +1 -0
- package/dist/esm/layouts/NextGrid/NextGrid.types.d.ts +40 -10
- package/dist/esm/layouts/PageLayout/PageLayout.types.d.ts +5 -0
- package/dist/esm/layouts/Section/Section.types.d.ts +21 -2
- package/dist/esm/layouts/Sidebar/Sidebar.d.ts +3 -0
- package/dist/esm/layouts/Sidebar/Sidebar.js.map +1 -1
- package/dist/esm/layouts/ToolHeader/ToolHeader.types.d.ts +2 -0
- package/dist/props/AvatarStack.json +1 -1
- package/dist/props/Banner.json +1 -1
- package/dist/props/Box.json +1 -1
- package/dist/props/Calendar.json +1 -1
- package/dist/props/Card.json +1 -1
- package/dist/props/ContactItem.json +1 -1
- package/dist/props/Dropdown.json +1 -1
- package/dist/props/FileSelect.json +1 -1
- package/dist/props/Form.json +1 -1
- package/dist/props/GridSource.json +1 -1
- package/dist/props/Input.json +1 -1
- package/dist/props/ListPage.json +1 -1
- package/dist/props/Menu.json +1 -1
- package/dist/props/MenuImperative.json +1 -1
- package/dist/props/Modal.json +1 -1
- package/dist/props/NextGrid.json +1 -1
- package/dist/props/NumberInput.json +1 -1
- package/dist/props/Pill.json +1 -1
- package/dist/props/PillSelect.json +1 -1
- package/dist/props/Popover.json +1 -1
- package/dist/props/Search.json +1 -1
- package/dist/props/SegmentedController.json +1 -1
- package/dist/props/Slider.json +1 -1
- package/dist/props/Spinner.json +1 -1
- package/dist/props/Table.json +1 -1
- package/dist/props/Tabs.json +1 -1
- package/dist/props/TieredDropdown.json +1 -1
- package/dist/props/TieredSelect.json +1 -1
- package/dist/props/ToolHeader.json +1 -1
- package/dist/props/Tree.json +1 -1
- package/dist/props/TreeSource.json +1 -1
- package/dist/props/allProps.json +15840 -3030
- package/dist/typedoc/components/Avatar/Avatar.types.json +21 -21
- package/dist/typedoc/components/AvatarStack/AvatarStack.types.json +40 -40
- package/dist/typedoc/components/Badge/Badge.types.json +6 -6
- package/dist/typedoc/components/Banner/Banner.types.json +16 -16
- package/dist/typedoc/components/Breadcrumbs/Breadcrumbs.types.json +8 -8
- package/dist/typedoc/components/Button/Button.types.json +22 -22
- package/dist/typedoc/components/Calendar/Calendar.types.json +128 -128
- package/dist/typedoc/components/Card/Card.types.json +9 -9
- package/dist/typedoc/components/Checkbox/Checkbox.types.json +13 -13
- package/dist/typedoc/components/ContactItem/ContactItem.types.json +14 -14
- package/dist/typedoc/components/DateInput/DateInput.types.json +67 -67
- package/dist/typedoc/components/DateSelect/DateSelect.types.json +23 -23
- package/dist/typedoc/components/Dropdown/Dropdown.types.json +66 -66
- package/dist/typedoc/components/DropdownFlyout/DropdownFlyout.types.json +61 -61
- package/dist/typedoc/components/Dropzone/Dropzone.types.json +81 -81
- package/dist/typedoc/components/EmptyState/EmptyState.types.json +16 -16
- package/dist/typedoc/components/FileList/FileList.types.json +6 -6
- package/dist/typedoc/components/FileSelect/FileSelect.types.json +50 -50
- package/dist/typedoc/components/FileSelect/GridSource/GridSource.types.json +41 -41
- package/dist/typedoc/components/FileSelect/LocalSource/LocalSource.types.json +27 -27
- package/dist/typedoc/components/FileSelect/TreeSource/TreeSource.types.json +27 -27
- package/dist/typedoc/components/Font/Font.types.json +11 -11
- package/dist/typedoc/components/Form/Form.types.json +1252 -1252
- package/dist/typedoc/components/GroupSelect/GroupSelect.types.json +93 -93
- package/dist/typedoc/components/Icon/Icon.types.json +17 -17
- package/dist/typedoc/components/Input/Input.types.json +5 -5
- package/dist/typedoc/components/Link/Link.types.json +5 -5
- package/dist/typedoc/components/Menu/Menu.types.json +126 -126
- package/dist/typedoc/components/MenuImperative/MenuImperative.types.json +129 -129
- package/dist/typedoc/components/Modal/Modal.types.json +44 -44
- package/dist/typedoc/components/MultiSelect/MultiSelect.types.json +50 -50
- package/dist/typedoc/components/Notation/Notation.types.json +5 -5
- package/dist/typedoc/components/NumberInput/NumberInput.types.json +50 -50
- package/dist/typedoc/components/OverlayTrigger/OverlayTrigger.json +26 -26
- package/dist/typedoc/components/Pagination/Pagination.types.json +13 -13
- package/dist/typedoc/components/Panel/Panel.types.json +34 -34
- package/dist/typedoc/components/Pill/Pill.types.json +2 -2
- package/dist/typedoc/components/PillSelect/PillSelect.types.json +88 -88
- package/dist/typedoc/components/Popover/Popover.types.json +15 -15
- package/dist/typedoc/components/ProgressBar/ProgressBar.types.json +7 -7
- package/dist/typedoc/components/RadioButton/RadioButton.types.json +9 -9
- package/dist/typedoc/components/Required/Required.types.json +8 -8
- package/dist/typedoc/components/Search/Search.types.json +43 -43
- package/dist/typedoc/components/SegmentedController/SegmentedController.types.json +31 -31
- package/dist/typedoc/components/Select/Select.types.json +60 -60
- package/dist/typedoc/components/Slider/Slider.types.json +12 -12
- package/dist/typedoc/components/Spinner/Spinner.types.json +14 -14
- package/dist/typedoc/components/Switch/Switch.types.json +3 -3
- package/dist/typedoc/components/Table/Table.types.json +150 -150
- package/dist/typedoc/components/Tabs/Tabs.types.json +26 -26
- package/dist/typedoc/components/TextArea/TextArea.types.json +6 -6
- package/dist/typedoc/components/TextEditor/TextEditor.types.json +14 -14
- package/dist/typedoc/components/Thumbnail/Thumbnail.types.json +24 -24
- package/dist/typedoc/components/TieredDropdown/TieredDropdown.types.json +78 -78
- package/dist/typedoc/components/TieredSelect/TieredSelect.types.json +50 -50
- package/dist/typedoc/components/Tile/Tile.types.json +40 -40
- package/dist/typedoc/components/Toast/Toast.types.json +5 -5
- package/dist/typedoc/components/ToggleButton/ToggleButton.types.json +6 -6
- package/dist/typedoc/components/Token/Token.types.json +19 -19
- package/dist/typedoc/components/Tooltip/Tooltip.types.json +20 -20
- package/dist/typedoc/components/Tree/Tree.types.json +210 -210
- package/dist/typedoc/components/Typeahead/Typeahead.types.json +4 -4
- package/dist/typedoc/components/Typography/Typography.types.json +14 -14
- package/dist/typedoc/layouts/Box/Box.types.json +140 -140
- package/dist/typedoc/layouts/DetailPage/DetailPage.json +16 -16
- package/dist/typedoc/layouts/Flex/Flex.types.json +49 -49
- package/dist/typedoc/layouts/FlexList/FlexList.types.json +55 -55
- package/dist/typedoc/layouts/Grid/Grid.json +17 -17
- package/dist/typedoc/layouts/LegacyDetailPage/LegacyDetailPage.json +8 -8
- package/dist/typedoc/layouts/ListPage/ListPage.types.json +15 -15
- package/dist/typedoc/layouts/NextDetailPage/NextDetailPage.types.json +5 -5
- package/dist/typedoc/layouts/NextGrid/NextGrid.types.json +20 -20
- package/dist/typedoc/layouts/PageLayout/PageLayout.types.json +11 -11
- package/dist/typedoc/layouts/ToolHeader/ToolHeader.types.json +11 -11
- package/dist/typedoc/utils/types.json +3 -3
- package/package.json +5 -5
- package/storybook-static/iframe.html +1 -1
- package/storybook-static/{main.41990b57.iframe.bundle.js → main.277b9c92.iframe.bundle.js} +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"GridProps":[{"name":"children","type":"ReactNode","required":false,"description":"React nodes to be displayed next to the search bar"},{"name":"emptyState","required":false,"description":"<Code>{`{ text: string, image: string }`}</Code> props for{' '}\n<Code>EmptyState</Code> component shown when there are no items in\ngrid"},{"name":"getGroupId","required":false,"description":"A function called returning group ID of a given grid item that is used\nto sort items by group. Returns <Code>item.groupId</Code>\nby default."},{"name":"getId","required":false,"description":"A function called returning ID of a given grid item that is used to\nidentify the item. Returns <Code>item.id</Code> by default."},{"name":"getThumbnailLabel","required":false,"description":"A function called returning label of a given grid item that is used to\ndisplay the item's thumbnail label. Returns <Code>item.label</Code>\nby default."},{"name":"getThumbnailName","required":false,"description":"A function called returning name of a given grid item that is used to\ndisplay the item's thumbnail name. Returns <Code>item.name</Code> by\ndefault."},{"name":"getThumbnailSource","required":false,"description":"A function called returning thumbnail URL of a given grid item that is\nused to display the item's thumbnail image. Returns{' '}\n<Code>item.src</Code>\nby default."},{"name":"groups","required":false,"description":"<Code>{`{ id: string | number, title: string }[]`}</Code> object\nrepresenting file groups"},{"name":"icon","type":"ReactNode","required":true,"deprecated":"String icon variant is deprecated, use the React components
|
|
1
|
+
{"GridProps":[{"name":"children","type":"ReactNode","required":false,"description":"React nodes to be displayed next to the search bar"},{"name":"emptyState","required":false,"description":"<Code>{`{ text: string, image: string }`}</Code> props for{' '}\n<Code>EmptyState</Code> component shown when there are no items in\ngrid"},{"name":"getGroupId","required":false,"description":"A function called returning group ID of a given grid item that is used\nto sort items by group. Returns <Code>item.groupId</Code>\nby default."},{"name":"getId","required":false,"description":"A function called returning ID of a given grid item that is used to\nidentify the item. Returns <Code>item.id</Code> by default."},{"name":"getThumbnailLabel","required":false,"description":"A function called returning label of a given grid item that is used to\ndisplay the item's thumbnail label. Returns <Code>item.label</Code>\nby default."},{"name":"getThumbnailName","required":false,"description":"A function called returning name of a given grid item that is used to\ndisplay the item's thumbnail name. Returns <Code>item.name</Code> by\ndefault."},{"name":"getThumbnailSource","required":false,"description":"A function called returning thumbnail URL of a given grid item that is\nused to display the item's thumbnail image. Returns{' '}\n<Code>item.src</Code>\nby default."},{"name":"groups","required":false,"description":"<Code>{`{ id: string | number, title: string }[]`}</Code> object\nrepresenting file groups"},{"name":"icon","type":"ReactNode","required":true,"deprecated":"String icon variant is deprecated, use the React components\ndirectly from the `@procore/core-icons/dist` package"},{"name":"isLoading","type":"boolean","required":false,"description":"Show/Hide loading indicator of the content"},{"name":"isLoadingMore","type":"boolean","required":false,"description":"Show/Hide loading indicator at the list bottom"},{"name":"items","required":true,"description":"An array of arbitrarily-shaped objects representing grid items.{' '}\n<Code>getId</Code> <Code>getName</Code> and <Code>getThumbnail</Code>{' '}\nshould be used to bind the target shape to a view."},{"name":"qa","type":"QaTags","required":false},{"name":"searchQuery","type":"string","required":false,"description":"Allows controlling the search input value. Can be used with\n<Code>onSearch</Code> to customize the default string-based search"},{"name":"sourceId","type":"string","required":true},{"name":"title","type":"string","required":true},{"name":"onScrollBottom","type":"Promise","required":true,"description":"Optional <Code>function</Code> that automatically executes when\nscrolling reaches the last item."},{"name":"onSearch","type":"void","required":true,"description":"Allows customizing the default string-based search by passing a\ndifferent set of <Code>items</Code> every time\n<Code>onSearch</Code> is called with query string as a single\nparameter"}],"SearchBarProps":[{"name":"query","type":"string","required":true},{"name":"onChange","type":"void","required":true}]}
|
package/dist/props/Input.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"InputProps":[{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead
|
|
1
|
+
{"InputProps":[{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead"}]}
|
package/dist/props/ListPage.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"DivProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"ListPageControlProps":[{"name":"alignRight","type":"boolean","required":false,"description":"Controls whether the contents will align to the right"},{"name":"block","type":"boolean","required":false,"description":"Controls whether the contents will attmpt to span the full width"},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"search","type":"boolean","required":false,"description":"Sets width to a specific size for Search to fit"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","required":false,"deprecated":"please use the equivalent boolean prop instead
|
|
1
|
+
{"DivProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"ListPageControlProps":[{"name":"alignRight","type":"boolean","required":false,"description":"Controls whether the contents will align to the right"},{"name":"block","type":"boolean","required":false,"description":"Controls whether the contents will attmpt to span the full width"},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"search","type":"boolean","required":false,"description":"Sets width to a specific size for Search to fit"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","required":false,"deprecated":"please use the equivalent boolean prop instead"}]}
|
package/dist/props/Menu.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"MenuFooterProps":[{"name":"alignContent","type":"","required":false},{"name":"alignItems","type":"","required":false},{"name":"alignSelf","type":"","required":false},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"display","type":"","required":false},{"name":"flex","required":false,"description":"Alias to the `flex` property on a flexbox child."},{"name":"flexBasis","required":false,"description":"Alias to the `basis` property on a flexbox child."},{"name":"flexDirection","type":"","required":false,"description":"Alias to the `direction` property on a flexbox child."},{"name":"flexGrow","required":false,"description":"Alias to the `grow` property on a flexbox child."},{"name":"flexShrink","required":false,"description":"Alias to the `shrink` property on a flexbox child."},{"name":"flexWrap","type":"","required":false,"description":"Alias to the `wrap` property on a flexbox child."},{"name":"justifyContent","type":"","required":false},{"name":"margin","type":"string","required":false},{"name":"marginBottom","type":"","required":false},{"name":"marginLeft","type":"","required":false},{"name":"marginRight","type":"","required":false},{"name":"marginTop","type":"","required":false},{"name":"order","type":"number","required":false,"description":"Alias to the `order` property on a flexbox child"},{"name":"padding","type":"string","required":false},{"name":"paddingBottom","type":"","required":false},{"name":"paddingLeft","type":"","required":false},{"name":"paddingRight","type":"","required":false},{"name":"paddingTop","type":"","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false},{"name":"textAlign","type":"","required":false}],"MenuGroupProps":[{"name":"className","type":"string","required":false},{"name":"clickable","type":"boolean","required":false,"description":"Can the group item be clicked"},{"name":"item","type":"any","required":false,"description":"Value which can be passed around various callback functions
|
|
1
|
+
{"MenuFooterProps":[{"name":"alignContent","type":"","required":false},{"name":"alignItems","type":"","required":false},{"name":"alignSelf","type":"","required":false},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"display","type":"","required":false},{"name":"flex","required":false,"description":"Alias to the `flex` property on a flexbox child."},{"name":"flexBasis","required":false,"description":"Alias to the `basis` property on a flexbox child."},{"name":"flexDirection","type":"","required":false,"description":"Alias to the `direction` property on a flexbox child."},{"name":"flexGrow","required":false,"description":"Alias to the `grow` property on a flexbox child."},{"name":"flexShrink","required":false,"description":"Alias to the `shrink` property on a flexbox child."},{"name":"flexWrap","type":"","required":false,"description":"Alias to the `wrap` property on a flexbox child."},{"name":"justifyContent","type":"","required":false},{"name":"margin","type":"string","required":false},{"name":"marginBottom","type":"","required":false},{"name":"marginLeft","type":"","required":false},{"name":"marginRight","type":"","required":false},{"name":"marginTop","type":"","required":false},{"name":"order","type":"number","required":false,"description":"Alias to the `order` property on a flexbox child."},{"name":"padding","type":"string","required":false},{"name":"paddingBottom","type":"","required":false},{"name":"paddingLeft","type":"","required":false},{"name":"paddingRight","type":"","required":false},{"name":"paddingTop","type":"","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false},{"name":"textAlign","type":"","required":false}],"MenuGroupProps":[{"name":"className","type":"string","required":false},{"name":"clickable","type":"boolean","required":false,"description":"Can the group item be clicked"},{"name":"item","type":"any","required":false,"description":"Value which can be passed around various callback functions.\nCan be anything!"}],"MenuHeaderProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false}],"MenuItemProps":[{"name":"children","type":"ReactNode","required":false},{"name":"className","type":"string","required":false},{"name":"index","type":"number","required":false},{"name":"item","type":"any","required":false,"description":"Value which can be passed around various callback functions.\nCan be anything!"},{"name":"ref","type":"Ref","required":false},{"name":"selected","type":"boolean","required":false,"description":"Is the item selected"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"suggested","type":"boolean","required":false},{"name":"onClick","type":"any","required":true}],"MenuOptionsProps":[{"name":"children","type":"ReactNode","required":false},{"name":"className","type":"string","required":false},{"name":"padding","type":"string","required":false},{"name":"scrollable","type":"boolean","required":false}],"MenuProps":[{"name":"UNSAFE_closesOnSelect","type":"boolean","required":false},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"isSelectable","type":"ElementTypeChecker","required":false,"description":"<CodeBlock>\n (element: any, index?: number, list?: any[]) => boolean\n</CodeBlock>","deprecated":"\n\nThe `isSelectable` prop has been deprecated and will be removed in a future version.\nMenu item selection is now handled internally and there is no need to configure this\nanymore.\n"},{"name":"keyHandlerRef","type":"RefObject","required":false,"description":"Ref object which will get the key handler listeners"},{"name":"scrollable","type":"boolean","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"usingHook","type":"MenuHook","required":false},{"name":"onScrollBottom","type":"void","required":true},{"name":"onSelect","type":"any","required":true,"description":"<div>Callback for selecting an item from the menu</div>\n<CodeBlock>\n{\n '({ event: ReactEvent, item: Menu.Item.props.item, group: bool }) => void'\n}\n</CodeBlock>\n<div>\n <Code>item</Code> will be the <Code>item</Code> prop supplied to the{' '}\n <Code>Item</Code> component\n <br />\n <Code>group</Code> will be <Code>true</Code> if the clicked item was\n a group label\n</div>"}],"MenuSearchProps":[{"name":"autoFocus","type":"boolean","required":false},{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the menu search's configurable strings. Defaults to\nusing the core library's default strings."},{"name":"initialValue","type":"string","required":false},{"name":"typeahead","type":"boolean","required":false,"deprecated":"\n\nThe `typeahead` prop has been deprecated and will be removed in a future version.\n\nA new component, `Typeahead`, has been introduced with specific UX for typeahead-like\nbehavior. Please use this component instead.\n\n**Before**\n\n<Search typeahead onChange={() => { ... }} />\n\n**After**\n\n<Typeahead onChange={() => { ... }} />\n"},{"name":"usingHook","type":"","required":false},{"name":"value","type":"string","required":false,"description":"Initial value string"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead"},{"name":"onClear","type":"void","required":true},{"name":"onSubmit","type":"void","required":true,"description":"<div>Input handler for search variant</div>\n<CodeBlock>(value: string) => void</CodeBlock>"}]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"DroppableProps":[{"name":"children","type":"ReactNode","required":true},{"name":"id","type":"string","required":true}],"FooterProps":[{"name":"alignContent","type":"","required":false},{"name":"alignItems","type":"","required":false},{"name":"alignSelf","type":"","required":false},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"display","type":"","required":false},{"name":"flex","required":false,"description":"Alias to the `flex` property on a flexbox child."},{"name":"flexBasis","required":false,"description":"Alias to the `basis` property on a flexbox child."},{"name":"flexDirection","type":"","required":false,"description":"Alias to the `direction` property on a flexbox child."},{"name":"flexGrow","required":false,"description":"Alias to the `grow` property on a flexbox child."},{"name":"flexShrink","required":false,"description":"Alias to the `shrink` property on a flexbox child."},{"name":"flexWrap","type":"","required":false,"description":"Alias to the `wrap` property on a flexbox child."},{"name":"justifyContent","type":"","required":false},{"name":"margin","type":"string","required":false},{"name":"marginBottom","type":"","required":false},{"name":"marginLeft","type":"","required":false},{"name":"marginRight","type":"","required":false},{"name":"marginTop","type":"","required":false},{"name":"order","type":"number","required":false,"description":"Alias to the `order` property on a flexbox child"},{"name":"padding","type":"string","required":false},{"name":"paddingBottom","type":"","required":false},{"name":"paddingLeft","type":"","required":false},{"name":"paddingRight","type":"","required":false},{"name":"paddingTop","type":"","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false},{"name":"textAlign","type":"","required":false}],"HeaderProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false}],"ItemProps":[{"name":"disabled","type":"boolean","required":false},{"name":"item","type":"any","required":true},{"name":"selected","type":"boolean","required":false},{"name":"suggested","type":"boolean","required":false}],"ItemWithDraggingProps":[{"name":"disabled","type":"boolean","required":false},{"name":"draggableId","type":"string","required":true},{"name":"draggableIndex","type":"number","required":true},{"name":"droppableIn","required":true},{"name":"item","type":"any","required":true},{"name":"selected","type":"boolean","required":false},{"name":"suggested","type":"boolean","required":false}],"MenuContext":[{"name":"currentlyDroppableIn","required":true},{"name":"onHoverItem","type":"void","required":true},{"name":"onScrollBottom","type":"void","required":true},{"name":"onSelect","type":"void","required":true}],"MenuRef":[{"name":"el","required":true},{"name":"highlight","type":"void","required":true},{"name":"highlightFirst","type":"void","required":true},{"name":"highlightLast","type":"void","required":true},{"name":"highlightSelected","type":"void","required":true},{"name":"highlightSuggested","type":"void","required":true},{"name":"highlighted","type":"any","required":true},{"name":"next","type":"void","required":true},{"name":"prev","type":"void","required":true},{"name":"select","type":"void","required":true}],"OptionsProps":[{"name":"children","type":"ReactNode","required":false},{"name":"className","type":"string","required":false}],"Reorder":[{"name":"destination","required":true},{"name":"draggableId","type":"string","required":true},{"name":"source","required":true}],"Selection":[{"name":"action","required":true},{"name":"event","required":true},{"name":"group","type":"boolean","required":true},{"name":"item","type":"any","required":true}]}
|
|
1
|
+
{"DroppableProps":[{"name":"children","type":"ReactNode","required":true},{"name":"id","type":"string","required":true}],"FooterProps":[{"name":"alignContent","type":"","required":false},{"name":"alignItems","type":"","required":false},{"name":"alignSelf","type":"","required":false},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"display","type":"","required":false},{"name":"flex","required":false,"description":"Alias to the `flex` property on a flexbox child."},{"name":"flexBasis","required":false,"description":"Alias to the `basis` property on a flexbox child."},{"name":"flexDirection","type":"","required":false,"description":"Alias to the `direction` property on a flexbox child."},{"name":"flexGrow","required":false,"description":"Alias to the `grow` property on a flexbox child."},{"name":"flexShrink","required":false,"description":"Alias to the `shrink` property on a flexbox child."},{"name":"flexWrap","type":"","required":false,"description":"Alias to the `wrap` property on a flexbox child."},{"name":"justifyContent","type":"","required":false},{"name":"margin","type":"string","required":false},{"name":"marginBottom","type":"","required":false},{"name":"marginLeft","type":"","required":false},{"name":"marginRight","type":"","required":false},{"name":"marginTop","type":"","required":false},{"name":"order","type":"number","required":false,"description":"Alias to the `order` property on a flexbox child."},{"name":"padding","type":"string","required":false},{"name":"paddingBottom","type":"","required":false},{"name":"paddingLeft","type":"","required":false},{"name":"paddingRight","type":"","required":false},{"name":"paddingTop","type":"","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false},{"name":"textAlign","type":"","required":false}],"HeaderProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false}],"ItemProps":[{"name":"disabled","type":"boolean","required":false},{"name":"item","type":"any","required":true},{"name":"selected","type":"boolean","required":false},{"name":"suggested","type":"boolean","required":false}],"ItemWithDraggingProps":[{"name":"disabled","type":"boolean","required":false},{"name":"draggableId","type":"string","required":true},{"name":"draggableIndex","type":"number","required":true},{"name":"droppableIn","required":true},{"name":"item","type":"any","required":true},{"name":"selected","type":"boolean","required":false},{"name":"suggested","type":"boolean","required":false}],"MenuContext":[{"name":"currentlyDroppableIn","required":true},{"name":"onHoverItem","type":"void","required":true},{"name":"onScrollBottom","type":"void","required":true},{"name":"onSelect","type":"void","required":true}],"MenuRef":[{"name":"el","required":true},{"name":"highlight","type":"void","required":true},{"name":"highlightFirst","type":"void","required":true},{"name":"highlightLast","type":"void","required":true},{"name":"highlightSelected","type":"void","required":true},{"name":"highlightSuggested","type":"void","required":true},{"name":"highlighted","type":"any","required":true},{"name":"next","type":"void","required":true},{"name":"prev","type":"void","required":true},{"name":"select","type":"void","required":true}],"OptionsProps":[{"name":"children","type":"ReactNode","required":false},{"name":"className","type":"string","required":false}],"Reorder":[{"name":"destination","required":true},{"name":"draggableId","type":"string","required":true},{"name":"source","required":true}],"Selection":[{"name":"action","required":true},{"name":"event","required":true},{"name":"group","type":"boolean","required":true},{"name":"item","type":"any","required":true}]}
|
package/dist/props/Modal.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"ConfirmModalProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"headline","type":"string","required":false,"description":"Headline message"},{"name":"open","type":"boolean","required":false,"description":"Modal open state","defaultValue":"false
|
|
1
|
+
{"ConfirmModalProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"headline","type":"string","required":false,"description":"Headline message"},{"name":"open","type":"boolean","required":false,"description":"Modal open state","defaultValue":"false"},{"name":"placement","required":false,"description":"Vertical placement of the modal","defaultValue":"center"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"width","required":false,"description":"Sets a width on the container and uses next centering.\nFuture will default to `md`"},{"name":"onClickOverlay","type":"void","required":true,"description":"Callback for clicking the overlay"},{"name":"onClose","type":"void","required":true,"description":"The dismiss onClick callback"}],"ModalBodyProps":[{"name":"noSideSpacing","type":"boolean","required":false,"description":"Removes left, right paddings from the modal body when true","defaultValue":"false"}],"ModalCloseableHeaderProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"qa","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"onClose","type":"void","required":true}],"ModalContainerProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"placement","required":true},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"width","required":false}],"ModalProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"open","type":"boolean","required":false,"description":"Modal open state","defaultValue":"false"},{"name":"placement","required":false,"description":"Vertical placement of the modal","defaultValue":"center"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"width","required":false,"description":"Sets a width on the container and uses next centering.\nFuture will default to `md`"},{"name":"onClickOverlay","type":"void","required":true,"description":"Callback for clicking the overlay"}]}
|
package/dist/props/NextGrid.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"NextGridColProps":[{"name":"colStart","required":false,"description":"If given a number value between 1 and 12, sets start positions across all
|
|
1
|
+
{"NextGridColProps":[{"name":"colStart","required":false,"description":"If given a number value between 1 and 12, sets start positions across all\nbreakpoints."},{"name":"colWidth","required":false,"defaultValue":"auto\nIf given a number value between 1 and 12, sets column width across all\nbreakpoints.\n\nIf given an object, sets column widths for given breakpoints\n(keys in configuration object, e.g. {\"tabletMd\": 10, \"mobileLg\": 5}).\n\nIf set to \"auto\", the column will take all the available space"}],"NextGridContextShape":[{"name":"colStackCap","required":true},{"name":"gutterX","type":"NextGridSpacing","required":true},{"name":"gutterY","type":"NextGridSpacing","required":true}],"NextGridProps":[{"name":"colStackCap","required":false,"description":"Sets a breakpoing at which columns will start stacking on top of each other.\nE.g. if set to \"tabletMd\" - columns will stack on \"tabletMd\", \"tabletSm\"\nand \"mobileLg\" breakpoints."},{"name":"gutterX","type":"NextGridSpacing","required":false,"description":"If given a spacing string value (e.g. \"sm\" or \"none\"), sets horizontal\ncolumn spacing across all breakpoints."},{"name":"gutterY","type":"NextGridSpacing","required":false,"description":"If given a spacing string value (e.g. \"sm\" or \"none\"), sets vertical\ncolumn spacing across all breakpoints. Vertical spacing is only displayed\nwhen the columns are stacked (typically, on smaller breakpoints or\nas defined by \"colStackCap\")."}]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"CursorPosition":[{"name":"selection","type":"string","required":true},{"name":"selectionEnd","type":"number","required":true},{"name":"selectionStart","type":"number","required":true}],"NumberInputProps":[{"name":"decimalScale","required":false,"description":"The maximum number of fraction digits to use. Possible values range from 0 to 14. Setting to true will result in the maximum size, setting to false will allow 0 decimals, whole numbers only.","defaultValue":"true
|
|
1
|
+
{"CursorPosition":[{"name":"selection","type":"string","required":true},{"name":"selectionEnd","type":"number","required":true},{"name":"selectionStart","type":"number","required":true}],"NumberInputProps":[{"name":"decimalScale","required":false,"description":"The maximum number of fraction digits to use. Possible values range from 0 to 14. Setting to true will result in the maximum size, setting to false will allow 0 decimals, whole numbers only.","defaultValue":"true"},{"name":"defaultValue","required":false,"description":"Initial value of an uncontrolled component"},{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"fillDecimalScale","required":false,"description":"<Code>none</Code> prevents from adding zeros to match given\n<Code>decimalScale</Code>.<br /> <Code>always</Code> automatically adds\nzeros to match given\n<Code>decimalScale</Code>. <br />\n<Code>onBlur</Code> automatically adds zeros to match given{' '}\n<Code>decimalScale</Code> when input has lost focus."},{"name":"locale","required":false,"description":"A string with a BCP 47 language tag or an array of such strings which specifies number formatting.","defaultValue":"en-US"},{"name":"prefix","type":"string","required":false,"description":"A string which is added to input as a prefix."},{"name":"qa","type":"QaTags","required":false},{"name":"step","type":"number","required":false,"description":"A stepping interval which is used in incrementer. Zero value turns off incrementer.","defaultValue":"0"},{"name":"suffix","type":"string","required":false,"description":"A string which is added to input as a suffix"},{"name":"value","required":false,"description":"Value of a controlled component"},{"name":"onChange","type":"void","required":true,"description":"`(value: ValueChange) => void`, where `ValueChange` is an object `{ value: string, parsedNumber: number | null }`."}],"ParsedInputValue":[{"name":"decimal","type":"string","required":true},{"name":"fraction","type":"string","required":true},{"name":"integer","type":"string","required":true},{"name":"parsedNumber","type":"number","required":true}],"Separators":[{"name":"decimal","type":"string","required":true},{"name":"group","type":"string","required":true}],"UseNumberFormatConfig":[{"name":"decimalScale","required":false,"description":"The maximum number of fraction digits to use. Possible values range from 0 to 14. Setting to true will result in the maximum size, setting to false will allow 0 decimals, whole numbers only.","defaultValue":"true"},{"name":"fillDecimalScale","required":false,"description":"<Code>none</Code> prevents from adding zeros to match given\n<Code>decimalScale</Code>.<br /> <Code>always</Code> automatically adds\nzeros to match given\n<Code>decimalScale</Code>. <br />\n<Code>onBlur</Code> automatically adds zeros to match given{' '}\n<Code>decimalScale</Code> when input has lost focus."},{"name":"locale","required":false,"description":"A string with a BCP 47 language tag or an array of such strings which specifies number formatting.","defaultValue":"en-US"}],"ValueChange":[{"name":"parsedNumber","required":true},{"name":"value","type":"string","required":true}]}
|
package/dist/props/Pill.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"PillProps":[{"name":"color","required":false,"description":"Controls the border, background and color of the Pill","defaultValue":"gray
|
|
1
|
+
{"PillProps":[{"name":"color","required":false,"description":"Controls the border, background and color of the Pill","defaultValue":"gray"}]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"PillOptGroup":[{"name":"id","type":"Id","required":true},{"name":"label","type":"string","required":true}],"PillOption":[{"name":"color","type":"","required":true},{"name":"groupId","type":"Id","required":false},{"name":"id","type":"Id","required":true},{"name":"label","type":"string","required":true},{"name":"suggested","type":"boolean","required":false}],"PillOptionProps":[{"name":"color","type":"","required":true},{"name":"disabled","type":"boolean","required":false},{"name":"index","type":"number","required":false},{"name":"label","type":"string","required":true},{"name":"selected","type":"boolean","required":false,"description":"Represents the currently selected value. This option will be styled\ndifferently as well as receive UX to scroll into view and start list\nnavigation from this element."},{"name":"suggested","type":"boolean","required":false,"description":"If nothing is selected, suggest this option. Suggested options mimic the\nUX of a selected option, scroll into view and start list navigation from\nthis element."},{"name":"value","type":"any","required":true}],"PillSelectProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false,"description":"Make the Select button 100% width"},{"name":"disabled","type":"boolean","required":false},{"name":"emptyMessage","type":"string","required":false,"description":"When there are no children this will render"},{"name":"error","type":"boolean","required":false},{"name":"footer","type":"ReactNode","required":false},{"name":"hideDelay","type":"number","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the select's configurable strings.\nDefaults to using the core library's default strings."},{"name":"loading","type":"boolean","required":false,"description":"If the select is loading"},{"name":"onScrollBottom","required":false},{"name":"onSelect","required":false},{"name":"optgroups","required":false,"description":"Array of available option groups"},{"name":"options","required":false,"description":"Array of available options"},{"name":"optionsRef","type":"RefObject","required":false},{"name":"placeholder","type":"string","required":false,"description":"Renders when the label is blank"},{"name":"placement","type":"","required":false,"description":"The placement of the overlay"},{"name":"qa","type":"Partial","required":false},{"name":"showDelay","type":"number","required":false},{"name":"tabIndex","type":"number","required":false,"description":"Configurable tabIndex for the select button"},{"name":"value","type":"","required":true,"description":"Currently selected value"},{"name":"getColor","type":"","required":true,"description":"A function returning the display color of an option's `Pill`\n`(option: unknown) => PillColor`","defaultValue":"`(option) => (option as PillOption).color
|
|
1
|
+
{"PillOptGroup":[{"name":"id","type":"Id","required":true},{"name":"label","type":"string","required":true}],"PillOption":[{"name":"color","type":"","required":true},{"name":"groupId","type":"Id","required":false},{"name":"id","type":"Id","required":true},{"name":"label","type":"string","required":true},{"name":"suggested","type":"boolean","required":false}],"PillOptionProps":[{"name":"color","type":"","required":true},{"name":"disabled","type":"boolean","required":false},{"name":"index","type":"number","required":false},{"name":"label","type":"string","required":true},{"name":"selected","type":"boolean","required":false,"description":"Represents the currently selected value. This option will be styled\ndifferently as well as receive UX to scroll into view and start list\nnavigation from this element."},{"name":"suggested","type":"boolean","required":false,"description":"If nothing is selected, suggest this option. Suggested options mimic the\nUX of a selected option, scroll into view and start list navigation from\nthis element."},{"name":"value","type":"any","required":true}],"PillSelectProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false,"description":"Make the Select button 100% width"},{"name":"disabled","type":"boolean","required":false},{"name":"emptyMessage","type":"string","required":false,"description":"When there are no children this will render"},{"name":"error","type":"boolean","required":false},{"name":"footer","type":"ReactNode","required":false},{"name":"hideDelay","type":"number","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the select's configurable strings.\nDefaults to using the core library's default strings."},{"name":"loading","type":"boolean","required":false,"description":"If the select is loading"},{"name":"onScrollBottom","required":false},{"name":"onSelect","required":false},{"name":"optgroups","required":false,"description":"Array of available option groups"},{"name":"options","required":false,"description":"Array of available options"},{"name":"optionsRef","type":"RefObject","required":false},{"name":"placeholder","type":"string","required":false,"description":"Renders when the label is blank"},{"name":"placement","type":"","required":false,"description":"The placement of the overlay"},{"name":"qa","type":"Partial","required":false},{"name":"showDelay","type":"number","required":false},{"name":"tabIndex","type":"number","required":false,"description":"Configurable tabIndex for the select button"},{"name":"value","type":"","required":true,"description":"Currently selected value"},{"name":"getColor","type":"","required":true,"description":"A function returning the display color of an option's `Pill`\n`(option: unknown) => PillColor`","defaultValue":"`(option) => (option as PillOption).color`"},{"name":"getGroup","required":true,"description":"A function returning group ID for a given option to define a relation to `optgroups`\n`(option: unknown) => string | number`","defaultValue":"`(option) => (option as PillOption).groupId`"},{"name":"getId","type":"Id","required":true,"description":"A function returning ID of a given option\n`(option: unknown) => string | number`","defaultValue":"`(option) => (option as PillOption).id`"},{"name":"getLabel","type":"string","required":true,"description":"A function returning label of an option\n`(option: unknown) => string`","defaultValue":"`(option) => (option as PillOption).label`"},{"name":"getSuggested","required":true,"description":"A function returning `boolean` value to suggest this option if nothing is selected.\n`(option: unknown) => boolean`","defaultValue":"`(option) => (option as PillOption).suggested`"},{"name":"groupGetId","type":"Id","required":true,"description":"A function returning the ID of a group\n`(group: unknown) => string | number`","defaultValue":"`(group) => (group as PillOptgroup).id`"},{"name":"groupGetLabel","type":"string","required":true,"description":"A function returning label of a group\n`(group: unknown) => string`","defaultValue":"`(group) => (group as PillOptgroup).label`"},{"name":"onClear","type":"void","required":true,"description":"It is possible for this component to have an empty value\n(render placeholder). Enables the x icon."},{"name":"onSearch","type":"void","required":true,"description":"Adds a search bar to the select."}]}
|
package/dist/props/Popover.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"PopoverContentProps":[{"name":"fluid","type":"boolean","required":false},{"name":"placement","type":"Placement","required":false}],"PopoverProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"initialIsVisible","type":"boolean","required":false,"description":"Whether to show the overlay on initial render","defaultValue":"false
|
|
1
|
+
{"PopoverContentProps":[{"name":"fluid","type":"boolean","required":false},{"name":"placement","type":"Placement","required":false}],"PopoverProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"initialIsVisible","type":"boolean","required":false,"description":"Whether to show the overlay on initial render","defaultValue":"false"},{"name":"overlay","type":"ReactElement","required":false,"description":"The tip we want to display"},{"name":"placement","type":"Placement","required":false,"description":"Determines the position of the arrow","defaultValue":"top"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"trigger","type":"TriggerVariant","required":false,"description":"The event to trigger the overlay","defaultValue":"click"}]}
|
package/dist/props/Search.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"SearchHook":[{"name":"domHandlers","required":true},{"name":"isEmpty","type":"boolean","required":true},{"name":"showSearch","type":"boolean","required":true},{"name":"value","type":"string","required":true},{"name":"clear","type":"void","required":true},{"name":"onChange","type":"void","required":true},{"name":"submit","type":"void","required":true}],"SearchHookConfig":[{"name":"initialValue","type":"string","required":false},{"name":"typeahead","type":"boolean","required":false,"deprecated":"\n\nThe `typeahead` prop has been deprecated and will be removed in a future version.\n\nA new component, `Typeahead`, has been introduced with specific UX for typeahead-like\nbehavior. Please use this component instead.\n\n**Before**\n\n<Search typeahead onChange={() => { ... }} />\n\n**After**\n\n<Typeahead onChange={() => { ... }} />\n"},{"name":"onChange","type":"void","required":true,"deprecated":"\n\nThe `onChange` prop has been deprecated and will be removed in a future version.\n\nA new component, `Typeahead`, has been introduced with specific UX for typeahead-like\nbehavior. Please use this component instead.\n\n**Before**\n\n<Search typeahead onChange={() => { ... }} />\n\n**After**\n\n<Typeahead onChange={() => { ... }} />\n"},{"name":"onClear","type":"void","required":true},{"name":"onSubmit","type":"void","required":true,"description":"<div>Input handler for search variant</div>\n<CodeBlock>(value: string) => void</CodeBlock>"}],"SearchProps":[{"name":"autoFocus","type":"boolean","required":false},{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"initialValue","type":"string","required":false},{"name":"typeahead","type":"boolean","required":false,"deprecated":"\n\nThe `typeahead` prop has been deprecated and will be removed in a future version.\n\nA new component, `Typeahead`, has been introduced with specific UX for typeahead-like\nbehavior. Please use this component instead.\n\n**Before**\n\n<Search typeahead onChange={() => { ... }} />\n\n**After**\n\n<Typeahead onChange={() => { ... }} />\n"},{"name":"usingHook","type":"","required":false},{"name":"value","type":"string","required":false,"description":"Initial value string"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead
|
|
1
|
+
{"SearchHook":[{"name":"domHandlers","required":true},{"name":"isEmpty","type":"boolean","required":true},{"name":"showSearch","type":"boolean","required":true},{"name":"value","type":"string","required":true},{"name":"clear","type":"void","required":true},{"name":"onChange","type":"void","required":true},{"name":"submit","type":"void","required":true}],"SearchHookConfig":[{"name":"initialValue","type":"string","required":false},{"name":"typeahead","type":"boolean","required":false,"deprecated":"\n\nThe `typeahead` prop has been deprecated and will be removed in a future version.\n\nA new component, `Typeahead`, has been introduced with specific UX for typeahead-like\nbehavior. Please use this component instead.\n\n**Before**\n\n<Search typeahead onChange={() => { ... }} />\n\n**After**\n\n<Typeahead onChange={() => { ... }} />\n"},{"name":"onChange","type":"void","required":true,"deprecated":"\n\nThe `onChange` prop has been deprecated and will be removed in a future version.\n\nA new component, `Typeahead`, has been introduced with specific UX for typeahead-like\nbehavior. Please use this component instead.\n\n**Before**\n\n<Search typeahead onChange={() => { ... }} />\n\n**After**\n\n<Typeahead onChange={() => { ... }} />\n"},{"name":"onClear","type":"void","required":true},{"name":"onSubmit","type":"void","required":true,"description":"<div>Input handler for search variant</div>\n<CodeBlock>(value: string) => void</CodeBlock>"}],"SearchProps":[{"name":"autoFocus","type":"boolean","required":false},{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"initialValue","type":"string","required":false},{"name":"typeahead","type":"boolean","required":false,"deprecated":"\n\nThe `typeahead` prop has been deprecated and will be removed in a future version.\n\nA new component, `Typeahead`, has been introduced with specific UX for typeahead-like\nbehavior. Please use this component instead.\n\n**Before**\n\n<Search typeahead onChange={() => { ... }} />\n\n**After**\n\n<Typeahead onChange={() => { ... }} />\n"},{"name":"usingHook","type":"","required":false},{"name":"value","type":"string","required":false,"description":"Initial value string"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead"},{"name":"onClear","type":"void","required":true},{"name":"onSubmit","type":"void","required":true,"description":"<div>Input handler for search variant</div>\n<CodeBlock>(value: string) => void</CodeBlock>"}]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"SegmentedControllerProps":[{"name":"active","type":"number","required":false,"description":"The segment is active"},{"name":"block","type":"boolean","required":false,"description":"The segment controller is block sized"},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"disabled","type":"boolean","required":false,"description":"Disables all segments in the controller"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","required":false,"deprecated":"Please use the `block` prop
|
|
1
|
+
{"SegmentedControllerProps":[{"name":"active","type":"number","required":false,"description":"The segment is active"},{"name":"block","type":"boolean","required":false,"description":"The segment controller is block sized"},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"disabled","type":"boolean","required":false,"description":"Disables all segments in the controller"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","required":false,"deprecated":"Please use the `block` prop"},{"name":"onChange","type":"void","required":true}],"SegmentedControllerSegmentProps":[{"name":"active","type":"boolean","required":false,"description":"The segment is active"},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"disabled","type":"boolean","required":false,"description":"Is the segment disabled"},{"name":"placement","type":"Placement","required":false,"description":"To change the tooltip placement"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tooltip","type":"ReactNode","required":false,"description":"The tooltip we want to display on hover"}],"SegmentedControllerTooltipProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"overlay","type":"any","required":false},{"name":"placement","type":"Placement","required":true},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}]}
|
package/dist/props/Slider.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"SliderProps":[{"name":"disabled","type":"boolean","required":false,"description":"Whether or not to put the slider into a disabled state."},{"name":"max","type":"number","required":false,"description":"The maximum value of the slider (right side)","defaultValue":"100
|
|
1
|
+
{"SliderProps":[{"name":"disabled","type":"boolean","required":false,"description":"Whether or not to put the slider into a disabled state."},{"name":"max","type":"number","required":false,"description":"The maximum value of the slider (right side)","defaultValue":"100"},{"name":"min","type":"number","required":false,"description":"The minimum value of the slider (left side)","defaultValue":"0"},{"name":"showLabel","type":"boolean","required":false,"description":"Whether or not to show value labels below the slider increments."},{"name":"step","type":"number","required":false,"description":"The distance between each stopping point on the Slider.","defaultValue":"1"},{"name":"value","type":"number","required":false,"description":"The currently set value of the Slider.\nDefaults to the middle between min and max.","defaultValue":"(max < min) ? min : min + (max - min)/2;"}]}
|
package/dist/props/Spinner.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"SpinnerProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"color","type":"Color","required":false,"description":"<span>\n Spinner color, one of the{' '}\n <Link to=\"/web/style/colors/#hsl-palette\">HSL Palette</Link> css\n strings\n</span>"},{"name":"label","type":"string","required":false,"description":"The spinner label, only displayed when used as an overlay"},{"name":"loading","type":"boolean","required":false,"description":"The spinner will show if loading is true"},{"name":"size","required":false,"description":"The size of the spinner"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","required":false,"deprecated":"\"variant\" prop will be removed in a future version
|
|
1
|
+
{"SpinnerProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"color","type":"Color","required":false,"description":"<span>\n Spinner color, one of the{' '}\n <Link to=\"/web/style/colors/#hsl-palette\">HSL Palette</Link> css\n strings\n</span>"},{"name":"label","type":"string","required":false,"description":"The spinner label, only displayed when used as an overlay"},{"name":"loading","type":"boolean","required":false,"description":"The spinner will show if loading is true"},{"name":"size","required":false,"description":"The size of the spinner"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","required":false,"deprecated":"\"variant\" prop will be removed in a future version.\nUse \"color\" prop instead to set a spinner's color."}]}
|
package/dist/props/Table.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"BodyCellProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"snugfit","type":"boolean","required":false,"description":"Shrink the cell around the contents"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","type":"TableCellVariant","required":false,"description":"The table body cell variant"}],"BodyRowProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"overdue","type":"boolean","required":false,"description":"Sets row text color to red to signify overdue items"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"CaratProps":[{"name":"expanded","type":"boolean","required":false,"description":"Whether or not the carat is rotated"},{"name":"onClick","required":true}],"CurrencyCellProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"DateSelectCellProps":[{"name":"beforeHide","type":"BeforeCallback","required":false,"description":"<div>\n The callback to run before the overlay is hidden. Returning\n <Code>false</Code> will prevent hiding.\n</div>\n<CodeBlock>(e: event) => boolean | Promise | undefined</CodeBlock>"},{"name":"beforeShow","type":"BeforeCallback","required":false,"description":"<div>\n The callback to run before the overlay is shown. Returning\n <Code>false</Code> will prevent showing.\n</div>\n<CodeBlock>(e: event) => boolean | Promise | undefined</CodeBlock>"},{"name":"className","type":"string","required":false
|
|
1
|
+
{"BodyCellProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"snugfit","type":"boolean","required":false,"description":"Shrink the cell around the contents"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","type":"TableCellVariant","required":false,"description":"The table body cell variant"}],"BodyRowProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"overdue","type":"boolean","required":false,"description":"Sets row text color to red to signify overdue items"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"CaratProps":[{"name":"expanded","type":"boolean","required":false,"description":"Whether or not the carat is rotated"},{"name":"onClick","required":true}],"CurrencyCellProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"DateSelectCellProps":[{"name":"beforeHide","type":"BeforeCallback","required":false,"description":"<div>\n The callback to run before the overlay is hidden. Returning\n <Code>false</Code> will prevent hiding.\n</div>\n<CodeBlock>(e: event) => boolean | Promise | undefined</CodeBlock>"},{"name":"beforeShow","type":"BeforeCallback","required":false,"description":"<div>\n The callback to run before the overlay is shown. Returning\n <Code>false</Code> will prevent showing.\n</div>\n<CodeBlock>(e: event) => boolean | Promise | undefined</CodeBlock>"},{"name":"className","type":"string","required":false},{"name":"disabled","type":"boolean","required":false},{"name":"error","type":"boolean","required":false,"description":"Error variant"},{"name":"errorMessage","type":"string","required":false,"description":"Message to be displayed below the date select during an error"},{"name":"processing","type":"boolean","required":false,"description":"Triggers the spinner that covers inline editable content"},{"name":"tabIndex","type":"number","required":false},{"name":"value","type":"Date","required":false},{"name":"variant","type":"DateInputVariant","required":false},{"name":"afterHide","type":"void","required":true},{"name":"afterShow","type":"void","required":true},{"name":"disabledDate","type":"boolean","required":true},{"name":"onChange","type":"void","required":true},{"name":"onClear","type":"void","required":true}],"GroupProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"colSpan","type":"number","required":false,"description":"Number of columns in table"},{"name":"depth","type":"number","required":false,"description":"Determines indentation of the group and content"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"GroupTitleProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"HeaderCellProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"snugfit","type":"boolean","required":false,"description":"Shrink the cell around the contents"},{"name":"sortable","type":"boolean","required":false,"description":"Is this the column sortable"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","type":"TableCellVariant","required":false,"description":"Allows for setting ascending or descending sorting icon"}],"IconCellProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"InputCellProps":[{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"errorMessage","type":"string","required":false,"description":"Message to be displayed below the input during an error"},{"name":"processing","type":"boolean","required":false,"description":"Triggers the spinner for processing inline editable content"},{"name":"size","type":"InputCellSize","required":false,"description":"The size of the input cell and corresponding error message"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead"}],"LinkCellProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"href","type":"string","required":true,"description":"Destination url"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"SelectCellProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false,"description":"Make the Select button 100% width"},{"name":"disabled","type":"boolean","required":false},{"name":"emptyMessage","type":"string","required":false,"description":"When there are no children this will render"},{"name":"error","type":"boolean","required":false},{"name":"errorMessage","type":"string","required":false,"description":"Message to be displayed below the select during an error"},{"name":"footer","type":"ReactNode","required":false},{"name":"hideDelay","type":"number","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the select's configurable strings.\nDefaults to using the core library's default strings."},{"name":"label","type":"ReactNode","required":false},{"name":"loading","type":"boolean","required":false,"description":"If the select is loading"},{"name":"onScrollBottom","required":false},{"name":"onSelect","required":false},{"name":"optionsRef","type":"RefObject","required":false},{"name":"placeholder","type":"string","required":false,"description":"Renders when the label is blank"},{"name":"placement","type":"","required":false,"description":"The placement of the overlay"},{"name":"processing","type":"boolean","required":false,"description":"Triggers the spinner that covers inline editable content"},{"name":"qa","type":"Partial","required":false},{"name":"showDelay","type":"number","required":false},{"name":"tabIndex","type":"number","required":false,"description":"Configurable tabIndex for the select button"},{"name":"onClear","type":"void","required":true,"description":"It is possible for this component to have an empty value\n(render placeholder). Enables the x icon."},{"name":"onSearch","type":"void","required":true,"description":"Adds a search bar to the select."}],"TableProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"inline","type":"boolean","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","type":"TableVariant","required":false,"description":"The table variant"}],"TextAreaCellProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"errorMessage","type":"string","required":false,"description":"Message to be displayed below the textarea during an error"},{"name":"processing","type":"boolean","required":false,"description":"Triggers the spinner for processing inline editable content"},{"name":"resizable","type":"boolean","required":false,"description":"Sets whether it is resizable"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"TextCellProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}]}
|
package/dist/props/Tabs.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"TabProps":[{"name":"active","type":"boolean","required":false,"description":"The tab is active"},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"dark","type":"boolean","required":false,"description":"Whether or not tab is in dark mode"},{"name":"dropdown","type":"boolean","required":false,"deprecated":"This was never intended to be a public facing API and does not\ndo anything. It will be removed in the future
|
|
1
|
+
{"TabProps":[{"name":"active","type":"boolean","required":false,"description":"The tab is active"},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"dark","type":"boolean","required":false,"description":"Whether or not tab is in dark mode"},{"name":"dropdown","type":"boolean","required":false,"deprecated":"This was never intended to be a public facing API and does not\ndo anything. It will be removed in the future."},{"name":"overflowing","type":"boolean","required":false,"deprecated":"This was never intended to be a public facing API and does not\ndo anything. It will be removed in the future."},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","type":"TabVariant","required":false,"deprecated":"please use the `active` and `dark` props to configure style. The\n`dropdown`, `hover`, and `overflowing` variants were only for internal use\nand should not be used in clients"},{"name":"onMount","type":"void","required":true},{"name":"onUnmount","type":"void","required":true}],"TabsProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"dark","type":"boolean","required":false},{"name":"qa","type":"QaTags","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"InternalTieredDropdownProps":[{"name":"block","type":"boolean","required":false,"description":"Sets the button to be 100% of the width of its parent"},{"name":"children","type":"ReactText","required":true},{"name":"data-qa","type":"string","required":false},{"name":"icon","type":"ReactNode","required":false,"description":"string icons have been deprecated, please pass a component from `@procore/core-icons`\nThe icon to display on the left side of the label"},{"name":"iconRight","type":"ReactNode","required":false,"description":"The icon to display on the right side of the label"},{"name":"loading","type":"boolean","required":false,"description":"Shows the button spinner"},{"name":"options","required":false},{"name":"size","type":"","required":false,"description":"The size of the button"},{"name":"value","required":false},{"name":"variant","type":"","required":false}],"TieredDropdownProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false},{"name":"children","type":"ReactText","required":true},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false},{"name":"error","type":"boolean","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the tiered select's configurable strings
|
|
1
|
+
{"InternalTieredDropdownProps":[{"name":"block","type":"boolean","required":false,"description":"Sets the button to be 100% of the width of its parent"},{"name":"children","type":"ReactText","required":true},{"name":"data-qa","type":"string","required":false},{"name":"icon","type":"ReactNode","required":false,"description":"string icons have been deprecated, please pass a component from `@procore/core-icons`\nThe icon to display on the left side of the label"},{"name":"iconRight","type":"ReactNode","required":false,"description":"The icon to display on the right side of the label"},{"name":"loading","type":"boolean","required":false,"description":"Shows the button spinner"},{"name":"options","required":false},{"name":"size","type":"","required":false,"description":"The size of the button"},{"name":"value","required":false},{"name":"variant","type":"","required":false}],"TieredDropdownProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false},{"name":"children","type":"ReactText","required":true},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false},{"name":"error","type":"boolean","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the tiered select's configurable strings.\nDefaults to using the core library's default strings."},{"name":"icon","type":"ReactNode","required":false,"description":"string icons have been deprecated, please pass a component from `@procore/core-icons`\nThe icon to display on the left side of the label"},{"name":"iconRight","type":"ReactNode","required":false,"description":"The icon to display on the right side of the label"},{"name":"loading","type":"boolean","required":false},{"name":"loadingMore","type":"boolean","required":false,"description":"Used to display a loading indicator as the last item of the list. Can\nbe used with <Code>onScrollBottom</Code> or <Code>onSearch</Code>{' '}\n(empty <Code>options</Code> during search async call) to indicate the\nloading of new items."},{"name":"onClear","required":false},{"name":"onScrollBottom","required":false},{"name":"onSearch","required":false},{"name":"onSelect","required":true},{"name":"options","required":false,"description":"Flat array of tier objects, this array is used as data for the component"},{"name":"selectableTiers","type":"boolean","required":false,"description":"If true, any tier is selectable. If false, only leaf nodes are selectable"},{"name":"size","type":"","required":false,"description":"The size of the button"},{"name":"tabIndex","type":"number","required":false},{"name":"variant","type":"","required":false},{"name":"getGroupId","type":"Id","required":true,"description":"Callback for using a custom <Code>tier</Code> shape\n<CodeBlock>{'(tier: any) => Id'}</CodeBlock>\nDefaults to <CodeBlock>{'(tier: any) => tier.GroupId'}</CodeBlock>"},{"name":"getId","type":"Id","required":true,"description":"Callback for using a custom <Code>tier</Code> shape\n<CodeBlock>{'(tier: any) => Id'}</CodeBlock>\nDefaults to <CodeBlock>{'(tier: any) => tier.Id'}</CodeBlock>"},{"name":"getLabel","required":true,"description":"Callback for using a custom <Code>tier</Code> shape\n<CodeBlock>{'(tier: any) => string'}</CodeBlock>\nDefaults to <CodeBlock>{'(tier: any) => tier.Label'}</CodeBlock>"},{"name":"getNextGroupId","type":"Id","required":true,"description":"Callback for using a custom <Code>tier</Code> shape\n<CodeBlock>{'(tier: any) => Id'}</CodeBlock>\nDefaults to <CodeBlock>{'(tier: any) => tier.NextGroupId'}</CodeBlock>"},{"name":"isLeaf","type":"boolean","required":true},{"name":"isTierDisabled","required":true},{"name":"onNavigate","type":"void","required":true,"description":"Callback for when navigation occurs. Triggered by the left and right\narrow keys, or clicking a navigable item. Returns the id of the next\ngroup that will be navigated to, and the updated path.\n<CodeBlock>\n {'(nextGroupId: string | number | undefined, path: any[]) => '}\n</CodeBlock>"},{"name":"onQuickCreate","type":"void","required":true,"description":"Pass this callback when a quick create experience is desired. Called\nwhen the \"create\" button in quick create mode is clicked. Returns the\nvalue of the quick create input.\n<CodeBlock>{'(string) =>'}</CodeBlock>"}]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"TieredSelectProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false},{"name":"disabled","type":"boolean","required":false},{"name":"error","type":"boolean","required":false},{"name":"getValueString","type":"GetValueString","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the tiered select's configurable strings
|
|
1
|
+
{"TieredSelectProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false},{"name":"disabled","type":"boolean","required":false},{"name":"error","type":"boolean","required":false},{"name":"getValueString","type":"GetValueString","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the tiered select's configurable strings.\nDefaults to using the core library's default strings."},{"name":"loading","type":"boolean","required":false},{"name":"loadingMore","type":"boolean","required":false,"description":"Used to display a loading indicator as the last item of the list. Can\nbe used with <Code>onScrollBottom</Code> or <Code>onSearch</Code>{' '}\n(empty <Code>options</Code> during search async call) to indicate the\nloading of new items."},{"name":"onClear","required":false},{"name":"onScrollBottom","required":false},{"name":"onSearch","required":false},{"name":"options","required":false,"description":"Flat array of tier objects, this array is used as data for the component"},{"name":"selectableTiers","type":"boolean","required":false,"description":"If true, any tier is selectable. If false, only leaf nodes are selectable"},{"name":"tabIndex","type":"number","required":false},{"name":"value","required":false,"description":"Flat array of tier objects that represents the selected value"},{"name":"getGroupId","type":"Id","required":true,"description":"Callback for using a custom <Code>tier</Code> shape\n<CodeBlock>{'(tier: any) => Id'}</CodeBlock>\nDefaults to <CodeBlock>{'(tier: any) => tier.GroupId'}</CodeBlock>"},{"name":"getId","type":"Id","required":true,"description":"Callback for using a custom <Code>tier</Code> shape\n<CodeBlock>{'(tier: any) => Id'}</CodeBlock>\nDefaults to <CodeBlock>{'(tier: any) => tier.Id'}</CodeBlock>"},{"name":"getLabel","required":true,"description":"Callback for using a custom <Code>tier</Code> shape\n<CodeBlock>{'(tier: any) => string'}</CodeBlock>\nDefaults to <CodeBlock>{'(tier: any) => tier.Label'}</CodeBlock>"},{"name":"getNextGroupId","type":"Id","required":true,"description":"Callback for using a custom <Code>tier</Code> shape\n<CodeBlock>{'(tier: any) => Id'}</CodeBlock>\nDefaults to <CodeBlock>{'(tier: any) => tier.NextGroupId'}</CodeBlock>"},{"name":"isLeaf","type":"boolean","required":true},{"name":"isTierDisabled","required":true},{"name":"onChange","type":"void","required":true,"description":"<div>\n Callback for selecting an item from the tiered select. Returns the{' '}\n <Code>Selection</Code> object from the <Code>Menu</Code> api, along\n with the updated <Code>value</Code>\n</div>\n<CodeBlock>\n {'(Selection: { event, item, group }, value) =>'}\n</CodeBlock>"},{"name":"onNavigate","type":"void","required":true,"description":"Callback for when navigation occurs. Triggered by the left and right\narrow keys, or clicking a navigable item. Returns the id of the next\ngroup that will be navigated to, and the updated path.\n<CodeBlock>\n {'(nextGroupId: string | number | undefined, path: any[]) => '}\n</CodeBlock>"},{"name":"onQuickCreate","type":"void","required":true,"description":"Pass this callback when a quick create experience is desired. Called\nwhen the \"create\" button in quick create mode is clicked. Returns the\nvalue of the quick create input.\n<CodeBlock>{'(string) =>'}</CodeBlock>"}]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"ToolHeaderBadgeProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","required":true,"description":"Controls the background/border/text colors of the Badge's pill"}],"ToolHeaderIconProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"icon","type":"string","required":false,"deprecated":"this will take an icon from '@procore/core-icons/dist' package\nin the near future. See Icon List page for further details
|
|
1
|
+
{"ToolHeaderBadgeProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","required":true,"description":"Controls the background/border/text colors of the Badge's pill"}],"ToolHeaderIconProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"icon","type":"string","required":false,"deprecated":"this will take an icon from '@procore/core-icons/dist' package\nin the near future. See Icon List page for further details"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}]}
|
package/dist/props/Tree.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"DefaultNode":[{"name":"id","required":true},{"name":"name","type":"string","required":true},{"name":"parentId","required":true},{"name":"type","type":"NodeType","required":true}],"IconContainerProps":[{"name":"alignContent","type":"","required":false},{"name":"alignItems","type":"","required":false},{"name":"alignSelf","type":"","required":false},{"name":"as","required":false,"description":"Render semantic HTML tags with browser reset and normalize CSS"},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"display","type":"","required":false},{"name":"flex","required":false,"description":"Alias to the `flex` property on a flexbox child."},{"name":"flexBasis","required":false,"description":"Alias to the `basis` property on a flexbox child."},{"name":"flexDirection","type":"","required":false,"description":"Alias to the `direction` property on a flexbox child."},{"name":"flexGrow","required":false,"description":"Alias to the `grow` property on a flexbox child."},{"name":"flexShrink","required":false,"description":"Alias to the `shrink` property on a flexbox child."},{"name":"flexWrap","type":"","required":false,"description":"Alias to the `wrap` property on a flexbox child."},{"name":"isSelected","type":"boolean","required":false},{"name":"justifyContent","type":"","required":false},{"name":"margin","type":"string","required":false},{"name":"marginBottom","type":"","required":false},{"name":"marginLeft","type":"","required":false},{"name":"marginRight","type":"","required":false},{"name":"marginTop","type":"","required":false},{"name":"order","type":"number","required":false,"description":"Alias to the `order` property on a flexbox child"},{"name":"padding","type":"string","required":false},{"name":"paddingBottom","type":"","required":false},{"name":"paddingLeft","type":"","required":false},{"name":"paddingRight","type":"","required":false},{"name":"paddingTop","type":"","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false},{"name":"textAlign","type":"","required":false}],"LevelWise":[{"name":"level","type":"number","required":true}],"Node":[{"name":"id","required":true}],"TreeNodeAPI":[{"name":"isFileLimitReached","type":"boolean","required":true},{"name":"isTreeFocused","type":"boolean","required":true},{"name":"nodes","required":true},{"name":"selectionLimit","type":"number","required":true},{"name":"treeContainer","type":"HTMLDivElement","required":true},{"name":"getIcon","type":"ReactNode","required":true},{"name":"getLabel","type":"string","required":true},{"name":"getType","type":"NodeType","required":true},{"name":"handleExpansion","type":"void","required":true},{"name":"handleSelection","type":"void","required":true},{"name":"highlight","type":"void","required":true},{"name":"isExpandable","type":"boolean","required":true},{"name":"isExpanded","type":"boolean","required":true},{"name":"isHighlighted","type":"boolean","required":true},{"name":"isLoading","type":"boolean","required":true},{"name":"isSelectable","type":"boolean","required":true},{"name":"isSelected","type":"boolean","required":true},{"name":"rowRenderer","type":"ReactNode","required":true}],"TreeNodeProps":[{"name":"data","type":"","required":true}],"TreeProps":[{"name":"autoExpandParent","type":"boolean","required":false,"description":"Whether to expand parent node when a child node is expanded or selected"},{"name":"expanded","required":false,"description":"Array of keys of initially expanded nodes"},{"name":"maxVisibleNodes","type":"number","required":false,"description":"Number of visible nodes. Helps fix performance bottlenecks in large dataset"},{"name":"multiple","type":"boolean","required":false,"description":"Allows selection of multiple nodes"},{"name":"options","type":"","required":true},{"name":"selected","required":false,"description":"Array of keys of initially selected nodes"},{"name":"selectionLimit","type":"number","required":false,"description":"Number of nodes that can be selected"},{"name":"visibleHeight","type":"number","required":false,"description":"Height of the list. Helps fix performance bottlenecks in large dataset."},{"name":"getChildren","required":true,"description":"Should return an array of children nodes.\n<CodeBlock>{'(node: Node): Node[]'}</CodeBlock>"},{"name":"getIcon","type":"ReactNode","required":true,"description":"This function will be executed on each node. Should return{' '}\n<Code>Icon</Code> component\n<CodeBlock>{'(node: Node): React.ReactNode'}</CodeBlock>"},{"name":"getLabel","type":"string","required":true,"description":"This function will be executed on each node. Should return{' '}\n<Code>label</Code> for row\n<CodeBlock>{'(node: Node): string'}</CodeBlock>"},{"name":"getParentId","required":true,"description":"This function will be executed on each node. Should return parent{' '}\n<Code>Node</Code>\n<CodeBlock>{'(node: Node): NodeId'}</CodeBlock>"},{"name":"getRoot","type":"","required":true,"description":"Function should return parent <Code>Root Node</Code>\n<CodeBlock>{'(): Node'}</CodeBlock>"},{"name":"getType","type":"NodeType","required":true,"description":"This function will be executed on each node. Should return{' '}\n<Code>'branch'</Code> or <Code>'leaf'</Code>\n<CodeBlock>{'(node: Node): NodeType'}</CodeBlock>"},{"name":"isExpandable","type":"boolean","required":true,"description":"Function of whether to enable tree node expansion/collapsing.\n<CodeBlock>{'(node: Node): boolean'}</CodeBlock>"},{"name":"isSelectable","type":"boolean","required":true,"description":"Function of whether to enable tree node selection.\n<CodeBlock>{'(node: Node): boolean'}</CodeBlock>"},{"name":"onCollapse","type":"void","required":true,"description":"Triggers when current node collapse\n<CodeBlock>{'(node: Node): void'}</CodeBlock>"},{"name":"onExpand","type":"Promise","required":true,"description":"Triggers when current node expand\n<CodeBlock>{'(node: Node): Promise<void>'}</CodeBlock>"},{"name":"onSelect","type":"void","required":true,"description":"Callback return currently selected array of nodes.\n<CodeBlock>{'(nodes: Node[]): void'}</CodeBlock>"},{"name":"rowRenderer","type":"ReactNode","required":true,"description":"Callback for rendering tree nodes\n<CodeBlock>{'(props: TreeRowProps): React.ReactNode'}</CodeBlock>"}],"TreeRef":[{"name":"rootEl","required":true},{"name":"setExpanded","type":"void","required":true},{"name":"setSelected","type":"void","required":true},{"name":"toggleExpanded","type":"void","required":true},{"name":"toggleSelected","type":"void","required":true}],"TreeRowContainerProps":[{"name":"isExpandable","type":"boolean","required":true},{"name":"isFileLimitReached","type":"boolean","required":true},{"name":"isHighlighted","type":"boolean","required":true},{"name":"isSelectable","type":"boolean","required":true},{"name":"isSelected","type":"boolean","required":true},{"name":"level","type":"number","required":true}],"TreeRowOverlayProps":[{"name":"message","required":true},{"name":"overlayRef","type":"RefObject","required":true},{"name":"targetRef","type":"RefObject","required":true}],"TreeRowProps":[{"name":"isFileLimitReached","type":"boolean","required":true},{"name":"isMouseOver","type":"boolean","required":true},{"name":"node","required":true},{"name":"selectionLimit","type":"number","required":true},{"name":"shouldShowTooltip","type":"boolean","required":true},{"name":"treeContainer","type":"HTMLDivElement","required":true},{"name":"getIcon","type":"ReactNode","required":true},{"name":"getLabel","type":"string","required":true},{"name":"getType","type":"NodeType","required":true},{"name":"handleExpansion","type":"void","required":true},{"name":"handleSelection","type":"void","required":true},{"name":"isExpandable","type":"boolean","required":true},{"name":"isExpanded","type":"boolean","required":true},{"name":"isHighlighted","type":"boolean","required":true},{"name":"isLoading","type":"boolean","required":true},{"name":"isSelectable","type":"boolean","required":true},{"name":"isSelected","type":"boolean","required":true}],"TreeRowTooltipProps":[{"name":"fileName","type":"string","required":true},{"name":"isFileLimitReached","type":"boolean","required":true},{"name":"isHighlighted","type":"boolean","required":true},{"name":"isMouseOver","type":"boolean","required":true},{"name":"isSelectable","type":"boolean","required":true},{"name":"isSelected","type":"boolean","required":true},{"name":"nodeType","type":"NodeType","required":true},{"name":"selectionLimit","type":"number","required":true},{"name":"shouldShowTooltip","type":"boolean","required":true},{"name":"treeContainer","type":"HTMLDivElement","required":true}],"UseTreeProps":[{"name":"autoExpandParent","type":"boolean","required":true},{"name":"expanded","required":true},{"name":"multiple","type":"boolean","required":true},{"name":"options","type":"","required":true},{"name":"selected","required":true},{"name":"selectionLimit","type":"number","required":true},{"name":"getChildren","required":true},{"name":"getParentId","required":true},{"name":"getRoot","type":"","required":true},{"name":"onCollapse","type":"void","required":true},{"name":"onExpand","type":"Promise","required":true},{"name":"onSelect","type":"void","required":true}]}
|
|
1
|
+
{"DefaultNode":[{"name":"id","required":true},{"name":"name","type":"string","required":true},{"name":"parentId","required":true},{"name":"type","type":"NodeType","required":true}],"IconContainerProps":[{"name":"alignContent","type":"","required":false},{"name":"alignItems","type":"","required":false},{"name":"alignSelf","type":"","required":false},{"name":"as","required":false,"description":"Render semantic HTML tags with browser reset and normalize CSS"},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"display","type":"","required":false},{"name":"flex","required":false,"description":"Alias to the `flex` property on a flexbox child."},{"name":"flexBasis","required":false,"description":"Alias to the `basis` property on a flexbox child."},{"name":"flexDirection","type":"","required":false,"description":"Alias to the `direction` property on a flexbox child."},{"name":"flexGrow","required":false,"description":"Alias to the `grow` property on a flexbox child."},{"name":"flexShrink","required":false,"description":"Alias to the `shrink` property on a flexbox child."},{"name":"flexWrap","type":"","required":false,"description":"Alias to the `wrap` property on a flexbox child."},{"name":"isSelected","type":"boolean","required":false},{"name":"justifyContent","type":"","required":false},{"name":"margin","type":"string","required":false},{"name":"marginBottom","type":"","required":false},{"name":"marginLeft","type":"","required":false},{"name":"marginRight","type":"","required":false},{"name":"marginTop","type":"","required":false},{"name":"order","type":"number","required":false,"description":"Alias to the `order` property on a flexbox child."},{"name":"padding","type":"string","required":false},{"name":"paddingBottom","type":"","required":false},{"name":"paddingLeft","type":"","required":false},{"name":"paddingRight","type":"","required":false},{"name":"paddingTop","type":"","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false},{"name":"textAlign","type":"","required":false}],"LevelWise":[{"name":"level","type":"number","required":true}],"Node":[{"name":"id","required":true}],"TreeNodeAPI":[{"name":"isFileLimitReached","type":"boolean","required":true},{"name":"isTreeFocused","type":"boolean","required":true},{"name":"nodes","required":true},{"name":"selectionLimit","type":"number","required":true},{"name":"treeContainer","type":"HTMLDivElement","required":true},{"name":"getIcon","type":"ReactNode","required":true},{"name":"getLabel","type":"string","required":true},{"name":"getType","type":"NodeType","required":true},{"name":"handleExpansion","type":"void","required":true},{"name":"handleSelection","type":"void","required":true},{"name":"highlight","type":"void","required":true},{"name":"isExpandable","type":"boolean","required":true},{"name":"isExpanded","type":"boolean","required":true},{"name":"isHighlighted","type":"boolean","required":true},{"name":"isLoading","type":"boolean","required":true},{"name":"isSelectable","type":"boolean","required":true},{"name":"isSelected","type":"boolean","required":true},{"name":"rowRenderer","type":"ReactNode","required":true}],"TreeNodeProps":[{"name":"data","type":"","required":true}],"TreeProps":[{"name":"autoExpandParent","type":"boolean","required":false,"description":"Whether to expand parent node when a child node is expanded or selected"},{"name":"expanded","required":false,"description":"Array of keys of initially expanded nodes"},{"name":"maxVisibleNodes","type":"number","required":false,"description":"Number of visible nodes. Helps fix performance bottlenecks in large dataset"},{"name":"multiple","type":"boolean","required":false,"description":"Allows selection of multiple nodes"},{"name":"options","type":"","required":true},{"name":"selected","required":false,"description":"Array of keys of initially selected nodes"},{"name":"selectionLimit","type":"number","required":false,"description":"Number of nodes that can be selected"},{"name":"visibleHeight","type":"number","required":false,"description":"Height of the list. Helps fix performance bottlenecks in large dataset."},{"name":"getChildren","required":true,"description":"Should return an array of children nodes.\n<CodeBlock>{'(node: Node): Node[]'}</CodeBlock>"},{"name":"getIcon","type":"ReactNode","required":true,"description":"This function will be executed on each node. Should return{' '}\n<Code>Icon</Code> component\n<CodeBlock>{'(node: Node): React.ReactNode'}</CodeBlock>"},{"name":"getLabel","type":"string","required":true,"description":"This function will be executed on each node. Should return{' '}\n<Code>label</Code> for row\n<CodeBlock>{'(node: Node): string'}</CodeBlock>"},{"name":"getParentId","required":true,"description":"This function will be executed on each node. Should return parent{' '}\n<Code>Node</Code>\n<CodeBlock>{'(node: Node): NodeId'}</CodeBlock>"},{"name":"getRoot","type":"","required":true,"description":"Function should return parent <Code>Root Node</Code>\n<CodeBlock>{'(): Node'}</CodeBlock>"},{"name":"getType","type":"NodeType","required":true,"description":"This function will be executed on each node. Should return{' '}\n<Code>'branch'</Code> or <Code>'leaf'</Code>\n<CodeBlock>{'(node: Node): NodeType'}</CodeBlock>"},{"name":"isExpandable","type":"boolean","required":true,"description":"Function of whether to enable tree node expansion/collapsing.\n<CodeBlock>{'(node: Node): boolean'}</CodeBlock>"},{"name":"isSelectable","type":"boolean","required":true,"description":"Function of whether to enable tree node selection.\n<CodeBlock>{'(node: Node): boolean'}</CodeBlock>"},{"name":"onCollapse","type":"void","required":true,"description":"Triggers when current node collapse\n<CodeBlock>{'(node: Node): void'}</CodeBlock>"},{"name":"onExpand","type":"Promise","required":true,"description":"Triggers when current node expand\n<CodeBlock>{'(node: Node): Promise<void>'}</CodeBlock>"},{"name":"onSelect","type":"void","required":true,"description":"Callback return currently selected array of nodes.\n<CodeBlock>{'(nodes: Node[]): void'}</CodeBlock>"},{"name":"rowRenderer","type":"ReactNode","required":true,"description":"Callback for rendering tree nodes\n<CodeBlock>{'(props: TreeRowProps): React.ReactNode'}</CodeBlock>"}],"TreeRef":[{"name":"rootEl","required":true},{"name":"setExpanded","type":"void","required":true},{"name":"setSelected","type":"void","required":true},{"name":"toggleExpanded","type":"void","required":true},{"name":"toggleSelected","type":"void","required":true}],"TreeRowContainerProps":[{"name":"isExpandable","type":"boolean","required":true},{"name":"isFileLimitReached","type":"boolean","required":true},{"name":"isHighlighted","type":"boolean","required":true},{"name":"isSelectable","type":"boolean","required":true},{"name":"isSelected","type":"boolean","required":true},{"name":"level","type":"number","required":true}],"TreeRowOverlayProps":[{"name":"message","required":true},{"name":"overlayRef","type":"RefObject","required":true},{"name":"targetRef","type":"RefObject","required":true}],"TreeRowProps":[{"name":"isFileLimitReached","type":"boolean","required":true},{"name":"isMouseOver","type":"boolean","required":true},{"name":"node","required":true},{"name":"selectionLimit","type":"number","required":true},{"name":"shouldShowTooltip","type":"boolean","required":true},{"name":"treeContainer","type":"HTMLDivElement","required":true},{"name":"getIcon","type":"ReactNode","required":true},{"name":"getLabel","type":"string","required":true},{"name":"getType","type":"NodeType","required":true},{"name":"handleExpansion","type":"void","required":true},{"name":"handleSelection","type":"void","required":true},{"name":"isExpandable","type":"boolean","required":true},{"name":"isExpanded","type":"boolean","required":true},{"name":"isHighlighted","type":"boolean","required":true},{"name":"isLoading","type":"boolean","required":true},{"name":"isSelectable","type":"boolean","required":true},{"name":"isSelected","type":"boolean","required":true}],"TreeRowTooltipProps":[{"name":"fileName","type":"string","required":true},{"name":"isFileLimitReached","type":"boolean","required":true},{"name":"isHighlighted","type":"boolean","required":true},{"name":"isMouseOver","type":"boolean","required":true},{"name":"isSelectable","type":"boolean","required":true},{"name":"isSelected","type":"boolean","required":true},{"name":"nodeType","type":"NodeType","required":true},{"name":"selectionLimit","type":"number","required":true},{"name":"shouldShowTooltip","type":"boolean","required":true},{"name":"treeContainer","type":"HTMLDivElement","required":true}],"UseTreeProps":[{"name":"autoExpandParent","type":"boolean","required":true},{"name":"expanded","required":true},{"name":"multiple","type":"boolean","required":true},{"name":"options","type":"","required":true},{"name":"selected","required":true},{"name":"selectionLimit","type":"number","required":true},{"name":"getChildren","required":true},{"name":"getParentId","required":true},{"name":"getRoot","type":"","required":true},{"name":"onCollapse","type":"void","required":true},{"name":"onExpand","type":"Promise","required":true},{"name":"onSelect","type":"void","required":true}]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"FileTreeProps":[{"name":"expanded","required":false,"description":"Array of keys of initially expanded nodes"},{"name":"icon","type":"ReactNode","required":true,"deprecated":"String icon variant is deprecated, use the React components
|
|
1
|
+
{"FileTreeProps":[{"name":"expanded","required":false,"description":"Array of keys of initially expanded nodes"},{"name":"icon","type":"ReactNode","required":true,"deprecated":"String icon variant is deprecated, use the React components\ndirectly from the `@procore/core-icons/dist` package"},{"name":"isLoading","type":"boolean","required":false,"description":"Show/Hide loading indicator of the content"},{"name":"options","required":true},{"name":"sourceId","type":"string","required":true},{"name":"title","type":"string","required":true},{"name":"getChildren","required":true,"description":"Should return an array of children nodes.\n<CodeBlock>{'(node: Node): Node[]'}</CodeBlock>"},{"name":"getLabel","type":"string","required":true,"description":"This function will be executed on each node. Should return{' '}\n<Code>label</Code> for row\n<CodeBlock>{'(node: Node): string'}</CodeBlock>"},{"name":"getParentId","type":"","required":true,"description":"This function will be executed on each node. Should return parent{' '}\n<Code>Node</Code>\n<CodeBlock>{'(node: Node): NodeId'}</CodeBlock>"},{"name":"getRoot","type":"","required":true,"description":"Function should return parent <Code>Root Node</Code>\n<CodeBlock>{'(): Node'}</CodeBlock>"},{"name":"getType","type":"NodeType","required":true,"description":"This function will be executed on each node. Should return{' '}\n<Code>'branch'</Code> or <Code>'leaf'</Code>\n<CodeBlock>{'(node: Node): NodeType'}</CodeBlock>"},{"name":"isExpandable","type":"boolean","required":true,"description":"Function of whether to enable tree node expansion/collapsing.\n<CodeBlock>{'(node: Node): boolean'}</CodeBlock>"},{"name":"isSelectable","type":"boolean","required":true,"description":"Function of whether to enable tree node selection.\n<CodeBlock>{'(node: Node): boolean'}</CodeBlock>"},{"name":"onChange","type":"void","required":true,"description":"Callback function fired with currently selected array of nodes.\n<CodeBlock>(nodes: DefaultNode[]) => void</CodeBlock>"},{"name":"onExpand","type":"Promise","required":true,"description":"Triggers when current node expand\n<CodeBlock>{'(node: Node): Promise<void>'}</CodeBlock>"}],"TreeSourceRef":[{"name":"setExpandedNodes","type":"void","required":true},{"name":"setValue","type":"void","required":true}]}
|