@patternfly/patternfly-doc-core 1.12.0 → 1.12.2
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/.astro/collections/{examples.schema.json → react-component-docs.schema.json} +4 -3
- package/.astro/content-modules.mjs +84 -2
- package/.astro/content.d.ts +3 -11
- package/cli/cli.ts +35 -16
- package/cli/convertToMDX.ts +10 -3
- package/cli/createCollectionContent.ts +2 -1
- package/dist/cli/cli.js +17 -6
- package/dist/cli/convertToMDX.js +8 -3
- package/dist/cli/createCollectionContent.js +2 -1
- package/dist/docs/_astro/AutoLinkHeader.BijNRLMB.js +1 -0
- package/dist/docs/_astro/CSSTable.-Emc9iTg.js +1 -0
- package/dist/docs/_astro/DropdownList.DP2npVYh.js +1 -0
- package/dist/docs/_astro/Label.CM_es7Cu.js +1 -0
- package/dist/docs/_astro/LiveExample.B5R4Dzng.js +263 -0
- package/dist/docs/_astro/Navigation.B2RHZcqO.js +1 -0
- package/dist/docs/_astro/PageSidebarBody.DgDLnRuY.js +1 -0
- package/dist/docs/_astro/PropsTables.D6ZI3FGj.css +1 -0
- package/dist/docs/_astro/PropsTables.YkW1puJk.js +1 -0
- package/dist/docs/_astro/SearchInput.CQ7aDztp.js +1 -0
- package/dist/docs/_astro/SectionGallery.B0I2mi5J.js +1 -0
- package/dist/docs/_astro/StackItem.CMxajCCo.js +1 -0
- package/dist/docs/_astro/Toolbar.BNjGRsAQ.js +1 -0
- package/dist/docs/_astro/ToolbarContent.CAAHjZHW.js +1 -0
- package/dist/{_astro/_page_.D1z73Byz.css → docs/_astro/_page_.BG_fQ4i5.css} +1 -1
- package/dist/docs/_astro/angle-down-icon.Dqz5ba9D.js +1 -0
- package/dist/docs/_astro/c_table__sticky_cell_InsetInlineStart.DGzYmtkF.js +8 -0
- package/dist/{_astro/divider.BLVh3KnH.js → docs/_astro/divider.BP4XR7uq.js} +1 -1
- package/dist/docs/_astro/index.DGdw5tfb.js +16 -0
- package/dist/{_astro/patternfly_charts.Dp3KzAU6.js → docs/_astro/patternfly_charts.CpLYMsW2.js} +23 -30
- package/dist/docs/_astro/resizeObserver.BgQpxO8W.js +1 -0
- package/dist/{_routes.json → docs/_routes.json} +1 -3
- package/dist/{_worker.js → docs/_worker.js}/_@astrojs-ssr-adapter.mjs +1 -1
- package/dist/{_worker.js → docs/_worker.js}/_astro-internal_middleware.mjs +3 -3
- package/dist/docs/_worker.js/chunks/Backdrop_ByJvccKQ.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Backdrop_D12wBLrB.mjs +1 -0
- package/dist/docs/_worker.js/chunks/BackgroundImage_7zaRIuh-.mjs +1 -0
- package/dist/docs/_worker.js/chunks/BackgroundImage_BFUrU51J.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Badge_DloPmeMn.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Badge_DxGDbEGv.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Banner_4Te4yy7I.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Banner_FbFCGml0.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Brand_Cjeb58fX.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Brand_DZEvbkMH.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Breadcrumb_DkNDUMw0.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Breadcrumb_bVSwIfTk.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Button_BqggYTWh.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Button_DbZb-z5h.mjs +1 -0
- package/dist/docs/_worker.js/chunks/CalendarMonth_BdoIQD1o.mjs +1 -0
- package/dist/docs/_worker.js/chunks/CalendarMonth_BqZc2rYW.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Card_BW6WmwTW.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Card_CEDol7Xx.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Checkbox_BqVpiIvF.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Checkbox_DSYhfv7p.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Chip_BciXepRF.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Chip_C23BxFTk.mjs +1 -0
- package/dist/docs/_worker.js/chunks/ClipboardCopy_BjySfoK1.mjs +1 -0
- package/dist/docs/_worker.js/chunks/ClipboardCopy_CvrD2b3T.mjs +1 -0
- package/dist/docs/_worker.js/chunks/CodeBlock_CuH1PrfL.mjs +1 -0
- package/dist/docs/_worker.js/chunks/CodeBlock_DK5AauFn.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Content_BfZIFUr8.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Content_lBUC3eEp.mjs +1 -0
- package/dist/docs/_worker.js/chunks/DataList_CSJAkMMZ.mjs +1 -0
- package/dist/docs/_worker.js/chunks/DataList_CaFvg0uz.mjs +1 -0
- package/dist/docs/_worker.js/chunks/DatePicker_Cw2abdEU.mjs +1 -0
- package/dist/docs/_worker.js/chunks/DatePicker_bYwsFHXL.mjs +1 -0
- package/dist/docs/_worker.js/chunks/DescriptionList_BTTyevMb.mjs +1 -0
- package/dist/docs/_worker.js/chunks/DescriptionList_Dr51d-67.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Divider_BgOt1--F.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Divider_Bh7n4QTo.mjs +1 -0
- package/dist/docs/_worker.js/chunks/DragDrop_BF-aF6Z8.mjs +1 -0
- package/dist/docs/_worker.js/chunks/DragDrop_DId590rN.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Drawer_BVywTMVo.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Drawer_RrCnySEa.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Dropdown_BjtqviYW.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Dropdown_GiUvjFPw.mjs +1 -0
- package/dist/docs/_worker.js/chunks/DualListSelector_8uLukfP0.mjs +1 -0
- package/dist/docs/_worker.js/chunks/DualListSelector_Bgj1IWqe.mjs +1 -0
- package/dist/docs/_worker.js/chunks/DualListSelector_C5QjTplp.mjs +1 -0
- package/dist/docs/_worker.js/chunks/DualListSelector_DLgspM0s.mjs +1 -0
- package/dist/docs/_worker.js/chunks/EmptyState_Ct_PJba3.mjs +1 -0
- package/dist/docs/_worker.js/chunks/EmptyState_Dk3hKJlg.mjs +1 -0
- package/dist/docs/_worker.js/chunks/ExpandableSection_DSw76PjZ.mjs +1 -0
- package/dist/docs/_worker.js/chunks/ExpandableSection_vUQO3FgG.mjs +1 -0
- package/dist/docs/_worker.js/chunks/FileUpload_CEvZ0G-d.mjs +1 -0
- package/dist/docs/_worker.js/chunks/FileUpload_Ci_s8Ghd.mjs +1 -0
- package/dist/docs/_worker.js/chunks/FormSelect_C2YPRAlw.mjs +1 -0
- package/dist/docs/_worker.js/chunks/FormSelect_DWShl8Fb.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Form_Dyb98Nez.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Form_olaoRN4o.mjs +1 -0
- package/dist/docs/_worker.js/chunks/HelperText_2CcHVaih.mjs +1 -0
- package/dist/docs/_worker.js/chunks/HelperText_DthGttZo.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Hint_BXDZKYhJ.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Hint_DHoiYdn6.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Icon_C4IPnIAg.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Icon_C_Dqbg9w.mjs +1 -0
- package/dist/docs/_worker.js/chunks/InputGroup_CDKP-uXZ.mjs +1 -0
- package/dist/docs/_worker.js/chunks/InputGroup_CmZgaEyr.mjs +1 -0
- package/dist/docs/_worker.js/chunks/JumpLinks_DvM3PVg0.mjs +1 -0
- package/dist/docs/_worker.js/chunks/JumpLinks_Dvdlxdps.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Label_C7fP9Jp9.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Label_Cxir7_Q4.mjs +1 -0
- package/dist/docs/_worker.js/chunks/List_CUgwFnXa.mjs +1 -0
- package/dist/docs/_worker.js/chunks/List_CWAsiYnN.mjs +1 -0
- package/dist/docs/_worker.js/chunks/LoginPage_BDfliKtU.mjs +1 -0
- package/dist/docs/_worker.js/chunks/LoginPage_BjIl_nF9.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Masthead_BWjm5CFj.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Masthead_BZnYzDu_.mjs +1 -0
- package/dist/docs/_worker.js/chunks/MenuToggle_DeKwv469.mjs +1 -0
- package/dist/docs/_worker.js/chunks/MenuToggle_DmJISlPR.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Menu_DRRoq5PM.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Menu_Sl-QVQ_w.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Modal_6WZzoDHU.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Modal_BI2dVPRJ.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Modal_CdokBUDP.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Modal_DJRobnfc.mjs +1 -0
- package/dist/docs/_worker.js/chunks/MultipleFileUpload_BaHVtkF_.mjs +1 -0
- package/dist/docs/_worker.js/chunks/MultipleFileUpload_BznvLbsj.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Nav_DwqATcJ4.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Nav_GZ0nRYXE.mjs +1 -0
- package/dist/docs/_worker.js/chunks/NotificationBadge_DO4OLgvO.mjs +1 -0
- package/dist/docs/_worker.js/chunks/NotificationBadge_DjINhOQ5.mjs +1 -0
- package/dist/docs/_worker.js/chunks/NotificationDrawer_BtpQ4pmZ.mjs +1 -0
- package/dist/docs/_worker.js/chunks/NotificationDrawer_D1lmMCgd.mjs +1 -0
- package/dist/docs/_worker.js/chunks/NumberInput_CggpJ5ge.mjs +1 -0
- package/dist/docs/_worker.js/chunks/NumberInput_zMcSUUwH.mjs +1 -0
- package/dist/docs/_worker.js/chunks/OverflowMenu_BX4nwFvK.mjs +1 -0
- package/dist/docs/_worker.js/chunks/OverflowMenu_DnQ7wMy-.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Page_Cw_XTB6Y.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Page_UhywZXdY.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Pagination_7rr0n7-V.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Pagination_Dc5L6yaI.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Panel_Bl_LqCWS.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Panel_s8-TwBlS.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Popover_CjipqBWs.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Popover_DvQgGJTf.mjs +1 -0
- package/dist/docs/_worker.js/chunks/ProgressStepper_DXBI4K2w.mjs +1 -0
- package/dist/docs/_worker.js/chunks/ProgressStepper_lBd5mTHE.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Progress_BZA5taDC.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Progress_CIgybc-D.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Radio_3tPx1coq.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Radio_BG7VZAk6.mjs +1 -0
- package/dist/docs/_worker.js/chunks/SearchInput_BZ43-Elo.mjs +1 -0
- package/dist/docs/_worker.js/chunks/SearchInput_aCFv-N1U.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Select_B4cumL7U.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Select_CJ78kBVM.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Sidebar_Bto2_gKJ.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Sidebar_DOfifBRA.mjs +1 -0
- package/dist/docs/_worker.js/chunks/SimpleList_CVkO5Odp.mjs +1 -0
- package/dist/docs/_worker.js/chunks/SimpleList_oJajk3_z.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Skeleton_CCJNka-d.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Skeleton_N02yA_k6.mjs +1 -0
- package/dist/docs/_worker.js/chunks/SkipToContent_DvOYRCWm.mjs +1 -0
- package/dist/docs/_worker.js/chunks/SkipToContent_o7vh-U_u.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Slider_C0bH-JMY.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Slider_CWRDqhx4.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Spinner_B-x8bJt0.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Spinner_hzAAbZdS.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Switch_Cpr1OETy.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Switch_Du7AKJ4O.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Tabs_CzDrfKA-.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Tabs_KXDkISY4.mjs +1 -0
- package/dist/docs/_worker.js/chunks/TextArea_C1dmG8mr.mjs +1 -0
- package/dist/docs/_worker.js/chunks/TextArea_Dtm0m8LO.mjs +1 -0
- package/dist/docs/_worker.js/chunks/TextInputGroup_D0NXU95v.mjs +1 -0
- package/dist/docs/_worker.js/chunks/TextInputGroup_mJpBrogC.mjs +1 -0
- package/dist/docs/_worker.js/chunks/TextInput_B0XLYaVA.mjs +1 -0
- package/dist/docs/_worker.js/chunks/TextInput_CmLcsUiv.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Tile_CF_12LPU.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Tile_DJ0LawLW.mjs +1 -0
- package/dist/docs/_worker.js/chunks/TimePicker_CijfSKJQ.mjs +1 -0
- package/dist/docs/_worker.js/chunks/TimePicker_VX9VE-Uy.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Timestamp_D7uyrIK7.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Timestamp_c2Mozpr4.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Title_DbrwFEEy.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Title_DlFn7G9R.mjs +1 -0
- package/dist/docs/_worker.js/chunks/ToggleGroup_DpLWzfAW.mjs +1 -0
- package/dist/docs/_worker.js/chunks/ToggleGroup_j1ooRpX3.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Toolbar_BEIh7r7J.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Toolbar_mjrD3_l-.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Tooltip_Bp5XOVoV.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Tooltip_BrFKk02i.mjs +1 -0
- package/dist/docs/_worker.js/chunks/TreeView_BImfKPD_.mjs +1 -0
- package/dist/docs/_worker.js/chunks/TreeView_CgO4iC1E.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Truncate_Bn55QoeZ.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Truncate_S939OotH.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Wizard_B28f3non.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Wizard_B4Dw5Yc8.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Wizard_BOCBVIjJ.mjs +1 -0
- package/dist/docs/_worker.js/chunks/Wizard_C2sit354.mjs +1 -0
- package/dist/{_worker.js/renderers.mjs → docs/_worker.js/chunks/_@astro-renderers_D4IG6Oyo.mjs} +55 -3
- package/dist/{_worker.js/chunks/_@astrojs-ssr-adapter_IMtcR503.mjs → docs/_worker.js/chunks/_@astrojs-ssr-adapter_CBRUgCDy.mjs} +4 -4
- package/dist/docs/_worker.js/chunks/_astro_assets_Dcv7PKDL.mjs +1 -0
- package/dist/docs/_worker.js/chunks/_astro_data-layer-content_CPgQSQEx.mjs +1 -0
- package/dist/{_worker.js/chunks/astro/server_YsSSp7Ny.mjs → docs/_worker.js/chunks/astro/server_CVEnF9i1.mjs} +1 -3
- package/dist/{_worker.js/chunks/astro-designed-error-pages_MEt0E9xn.mjs → docs/_worker.js/chunks/astro-designed-error-pages_CXRddWNa.mjs} +1 -1
- package/dist/docs/_worker.js/chunks/content-assets_XqCgPAV2.mjs +1 -0
- package/dist/docs/_worker.js/chunks/content-modules_pw1AqUgZ.mjs +1 -0
- package/dist/{_worker.js/chunks/index_BE2AHcwI.mjs → docs/_worker.js/chunks/index_CYXMeXT4.mjs} +2 -2
- package/dist/{_worker.js/chunks/noop-middleware_CMUpAQ6F.mjs → docs/_worker.js/chunks/noop-middleware_DIXVCvyq.mjs} +1 -1
- package/dist/docs/_worker.js/chunks/sharp_BKxWP4lT.mjs +1 -0
- package/dist/{_worker.js → docs/_worker.js}/index.js +4 -8
- package/dist/docs/_worker.js/manifest_Dsi4HnVg.mjs +100 -0
- package/dist/{_worker.js → docs/_worker.js}/pages/_image.astro.mjs +1 -1
- package/dist/docs/_worker.js/pages/_section_/_---page_.astro.mjs +1 -0
- package/dist/docs/_worker.js/pages/_section_/_page_/_---tab_.astro.mjs +1 -0
- package/dist/docs/_worker.js/pages/index.astro.mjs +1 -0
- package/dist/{_worker.js → docs/_worker.js}/pages/props.astro.mjs +1 -1
- package/dist/docs/_worker.js/renderers.mjs +2 -0
- package/dist/docs/components/about-modal/index.html +56 -0
- package/dist/docs/components/about-modal/react/index.html +56 -0
- package/dist/docs/components/accordion/index.html +62 -0
- package/dist/docs/components/accordion/react/index.html +62 -0
- package/dist/docs/components/action-list/index.html +59 -0
- package/dist/docs/components/action-list/react/index.html +59 -0
- package/dist/docs/components/alert/index.html +428 -0
- package/dist/docs/components/alert/react/index.html +428 -0
- package/dist/docs/components/avatar/index.html +56 -0
- package/dist/docs/components/avatar/react/index.html +56 -0
- package/dist/docs/components/back-to-top/index.html +53 -0
- package/dist/docs/components/back-to-top/react/index.html +53 -0
- package/dist/docs/components/backdrop/index.html +49 -0
- package/dist/docs/components/backdrop/react/index.html +49 -0
- package/dist/docs/components/background-image/index.html +49 -0
- package/dist/docs/components/background-image/react/index.html +49 -0
- package/dist/docs/components/badge/index.html +57 -0
- package/dist/docs/components/badge/react/index.html +57 -0
- package/dist/docs/components/banner/index.html +57 -0
- package/dist/docs/components/banner/react/index.html +57 -0
- package/dist/docs/components/brand/index.html +55 -0
- package/dist/docs/components/brand/react/index.html +55 -0
- package/dist/docs/components/breadcrumb/index.html +59 -0
- package/dist/docs/components/breadcrumb/react/index.html +59 -0
- package/dist/docs/components/button/index.html +152 -0
- package/dist/docs/components/button/react/index.html +152 -0
- package/dist/docs/components/calendar-month/index.html +55 -0
- package/dist/docs/components/calendar-month/react/index.html +55 -0
- package/dist/docs/components/card/index.html +159 -0
- package/dist/docs/components/card/react/index.html +159 -0
- package/dist/docs/components/checkbox/index.html +78 -0
- package/dist/docs/components/checkbox/react/index.html +78 -0
- package/dist/docs/components/chip/index.html +61 -0
- package/dist/docs/components/chip/react-deprecated/index.html +61 -0
- package/dist/docs/components/clipboard-copy/index.html +84 -0
- package/dist/docs/components/clipboard-copy/react/index.html +84 -0
- package/dist/docs/components/code-block/index.html +55 -0
- package/dist/docs/components/code-block/react/index.html +55 -0
- package/dist/docs/components/content/index.html +79 -0
- package/dist/docs/components/content/react/index.html +79 -0
- package/dist/docs/components/data-list/index.html +86 -0
- package/dist/docs/components/data-list/react/index.html +86 -0
- package/dist/docs/components/date-picker/index.html +77 -0
- package/dist/docs/components/date-picker/react/index.html +77 -0
- package/dist/docs/components/description-list/index.html +135 -0
- package/dist/docs/components/description-list/react/index.html +135 -0
- package/dist/docs/components/divider/index.html +74 -0
- package/dist/docs/components/divider/react/index.html +74 -0
- package/dist/docs/components/drag-and-drop/index.html +69 -0
- package/dist/docs/components/drag-and-drop/react-deprecated/index.html +69 -0
- package/dist/docs/components/drawer/index.html +108 -0
- package/dist/docs/components/drawer/react/index.html +108 -0
- package/dist/docs/components/dropdown/index.html +71 -0
- package/dist/docs/components/dropdown/react/index.html +71 -0
- package/dist/docs/components/dual-list-selector/index.html +89 -0
- package/dist/docs/components/dual-list-selector/react/index.html +89 -0
- package/dist/docs/components/dual-list-selector/react-deprecated/index.html +106 -0
- package/dist/docs/components/empty-state/index.html +71 -0
- package/dist/docs/components/empty-state/react/index.html +71 -0
- package/dist/docs/components/expandable-section/index.html +76 -0
- package/dist/docs/components/expandable-section/react/index.html +76 -0
- package/dist/docs/components/form/index.html +87 -0
- package/dist/docs/components/form/react/index.html +87 -0
- package/dist/docs/components/form-select/index.html +59 -0
- package/dist/docs/components/form-select/react/index.html +59 -0
- package/dist/docs/components/helper-text/index.html +57 -0
- package/dist/docs/components/helper-text/react/index.html +57 -0
- package/dist/docs/components/hint/index.html +59 -0
- package/dist/docs/components/hint/react/index.html +59 -0
- package/dist/docs/components/icon/index.html +80 -0
- package/dist/docs/components/icon/react/index.html +80 -0
- package/dist/docs/components/input-group/index.html +62 -0
- package/dist/docs/components/input-group/react/index.html +62 -0
- package/dist/docs/components/jump-links/index.html +66 -0
- package/dist/docs/components/jump-links/react/index.html +66 -0
- package/dist/docs/components/label/index.html +103 -0
- package/dist/docs/components/label/react/index.html +103 -0
- package/dist/docs/components/list/index.html +68 -0
- package/dist/docs/components/list/react/index.html +68 -0
- package/dist/docs/components/login-page/index.html +56 -0
- package/dist/docs/components/login-page/react/index.html +56 -0
- package/dist/docs/components/masthead/index.html +76 -0
- package/dist/docs/components/masthead/react/index.html +76 -0
- package/dist/docs/components/menu/index.html +160 -0
- package/dist/docs/components/menu/react/index.html +160 -0
- package/dist/docs/components/menu-toggle/index.html +201 -0
- package/dist/docs/components/menu-toggle/react/index.html +201 -0
- package/dist/docs/components/modal/index.html +113 -0
- package/dist/docs/components/modal/react/index.html +113 -0
- package/dist/docs/components/modal/react-deprecated/index.html +117 -0
- package/dist/docs/components/multiple-file-upload/index.html +84 -0
- package/dist/docs/components/multiple-file-upload/react/index.html +84 -0
- package/dist/docs/components/navigation/index.html +89 -0
- package/dist/docs/components/navigation/react/index.html +89 -0
- package/dist/docs/components/notification-badge/index.html +65 -0
- package/dist/docs/components/notification-badge/react/index.html +65 -0
- package/dist/docs/components/notification-drawer/index.html +56 -0
- package/dist/docs/components/notification-drawer/react/index.html +56 -0
- package/dist/docs/components/number-input/index.html +72 -0
- package/dist/docs/components/number-input/react/index.html +72 -0
- package/dist/docs/components/overflow-menu/index.html +64 -0
- package/dist/docs/components/overflow-menu/react/index.html +64 -0
- package/dist/docs/components/page/index.html +114 -0
- package/dist/docs/components/page/react/index.html +114 -0
- package/dist/docs/components/pagination/index.html +77 -0
- package/dist/docs/components/pagination/react/index.html +77 -0
- package/dist/docs/components/panel/index.html +196 -0
- package/dist/docs/components/panel/react/index.html +196 -0
- package/dist/docs/components/popover/index.html +89 -0
- package/dist/docs/components/popover/react/index.html +89 -0
- package/dist/docs/components/progress/index.html +101 -0
- package/dist/docs/components/progress/react/index.html +101 -0
- package/dist/docs/components/progress-stepper/index.html +74 -0
- package/dist/docs/components/progress-stepper/react/index.html +74 -0
- package/dist/docs/components/radio/index.html +75 -0
- package/dist/docs/components/radio/react/index.html +75 -0
- package/dist/docs/components/search-input/index.html +76 -0
- package/dist/docs/components/search-input/react/index.html +76 -0
- package/dist/docs/components/select/index.html +129 -0
- package/dist/docs/components/select/react/index.html +129 -0
- package/dist/docs/components/sidebar/index.html +77 -0
- package/dist/docs/components/sidebar/react/index.html +77 -0
- package/dist/docs/components/simple-file-upload/index.html +93 -0
- package/dist/docs/components/simple-file-upload/react/index.html +93 -0
- package/dist/docs/components/simple-list/index.html +59 -0
- package/dist/docs/components/simple-list/react/index.html +59 -0
- package/dist/docs/components/skeleton/index.html +62 -0
- package/dist/docs/components/skeleton/react/index.html +62 -0
- package/dist/docs/components/skip-to-content/index.html +49 -0
- package/dist/docs/components/skip-to-content/react/index.html +49 -0
- package/dist/docs/components/slider/index.html +78 -0
- package/dist/docs/components/slider/react/index.html +78 -0
- package/dist/docs/components/spinner/index.html +59 -0
- package/dist/docs/components/spinner/react/index.html +59 -0
- package/dist/docs/components/switch/index.html +66 -0
- package/dist/docs/components/switch/react/index.html +66 -0
- package/dist/docs/components/tabs/index.html +169 -0
- package/dist/docs/components/tabs/react/index.html +169 -0
- package/dist/docs/components/text-area/index.html +77 -0
- package/dist/docs/components/text-area/react/index.html +77 -0
- package/dist/docs/components/text-input/index.html +71 -0
- package/dist/docs/components/text-input/react/index.html +71 -0
- package/dist/docs/components/text-input-group/index.html +68 -0
- package/dist/docs/components/text-input-group/react/index.html +68 -0
- package/dist/docs/components/tile/index.html +153 -0
- package/dist/docs/components/tile/react-deprecated/index.html +153 -0
- package/dist/docs/components/time-picker/index.html +67 -0
- package/dist/docs/components/time-picker/react/index.html +67 -0
- package/dist/docs/components/timestamp/index.html +75 -0
- package/dist/docs/components/timestamp/react/index.html +75 -0
- package/dist/docs/components/title/index.html +53 -0
- package/dist/docs/components/title/react/index.html +53 -0
- package/dist/docs/components/toggle-group/index.html +74 -0
- package/dist/docs/components/toggle-group/react/index.html +74 -0
- package/dist/docs/components/toolbar/index.html +111 -0
- package/dist/docs/components/toolbar/react/index.html +111 -0
- package/dist/docs/components/tooltip/index.html +65 -0
- package/dist/docs/components/tooltip/react/index.html +65 -0
- package/dist/docs/components/tree-view/index.html +93 -0
- package/dist/docs/components/tree-view/react/index.html +93 -0
- package/dist/docs/components/truncate/index.html +80 -0
- package/dist/docs/components/truncate/react/index.html +80 -0
- package/dist/docs/components/wizard/index.html +120 -0
- package/dist/docs/components/wizard/react/index.html +120 -0
- package/dist/docs/components/wizard/react-deprecated/index.html +372 -0
- package/dist/docs/index.html +43 -0
- package/dist/props.json +1 -0
- package/package.json +10 -6
- package/src/components/AutoLinkHeader.tsx +3 -11
- package/src/components/DocsTables.astro +10 -4
- package/src/components/LiveExample.tsx +2 -0
- package/src/components/PropsTables.tsx +62 -0
- package/src/content.config.ts +2 -4
- package/src/content.ts +1 -15
- package/src/layouts/Main.astro +1 -0
- package/src/pages/[section]/[...page].astro +1 -5
- package/src/pages/[section]/[page]/[...tab].astro +1 -1
- package/.astro/collections/textContent.schema.json +0 -59
- package/dist/_astro/CSSTable.E6iSHjec.js +0 -1
- package/dist/_astro/DropdownList.-xE7qrND.js +0 -1
- package/dist/_astro/LiveExample.CVVccYEB.js +0 -259
- package/dist/_astro/Navigation.CONcolRR.js +0 -1
- package/dist/_astro/PageSidebarBody.CDWZuFeK.js +0 -1
- package/dist/_astro/SearchInput.BNt7BTX_.js +0 -1
- package/dist/_astro/SectionGallery.Dwb-QA5z.js +0 -1
- package/dist/_astro/Toolbar.DNd68Ck-.js +0 -1
- package/dist/_astro/ToolbarContent.C58gpKLu.js +0 -1
- package/dist/_astro/_page_.CtheD08_.css +0 -1
- package/dist/_astro/index.jm6QVFFy.js +0 -16
- package/dist/_worker.js/chunks/AutoLinkHeader_DLgn_YRm.mjs +0 -739
- package/dist/_worker.js/chunks/Button_CBcC0ViE.mjs +0 -709
- package/dist/_worker.js/chunks/CSSTable_C1dV02qV.mjs +0 -18
- package/dist/_worker.js/chunks/DocsTables_Br4g5x5_.mjs +0 -20
- package/dist/_worker.js/chunks/PropsTables_Dcd7znAq.mjs +0 -6628
- package/dist/_worker.js/chunks/angle-down-icon_VyCXUC7F.mjs +0 -3686
- package/dist/_worker.js/chunks/index_CBCp_CJ0.mjs +0 -57
- package/dist/_worker.js/manifest_CyDNnCoC.mjs +0 -100
- package/dist/components/accordion/index.html +0 -60
- package/dist/components/accordion/react/index.html +0 -60
- package/dist/components/all-components/index.html +0 -47
- package/dist/design-foundations/typography/index.html +0 -198
- package/dist/design-foundations/usage-and-behavior/index.html +0 -347
- package/dist/get-started/contribute/index.html +0 -94
- package/dist/index.html +0 -43
- package/src/components/PropsTables.astro +0 -52
- /package/dist/{.assetsignore → docs/.assetsignore} +0 -0
- /package/dist/{PF-HorizontalLogo-Color.svg → docs/PF-HorizontalLogo-Color.svg} +0 -0
- /package/dist/{PF-HorizontalLogo-Reverse.svg → docs/PF-HorizontalLogo-Reverse.svg} +0 -0
- /package/dist/{_astro/_page_.Chv_bGyU.css → docs/_astro/AutoLinkHeader.Chv_bGyU.css} +0 -0
- /package/dist/{_astro → docs/_astro}/Button.BVfR1y85.js +0 -0
- /package/dist/{_astro → docs/_astro}/ClientRouter.astro_astro_type_script_index_0_lang.CtSceO8m.js +0 -0
- /package/dist/{_astro → docs/_astro}/Content.CYLxURqU.js +0 -0
- /package/dist/{_astro → docs/_astro}/LiveExample.CxJsMvEq.css +0 -0
- /package/dist/{_astro → docs/_astro}/PageContext.BUbWpNW2.js +0 -0
- /package/dist/{_astro → docs/_astro}/PageToggle.Dnbvoa7R.js +0 -0
- /package/dist/{_astro → docs/_astro}/RedHatDisplayVF-Italic.CRpusWc8.woff2 +0 -0
- /package/dist/{_astro → docs/_astro}/RedHatDisplayVF.CYDHf1NI.woff2 +0 -0
- /package/dist/{_astro → docs/_astro}/RedHatMonoVF-Italic.DGQo2ogW.woff2 +0 -0
- /package/dist/{_astro → docs/_astro}/RedHatMonoVF.C4fMH6Vz.woff2 +0 -0
- /package/dist/{_astro → docs/_astro}/RedHatTextVF-Italic.Dkj_WqbA.woff2 +0 -0
- /package/dist/{_astro → docs/_astro}/RedHatTextVF.wYvZ7prR.woff2 +0 -0
- /package/dist/{_astro → docs/_astro}/_page_.DxJDkZPc.css +0 -0
- /package/dist/{_astro → docs/_astro}/angle-left-icon.CfKwuSCS.js +0 -0
- /package/dist/{_astro → docs/_astro}/bars-icon.wdJgEs3A.js +0 -0
- /package/dist/{_astro → docs/_astro}/client.DN8ES6L5.js +0 -0
- /package/dist/{_astro → docs/_astro}/fa-solid-900.DguXoeIz.woff2 +0 -0
- /package/dist/{_astro → docs/_astro}/github-icon.DzpohUp_.js +0 -0
- /package/dist/{_astro → docs/_astro}/index.BQFV5hT1.js +0 -0
- /package/dist/{_astro → docs/_astro}/index.CAChmxYj.js +0 -0
- /package/dist/{_astro → docs/_astro}/index.eCxJ45ll.js +0 -0
- /package/dist/{_astro → docs/_astro}/page.BTC3Kf3x.js +0 -0
- /package/dist/{_astro → docs/_astro}/pf-v6-pficon.Dy6oiu9u.woff2 +0 -0
- /package/dist/{_worker.js → docs/_worker.js}/_noop-actions.mjs +0 -0
- /package/dist/{_worker.js/chunks/Accordion_CQUal4ef.mjs → docs/_worker.js/chunks/AboutModal_CrdYiVZ2.mjs} +0 -0
- /package/dist/{_worker.js/chunks/Accordion_R7bP3pwr.mjs → docs/_worker.js/chunks/AboutModal_D3R-r6ju.mjs} +0 -0
- /package/dist/{_worker.js/chunks/AllComponents_BDKlE-WJ.mjs → docs/_worker.js/chunks/Accordion_Dbx8tdfD.mjs} +0 -0
- /package/dist/{_worker.js/chunks/AllComponents_DWDph25H.mjs → docs/_worker.js/chunks/Accordion_sjy0EnPK.mjs} +0 -0
- /package/dist/{_worker.js/chunks/_astro_assets_uN1DLT1q.mjs → docs/_worker.js/chunks/ActionList_Bx7eAKgV.mjs} +0 -0
- /package/dist/{_worker.js/chunks/_astro_data-layer-content_D0hm6p8E.mjs → docs/_worker.js/chunks/ActionList_CuygbYGp.mjs} +0 -0
- /package/dist/{_worker.js/chunks/content-assets_XqCgPAV2.mjs → docs/_worker.js/chunks/Alert_Cgh0pfMA.mjs} +0 -0
- /package/dist/{_worker.js/chunks/content-modules_BbCqcGJp.mjs → docs/_worker.js/chunks/Alert_CplJ22O9.mjs} +0 -0
- /package/dist/{_worker.js/chunks/sharp_Cc2xj7B1.mjs → docs/_worker.js/chunks/Avatar_BszzDSZB.mjs} +0 -0
- /package/dist/{_worker.js/pages/_section_/_---page_.astro.mjs → docs/_worker.js/chunks/Avatar_DuNXB-Tl.mjs} +0 -0
- /package/dist/{_worker.js/pages/_section_/_page_/_---tab_.astro.mjs → docs/_worker.js/chunks/BackToTop_B_0NN1kJ.mjs} +0 -0
- /package/dist/{_worker.js/pages/index.astro.mjs → docs/_worker.js/chunks/BackToTop_DKY1zHBL.mjs} +0 -0
- /package/dist/{_worker.js → docs/_worker.js}/chunks/cloudflare-kv-binding_DMly_2Gl.mjs +0 -0
- /package/dist/{_worker.js → docs/_worker.js}/chunks/parse_EttCPxrw.mjs +0 -0
- /package/dist/{_worker.js → docs/_worker.js}/chunks/path_C-ZOwaTP.mjs +0 -0
- /package/dist/{avatarImg.svg → docs/avatarImg.svg} +0 -0
- /package/dist/{avatarImgDark.svg → docs/avatarImgDark.svg} +0 -0
- /package/dist/{content → docs/content}/typography/line-height.png +0 -0
- /package/dist/{favicon.svg → docs/favicon.svg} +0 -0
package/dist/props.json
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"KeyboardHandler":{"name":"KeyboardHandler","description":"","props":[{"name":"additionalKeyHandler","type":"(event: KeyboardEvent) => void","description":"Additional key handling outside of the included arrow keys, enter, and space handling"},{"name":"containerRef","type":"React.RefObject<any>","description":"Reference of the container to apply keyboard interaction","defaultValue":"null"},{"name":"createNavigableElements","type":"() => Element[]","description":"Callback returning an array of navigable elements to be traversable via vertical arrow keys. This array should not include non-navigable elements such as disabled elements.","defaultValue":"() => null as Element[]"},{"name":"getFocusableElement","type":"(navigableElement: Element) => Element","description":"Callback returning the focusable element of a given element from the navigable elements array","defaultValue":"(navigableElement: Element) => navigableElement"},{"name":"isActiveElement","type":"(navigableElement: Element) => boolean","description":"Callback to determine if a given element from the navigable elements array is the active element of the page","defaultValue":"(navigableElement: Element) => document.activeElement === navigableElement"},{"name":"isEventFromContainer","type":"(event: KeyboardEvent) => boolean","description":"Callback to determine if a given event is from the container. By default the function conducts a basic check to see if the containerRef contains the event target"},{"name":"noEnterHandling","type":"boolean","description":"Flag indicating that the included enter key handling should be ignored","defaultValue":"false"},{"name":"noHorizontalArrowHandling","type":"boolean","description":"Flag indicating that the included horizontal arrow key handling should be ignored","defaultValue":"false"},{"name":"noSpaceHandling","type":"boolean","description":"Flag indicating that the included space key handling should be ignored","defaultValue":"false"},{"name":"noVerticalArrowHandling","type":"boolean","description":"Flag indicating that the included vertical arrow key handling should be ignored","defaultValue":"false"},{"name":"onlyTraverseSiblings","type":"boolean","description":"Flag indicating that next focusable element of a horizontal movement will be this element's sibling","defaultValue":"true"},{"name":"updateTabIndex","type":"boolean","description":"Flag indicating that the tabIndex of the currently focused element and next focused element should be updated, in the case of using a roving tabIndex","defaultValue":"true"},{"name":"validSiblingTags","type":"string[]","description":"Valid sibling tags that horizontal arrow handling will focus","defaultValue":"['BUTTON', 'A']"}]},"KeyboardHandlerProps":{"name":"KeyboardHandlerProps","description":"","props":[{"name":"additionalKeyHandler","type":"(event: KeyboardEvent) => void","description":"Additional key handling outside of the included arrow keys, enter, and space handling"},{"name":"containerRef","type":"React.RefObject<any>","description":"Reference of the container to apply keyboard interaction","required":true},{"name":"createNavigableElements","type":"() => Element[]","description":"Callback returning an array of navigable elements to be traversable via vertical arrow keys. This array should not include non-navigable elements such as disabled elements.","required":true},{"name":"getFocusableElement","type":"(navigableElement: Element) => Element","description":"Callback returning the focusable element of a given element from the navigable elements array"},{"name":"isActiveElement","type":"(navigableElement: Element) => boolean","description":"Callback to determine if a given element from the navigable elements array is the active element of the page"},{"name":"isEventFromContainer","type":"(event: KeyboardEvent) => boolean","description":"Callback to determine if a given event is from the container. By default the function conducts a basic check to see if the containerRef contains the event target"},{"name":"noEnterHandling","type":"boolean","description":"Flag indicating that the included enter key handling should be ignored"},{"name":"noHorizontalArrowHandling","type":"boolean","description":"Flag indicating that the included horizontal arrow key handling should be ignored"},{"name":"noSpaceHandling","type":"boolean","description":"Flag indicating that the included space key handling should be ignored"},{"name":"noVerticalArrowHandling","type":"boolean","description":"Flag indicating that the included vertical arrow key handling should be ignored"},{"name":"onlyTraverseSiblings","type":"boolean","description":"Flag indicating that next focusable element of a horizontal movement will be this element's sibling"},{"name":"updateTabIndex","type":"boolean","description":"Flag indicating that the tabIndex of the currently focused element and next focused element should be updated, in the case of using a roving tabIndex"},{"name":"validSiblingTags","type":"string[]","description":"Valid sibling tags that horizontal arrow handling will focus"}]},"SampleDataRow":{"name":"SampleDataRow","description":"","props":[{"name":"applications","type":"number","description":null,"required":true},{"name":"lastModified","type":"string","description":null,"required":true},{"name":"name","type":"string","description":null,"required":true},{"name":"threads","type":"number","description":null,"required":true},{"name":"url","type":"string","description":null,"required":true},{"name":"workspaces","type":"number","description":null,"required":true}]},"DashboardWrapper":{"name":"DashboardWrapper","description":"","props":[{"name":"hasDefaultBreadcrumb","type":"boolean","description":"Flag to render sample breadcrumb if custom breadcrumb not passed"},{"name":"hasPageTemplateTitle","type":"boolean","description":"Flag to render sample page title if custom title not passed"},{"name":"sidebarNavOpen","type":"boolean","description":"Programmatically manage if the sidebar nav is shown"}]},"DashboardWrapperProps":{"name":"DashboardWrapperProps","description":"","props":[{"name":"hasDefaultBreadcrumb","type":"boolean","description":"Flag to render sample breadcrumb if custom breadcrumb not passed"},{"name":"hasPageTemplateTitle","type":"boolean","description":"Flag to render sample page title if custom title not passed"},{"name":"sidebarNavOpen","type":"boolean","description":"Programmatically manage if the sidebar nav is shown"}]},"DashboardHeader":{"name":"DashboardHeader","description":"","props":[]},"DashboardHeaderProps":{"name":"DashboardHeaderProps","description":"","props":[{"name":"notificationBadge","type":"React.ReactNode","description":"Render custom notification badge"}]},"StackItem":{"name":"StackItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Additional classes added to the stack layout item.","defaultValue":"null"},{"name":"className","type":"string","description":"Content rendered inside the stack layout item.","defaultValue":"''"},{"name":"component","type":"React.ReactNode","description":"Sets the base component to render. Defaults to div.","defaultValue":"'div'"},{"name":"isFilled","type":"boolean","description":"Flag indicating if this stack layout item should fill the available vertical space.","defaultValue":"false"}]},"StackItemProps":{"name":"StackItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Additional classes added to the stack layout item."},{"name":"className","type":"string","description":"Content rendered inside the stack layout item."},{"name":"component","type":"React.ReactNode","description":"Sets the base component to render. Defaults to div."},{"name":"isFilled","type":"boolean","description":"Flag indicating if this stack layout item should fill the available vertical space."}]},"Stack":{"name":"Stack","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the stack layout.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the stack layout.","defaultValue":"''"},{"name":"component","type":"React.ReactNode","description":"Sets the base component to render. Defaults to div.","defaultValue":"'div'"},{"name":"hasGutter","type":"boolean","description":"Adds space between children.","defaultValue":"false"}]},"StackProps":{"name":"StackProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the stack layout."},{"name":"className","type":"string","description":"Additional classes added to the stack layout."},{"name":"component","type":"React.ReactNode","description":"Sets the base component to render. Defaults to div."},{"name":"hasGutter","type":"boolean","description":"Adds space between children."}]},"SplitItem":{"name":"SplitItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the split layout item.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the split layout item.","defaultValue":"''"},{"name":"component","type":"React.ReactNode","description":"Sets the base component to render. Defaults to div.","defaultValue":"'div'"},{"name":"isFilled","type":"boolean","description":"Flag indicating if this split layout item should fill the available horizontal space.","defaultValue":"false"}]},"SplitItemProps":{"name":"SplitItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the split layout item."},{"name":"className","type":"string","description":"Additional classes added to the split layout item."},{"name":"component","type":"React.ReactNode","description":"Sets the base component to render. Defaults to div."},{"name":"isFilled","type":"boolean","description":"Flag indicating if this split layout item should fill the available horizontal space."}]},"Split":{"name":"Split","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the split layout.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the split layout.","defaultValue":"''"},{"name":"component","type":"React.ReactNode","description":"Sets the base component to render. Defaults to div.","defaultValue":"'div'"},{"name":"hasGutter","type":"boolean","description":"Adds space between children.","defaultValue":"false"},{"name":"isWrappable","type":"boolean","description":"Allows children to wrap.","defaultValue":"false"}]},"SplitProps":{"name":"SplitProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the split layout."},{"name":"className","type":"string","description":"Additional classes added to the split layout."},{"name":"component","type":"React.ReactNode","description":"Sets the base component to render. Defaults to div."},{"name":"hasGutter","type":"boolean","description":"Adds space between children."},{"name":"isWrappable","type":"boolean","description":"Allows children to wrap."}]},"LevelItem":{"name":"LevelItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Level Layout Item","defaultValue":"null"}]},"LevelItemProps":{"name":"LevelItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Level Layout Item"}]},"Level":{"name":"Level","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Level layout","defaultValue":"null"},{"name":"className","type":"string","description":"additional classes added to the Level layout","defaultValue":"''"},{"name":"hasGutter","type":"boolean","description":"Adds space between children."}]},"LevelProps":{"name":"LevelProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Level layout"},{"name":"className","type":"string","description":"additional classes added to the Level layout"},{"name":"hasGutter","type":"boolean","description":"Adds space between children."}]},"GridItem":{"name":"GridItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Grid Layout Item","defaultValue":"null"},{"name":"className","type":"string","description":"additional classes added to the Grid Layout Item","defaultValue":"''"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to div","defaultValue":"'div'"},{"name":"lg","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns the grid item spans on large device. Value should be a number 1-12"},{"name":"lgOffset","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns the grid item is offset on large device. Value should be a number 1-12"},{"name":"lgRowSpan","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of rows the grid item spans on large device. Value should be a number 1-12"},{"name":"md","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns the grid item spans on medium device. Value should be a number 1-12"},{"name":"mdOffset","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns the grid item is offset on medium device. Value should be a number 1-12"},{"name":"mdRowSpan","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of rows the grid item spans on medium device. Value should be a number 1-12"},{"name":"offset","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns a grid item is offset","defaultValue":"null"},{"name":"order","type":"{\n default?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}","description":"Modifies the flex layout element order property"},{"name":"rowSpan","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of rows the grid item spans. Value should be a number 1-12","defaultValue":"null"},{"name":"sm","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns the grid item spans on small device. Value should be a number 1-12"},{"name":"smOffset","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns the grid item is offset on small device. Value should be a number 1-12"},{"name":"smRowSpan","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of rows the grid item spans on medium device. Value should be a number 1-12"},{"name":"span","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns the grid item spans. Value should be a number 1-12","defaultValue":"null"},{"name":"xl","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns the grid item spans on xLarge device. Value should be a number 1-12"},{"name":"xl2","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns the grid item spans on 2xLarge device. Value should be a number 1-12"},{"name":"xl2Offset","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns the grid item is offset on 2xLarge device. Value should be a number 1-12"},{"name":"xl2RowSpan","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of rows the grid item spans on 2xLarge device. Value should be a number 1-12"},{"name":"xlOffset","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns the grid item is offset on xLarge device. Value should be a number 1-12"},{"name":"xlRowSpan","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of rows the grid item spans on large device. Value should be a number 1-12"}]},"GridItemProps":{"name":"GridItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Grid Layout Item"},{"name":"className","type":"string","description":"additional classes added to the Grid Layout Item"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to div"},{"name":"lg","type":"gridSpans","description":"the number of columns the grid item spans on large device. Value should be a number 1-12"},{"name":"lgOffset","type":"gridSpans","description":"the number of columns the grid item is offset on large device. Value should be a number 1-12"},{"name":"lgRowSpan","type":"gridSpans","description":"the number of rows the grid item spans on large device. Value should be a number 1-12"},{"name":"md","type":"gridSpans","description":"the number of columns the grid item spans on medium device. Value should be a number 1-12"},{"name":"mdOffset","type":"gridSpans","description":"the number of columns the grid item is offset on medium device. Value should be a number 1-12"},{"name":"mdRowSpan","type":"gridSpans","description":"the number of rows the grid item spans on medium device. Value should be a number 1-12"},{"name":"offset","type":"gridSpans","description":"the number of columns a grid item is offset"},{"name":"order","type":"{\n default?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n }","description":"Modifies the flex layout element order property"},{"name":"rowSpan","type":"gridSpans","description":"the number of rows the grid item spans. Value should be a number 1-12"},{"name":"sm","type":"gridSpans","description":"the number of columns the grid item spans on small device. Value should be a number 1-12"},{"name":"smOffset","type":"gridSpans","description":"the number of columns the grid item is offset on small device. Value should be a number 1-12"},{"name":"smRowSpan","type":"gridSpans","description":"the number of rows the grid item spans on medium device. Value should be a number 1-12"},{"name":"span","type":"gridSpans","description":"the number of columns the grid item spans. Value should be a number 1-12"},{"name":"xl","type":"gridSpans","description":"the number of columns the grid item spans on xLarge device. Value should be a number 1-12"},{"name":"xl2","type":"gridSpans","description":"the number of columns the grid item spans on 2xLarge device. Value should be a number 1-12"},{"name":"xl2Offset","type":"gridSpans","description":"the number of columns the grid item is offset on 2xLarge device. Value should be a number 1-12"},{"name":"xl2RowSpan","type":"gridSpans","description":"the number of rows the grid item spans on 2xLarge device. Value should be a number 1-12"},{"name":"xlOffset","type":"gridSpans","description":"the number of columns the grid item is offset on xLarge device. Value should be a number 1-12"},{"name":"xlRowSpan","type":"gridSpans","description":"the number of rows the grid item spans on large device. Value should be a number 1-12"}]},"gridSpans":{"name":"gridSpans","description":"","props":[]},"Grid":{"name":"Grid","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Grid layout","defaultValue":"null"},{"name":"className","type":"string","description":"additional classes added to the Grid layout","defaultValue":"''"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to div","defaultValue":"'div'"},{"name":"hasGutter","type":"boolean","description":"Adds space between children."},{"name":"lg","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns all grid items should span on a large device"},{"name":"md","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns all grid items should span on a medium device"},{"name":"order","type":"{\n default?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}","description":"Modifies the flex layout element order property"},{"name":"sm","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns all grid items should span on a small device"},{"name":"span","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"The number of rows a column in the grid should span. Value should be a number 1-12","defaultValue":"null"},{"name":"xl","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns all grid items should span on a xLarge device"},{"name":"xl2","type":"1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12","description":"the number of columns all grid items should span on a 2xLarge device"}]},"GridProps":{"name":"GridProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Grid layout"},{"name":"className","type":"string","description":"additional classes added to the Grid layout"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to div"},{"name":"hasGutter","type":"boolean","description":"Adds space between children."},{"name":"lg","type":"gridItemSpanValueShape","description":"the number of columns all grid items should span on a large device"},{"name":"md","type":"gridItemSpanValueShape","description":"the number of columns all grid items should span on a medium device"},{"name":"order","type":"{\n default?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n }","description":"Modifies the flex layout element order property"},{"name":"sm","type":"gridItemSpanValueShape","description":"the number of columns all grid items should span on a small device"},{"name":"span","type":"gridItemSpanValueShape","description":"The number of rows a column in the grid should span. Value should be a number 1-12"},{"name":"xl","type":"gridItemSpanValueShape","description":"the number of columns all grid items should span on a xLarge device"},{"name":"xl2","type":"gridItemSpanValueShape","description":"the number of columns all grid items should span on a 2xLarge device"}]},"gridItemSpanValueShape":{"name":"gridItemSpanValueShape","description":"","props":[]},"GalleryItem":{"name":"GalleryItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Gallery Item","defaultValue":"null"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to div","defaultValue":"'div'"}]},"GalleryItemProps":{"name":"GalleryItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Gallery Item"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to div"}]},"Gallery":{"name":"Gallery","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Gallery layout","defaultValue":"null"},{"name":"className","type":"string","description":"additional classes added to the Gallery layout","defaultValue":"''"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to div","defaultValue":"'div'"},{"name":"hasGutter","type":"boolean","description":"Adds space between children.","defaultValue":"false"},{"name":"maxWidths","type":"{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}","description":"Maximum widths at various breakpoints."},{"name":"minWidths","type":"{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}","description":"Minimum widths at various breakpoints."}]},"GalleryProps":{"name":"GalleryProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Gallery layout"},{"name":"className","type":"string","description":"additional classes added to the Gallery layout"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to div"},{"name":"hasGutter","type":"boolean","description":"Adds space between children."},{"name":"maxWidths","type":"{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n }","description":"Maximum widths at various breakpoints."},{"name":"minWidths","type":"{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n }","description":"Minimum widths at various breakpoints."}]},"FlexItem":{"name":"FlexItem","description":"","props":[{"name":"align","type":"{\n default?: 'alignLeft' | 'alignRight';\n sm?: 'alignLeft' | 'alignRight';\n md?: 'alignLeft' | 'alignRight';\n lg?: 'alignLeft' | 'alignRight';\n xl?: 'alignLeft' | 'alignRight';\n '2xl'?: 'alignLeft' | 'alignRight';\n}","description":"Value to use for margin: auto at various breakpoints"},{"name":"alignSelf","type":"{\n default?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n sm?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n md?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n lg?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n xl?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n '2xl'?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n}","description":"Value to add for align-self property at various breakpoints"},{"name":"children","type":"React.ReactNode","description":"content rendered inside the Flex layout","defaultValue":"null"},{"name":"className","type":"string","description":"additional classes added to the Flex layout","defaultValue":"''"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to div","defaultValue":"'div'"},{"name":"flex","type":"{\n default?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n sm?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n md?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n lg?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n xl?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n '2xl'?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n}","description":"Value to add for flex property at various breakpoints"},{"name":"fullWidth","type":"{\n default?: 'fullWidth';\n sm?: 'fullWidth';\n md?: 'fullWidth';\n lg?: 'fullWidth';\n xl?: 'fullWidth';\n '2xl'?: 'fullWidth';\n}","description":"Whether to set width: 100% at various breakpoints"},{"name":"grow","type":"{\n default?: 'grow';\n sm?: 'grow';\n md?: 'grow';\n lg?: 'grow';\n xl?: 'grow';\n '2xl'?: 'grow';\n}","description":"Whether to add flex: grow at various breakpoints"},{"name":"order","type":"{\n default?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}","description":"Modifies the flex layout element order property"},{"name":"shrink","type":"{\n default?: 'shrink';\n sm?: 'shrink';\n md?: 'shrink';\n lg?: 'shrink';\n xl?: 'shrink';\n '2xl'?: 'shrink';\n}","description":"Whether to add flex: shrink at various breakpoints"},{"name":"spacer","type":"{\n default?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n sm?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n md?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n lg?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n xl?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n '2xl'?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n}","description":"Spacers at various breakpoints"}]},"FlexItemProps":{"name":"FlexItemProps","description":"","props":[{"name":"align","type":"{\n default?: 'alignLeft' | 'alignRight';\n sm?: 'alignLeft' | 'alignRight';\n md?: 'alignLeft' | 'alignRight';\n lg?: 'alignLeft' | 'alignRight';\n xl?: 'alignLeft' | 'alignRight';\n '2xl'?: 'alignLeft' | 'alignRight';\n }","description":"Value to use for margin: auto at various breakpoints"},{"name":"alignSelf","type":"{\n default?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n sm?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n md?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n lg?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n xl?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n '2xl'?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n }","description":"Value to add for align-self property at various breakpoints"},{"name":"children","type":"React.ReactNode","description":"content rendered inside the Flex layout"},{"name":"className","type":"string","description":"additional classes added to the Flex layout"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to div"},{"name":"flex","type":"{\n default?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n sm?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n md?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n lg?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n xl?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n '2xl'?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n }","description":"Value to add for flex property at various breakpoints"},{"name":"fullWidth","type":"{\n default?: 'fullWidth';\n sm?: 'fullWidth';\n md?: 'fullWidth';\n lg?: 'fullWidth';\n xl?: 'fullWidth';\n '2xl'?: 'fullWidth';\n }","description":"Whether to set width: 100% at various breakpoints"},{"name":"grow","type":"{\n default?: 'grow';\n sm?: 'grow';\n md?: 'grow';\n lg?: 'grow';\n xl?: 'grow';\n '2xl'?: 'grow';\n }","description":"Whether to add flex: grow at various breakpoints"},{"name":"order","type":"{\n default?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n }","description":"Modifies the flex layout element order property"},{"name":"shrink","type":"{\n default?: 'shrink';\n sm?: 'shrink';\n md?: 'shrink';\n lg?: 'shrink';\n xl?: 'shrink';\n '2xl'?: 'shrink';\n }","description":"Whether to add flex: shrink at various breakpoints"},{"name":"spacer","type":"{\n default?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n sm?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n md?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n lg?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n xl?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n '2xl'?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n }","description":"Spacers at various breakpoints"}]},"Flex":{"name":"Flex","description":"","props":[{"name":"align","type":"{\n default?: 'alignLeft' | 'alignRight';\n sm?: 'alignLeft' | 'alignRight';\n md?: 'alignLeft' | 'alignRight';\n lg?: 'alignLeft' | 'alignRight';\n xl?: 'alignLeft' | 'alignRight';\n '2xl'?: 'alignLeft' | 'alignRight';\n}","description":"Value to use for margin: auto at various breakpoints"},{"name":"alignContent","type":"{\n default?:\n | 'alignContentFlexStart'\n | 'alignContentFlexEnd'\n | 'alignContentCenter'\n | 'alignContentStretch'\n | 'alignContentSpaceBetween'\n | 'alignContentSpaceAround';\n sm?:\n | 'alignContentFlexStart'\n | 'alignContentFlexEnd'\n | 'alignContentCenter'\n | 'alignContentStretch'\n | 'alignContentSpaceBetween'\n | 'alignContentSpaceAround';\n md?:\n | 'alignContentFlexStart'\n | 'alignContentFlexEnd'\n | 'alignContentCenter'\n | 'alignContentStretch'\n | 'alignContentSpaceBetween'\n | 'alignContentSpaceAround';\n lg?:\n | 'alignContentFlexStart'\n | 'alignContentFlexEnd'\n | 'alignContentCenter'\n | 'alignContentStretch'\n | 'alignContentSpaceBetween'\n | 'alignContentSpaceAround';\n xl?:\n | 'alignContentFlexStart'\n | 'alignContentFlexEnd'\n | 'alignContentCenter'\n | 'alignContentStretch'\n | 'alignContentSpaceBetween'\n | 'alignContentSpaceAround';\n '2xl'?:\n | 'alignContentFlexStart'\n | 'alignContentFlexEnd'\n | 'alignContentCenter'\n | 'alignContentStretch'\n | 'alignContentSpaceBetween'\n | 'alignContentSpaceAround';\n}","description":"Value to add for align-content property at various breakpoints"},{"name":"alignItems","type":"{\n default?:\n | 'alignItemsFlexStart'\n | 'alignItemsFlexEnd'\n | 'alignItemsCenter'\n | 'alignItemsStretch'\n | 'alignItemsBaseline';\n sm?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';\n md?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';\n lg?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';\n xl?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';\n '2xl'?:\n | 'alignItemsFlexStart'\n | 'alignItemsFlexEnd'\n | 'alignItemsCenter'\n | 'alignItemsStretch'\n | 'alignItemsBaseline';\n}","description":"Value to add for align-items property at various breakpoints"},{"name":"alignSelf","type":"{\n default?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n sm?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n md?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n lg?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n xl?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n '2xl'?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n}","description":"Value to add for align-self property at various breakpoints"},{"name":"children","type":"React.ReactNode","description":"content rendered inside the Flex layout","defaultValue":"null"},{"name":"className","type":"string","description":"additional classes added to the Flex layout","defaultValue":"''"},{"name":"columnGap","type":"{\n default?:\n | 'columnGap'\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap2xl'\n | 'columnGap3xl'\n | 'columnGap4xl';\n sm?:\n | 'columnGap'\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap2xl'\n | 'columnGap3xl'\n | 'columnGap4xl';\n md?:\n | 'columnGap'\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap2xl'\n | 'columnGap3xl'\n | 'columnGap4xl';\n lg?:\n | 'columnGap'\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap2xl'\n | 'columnGap3xl'\n | 'columnGap4xl';\n xl?:\n | 'columnGap'\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap2xl'\n | 'columnGap3xl'\n | 'columnGap4xl';\n '2xl'?:\n | 'columnGap'\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap2xl'\n | 'columnGap3xl'\n | 'columnGap4xl';\n}","description":"Gap beween columns at various breakpoints. This will override spacers for the main axis."},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to div","defaultValue":"'div'"},{"name":"direction","type":"{\n default?: 'column' | 'columnReverse' | 'row' | 'rowReverse';\n sm?: 'column' | 'columnReverse' | 'row' | 'rowReverse';\n md?: 'column' | 'columnReverse' | 'row' | 'rowReverse';\n lg?: 'column' | 'columnReverse' | 'row' | 'rowReverse';\n xl?: 'column' | 'columnReverse' | 'row' | 'rowReverse';\n '2xl'?: 'column' | 'columnReverse' | 'row' | 'rowReverse';\n}","description":"Value to add for flex-direction property at various breakpoints"},{"name":"display","type":"{\n default?: 'inlineFlex';\n sm?: 'flex' | 'inlineFlex';\n md?: 'flex' | 'inlineFlex';\n lg?: 'flex' | 'inlineFlex';\n xl?: 'flex' | 'inlineFlex';\n '2xl'?: 'flex' | 'inlineFlex';\n}","description":"Value to set to display property at various breakpoints"},{"name":"flex","type":"{\n default?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n sm?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n md?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n lg?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n xl?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n '2xl'?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n}","description":"Value to add for flex property at various breakpoints"},{"name":"flexWrap","type":"{\n default?: 'wrap' | 'wrapReverse' | 'nowrap';\n sm?: 'wrap' | 'wrapReverse' | 'nowrap';\n md?: 'wrap' | 'wrapReverse' | 'nowrap';\n lg?: 'wrap' | 'wrapReverse' | 'nowrap';\n xl?: 'wrap' | 'wrapReverse' | 'nowrap';\n '2xl'?: 'wrap' | 'wrapReverse' | 'nowrap';\n}","description":"Value to set for flex-wrap property at various breakpoints"},{"name":"fullWidth","type":"{\n default?: 'fullWidth';\n sm?: 'fullWidth';\n md?: 'fullWidth';\n lg?: 'fullWidth';\n xl?: 'fullWidth';\n '2xl'?: 'fullWidth';\n}","description":"Whether to set width: 100% at various breakpoints"},{"name":"gap","type":"{\n default?: 'gap' | 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';\n sm?: 'gap' | 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';\n md?: 'gap' | 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';\n lg?: 'gap' | 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';\n xl?: 'gap' | 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';\n '2xl'?: 'gap' | 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';\n}","description":"Gap between items at various breakpoints. This will override spacers for the main axis."},{"name":"grow","type":"{\n default?: 'grow';\n sm?: 'grow';\n md?: 'grow';\n lg?: 'grow';\n xl?: 'grow';\n '2xl'?: 'grow';\n}","description":"Whether to add flex: grow at various breakpoints"},{"name":"justifyContent","type":"{\n default?:\n | 'justifyContentFlexStart'\n | 'justifyContentFlexEnd'\n | 'justifyContentCenter'\n | 'justifyContentSpaceBetween'\n | 'justifyContentSpaceAround'\n | 'justifyContentSpaceEvenly';\n sm?:\n | 'justifyContentFlexStart'\n | 'justifyContentFlexEnd'\n | 'justifyContentCenter'\n | 'justifyContentSpaceBetween'\n | 'justifyContentSpaceAround'\n | 'justifyContentSpaceEvenly';\n md?:\n | 'justifyContentFlexStart'\n | 'justifyContentFlexEnd'\n | 'justifyContentCenter'\n | 'justifyContentSpaceBetween'\n | 'justifyContentSpaceAround'\n | 'justifyContentSpaceEvenly';\n lg?:\n | 'justifyContentFlexStart'\n | 'justifyContentFlexEnd'\n | 'justifyContentCenter'\n | 'justifyContentSpaceBetween'\n | 'justifyContentSpaceAround'\n | 'justifyContentSpaceEvenly';\n xl?:\n | 'justifyContentFlexStart'\n | 'justifyContentFlexEnd'\n | 'justifyContentCenter'\n | 'justifyContentSpaceBetween'\n | 'justifyContentSpaceAround'\n | 'justifyContentSpaceEvenly';\n '2xl'?:\n | 'justifyContentFlexStart'\n | 'justifyContentFlexEnd'\n | 'justifyContentCenter'\n | 'justifyContentSpaceBetween'\n | 'justifyContentSpaceAround'\n | 'justifyContentSpaceEvenly';\n}","description":"Value to add for justify-content property at various breakpoints"},{"name":"order","type":"{\n default?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}","description":"Modifies the flex layout element order property"},{"name":"rowGap","type":"{\n default?:\n | 'rowGap'\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap2xl'\n | 'rowGap3xl'\n | 'rowGap4xl';\n sm?:\n | 'rowGap'\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap2xl'\n | 'rowGap3xl'\n | 'rowGap4xl';\n md?:\n | 'rowGap'\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap2xl'\n | 'rowGap3xl'\n | 'rowGap4xl';\n lg?:\n | 'rowGap'\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap2xl'\n | 'rowGap3xl'\n | 'rowGap4xl';\n xl?:\n | 'rowGap'\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap2xl'\n | 'rowGap3xl'\n | 'rowGap4xl';\n '2xl'?:\n | 'rowGap'\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap2xl'\n | 'rowGap3xl'\n | 'rowGap4xl';\n}","description":"Gap between rows at various breakpoints. This will override spacers for the main axis."},{"name":"shrink","type":"{\n default?: 'shrink';\n sm?: 'shrink';\n md?: 'shrink';\n lg?: 'shrink';\n xl?: 'shrink';\n '2xl'?: 'shrink';\n}","description":"Whether to add flex: shrink at various breakpoints"},{"name":"spaceItems","type":"{\n default?:\n | 'spaceItemsNone'\n | 'spaceItemsXs'\n | 'spaceItemsSm'\n | 'spaceItemsMd'\n | 'spaceItemsLg'\n | 'spaceItemsXl'\n | 'spaceItems2xl'\n | 'spaceItems3xl'\n | 'spaceItems4xl';\n sm?:\n | 'spaceItemsNone'\n | 'spaceItemsXs'\n | 'spaceItemsSm'\n | 'spaceItemsMd'\n | 'spaceItemsLg'\n | 'spaceItemsXl'\n | 'spaceItems2xl'\n | 'spaceItems3xl'\n | 'spaceItems4xl';\n md?:\n | 'spaceItemsNone'\n | 'spaceItemsXs'\n | 'spaceItemsSm'\n | 'spaceItemsMd'\n | 'spaceItemsLg'\n | 'spaceItemsXl'\n | 'spaceItems2xl'\n | 'spaceItems3xl'\n | 'spaceItems4xl';\n lg?:\n | 'spaceItemsNone'\n | 'spaceItemsXs'\n | 'spaceItemsSm'\n | 'spaceItemsMd'\n | 'spaceItemsLg'\n | 'spaceItemsXl'\n | 'spaceItems2xl'\n | 'spaceItems3xl'\n | 'spaceItems4xl';\n xl?:\n | 'spaceItemsNone'\n | 'spaceItemsXs'\n | 'spaceItemsSm'\n | 'spaceItemsMd'\n | 'spaceItemsLg'\n | 'spaceItemsXl'\n | 'spaceItems2xl'\n | 'spaceItems3xl'\n | 'spaceItems4xl';\n '2xl'?:\n | 'spaceItemsNone'\n | 'spaceItemsXs'\n | 'spaceItemsSm'\n | 'spaceItemsMd'\n | 'spaceItemsLg'\n | 'spaceItemsXl'\n | 'spaceItems2xl'\n | 'spaceItems3xl'\n | 'spaceItems4xl';\n}","description":"Space items at various breakpoints"},{"name":"spacer","type":"{\n default?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n sm?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n md?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n lg?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n xl?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n '2xl'?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n}","description":"Spacers at various breakpoints"}]},"FlexProps":{"name":"FlexProps","description":"","props":[{"name":"align","type":"{\n default?: 'alignLeft' | 'alignRight';\n sm?: 'alignLeft' | 'alignRight';\n md?: 'alignLeft' | 'alignRight';\n lg?: 'alignLeft' | 'alignRight';\n xl?: 'alignLeft' | 'alignRight';\n '2xl'?: 'alignLeft' | 'alignRight';\n }","description":"Value to use for margin: auto at various breakpoints"},{"name":"alignContent","type":"{\n default?:\n | 'alignContentFlexStart'\n | 'alignContentFlexEnd'\n | 'alignContentCenter'\n | 'alignContentStretch'\n | 'alignContentSpaceBetween'\n | 'alignContentSpaceAround';\n sm?:\n | 'alignContentFlexStart'\n | 'alignContentFlexEnd'\n | 'alignContentCenter'\n | 'alignContentStretch'\n | 'alignContentSpaceBetween'\n | 'alignContentSpaceAround';\n md?:\n | 'alignContentFlexStart'\n | 'alignContentFlexEnd'\n | 'alignContentCenter'\n | 'alignContentStretch'\n | 'alignContentSpaceBetween'\n | 'alignContentSpaceAround';\n lg?:\n | 'alignContentFlexStart'\n | 'alignContentFlexEnd'\n | 'alignContentCenter'\n | 'alignContentStretch'\n | 'alignContentSpaceBetween'\n | 'alignContentSpaceAround';\n xl?:\n | 'alignContentFlexStart'\n | 'alignContentFlexEnd'\n | 'alignContentCenter'\n | 'alignContentStretch'\n | 'alignContentSpaceBetween'\n | 'alignContentSpaceAround';\n '2xl'?:\n | 'alignContentFlexStart'\n | 'alignContentFlexEnd'\n | 'alignContentCenter'\n | 'alignContentStretch'\n | 'alignContentSpaceBetween'\n | 'alignContentSpaceAround';\n }","description":"Value to add for align-content property at various breakpoints"},{"name":"alignItems","type":"{\n default?:\n | 'alignItemsFlexStart'\n | 'alignItemsFlexEnd'\n | 'alignItemsCenter'\n | 'alignItemsStretch'\n | 'alignItemsBaseline';\n sm?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';\n md?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';\n lg?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';\n xl?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';\n '2xl'?:\n | 'alignItemsFlexStart'\n | 'alignItemsFlexEnd'\n | 'alignItemsCenter'\n | 'alignItemsStretch'\n | 'alignItemsBaseline';\n }","description":"Value to add for align-items property at various breakpoints"},{"name":"alignSelf","type":"{\n default?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n sm?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n md?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n lg?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n xl?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n '2xl'?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';\n }","description":"Value to add for align-self property at various breakpoints"},{"name":"children","type":"React.ReactNode","description":"content rendered inside the Flex layout"},{"name":"className","type":"string","description":"additional classes added to the Flex layout"},{"name":"columnGap","type":"{\n default?:\n | 'columnGap'\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap2xl'\n | 'columnGap3xl'\n | 'columnGap4xl';\n sm?:\n | 'columnGap'\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap2xl'\n | 'columnGap3xl'\n | 'columnGap4xl';\n md?:\n | 'columnGap'\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap2xl'\n | 'columnGap3xl'\n | 'columnGap4xl';\n lg?:\n | 'columnGap'\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap2xl'\n | 'columnGap3xl'\n | 'columnGap4xl';\n xl?:\n | 'columnGap'\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap2xl'\n | 'columnGap3xl'\n | 'columnGap4xl';\n '2xl'?:\n | 'columnGap'\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap2xl'\n | 'columnGap3xl'\n | 'columnGap4xl';\n }","description":"Gap beween columns at various breakpoints. This will override spacers for the main axis."},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to div"},{"name":"direction","type":"{\n default?: 'column' | 'columnReverse' | 'row' | 'rowReverse';\n sm?: 'column' | 'columnReverse' | 'row' | 'rowReverse';\n md?: 'column' | 'columnReverse' | 'row' | 'rowReverse';\n lg?: 'column' | 'columnReverse' | 'row' | 'rowReverse';\n xl?: 'column' | 'columnReverse' | 'row' | 'rowReverse';\n '2xl'?: 'column' | 'columnReverse' | 'row' | 'rowReverse';\n }","description":"Value to add for flex-direction property at various breakpoints"},{"name":"display","type":"{\n default?: 'inlineFlex';\n sm?: 'flex' | 'inlineFlex';\n md?: 'flex' | 'inlineFlex';\n lg?: 'flex' | 'inlineFlex';\n xl?: 'flex' | 'inlineFlex';\n '2xl'?: 'flex' | 'inlineFlex';\n }","description":"Value to set to display property at various breakpoints"},{"name":"flex","type":"{\n default?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n sm?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n md?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n lg?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n xl?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n '2xl'?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';\n }","description":"Value to add for flex property at various breakpoints"},{"name":"flexWrap","type":"{\n default?: 'wrap' | 'wrapReverse' | 'nowrap';\n sm?: 'wrap' | 'wrapReverse' | 'nowrap';\n md?: 'wrap' | 'wrapReverse' | 'nowrap';\n lg?: 'wrap' | 'wrapReverse' | 'nowrap';\n xl?: 'wrap' | 'wrapReverse' | 'nowrap';\n '2xl'?: 'wrap' | 'wrapReverse' | 'nowrap';\n }","description":"Value to set for flex-wrap property at various breakpoints"},{"name":"fullWidth","type":"{\n default?: 'fullWidth';\n sm?: 'fullWidth';\n md?: 'fullWidth';\n lg?: 'fullWidth';\n xl?: 'fullWidth';\n '2xl'?: 'fullWidth';\n }","description":"Whether to set width: 100% at various breakpoints"},{"name":"gap","type":"{\n default?: 'gap' | 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';\n sm?: 'gap' | 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';\n md?: 'gap' | 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';\n lg?: 'gap' | 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';\n xl?: 'gap' | 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';\n '2xl'?: 'gap' | 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap2xl' | 'gap3xl' | 'gap4xl';\n }","description":"Gap between items at various breakpoints. This will override spacers for the main axis."},{"name":"grow","type":"{\n default?: 'grow';\n sm?: 'grow';\n md?: 'grow';\n lg?: 'grow';\n xl?: 'grow';\n '2xl'?: 'grow';\n }","description":"Whether to add flex: grow at various breakpoints"},{"name":"justifyContent","type":"{\n default?:\n | 'justifyContentFlexStart'\n | 'justifyContentFlexEnd'\n | 'justifyContentCenter'\n | 'justifyContentSpaceBetween'\n | 'justifyContentSpaceAround'\n | 'justifyContentSpaceEvenly';\n sm?:\n | 'justifyContentFlexStart'\n | 'justifyContentFlexEnd'\n | 'justifyContentCenter'\n | 'justifyContentSpaceBetween'\n | 'justifyContentSpaceAround'\n | 'justifyContentSpaceEvenly';\n md?:\n | 'justifyContentFlexStart'\n | 'justifyContentFlexEnd'\n | 'justifyContentCenter'\n | 'justifyContentSpaceBetween'\n | 'justifyContentSpaceAround'\n | 'justifyContentSpaceEvenly';\n lg?:\n | 'justifyContentFlexStart'\n | 'justifyContentFlexEnd'\n | 'justifyContentCenter'\n | 'justifyContentSpaceBetween'\n | 'justifyContentSpaceAround'\n | 'justifyContentSpaceEvenly';\n xl?:\n | 'justifyContentFlexStart'\n | 'justifyContentFlexEnd'\n | 'justifyContentCenter'\n | 'justifyContentSpaceBetween'\n | 'justifyContentSpaceAround'\n | 'justifyContentSpaceEvenly';\n '2xl'?:\n | 'justifyContentFlexStart'\n | 'justifyContentFlexEnd'\n | 'justifyContentCenter'\n | 'justifyContentSpaceBetween'\n | 'justifyContentSpaceAround'\n | 'justifyContentSpaceEvenly';\n }","description":"Value to add for justify-content property at various breakpoints"},{"name":"order","type":"{\n default?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n }","description":"Modifies the flex layout element order property"},{"name":"rowGap","type":"{\n default?:\n | 'rowGap'\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap2xl'\n | 'rowGap3xl'\n | 'rowGap4xl';\n sm?:\n | 'rowGap'\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap2xl'\n | 'rowGap3xl'\n | 'rowGap4xl';\n md?:\n | 'rowGap'\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap2xl'\n | 'rowGap3xl'\n | 'rowGap4xl';\n lg?:\n | 'rowGap'\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap2xl'\n | 'rowGap3xl'\n | 'rowGap4xl';\n xl?:\n | 'rowGap'\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap2xl'\n | 'rowGap3xl'\n | 'rowGap4xl';\n '2xl'?:\n | 'rowGap'\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap2xl'\n | 'rowGap3xl'\n | 'rowGap4xl';\n }","description":"Gap between rows at various breakpoints. This will override spacers for the main axis."},{"name":"shrink","type":"{\n default?: 'shrink';\n sm?: 'shrink';\n md?: 'shrink';\n lg?: 'shrink';\n xl?: 'shrink';\n '2xl'?: 'shrink';\n }","description":"Whether to add flex: shrink at various breakpoints"},{"name":"spaceItems","type":"{\n default?:\n | 'spaceItemsNone'\n | 'spaceItemsXs'\n | 'spaceItemsSm'\n | 'spaceItemsMd'\n | 'spaceItemsLg'\n | 'spaceItemsXl'\n | 'spaceItems2xl'\n | 'spaceItems3xl'\n | 'spaceItems4xl';\n sm?:\n | 'spaceItemsNone'\n | 'spaceItemsXs'\n | 'spaceItemsSm'\n | 'spaceItemsMd'\n | 'spaceItemsLg'\n | 'spaceItemsXl'\n | 'spaceItems2xl'\n | 'spaceItems3xl'\n | 'spaceItems4xl';\n md?:\n | 'spaceItemsNone'\n | 'spaceItemsXs'\n | 'spaceItemsSm'\n | 'spaceItemsMd'\n | 'spaceItemsLg'\n | 'spaceItemsXl'\n | 'spaceItems2xl'\n | 'spaceItems3xl'\n | 'spaceItems4xl';\n lg?:\n | 'spaceItemsNone'\n | 'spaceItemsXs'\n | 'spaceItemsSm'\n | 'spaceItemsMd'\n | 'spaceItemsLg'\n | 'spaceItemsXl'\n | 'spaceItems2xl'\n | 'spaceItems3xl'\n | 'spaceItems4xl';\n xl?:\n | 'spaceItemsNone'\n | 'spaceItemsXs'\n | 'spaceItemsSm'\n | 'spaceItemsMd'\n | 'spaceItemsLg'\n | 'spaceItemsXl'\n | 'spaceItems2xl'\n | 'spaceItems3xl'\n | 'spaceItems4xl';\n '2xl'?:\n | 'spaceItemsNone'\n | 'spaceItemsXs'\n | 'spaceItemsSm'\n | 'spaceItemsMd'\n | 'spaceItemsLg'\n | 'spaceItemsXl'\n | 'spaceItems2xl'\n | 'spaceItems3xl'\n | 'spaceItems4xl';\n }","description":"Space items at various breakpoints"},{"name":"spacer","type":"{\n default?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n sm?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n md?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n lg?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n xl?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n '2xl'?:\n | 'spacerNone'\n | 'spacerXs'\n | 'spacerSm'\n | 'spacerMd'\n | 'spacerLg'\n | 'spacerXl'\n | 'spacer2xl'\n | 'spacer3xl'\n | 'spacer4xl';\n }","description":"Spacers at various breakpoints"}]},"Bullseye":{"name":"Bullseye","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Bullseye layout","defaultValue":"null"},{"name":"className","type":"string","description":"additional classes added to the Bullseye layout","defaultValue":"''"},{"name":"component","type":"JSX.IntrinsicElements","description":"Sets the base component to render. defaults to div","defaultValue":"'div'"}]},"BullseyeProps":{"name":"BullseyeProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Bullseye layout"},{"name":"className","type":"string","description":"additional classes added to the Bullseye layout"},{"name":"component","type":"keyof JSX.IntrinsicElements","description":"Sets the base component to render. defaults to div"}]},"Popper":{"name":"Popper","description":"","props":[{"name":"animationDuration","type":"No type info","defaultValue":"0"},{"name":"appendTo","type":"No type info","defaultValue":"() => document.body"},{"name":"direction","type":"No type info","defaultValue":"'down'"},{"name":"distance","type":"No type info","defaultValue":"0"},{"name":"enableFlip","type":"No type info","defaultValue":"true"},{"name":"entryDelay","type":"No type info","defaultValue":"0"},{"name":"exitDelay","type":"No type info","defaultValue":"0"},{"name":"flipBehavior","type":"No type info","defaultValue":"'flip'"},{"name":"isVisible","type":"No type info","defaultValue":"true"},{"name":"minWidth","type":"No type info","defaultValue":"'trigger'"},{"name":"onHidden","type":"No type info","defaultValue":"() => {}"},{"name":"onHide","type":"No type info","defaultValue":"() => {}"},{"name":"onMount","type":"No type info","defaultValue":"() => {}"},{"name":"onShow","type":"No type info","defaultValue":"() => {}"},{"name":"onShown","type":"No type info","defaultValue":"() => {}"},{"name":"position","type":"No type info","defaultValue":"'start'"},{"name":"preventOverflow","type":"No type info","defaultValue":"false"},{"name":"zIndex","type":"No type info","defaultValue":"9999"}]},"PopperProps":{"name":"PopperProps","description":"","props":[{"name":"animationDuration","type":"number","description":"The duration of the CSS fade transition animation."},{"name":"appendTo","type":"HTMLElement | (() => HTMLElement) | 'inline'","description":"The container to append the popper to. Defaults to 'inline'."},{"name":"direction","type":"'up' | 'down'","description":"popper direction"},{"name":"distance","type":"number","description":"Distance of the popper to the trigger"},{"name":"enableFlip","type":"boolean","description":"Enable to flip the popper when it reaches the boundary"},{"name":"entryDelay","type":"number","description":"Delay in ms before the popper appears"},{"name":"exitDelay","type":"number","description":"Delay in ms before the popper disappears"},{"name":"flipBehavior","type":"| 'flip'\n | (\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'\n )[]","description":"The behavior of how the popper flips when it reaches the boundary"},{"name":"isVisible","type":"boolean","description":"True to make the popper visible"},{"name":"maxWidth","type":"string | 'trigger'","description":"Maximum width of the popper. If the value is \"trigger\", it will set the max width to the trigger element's width"},{"name":"minWidth","type":"string | 'trigger'","description":"Minimum width of the popper. If the value is \"trigger\", it will set the min width to the trigger element's width"},{"name":"onBlur","type":"(event?: FocusEvent) => void","description":"Callback function when trigger is blurred (focus leaves)"},{"name":"onDocumentClick","type":"(event?: MouseEvent, triggerElement?: HTMLElement, popperElement?: HTMLElement) => void","description":"Callback function when document is clicked"},{"name":"onDocumentKeyDown","type":"(event?: KeyboardEvent) => void","description":"Callback function when keydown event occurs on document"},{"name":"onFocus","type":"(event?: FocusEvent) => void","description":"Callback function when trigger is focused"},{"name":"onHidden","type":"() => void","description":"Callback when popper's hide transition has finished executing"},{"name":"onHide","type":"() => void","description":"Lifecycle function invoked when the popper begins to transition out."},{"name":"onMount","type":"() => void","description":"Lifecycle function invoked when the popper has been mounted to the DOM."},{"name":"onMouseEnter","type":"(event?: MouseEvent) => void","description":"Callback function when mouse enters trigger"},{"name":"onMouseLeave","type":"(event?: MouseEvent) => void","description":"Callback function when mouse leaves trigger"},{"name":"onPopperClick","type":"(event?: MouseEvent) => void","description":"Callback function when popper is clicked"},{"name":"onPopperMouseEnter","type":"(event?: MouseEvent) => void","description":"Callback function when mouse enters popper content"},{"name":"onPopperMouseLeave","type":"(event?: MouseEvent) => void","description":"Callback function when mouse leaves popper content"},{"name":"onShow","type":"() => void","description":"Lifecycle function invoked when the popper begins to transition in."},{"name":"onShown","type":"() => void","description":"Lifecycle function invoked when the popper has fully transitioned in."},{"name":"onTriggerClick","type":"(event?: MouseEvent) => void","description":"Callback function when trigger is clicked"},{"name":"onTriggerEnter","type":"(event?: KeyboardEvent) => void","description":"Callback function when Enter key is used on trigger"},{"name":"placement","type":"Placement","description":"Instead of direction and position can set the placement of the popper"},{"name":"popper","type":"React.ReactElement<any>","description":"The popper (menu/tooltip/popover) element","required":true},{"name":"popperRef","type":"HTMLElement | (() => HTMLElement) | React.RefObject<any>","description":"Reference to the popper (menu/tooltip/popover) element.\nPassing this prop will remove the wrapper div element from the popper."},{"name":"position","type":"'right' | 'left' | 'center' | 'start' | 'end'","description":"popper position"},{"name":"positionModifiers","type":"{\n top?: string;\n right?: string;\n bottom?: string;\n left?: string;\n topStart?: string;\n topEnd?: string;\n bottomStart?: string;\n bottomEnd?: string;\n leftStart?: string;\n leftEnd?: string;\n rightStart?: string;\n rightEnd?: string;\n }","description":"Map class names to positions, for example:\n{\n top: styles.modifiers.top,\n bottom: styles.modifiers.bottom,\n left: styles.modifiers.left,\n right: styles.modifiers.right\n}"},{"name":"preventOverflow","type":"boolean","description":"Flag to prevent the popper from overflowing its container and becoming partially obscured."},{"name":"trigger","type":"React.ReactNode","description":"Trigger reference element to which the popper is relatively placed to."},{"name":"triggerRef","type":"HTMLElement | (() => HTMLElement) | React.RefObject<any>","description":"A reference to the trigger reference element that can be passed instead of or along\nwith the trigger prop. When passed along with the trigger prop, the div element that\nwraps the trigger will be removed."},{"name":"width","type":"string | 'trigger'","description":"Custom width of the popper. If the value is \"trigger\", it will set the width to the trigger element's width"},{"name":"zIndex","type":"number","description":"z-index of the popper element"}]},"FocusTrap":{"name":"FocusTrap","description":"","props":[{"name":"active","type":"boolean","description":"","defaultValue":"true"},{"name":"focusTrapOptions","type":"FocusTrapOptions","description":"","defaultValue":"{}"},{"name":"paused","type":"boolean","description":"","defaultValue":"false"},{"name":"preventScrollOnDeactivate","type":"boolean","description":"Prevent from scrolling to the previously focused element on deactivation","defaultValue":"false"}]},"FocusTrapProps":{"name":"FocusTrapProps","description":"","props":[{"name":"active","type":"boolean","description":null},{"name":"focusTrapOptions","type":"FocusTrapOptions","description":null},{"name":"paused","type":"boolean","description":null},{"name":"preventScrollOnDeactivate","type":"boolean","description":"Prevent from scrolling to the previously focused element on deactivation"}]},"WizardBasicStep":{"name":"WizardBasicStep","description":"Type used to define 'basic' steps, or in other words, steps that are neither parents or children of parents.","props":[{"name":"component","type":"React.ReactElement<any>","description":"Content shown when the step's navigation item is selected. When treated as a parent step, only sub-step content will be shown."},{"name":"footer","type":"React.ReactElement<any> | Partial<WizardFooterProps>","description":"Replaces the step's footer. The step's footer takes precedence over the wizard's footer."},{"name":"id","type":"string | number","description":"Unique identifier","required":true},{"name":"index","type":"number","description":"Order index of step (starts at 1)","required":true},{"name":"isDisabled","type":"boolean","description":"Flag to disable the step's navigation item"},{"name":"isHidden","type":"boolean","description":"Flag to determine whether the step is hidden"},{"name":"isVisited","type":"boolean","description":"Flag to represent whether the step has been visited (navigated to)"},{"name":"name","type":"React.ReactNode","description":"Name of the step's navigation item","required":true},{"name":"navItem","type":"WizardNavItemType","description":"Replaces the step's navigation item or its properties."},{"name":"status","type":"'default' | 'error' | 'success'","description":"Used to determine icon next to the step's navItem"}]},"WizardParentStep":{"name":"WizardParentStep","description":"Type used to define parent steps.","props":[{"name":"isExpandable","type":"boolean","description":"Flag to determine whether the step can expand or not."},{"name":"subStepIds","type":"(string | number)[]","description":"Nested step IDs","required":true}]},"WizardSubStep":{"name":"WizardSubStep","description":"Type used to define sub-steps.","props":[{"name":"parentId","type":"string | number","description":"Unique identifier of the parent step","required":true}]},"WizardFooterButtonProps":{"name":"WizardFooterButtonProps","description":"Type for customizing a button (next, back or cancel) in a Wizard footer. It omits some props which either have a default value or are passed directly via WizardFooterProps.","props":[]},"WizardStepType":{"name":"WizardStepType","description":"Encompasses all step type variants that are internally controlled by the Wizard.","props":[]},"WizardFooterType":{"name":"WizardFooterType","description":"","props":[]},"WizardNavType":{"name":"WizardNavType","description":"","props":[]},"WizardNavItemType":{"name":"WizardNavItemType","description":"","props":[]},"CustomWizardNavFunction":{"name":"CustomWizardNavFunction","description":"Callback for the Wizard's 'nav' property. Returns element which replaces the Wizard's default navigation.","props":[]},"CustomWizardNavItemFunction":{"name":"CustomWizardNavItemFunction","description":"Callback for the Wizard's 'navItem' property. Returns element which replaces the WizardStep's default navigation item.","props":[]},"CustomWizardFooterFunction":{"name":"CustomWizardFooterFunction","description":"Callback for the Wizard's 'footer' property. Returns element which replaces the Wizard's default footer.","props":[]},"WizardToggle":{"name":"WizardToggle","description":"Used to toggle between step content, including the body and footer. This is also where the navigation and its expandability is controlled.","props":[{"name":"activeStep","type":"WizardBasicStep | WizardParentStep | WizardSubStep","description":"The current step","required":true},{"name":"aria-label","type":"string","description":"The expandable dropdown button's aria-label","defaultValue":"'Wizard toggle'"},{"name":"footer","type":"React.ReactElement<any>","description":"Wizard footer","required":true},{"name":"isNavExpanded","type":"boolean","description":"Flag to determine whether the dropdown navigation is expanded"},{"name":"nav","type":"React.ReactElement<WizardNavProps>","description":"Wizard navigation","required":true},{"name":"steps","type":"WizardStepType[]","description":"List of steps and/or sub-steps","required":true},{"name":"toggleNavExpanded","type":"(event: React.MouseEvent<HTMLButtonElement> | KeyboardEvent) => void","description":"Callback to expand or collapse the dropdown navigation"}]},"WizardToggleProps":{"name":"WizardToggleProps","description":"Used to toggle between step content, including the body and footer. This is also where the navigation and its expandability is controlled.","props":[{"name":"activeStep","type":"WizardStepType","description":"The current step","required":true},{"name":"footer","type":"React.ReactElement<any>","description":"Wizard footer","required":true},{"name":"isNavExpanded","type":"boolean","description":"Flag to determine whether the dropdown navigation is expanded"},{"name":"nav","type":"React.ReactElement<WizardNavProps>","description":"Wizard navigation","required":true},{"name":"steps","type":"WizardStepType[]","description":"List of steps and/or sub-steps","required":true},{"name":"toggleNavExpanded","type":"(event: React.MouseEvent<HTMLButtonElement> | KeyboardEvent) => void","description":"Callback to expand or collapse the dropdown navigation"},{"name":"Unknown","type":"string","description":"The expandable dropdown button's aria-label"}]},"WizardStep":{"name":"WizardStep","description":"The primary child component for Wizard. Step props are used for the list of steps managed in context.","props":[{"name":"body","type":"Omit<Omit<WizardBodyProps, 'children'>, 'children'>","description":"Props for WizardBody that wraps content by default."},{"name":"children","type":"React.ReactNode | undefined","description":"Optional for when the step is used as a parent to sub-steps"},{"name":"footer","type":"React.ReactElement<any> | Partial<WizardFooterProps>","description":"Replaces the step's footer. The step's footer takes precedence over the wizard's footer."},{"name":"id","type":"string | number","description":"Unique identifier","required":true},{"name":"isDisabled","type":"boolean","description":"Flag to disable the step's navigation item"},{"name":"isExpandable","type":"boolean","description":"Flag to determine whether parent steps can expand or not. Defaults to false."},{"name":"isHidden","type":"boolean","description":"Flag to determine whether the step is hidden"},{"name":"name","type":"React.ReactNode","description":"Name of the step's navigation item","required":true},{"name":"navItem","type":"Partial<WizardNavItemProps> | CustomWizardNavItemFunction | React.ReactElement<any>","description":"Replaces the step's navigation item or its properties."},{"name":"status","type":"'default' | 'error' | 'success'","description":"Used to determine icon next to the step's navigation item"},{"name":"steps","type":"React.ReactElement<WizardStepProps>[]","description":"Optional list of sub-steps"}]},"WizardStepProps":{"name":"WizardStepProps","description":"The primary child component for Wizard. Step props are used for the list of steps managed in context.","props":[{"name":"body","type":"Omit<Omit<WizardBodyProps, 'children'>, 'children'>","description":"Props for WizardBody that wraps content by default."},{"name":"children","type":"React.ReactNode | undefined","description":"Optional for when the step is used as a parent to sub-steps"},{"name":"footer","type":"React.ReactElement<any> | Partial<WizardFooterProps>","description":"Replaces the step's footer. The step's footer takes precedence over the wizard's footer."},{"name":"id","type":"string | number","description":"Unique identifier","required":true},{"name":"isDisabled","type":"boolean","description":"Flag to disable the step's navigation item"},{"name":"isExpandable","type":"boolean","description":"Flag to determine whether parent steps can expand or not. Defaults to false."},{"name":"isHidden","type":"boolean","description":"Flag to determine whether the step is hidden"},{"name":"name","type":"React.ReactNode","description":"Name of the step's navigation item","required":true},{"name":"navItem","type":"WizardNavItemType","description":"Replaces the step's navigation item or its properties."},{"name":"status","type":"'default' | 'error' | 'success'","description":"Used to determine icon next to the step's navigation item"},{"name":"steps","type":"React.ReactElement<WizardStepProps>[]","description":"Optional list of sub-steps"}]},"WizardNavItem":{"name":"WizardNavItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Can nest a WizardNav component for substeps","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes spread to the wizard nav item"},{"name":"component","type":"'button' | 'a'","description":"Component used to render WizardNavItem","defaultValue":"'button'"},{"name":"content","type":"React.ReactNode","description":"The content to display in the navigation item","defaultValue":"''"},{"name":"href","type":"string","description":"An optional url to use for when using an anchor component"},{"name":"id","type":"string | number","description":"The id for the navigation item"},{"name":"isCurrent","type":"boolean","description":"Whether the navigation item is the currently active item","defaultValue":"false"},{"name":"isDisabled","type":"boolean","description":"Whether the navigation item is disabled","defaultValue":"false"},{"name":"isExpandable","type":"boolean","description":"Flag indicating that this NavItem has child steps and is expandable","defaultValue":"false"},{"name":"isVisited","type":"boolean","description":"Whether the navigation item has been visited","defaultValue":"false"},{"name":"onClick","type":"(event: React.MouseEvent<HTMLButtonElement> | React.MouseEvent<HTMLAnchorElement>, index: number) => any","description":"Callback for when the navigation item is clicked"},{"name":"ouiaId","type":"number | string","description":""},{"name":"ouiaSafe","type":"boolean","description":"","defaultValue":"true"},{"name":"status","type":"'default' | 'error' | 'success'","description":"Used to determine the icon displayed next to content. Default has no icon.","defaultValue":"'default'"},{"name":"stepIndex","type":"number","description":"The step index passed into the onNavItemClick callback","required":true},{"name":"target","type":"React.HTMLAttributeAnchorTarget","description":"Where to display the linked URL when using an anchor component"}]},"WizardNavItemProps":{"name":"WizardNavItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Can nest a WizardNav component for substeps"},{"name":"className","type":"string","description":"Additional classes spread to the wizard nav item"},{"name":"component","type":"'button' | 'a'","description":"Component used to render WizardNavItem"},{"name":"content","type":"React.ReactNode","description":"The content to display in the navigation item"},{"name":"href","type":"string","description":"An optional url to use for when using an anchor component"},{"name":"id","type":"string | number","description":"The id for the navigation item"},{"name":"isCurrent","type":"boolean","description":"Whether the navigation item is the currently active item"},{"name":"isDisabled","type":"boolean","description":"Whether the navigation item is disabled"},{"name":"isExpandable","type":"boolean","description":"Flag indicating that this NavItem has child steps and is expandable"},{"name":"isVisited","type":"boolean","description":"Whether the navigation item has been visited"},{"name":"onClick","type":"(event: React.MouseEvent<HTMLButtonElement> | React.MouseEvent<HTMLAnchorElement>, index: number) => any","description":"Callback for when the navigation item is clicked"},{"name":"status","type":"'default' | 'error' | 'success'","description":"Used to determine the icon displayed next to content. Default has no icon."},{"name":"stepIndex","type":"number","description":"The step index passed into the onNavItemClick callback","required":true},{"name":"target","type":"React.HTMLAttributeAnchorTarget","description":"Where to display the linked URL when using an anchor component"}]},"WizardNavInternal":{"name":"WizardNavInternal","description":"Hosts default wizard navigation logic by utilizing the wizard's context and WizardNav/WizardNavItem.\nThis component is not exposed to consumers.","props":[{"name":"isNavExpanded","type":"boolean","description":"","required":true},{"name":"nav","type":"Partial<WizardNavProps>","description":"","required":true},{"name":"navAriaLabel","type":"string","description":"","required":true}]},"WizardNavInternalProps":{"name":"WizardNavInternalProps","description":"Hosts default wizard navigation logic by utilizing the wizard's context and WizardNav/WizardNavItem.\nThis component is not exposed to consumers.","props":[{"name":"isNavExpanded","type":"boolean","description":null,"required":true},{"name":"nav","type":"Partial<WizardNavProps>","description":null,"required":true},{"name":"navAriaLabel","type":"string","description":null,"required":true}]},"WizardNav":{"name":"WizardNav","description":"","props":[{"name":"aria-label","type":"string","description":"Aria-label applied to the navigation element"},{"name":"aria-labelledby","type":"string","description":"Sets the aria-labelledby attribute on the navigation element"},{"name":"children","type":"any","description":"children should be WizardNavItem components"},{"name":"className","type":"string","description":"Additional classes spread to the wizard nav"},{"name":"isExpanded","type":"boolean","description":"Whether the navigation is expanded","defaultValue":"false"},{"name":"isInnerList","type":"boolean","description":"True to return the inner list without the wrapping navigation element","defaultValue":"false"}]},"WizardNavProps":{"name":"WizardNavProps","description":"","props":[{"name":"children","type":"any","description":"children should be WizardNavItem components"},{"name":"className","type":"string","description":"Additional classes spread to the wizard nav"},{"name":"isExpanded","type":"boolean","description":"Whether the navigation is expanded"},{"name":"isInnerList","type":"boolean","description":"True to return the inner list without the wrapping navigation element"},{"name":"Unknown","type":"string","description":"Sets the aria-labelledby attribute on the navigation element"}]},"WizardHeader":{"name":"WizardHeader","description":"","props":[{"name":"className","type":"string","description":"Additional classes spread to the wizard header"},{"name":"closeButtonAriaLabel","type":"string","description":"Aria-label applied to the X (Close) button"},{"name":"description","type":"React.ReactNode","description":"Description of the wizard"},{"name":"descriptionComponent","type":"'div' | 'p'","description":"Component type of the description","defaultValue":"'div'"},{"name":"descriptionId","type":"string","description":"id for the description"},{"name":"isCloseHidden","type":"boolean","description":"Flag indicating whether the close button should be in the header"},{"name":"onClose","type":"(event: React.MouseEvent<HTMLButtonElement>) => void","description":"Callback function called when the X (Close) button is clicked","defaultValue":"() => undefined"},{"name":"title","type":"string","description":"Title of the wizard","required":true},{"name":"titleId","type":"string","description":"id for the title"}]},"WizardHeaderProps":{"name":"WizardHeaderProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes spread to the wizard header"},{"name":"closeButtonAriaLabel","type":"string","description":"Aria-label applied to the X (Close) button"},{"name":"description","type":"React.ReactNode","description":"Description of the wizard"},{"name":"descriptionComponent","type":"'div' | 'p'","description":"Component type of the description"},{"name":"descriptionId","type":"string","description":"id for the description"},{"name":"isCloseHidden","type":"boolean","description":"Flag indicating whether the close button should be in the header"},{"name":"onClose","type":"(event: React.MouseEvent<HTMLButtonElement>) => void","description":"Callback function called when the X (Close) button is clicked"},{"name":"title","type":"string","description":"Title of the wizard","required":true},{"name":"titleId","type":"string","description":"id for the title"}]},"WizardFooterProps":{"name":"WizardFooterProps","description":"Hosts the standard structure of a footer with ties to the active step so that text for buttons can vary from step to step.","props":[{"name":"activeStep","type":"WizardStepType","description":"The active step","required":true},{"name":"backButtonProps","type":"Omit<WizardFooterButtonProps, 'isDisabled'>","description":"Additional props for the Back button."},{"name":"backButtonText","type":"React.ReactNode","description":"Custom text for the Back button"},{"name":"cancelButtonProps","type":"WizardFooterButtonProps","description":"Additional props for the Cancel button."},{"name":"cancelButtonText","type":"React.ReactNode","description":"Custom text for the Cancel link"},{"name":"className","type":"string","description":"Additional classes spread to the wizard footer"},{"name":"isBackDisabled","type":"boolean","description":"Flag to disable the back button"},{"name":"isBackHidden","type":"boolean","description":"Flag to hide the back button"},{"name":"isCancelHidden","type":"boolean","description":"Flag to hide the cancel button"},{"name":"isNextDisabled","type":"boolean","description":"Flag to disable the next button"},{"name":"nextButtonProps","type":"Omit<WizardFooterButtonProps, 'isDisabled' | 'type'>","description":"Additional props for the Next button."},{"name":"nextButtonText","type":"React.ReactNode","description":"Custom text for the Next button. The current step's nextButtonText takes precedence."},{"name":"onBack","type":"(event: React.MouseEvent<HTMLButtonElement>) => void | Promise<void>","description":"Back button callback","required":true},{"name":"onClose","type":"(event: React.MouseEvent<HTMLButtonElement>) => void","description":"Cancel link callback","required":true},{"name":"onNext","type":"(event: React.MouseEvent<HTMLButtonElement>) => void | Promise<void>","description":"Next button callback","required":true}]},"WizardFooterWrapperProps":{"name":"WizardFooterWrapperProps","description":"Applies default wizard footer styling any number of child elements.","props":[{"name":"children","type":"React.ReactNode","description":null,"required":true},{"name":"className","type":"string","description":null}]},"WizardContextProvider":{"name":"WizardContextProvider","description":"","props":[]},"WizardContextProps":{"name":"WizardContextProps","description":"","props":[{"name":"activeStep","type":"WizardStepType","description":"Current step","required":true},{"name":"close","type":"() => void","description":"Close the wizard","required":true},{"name":"footer","type":"React.ReactElement<any>","description":"Footer element","required":true},{"name":"getStep","type":"(stepId: number | string) => WizardStepType","description":"Get step by ID","required":true},{"name":"goToNextStep","type":"() => void | Promise<void>","description":"Navigate to the next step","required":true},{"name":"goToPrevStep","type":"() => void | Promise<void>","description":"Navigate to the previous step","required":true},{"name":"goToStepById","type":"(id: number | string) => void","description":"Navigate to step by ID","required":true},{"name":"goToStepByIndex","type":"(index: number) => void","description":"Navigate to step by index","required":true},{"name":"goToStepByName","type":"(name: string) => void","description":"Navigate to step by name","required":true},{"name":"mainWrapperRef","type":"React.RefObject<HTMLElement | null>","description":"Ref for main wizard content element.","required":true},{"name":"setFooter","type":"(footer: React.ReactElement<any> | Partial<WizardFooterProps>) => void","description":"Update the footer with any react element","required":true},{"name":"setStep","type":"(step: Pick<WizardStepType, 'id'> & Partial<WizardStepType>) => void","description":"Set step by ID","required":true},{"name":"shouldFocusContent","type":"boolean","description":"Flag indicating whether the wizard content should be focused after the onNext or onBack callbacks\nare called.","required":true},{"name":"steps","type":"WizardStepType[]","description":"List of steps","required":true}]},"WizardContextProviderProps":{"name":"WizardContextProviderProps","description":"","props":[{"name":"activeStepIndex","type":"number","description":null,"required":true},{"name":"children","type":"React.ReactElement<any>","description":null,"required":true},{"name":"footer","type":"WizardFooterType","description":null,"required":true},{"name":"goToStepById","type":"void","description":null,"required":true},{"name":"goToStepByIndex","type":"void","description":null,"required":true},{"name":"goToStepByName","type":"void","description":null,"required":true},{"name":"mainWrapperRef","type":"React.RefObject<HTMLElement | null>","description":null,"required":true},{"name":"onBack","type":"void","description":null,"required":true},{"name":"onClose","type":"void","description":null},{"name":"onNext","type":"void","description":null,"required":true},{"name":"shouldFocusContent","type":"boolean","description":null,"required":true},{"name":"steps","type":"WizardStepType[]","description":null,"required":true}]},"WizardBody":{"name":"WizardBody","description":"Used as a wrapper for WizardStep content, where the wrapping element is customizable.","props":[{"name":"aria-label","type":"string","description":"Adds an accessible name to the wrapper element when the content overflows and renders\na scrollbar."},{"name":"aria-labelledby","type":"string","description":"Adds an accessible name to the wrapper element by passing the the id of one or more elements.\nThe aria-labelledby will only be applied when the content overflows and renders a scrollbar."},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered in the Wizard body","required":true},{"name":"className","type":"string","description":"Additional classes spread to the wizard body"},{"name":"component","type":"React.ElementType","description":"Component used as the wrapping content container","defaultValue":"'div'"},{"name":"hasNoPadding","type":"boolean","description":"Flag to remove the default body padding","defaultValue":"false"}]},"WizardBodyProps":{"name":"WizardBodyProps","description":"Used as a wrapper for WizardStep content, where the wrapping element is customizable.","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered in the Wizard body","required":true},{"name":"className","type":"string","description":"Additional classes spread to the wizard body"},{"name":"component","type":"React.ElementType","description":"Component used as the wrapping content container"},{"name":"hasNoPadding","type":"boolean","description":"Flag to remove the default body padding"},{"name":"Unknown","type":"string","description":"Adds an accessible name to the wrapper element by passing the the id of one or more elements.\nThe aria-labelledby will only be applied when the content overflows and renders a scrollbar."}]},"Wizard":{"name":"Wizard","description":"Wrapper for all steps and hosts state, including navigation helpers, within context.\nThe WizardContext provided by default gives any child of wizard access to those resources.","props":[{"name":"children","type":"React.ReactNode","description":"Step components","required":true},{"name":"className","type":"string","description":"Additional classes spread to the wizard"},{"name":"footer","type":"Partial<WizardFooterProps> | CustomWizardFooterFunction | React.ReactElement<any>","description":"Wizard footer"},{"name":"header","type":"React.ReactNode","description":"Wizard header"},{"name":"height","type":"number | string","description":"Custom height of the wizard"},{"name":"isProgressive","type":"boolean","description":"Progressively shows steps, where all steps following the active step are hidden. Defaults to false.","defaultValue":"false"},{"name":"isVisitRequired","type":"boolean","description":"Disables steps that haven't been visited. Defaults to false.","defaultValue":"false"},{"name":"nav","type":"Partial<WizardNavProps> | CustomWizardNavFunction | React.ReactElement<any>","description":"Wizard navigation"},{"name":"navAriaLabel","type":"string","description":"Aria-label for the Nav"},{"name":"onClose","type":"(event: React.MouseEvent<HTMLButtonElement>) => void","description":"Callback function to close the wizard"},{"name":"onSave","type":"(event: React.MouseEvent<HTMLButtonElement>) => void | Promise<void>","description":"Callback function to save at the end of the wizard, if not specified uses onClose"},{"name":"onStepChange","type":"(\n event: React.MouseEvent<HTMLButtonElement>,\n currentStep: WizardStepType,\n prevStep: WizardStepType,\n scope: WizardStepChangeScope\n) => void | Promise<void>","description":"Callback function when navigating between steps"},{"name":"shouldFocusContent","type":"boolean","description":"Flag indicating whether the wizard content should be focused after the onNext or onBack callbacks\nare called.","defaultValue":"true"},{"name":"startIndex","type":"number","description":"The initial index the wizard is to start on (1 or higher). Defaults to 1.","defaultValue":"1"},{"name":"width","type":"number | string","description":"Custom width of the wizard"}]},"WizardProps":{"name":"WizardProps","description":"Wrapper for all steps and hosts state, including navigation helpers, within context.\nThe WizardContext provided by default gives any child of wizard access to those resources.","props":[{"name":"children","type":"React.ReactNode","description":"Step components","required":true},{"name":"className","type":"string","description":"Additional classes spread to the wizard"},{"name":"footer","type":"WizardFooterType","description":"Wizard footer"},{"name":"header","type":"React.ReactNode","description":"Wizard header"},{"name":"height","type":"number | string","description":"Custom height of the wizard"},{"name":"isProgressive","type":"boolean","description":"Progressively shows steps, where all steps following the active step are hidden. Defaults to false."},{"name":"isVisitRequired","type":"boolean","description":"Disables steps that haven't been visited. Defaults to false."},{"name":"nav","type":"WizardNavType","description":"Wizard navigation"},{"name":"navAriaLabel","type":"string","description":"Aria-label for the Nav"},{"name":"onClose","type":"(event: React.MouseEvent<HTMLButtonElement>) => void","description":"Callback function to close the wizard"},{"name":"onSave","type":"(event: React.MouseEvent<HTMLButtonElement>) => void | Promise<void>","description":"Callback function to save at the end of the wizard, if not specified uses onClose"},{"name":"onStepChange","type":"(\n event: React.MouseEvent<HTMLButtonElement>,\n currentStep: WizardStepType,\n prevStep: WizardStepType,\n scope: WizardStepChangeScope\n ) => void | Promise<void>","description":"Callback function when navigating between steps"},{"name":"shouldFocusContent","type":"boolean","description":"Flag indicating whether the wizard content should be focused after the onNext or onBack callbacks\nare called."},{"name":"startIndex","type":"number","description":"The initial index the wizard is to start on (1 or higher). Defaults to 1."},{"name":"width","type":"number | string","description":"Custom width of the wizard"}]},"Truncate":{"name":"Truncate","description":"","props":[{"name":"className","type":"string","description":"Class to add to outer span"},{"name":"content","type":"string","description":"Text to truncate","required":true},{"name":"position","type":"'start' | 'middle' | 'end'","description":"Where the text will be truncated","defaultValue":"'end'"},{"name":"tooltipPosition","type":"| TooltipPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Tooltip position","defaultValue":"'top'"},{"name":"trailingNumChars","type":"number","description":"The number of characters displayed in the second half of the truncation","defaultValue":"7"}]},"TruncateProps":{"name":"TruncateProps","description":"","props":[{"name":"className","type":"string","description":"Class to add to outer span"},{"name":"content","type":"string","description":"Text to truncate","required":true},{"name":"position","type":"'start' | 'middle' | 'end'","description":"Where the text will be truncated"},{"name":"refToGetParent","type":"React.RefObject<any>","description":""},{"name":"tooltipPosition","type":"| TooltipPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Tooltip position"},{"name":"trailingNumChars","type":"number","description":"The number of characters displayed in the second half of the truncation"}]},"TreeViewSearch":{"name":"TreeViewSearch","description":"Renders a search input for the tree view. This sub-component should be passed into the\ntree view component's toolbar property.","props":[{"name":"aria-label","type":"string","description":"Accessible label for the search input."},{"name":"className","type":"string","description":"Classes applied to the wrapper for the search input."},{"name":"id","type":"string","description":"Id for the search input."},{"name":"name","type":"string","description":"Name for the search input."},{"name":"onSearch","type":"(event: React.ChangeEvent<HTMLInputElement>) => void","description":"Callback for search input."}]},"TreeViewSearchProps":{"name":"TreeViewSearchProps","description":"Renders a search input for the tree view. This sub-component should be passed into the\ntree view component's toolbar property.","props":[{"name":"className","type":"string","description":"Classes applied to the wrapper for the search input."},{"name":"id","type":"string","description":"Id for the search input."},{"name":"name","type":"string","description":"Name for the search input."},{"name":"onSearch","type":"(event: React.ChangeEvent<HTMLInputElement>) => void","description":"Callback for search input."},{"name":"Unknown","type":"string","description":"Accessible label for the search input."}]},"TreeViewRoot":{"name":"TreeViewRoot","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Child nodes of the tree view","required":true},{"name":"className","type":"string","description":"Class to add to add if not passed a parentItem"},{"name":"hasCheckboxes","type":"boolean","description":"Flag indicating if the tree view has checkboxes."},{"name":"hasGuides","type":"boolean","description":"Flag indicating if tree view has guide lines."},{"name":"hasSelectableNodes","type":"boolean","description":"Flag indicating that tree nodes should be independently selectable, even when having children"},{"name":"variant","type":"'default' | 'compact' | 'compactNoBackground'","description":"Variant presentation styles for the tree view."}]},"TreeViewRootProps":{"name":"TreeViewRootProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Child nodes of the tree view","required":true},{"name":"className","type":"string","description":"Class to add to add if not passed a parentItem"},{"name":"hasCheckboxes","type":"boolean","description":"Flag indicating if the tree view has checkboxes."},{"name":"hasGuides","type":"boolean","description":"Flag indicating if tree view has guide lines."},{"name":"hasSelectableNodes","type":"boolean","description":"Flag indicating that tree nodes should be independently selectable, even when having children"},{"name":"variant","type":"'default' | 'compact' | 'compactNoBackground'","description":"Variant presentation styles for the tree view."}]},"TreeViewListItemBase":{"name":"TreeViewListItemBase","description":"","props":[{"name":"action","type":"React.ReactNode","description":"Action of a tree view item, which can be either a button or dropdown component."},{"name":"activeItems","type":"TreeViewDataItem[]","description":"Active items of tree view.","defaultValue":"[]"},{"name":"badgeProps","type":"any","description":"Additional properties of the tree view item badge.","defaultValue":"{ isRead: true }"},{"name":"checkProps","type":"TreeViewCheckProps","description":"Additional properties of the tree view item checkbox.","defaultValue":"{\n checked: false\n}"},{"name":"children","type":"React.ReactNode","description":"Child nodes of a tree view item.","defaultValue":"null"},{"name":"compareItems","type":"(item: TreeViewDataItem, itemToCheck: TreeViewDataItem) => boolean","description":"Callback for item comparison function."},{"name":"customBadgeContent","type":"React.ReactNode","description":"Optional prop for a custom badge."},{"name":"defaultExpanded","type":"boolean","description":"Flag indicating if node is expanded by default.","defaultValue":"false"},{"name":"expandedIcon","type":"React.ReactNode","description":"Expanded icon of a tree view item."},{"name":"hasBadge","type":"boolean","description":"Flag indicating if a tree view item has a badge.","defaultValue":"false"},{"name":"hasCheckbox","type":"boolean","description":"Flag indicating if a tree view item has a checkbox.","defaultValue":"false"},{"name":"icon","type":"React.ReactNode","description":"Default icon of a tree view item."},{"name":"id","type":"string","description":"ID of a tree view item."},{"name":"isCompact","type":"boolean","description":"Flag indicating if the tree view is using a compact variation."},{"name":"isExpanded","type":"boolean","description":"Flag indicating if the node is expanded, overrides internal state."},{"name":"isSelectable","type":"boolean","description":"Flag indicating that tree nodes should be independently selectable, even when having\nchildren.","defaultValue":"false"},{"name":"itemData","type":"TreeViewDataItem","description":"Data structure of tree view item."},{"name":"name","type":"React.ReactNode","description":"Internal content of a tree view item.","required":true},{"name":"onCheck","type":"(event: React.ChangeEvent<HTMLInputElement>, item: TreeViewDataItem, parent: TreeViewDataItem) => void","description":"Callback for item checkbox selection."},{"name":"onCollapse","type":"(event: React.MouseEvent, item: TreeViewDataItem, parentItem: TreeViewDataItem) => void","description":"Callback for collapsing a node with children."},{"name":"onExpand","type":"(event: React.MouseEvent, item: TreeViewDataItem, parentItem: TreeViewDataItem) => void","description":"Callback for expanding a node with children."},{"name":"onSelect","type":"(event: React.MouseEvent, item: TreeViewDataItem, parent: TreeViewDataItem) => void","description":"Callback for item selection. Note: calling event.preventDefault() will prevent the node\nfrom toggling."},{"name":"parentItem","type":"TreeViewDataItem","description":"Parent item of tree view item."},{"name":"title","type":"React.ReactNode","description":"Title of a tree view item.","required":true},{"name":"useMemo","type":"boolean","description":"Flag indicating the tree view should utilize memoization to help render large data sets.\nSetting this property requires that the activeItems property is passed an array containing\nevery node in the selected item's path."}]},"TreeViewCheckProps":{"name":"TreeViewCheckProps","description":"","props":[{"name":"checked","type":"boolean | null","description":null}]},"TreeViewListItemProps":{"name":"TreeViewListItemProps","description":"","props":[{"name":"action","type":"React.ReactNode","description":"Action of a tree view item, which can be either a button or dropdown component."},{"name":"activeItems","type":"TreeViewDataItem[]","description":"Active items of tree view."},{"name":"badgeProps","type":"any","description":"Additional properties of the tree view item badge."},{"name":"checkProps","type":"TreeViewCheckProps","description":"Additional properties of the tree view item checkbox."},{"name":"children","type":"React.ReactNode","description":"Child nodes of a tree view item."},{"name":"compareItems","type":"(item: TreeViewDataItem, itemToCheck: TreeViewDataItem) => boolean","description":"Callback for item comparison function."},{"name":"customBadgeContent","type":"React.ReactNode","description":"Optional prop for a custom badge."},{"name":"defaultExpanded","type":"boolean","description":"Flag indicating if node is expanded by default."},{"name":"expandedIcon","type":"React.ReactNode","description":"Expanded icon of a tree view item."},{"name":"hasBadge","type":"boolean","description":"Flag indicating if a tree view item has a badge."},{"name":"hasCheckbox","type":"boolean","description":"Flag indicating if a tree view item has a checkbox."},{"name":"icon","type":"React.ReactNode","description":"Default icon of a tree view item."},{"name":"id","type":"string","description":"ID of a tree view item."},{"name":"isCompact","type":"boolean","description":"Flag indicating if the tree view is using a compact variation."},{"name":"isExpanded","type":"boolean","description":"Flag indicating if the node is expanded, overrides internal state."},{"name":"isSelectable","type":"boolean","description":"Flag indicating that tree nodes should be independently selectable, even when having\nchildren."},{"name":"itemData","type":"TreeViewDataItem","description":"Data structure of tree view item."},{"name":"name","type":"React.ReactNode","description":"Internal content of a tree view item.","required":true},{"name":"onCheck","type":"(event: React.ChangeEvent<HTMLInputElement>, item: TreeViewDataItem, parent: TreeViewDataItem) => void","description":"Callback for item checkbox selection."},{"name":"onCollapse","type":"(event: React.MouseEvent, item: TreeViewDataItem, parentItem: TreeViewDataItem) => void","description":"Callback for collapsing a node with children."},{"name":"onExpand","type":"(event: React.MouseEvent, item: TreeViewDataItem, parentItem: TreeViewDataItem) => void","description":"Callback for expanding a node with children."},{"name":"onSelect","type":"(event: React.MouseEvent, item: TreeViewDataItem, parent: TreeViewDataItem) => void","description":"Callback for item selection. Note: calling event.preventDefault() will prevent the node\nfrom toggling."},{"name":"parentItem","type":"TreeViewDataItem","description":"Parent item of tree view item."},{"name":"title","type":"React.ReactNode","description":"Title of a tree view item.","required":true},{"name":"useMemo","type":"boolean","description":"Flag indicating the tree view should utilize memoization to help render large data sets.\nSetting this property requires that the activeItems property is passed an array containing\nevery node in the selected item's path."}]},"TreeViewList":{"name":"TreeViewList","description":"","props":[{"name":"aria-label","type":"string","description":"A text string that sets the accessible name of the tree view list. Either this or the aria-labelledby property must\nbe passed in."},{"name":"aria-labelledby","type":"string","description":"A space separated list of element id's that sets the accessible name of the tree view list. Either\nthis or the aria-label property must be passed in."},{"name":"children","type":"React.ReactNode","description":"Child nodes of the current tree view.","required":true},{"name":"isMultiSelectable","type":"boolean","description":"Flag indicating whether multiple nodes can be selected in the tree view. This will also set the\naria-multiselectable attribute on the tree view list which is required to be true when multiple selection is intended.\nCan only be applied to the root tree view list.","defaultValue":"false"},{"name":"isNested","type":"boolean","description":"Flag indicating if the tree view is nested under another tree view.","defaultValue":"false"},{"name":"toolbar","type":"React.ReactNode","description":"Toolbar to display above the tree view."}]},"TreeViewListProps":{"name":"TreeViewListProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Child nodes of the current tree view.","required":true},{"name":"isMultiSelectable","type":"boolean","description":"Flag indicating whether multiple nodes can be selected in the tree view. This will also set the\naria-multiselectable attribute on the tree view list which is required to be true when multiple selection is intended.\nCan only be applied to the root tree view list."},{"name":"isNested","type":"boolean","description":"Flag indicating if the tree view is nested under another tree view."},{"name":"toolbar","type":"React.ReactNode","description":"Toolbar to display above the tree view."},{"name":"Unknown","type":"string","description":"A space separated list of element id's that sets the accessible name of the tree view list. Either\nthis or the aria-label property must be passed in."}]},"TreeView":{"name":"TreeView","description":"The main tree view component.","props":[{"name":"activeItems","type":"TreeViewDataItem[]","description":"Active items of tree view."},{"name":"allExpanded","type":"boolean","description":"Sets the expanded state on all tree nodes, overriding default behavior and current\ninternal state."},{"name":"aria-label","type":"string","description":"A text string that sets the accessible name of the tree view list. Either this or the aria-labelledby property must\nbe passed in."},{"name":"aria-labelledby","type":"string","description":"A space separated list of element id's that sets the accessible name of the tree view list. Either\nthis or the aria-label property must be passed in."},{"name":"className","type":"string","description":"Class to add if not passed a parentItem property."},{"name":"compareItems","type":"(item: TreeViewDataItem, itemToCheck: TreeViewDataItem) => boolean","description":"Comparison function for determining active items.","defaultValue":"(item, itemToCheck) => item.id === itemToCheck.id"},{"name":"data","type":"TreeViewDataItem[]","description":"Data of the tree view.","required":true},{"name":"defaultAllExpanded","type":"boolean","description":"Sets the default expanded behavior.","defaultValue":"false"},{"name":"expandedIcon","type":"React.ReactNode","description":"Icon for all expanded node items."},{"name":"hasBadges","type":"boolean","description":"Flag indicating if all nodes in the tree view should have badges.","defaultValue":"false"},{"name":"hasCheckboxes","type":"boolean","description":"Flag indicating if all nodes in the tree view should have checkboxes.","defaultValue":"false"},{"name":"hasGuides","type":"boolean","description":"Flag indicating if the tree view has guide lines.","defaultValue":"false"},{"name":"hasSelectableNodes","type":"boolean","description":"Flag indicating that tree nodes should be independently selectable, even when having\nchildren.","defaultValue":"false"},{"name":"icon","type":"React.ReactNode","description":"Icon for all leaf or unexpanded node items."},{"name":"id","type":"string","description":"ID of the tree view."},{"name":"isMultiSelectable","type":"boolean","description":"Flag indicating whether multiple nodes can be selected in the tree view. This will also set the\naria-multiselectable attribute on the tree view list which is required to be true when multiple selection is intended.\nCan only be applied to the root tree view list.","defaultValue":"false"},{"name":"isNested","type":"boolean","description":"Flag indicating if the tree view is nested.","defaultValue":"false"},{"name":"onCheck","type":"(event: React.ChangeEvent<HTMLInputElement>, item: TreeViewDataItem, parentItem: TreeViewDataItem) => void","description":"Callback for item checkbox selection."},{"name":"onCollapse","type":"(event: React.MouseEvent, item: TreeViewDataItem, parentItem: TreeViewDataItem) => void","description":"Callback for collapsing a node with children."},{"name":"onExpand","type":"(event: React.MouseEvent, item: TreeViewDataItem, parentItem: TreeViewDataItem) => void","description":"Callback for expanding a node with children."},{"name":"onSelect","type":"(event: React.MouseEvent, item: TreeViewDataItem, parentItem: TreeViewDataItem) => void","description":"Callback for item selection."},{"name":"parentItem","type":"TreeViewDataItem","description":"Internal. Parent item of a tree view list item."},{"name":"toolbar","type":"React.ReactNode","description":"Toolbar to display above the tree view."},{"name":"useMemo","type":"boolean","description":"Flag indicating the tree view should utilize memoization to help render large data sets.\nSetting this property requires that the activeItems property is passed an array containing\nevery node in the selected item's path."},{"name":"variant","type":"'default' | 'compact' | 'compactNoBackground'","description":"Variant presentation styles for the tree view.","defaultValue":"'default'"}]},"TreeViewDataItem":{"name":"TreeViewDataItem","description":"Properties that make up a tree view data item. These properties should be passed in as an\nobject to one of the various tree view component properties which accept TreeViewDataItem as\na type.","props":[{"name":"action","type":"React.ReactNode","description":"Action of a tree view item, which can be either a button or dropdown component."},{"name":"badgeProps","type":"any","description":"Additional properties of the tree view item badge."},{"name":"checkProps","type":"TreeViewCheckProps","description":"Additional properties of the tree view item checkbox."},{"name":"children","type":"TreeViewDataItem[]","description":"Child nodes of a tree view item."},{"name":"customBadgeContent","type":"React.ReactNode","description":"Optional prop for a custom badge."},{"name":"defaultExpanded","type":"boolean","description":"Flag indicating if node is expanded by default."},{"name":"expandedIcon","type":"React.ReactNode","description":"Expanded icon of a tree view item."},{"name":"hasBadge","type":"boolean","description":"Flag indicating if a tree view item has a badge."},{"name":"hasCheckbox","type":"boolean","description":"Flag indicating if a tree view item has a checkbox."},{"name":"icon","type":"React.ReactNode","description":"Default icon of a tree view item."},{"name":"id","type":"string","description":"ID of a tree view item."},{"name":"name","type":"React.ReactNode","description":"Internal content of a tree view item.","required":true},{"name":"title","type":"React.ReactNode","description":"Title of a tree view item. Only used in compact presentations."}]},"TreeViewProps":{"name":"TreeViewProps","description":"The main tree view component.","props":[{"name":"activeItems","type":"TreeViewDataItem[]","description":"Active items of tree view."},{"name":"allExpanded","type":"boolean","description":"Sets the expanded state on all tree nodes, overriding default behavior and current\ninternal state."},{"name":"className","type":"string","description":"Class to add if not passed a parentItem property."},{"name":"compareItems","type":"(item: TreeViewDataItem, itemToCheck: TreeViewDataItem) => boolean","description":"Comparison function for determining active items."},{"name":"data","type":"TreeViewDataItem[]","description":"Data of the tree view.","required":true},{"name":"defaultAllExpanded","type":"boolean","description":"Sets the default expanded behavior."},{"name":"expandedIcon","type":"React.ReactNode","description":"Icon for all expanded node items."},{"name":"hasBadges","type":"boolean","description":"Flag indicating if all nodes in the tree view should have badges."},{"name":"hasCheckboxes","type":"boolean","description":"Flag indicating if all nodes in the tree view should have checkboxes."},{"name":"hasGuides","type":"boolean","description":"Flag indicating if the tree view has guide lines."},{"name":"hasSelectableNodes","type":"boolean","description":"Flag indicating that tree nodes should be independently selectable, even when having\nchildren."},{"name":"icon","type":"React.ReactNode","description":"Icon for all leaf or unexpanded node items."},{"name":"id","type":"string","description":"ID of the tree view."},{"name":"isMultiSelectable","type":"boolean","description":"Flag indicating whether multiple nodes can be selected in the tree view. This will also set the\naria-multiselectable attribute on the tree view list which is required to be true when multiple selection is intended.\nCan only be applied to the root tree view list."},{"name":"isNested","type":"boolean","description":"Flag indicating if the tree view is nested."},{"name":"onCheck","type":"(event: React.ChangeEvent<HTMLInputElement>, item: TreeViewDataItem, parentItem: TreeViewDataItem) => void","description":"Callback for item checkbox selection."},{"name":"onCollapse","type":"(event: React.MouseEvent, item: TreeViewDataItem, parentItem: TreeViewDataItem) => void","description":"Callback for collapsing a node with children."},{"name":"onExpand","type":"(event: React.MouseEvent, item: TreeViewDataItem, parentItem: TreeViewDataItem) => void","description":"Callback for expanding a node with children."},{"name":"onSelect","type":"(event: React.MouseEvent, item: TreeViewDataItem, parentItem: TreeViewDataItem) => void","description":"Callback for item selection."},{"name":"parentItem","type":"TreeViewDataItem","description":"Internal. Parent item of a tree view list item."},{"name":"toolbar","type":"React.ReactNode","description":"Toolbar to display above the tree view."},{"name":"Unknown","type":"string","description":"A space separated list of element id's that sets the accessible name of the tree view list. Either\nthis or the aria-label property must be passed in."},{"name":"useMemo","type":"boolean","description":"Flag indicating the tree view should utilize memoization to help render large data sets.\nSetting this property requires that the activeItems property is passed an array containing\nevery node in the selected item's path."},{"name":"variant","type":"'default' | 'compact' | 'compactNoBackground'","description":"Variant presentation styles for the tree view."}]},"TooltipContent":{"name":"TooltipContent","description":"","props":[{"name":"children","type":"React.ReactNode","description":"PopoverContent content","required":true},{"name":"className","type":"string","description":"PopoverContent additional class"},{"name":"isLeftAligned","type":"boolean","description":"Flag to align text to the left"}]},"TooltipContentProps":{"name":"TooltipContentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"PopoverContent content","required":true},{"name":"className","type":"string","description":"PopoverContent additional class"},{"name":"isLeftAligned","type":"boolean","description":"Flag to align text to the left"}]},"TooltipArrow":{"name":"TooltipArrow","description":"","props":[{"name":"className","type":"string","description":"className"}]},"TooltipArrowProps":{"name":"TooltipArrowProps","description":"","props":[{"name":"className","type":"string","description":"className"}]},"Tooltip":{"name":"Tooltip","description":"","props":[{"name":"animationDuration","type":"number","description":"CSS fade transition animation duration","defaultValue":"300"},{"name":"appendTo","type":"HTMLElement | ((ref?: HTMLElement) => HTMLElement)","description":"The element to append the tooltip to, defaults to body","defaultValue":"() => document.body"},{"name":"aria","type":"'describedby' | 'labelledby' | 'none'","description":"aria-labelledby or aria-describedby for tooltip.\nThe trigger will be cloned to add the aria attribute, and the corresponding id in the form of 'pf-tooltip-#' is added to the content container.\nIf you don't want that or prefer to add the aria attribute yourself on the trigger, set aria to 'none'.","defaultValue":"'describedby'"},{"name":"aria-live","type":"'off' | 'polite'","description":"Determines whether the tooltip is an aria-live region. If the triggerRef prop is passed in the\ndefault behavior is 'polite' in order to ensure the tooltip contents is announced to\nassistive technologies. Otherwise the default behavior is 'off'.","defaultValue":"triggerRef ? 'polite' : 'off'"},{"name":"children","type":"ReactElement<any>","description":"The trigger reference element to which the Tooltip is relatively placed to.\nIf you cannot wrap the element with the Tooltip, you can use the triggerRef prop instead.\nUsage: <Tooltip><Button>Reference</Button></Tooltip>"},{"name":"className","type":"string","description":"Tooltip additional class","defaultValue":"''"},{"name":"content","type":"React.ReactNode","description":"Tooltip content","required":true},{"name":"distance","type":"number","description":"Distance of the tooltip to its target, defaults to 15","defaultValue":"15"},{"name":"enableFlip","type":"boolean","description":"If true, tries to keep the tooltip in view by flipping it if necessary","defaultValue":"true"},{"name":"entryDelay","type":"number","description":"Delay in ms before the tooltip appears","defaultValue":"300"},{"name":"exitDelay","type":"number","description":"Delay in ms before the tooltip disappears, Avoid passing in a value of \"0\", as users should\nbe given ample time to move their mouse from the trigger to the tooltip content without the content\nbeing hidden.","defaultValue":"300"},{"name":"flipBehavior","type":"| 'flip'\n| (\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'\n )[]","description":"The desired position to flip the tooltip to if the initial position is not possible.\nBy setting this prop to 'flip' it attempts to flip the tooltip to the opposite side if there is no space.\nYou can also pass an array of positions that determines the flip order. It should contain the initial position\nfollowed by alternative positions if that position is unavailable.\nExample: Initial position is 'top'. Button with tooltip is in the top right corner. 'flipBehavior' is set to\n['top', 'right', 'left']. Since there is no space to the top, it checks if right is available. There's also no\nspace to the right, so it finally shows the tooltip on the left.","defaultValue":"['top', 'right', 'bottom', 'left', 'top', 'right', 'bottom']"},{"name":"id","type":"string","description":"id of the tooltip"},{"name":"isContentLeftAligned","type":"boolean","description":"Flag to indicate that the text content is left aligned","defaultValue":"false"},{"name":"isVisible","type":"boolean","description":"value for visibility when trigger is 'manual'","defaultValue":"false"},{"name":"maxWidth","type":"string","description":"Maximum width of the tooltip (default 18.75rem)","defaultValue":"\"18.75rem\""},{"name":"minWidth","type":"string | 'trigger'","description":"Minimum width of the tooltip. If set to \"trigger\", the minimum width will be set to the reference element width."},{"name":"onTooltipHidden","type":"() => void","description":"Callback when tooltip's hide transition has finished executing","defaultValue":"() => {}"},{"name":"position","type":"| TooltipPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Tooltip position. Note: With 'enableFlip' set to true,\nit will change the position if there is not enough space for the starting position.\nThe behavior of where it flips to can be controlled through the flipBehavior prop.\nThe 'auto' position chooses the side with the most space.\nThe 'auto' position requires the 'enableFlip' prop to be true.","defaultValue":"'top'"},{"name":"trigger","type":"string","description":"Tooltip trigger: click, mouseenter, focus, manual\nSet to manual to trigger tooltip programmatically (through the isVisible prop)","defaultValue":"'mouseenter focus'"},{"name":"triggerRef","type":"HTMLElement | (() => HTMLElement) | React.RefObject<any>","description":"The trigger reference element to which the Tooltip is relatively placed to.\nIf you can wrap the element with the Tooltip, you can use the children prop instead, or both props together.\nWhen passed along with the trigger prop, the div element that wraps the trigger will be removed.\nUsage: <Tooltip triggerRef={() => document.getElementById('reference-element')} />"},{"name":"zIndex","type":"number","description":"z-index of the tooltip","defaultValue":"9999"}]},"TooltipProps":{"name":"TooltipProps","description":"","props":[{"name":"animationDuration","type":"number","description":"CSS fade transition animation duration"},{"name":"appendTo","type":"HTMLElement | ((ref?: HTMLElement) => HTMLElement)","description":"The element to append the tooltip to, defaults to body"},{"name":"aria","type":"'describedby' | 'labelledby' | 'none'","description":"aria-labelledby or aria-describedby for tooltip.\nThe trigger will be cloned to add the aria attribute, and the corresponding id in the form of 'pf-tooltip-#' is added to the content container.\nIf you don't want that or prefer to add the aria attribute yourself on the trigger, set aria to 'none'."},{"name":"children","type":"ReactElement<any>","description":"The trigger reference element to which the Tooltip is relatively placed to.\nIf you cannot wrap the element with the Tooltip, you can use the triggerRef prop instead.\nUsage: <Tooltip><Button>Reference</Button></Tooltip>"},{"name":"className","type":"string","description":"Tooltip additional class"},{"name":"content","type":"React.ReactNode","description":"Tooltip content","required":true},{"name":"distance","type":"number","description":"Distance of the tooltip to its target, defaults to 15"},{"name":"enableFlip","type":"boolean","description":"If true, tries to keep the tooltip in view by flipping it if necessary"},{"name":"entryDelay","type":"number","description":"Delay in ms before the tooltip appears"},{"name":"exitDelay","type":"number","description":"Delay in ms before the tooltip disappears, Avoid passing in a value of \"0\", as users should\nbe given ample time to move their mouse from the trigger to the tooltip content without the content\nbeing hidden."},{"name":"flipBehavior","type":"| 'flip'\n | (\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'\n )[]","description":"The desired position to flip the tooltip to if the initial position is not possible.\nBy setting this prop to 'flip' it attempts to flip the tooltip to the opposite side if there is no space.\nYou can also pass an array of positions that determines the flip order. It should contain the initial position\nfollowed by alternative positions if that position is unavailable.\nExample: Initial position is 'top'. Button with tooltip is in the top right corner. 'flipBehavior' is set to\n['top', 'right', 'left']. Since there is no space to the top, it checks if right is available. There's also no\nspace to the right, so it finally shows the tooltip on the left."},{"name":"id","type":"string","description":"id of the tooltip"},{"name":"isContentLeftAligned","type":"boolean","description":"Flag to indicate that the text content is left aligned"},{"name":"isVisible","type":"boolean","description":"value for visibility when trigger is 'manual'"},{"name":"maxWidth","type":"string","description":"Maximum width of the tooltip (default 18.75rem)"},{"name":"minWidth","type":"string | 'trigger'","description":"Minimum width of the tooltip. If set to \"trigger\", the minimum width will be set to the reference element width."},{"name":"onTooltipHidden","type":"() => void","description":"Callback when tooltip's hide transition has finished executing"},{"name":"position","type":"| TooltipPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Tooltip position. Note: With 'enableFlip' set to true,\nit will change the position if there is not enough space for the starting position.\nThe behavior of where it flips to can be controlled through the flipBehavior prop.\nThe 'auto' position chooses the side with the most space.\nThe 'auto' position requires the 'enableFlip' prop to be true."},{"name":"trigger","type":"string","description":"Tooltip trigger: click, mouseenter, focus, manual\nSet to manual to trigger tooltip programmatically (through the isVisible prop)"},{"name":"triggerRef","type":"HTMLElement | (() => HTMLElement) | React.RefObject<any>","description":"The trigger reference element to which the Tooltip is relatively placed to.\nIf you can wrap the element with the Tooltip, you can use the children prop instead, or both props together.\nWhen passed along with the trigger prop, the div element that wraps the trigger will be removed.\nUsage: <Tooltip triggerRef={() => document.getElementById('reference-element')} />"},{"name":"Unknown","type":"'off' | 'polite'","description":"Determines whether the tooltip is an aria-live region. If the triggerRef prop is passed in the\ndefault behavior is 'polite' in order to ensure the tooltip contents is announced to\nassistive technologies. Otherwise the default behavior is 'off'."},{"name":"zIndex","type":"number","description":"z-index of the tooltip"}]},"ToolbarContextProps":{"name":"ToolbarContextProps","description":"","props":[{"name":"clearAllFilters","type":"() => void","description":null},{"name":"clearFiltersButtonText","type":"string","description":null},{"name":"customLabelGroupContent","type":"React.ReactNode","description":null},{"name":"isExpanded","type":"boolean","description":null,"required":true},{"name":"labelGroupContentRef","type":"RefObject<HTMLDivElement | null>","description":null,"required":true},{"name":"numberOfFilters","type":"number","description":null,"required":true},{"name":"showClearFiltersButton","type":"boolean","description":null},{"name":"toggleIsExpanded","type":"() => void","description":null,"required":true},{"name":"toolbarId","type":"string","description":null},{"name":"updateNumberFilters","type":"(categoryName: string, numberOfFilters: number) => void","description":null,"required":true}]},"ToolbarContentContextProps":{"name":"ToolbarContentContextProps","description":"","props":[{"name":"clearAllFilters","type":"() => void","description":null},{"name":"clearFiltersButtonText","type":"string","description":null},{"name":"expandableContentId","type":"string","description":null,"required":true},{"name":"expandableContentRef","type":"RefObject<HTMLDivElement | null>","description":null,"required":true},{"name":"isExpanded","type":"boolean","description":null},{"name":"labelContainerRef","type":"RefObject<any>","description":null,"required":true},{"name":"showClearFiltersButton","type":"boolean","description":null}]},"ToolbarToggleGroup":{"name":"ToolbarToggleGroup","description":"","props":[{"name":"align","type":"{\n default?: 'alignEnd' | 'alignStart' | 'alignCenter';\n md?: 'alignEnd' | 'alignStart' | 'alignCenter';\n lg?: 'alignEnd' | 'alignStart' | 'alignCenter';\n xl?: 'alignEnd' | 'alignStart' | 'alignCenter';\n '2xl'?: 'alignEnd' | 'alignStart' | 'alignCenter';\n}","description":"Applies to a child of a flex layout, and aligns that child (and any adjacent children on the other side of it) to one side of the main axis"},{"name":"alignItems","type":"'start' | 'center' | 'baseline' | 'default' | 'end' | 'stretch'","description":"Vertical alignment of children"},{"name":"alignSelf","type":"'start' | 'center' | 'baseline' | 'default' | 'end' | 'stretch'","description":"Vertical alignment"},{"name":"breakpoint","type":"'md' | 'lg' | 'xl' | '2xl'","description":"Controls when filters are shown and when the toggle button is hidden.","required":true},{"name":"children","type":"React.ReactNode","description":"Content to be rendered inside the data toolbar group"},{"name":"className","type":"string","description":"Classes applied to root element of the data toolbar group"},{"name":"clearAllFilters","type":"() => void","description":"Optional callback for clearing all filters in the toolbar toggle group"},{"name":"clearFiltersButtonText","type":"string","description":"Text to display in the clear all filters button of the toolbar toggle group"},{"name":"columnGap","type":"{\n default?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n md?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n lg?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n xl?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n '2xl'?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n}","description":"Sets only the column gap at various breakpoints."},{"name":"gap","type":"{\n default?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n md?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n lg?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n xl?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n '2xl'?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n}","description":"Sets both the column and row gap at various breakpoints."},{"name":"isExpanded","type":"boolean","description":"Flag indicating when toggle group is expanded for non-managed toolbar toggle groups."},{"name":"isOverflowContainer","type":"boolean","description":"Flag that modifies the toolbar group to hide overflow and respond to available space. Used for horizontal navigation."},{"name":"labelContainerRef","type":"React.RefObject<any>","description":"Reference to a label container group for filters inside the toolbar toggle group"},{"name":"onToggle","type":"(event: React.MouseEvent) => void","description":"Callback for toggle group click event for non-managed toolbar toggle groups."},{"name":"rowGap","type":"{\n default?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n md?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n lg?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n xl?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n '2xl'?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n}","description":"Sets only the row gap at various breakpoints."},{"name":"rowWrap","type":"{\n default?: 'wrap' | 'nowrap';\n sm?: 'wrap' | 'nowrap';\n md?: 'wrap' | 'nowrap';\n lg?: 'wrap' | 'nowrap';\n xl?: 'wrap' | 'nowrap';\n '2xl'?: 'wrap' | 'nowrap';\n}","description":"Value to set for row wrapping at various breakpoints"},{"name":"showClearFiltersButton","type":"boolean","description":"Flag indicating that the clear all filters button should be visible in the toolbar toggle group"},{"name":"toggleIcon","type":"React.ReactNode","description":"An icon to be rendered when the toggle group has collapsed down","required":true},{"name":"variant","type":"| ToolbarGroupVariant\n| 'filter-group'\n| 'action-group'\n| 'action-group-inline'\n| 'action-group-plain'\n| 'label-group'","description":"A type modifier which modifies spacing specifically depending on the type of group"},{"name":"visibility","type":"{\n default?: 'hidden' | 'visible';\n md?: 'hidden' | 'visible';\n lg?: 'hidden' | 'visible';\n xl?: 'hidden' | 'visible';\n '2xl'?: 'hidden' | 'visible';\n}","description":"Visibility at various breakpoints."}]},"ToolbarToggleGroupProps":{"name":"ToolbarToggleGroupProps","description":"","props":[{"name":"breakpoint","type":"'md' | 'lg' | 'xl' | '2xl'","description":"Controls when filters are shown and when the toggle button is hidden.","required":true},{"name":"clearAllFilters","type":"() => void","description":"Optional callback for clearing all filters in the toolbar toggle group"},{"name":"clearFiltersButtonText","type":"string","description":"Text to display in the clear all filters button of the toolbar toggle group"},{"name":"columnGap","type":"{\n default?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n md?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n lg?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n xl?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n '2xl'?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n }","description":"Sets only the column gap at various breakpoints."},{"name":"gap","type":"{\n default?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n md?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n lg?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n xl?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n '2xl'?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n }","description":"Sets both the column and row gap at various breakpoints."},{"name":"isExpanded","type":"boolean","description":"Flag indicating when toggle group is expanded for non-managed toolbar toggle groups."},{"name":"labelContainerRef","type":"React.RefObject<any>","description":"Reference to a label container group for filters inside the toolbar toggle group"},{"name":"onToggle","type":"(event: React.MouseEvent) => void","description":"Callback for toggle group click event for non-managed toolbar toggle groups."},{"name":"rowGap","type":"{\n default?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n md?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n lg?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n xl?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n '2xl'?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n }","description":"Sets only the row gap at various breakpoints."},{"name":"showClearFiltersButton","type":"boolean","description":"Flag indicating that the clear all filters button should be visible in the toolbar toggle group"},{"name":"toggleIcon","type":"React.ReactNode","description":"An icon to be rendered when the toggle group has collapsed down","required":true},{"name":"visibility","type":"{\n default?: 'hidden' | 'visible';\n md?: 'hidden' | 'visible';\n lg?: 'hidden' | 'visible';\n xl?: 'hidden' | 'visible';\n '2xl'?: 'hidden' | 'visible';\n }","description":"Visibility at various breakpoints."}]},"ToolbarLabelGroupContent":{"name":"ToolbarLabelGroupContent","description":"","props":[{"name":"className","type":"string","description":"Classes applied to root element of the data toolbar content row"},{"name":"clearAllFilters","type":"() => void","description":"optional callback for clearing all filters in the toolbar"},{"name":"clearFiltersButtonText","type":"string","description":"Text to display in the clear all filters button","defaultValue":"'Clear all filters'"},{"name":"collapseListedFiltersBreakpoint","type":"'all' | 'md' | 'lg' | 'xl' | '2xl'","description":"The breakpoint at which the listed filters in label groups are collapsed down to a summary","defaultValue":"'lg'"},{"name":"customLabelGroupContent","type":"React.ReactNode","description":"Custom additional content appended to the generated labels. To maintain spacing and styling, each node should be a ToolbarItem or ToolbarGroup. This property will remove the built in \"Clear all filters\" button."},{"name":"isExpanded","type":"boolean","description":"Flag indicating if a data toolbar toggle group's expandable content is expanded"},{"name":"labelGroupContentRef","type":"RefObject<any>","description":"Label group content reference for passing to data toolbar children"},{"name":"numberOfFilters","type":"number","description":"Total number of filters currently being applied across all ToolbarFilter components","required":true},{"name":"numberOfFiltersText","type":"(numberOfFilters: number) => string","description":"Text to display in the total number of applied filters ToolbarFilter","defaultValue":"(numberOfFilters: number) => `${numberOfFilters} filters applied`"},{"name":"showClearFiltersButton","type":"boolean","description":"Flag indicating that the clear all filters button should be visible","required":true}]},"ToolbarLabelGroupContentProps":{"name":"ToolbarLabelGroupContentProps","description":"","props":[{"name":"className","type":"string","description":"Classes applied to root element of the data toolbar content row"},{"name":"clearAllFilters","type":"() => void","description":"optional callback for clearing all filters in the toolbar"},{"name":"clearFiltersButtonText","type":"string","description":"Text to display in the clear all filters button"},{"name":"collapseListedFiltersBreakpoint","type":"'all' | 'md' | 'lg' | 'xl' | '2xl'","description":"The breakpoint at which the listed filters in label groups are collapsed down to a summary"},{"name":"customLabelGroupContent","type":"React.ReactNode","description":"Custom additional content appended to the generated labels. To maintain spacing and styling, each node should be a ToolbarItem or ToolbarGroup. This property will remove the built in \"Clear all filters\" button."},{"name":"isExpanded","type":"boolean","description":"Flag indicating if a data toolbar toggle group's expandable content is expanded"},{"name":"labelGroupContentRef","type":"RefObject<any>","description":"Label group content reference for passing to data toolbar children"},{"name":"numberOfFilters","type":"number","description":"Total number of filters currently being applied across all ToolbarFilter components","required":true},{"name":"numberOfFiltersText","type":"(numberOfFilters: number) => string","description":"Text to display in the total number of applied filters ToolbarFilter"},{"name":"showClearFiltersButton","type":"boolean","description":"Flag indicating that the clear all filters button should be visible","required":true}]},"ToolbarItem":{"name":"ToolbarItem","description":"","props":[{"name":"align","type":"{\n default?: 'alignEnd' | 'alignStart' | 'alignCenter';\n md?: 'alignEnd' | 'alignStart' | 'alignCenter';\n lg?: 'alignEnd' | 'alignStart' | 'alignCenter';\n xl?: 'alignEnd' | 'alignStart' | 'alignCenter';\n '2xl'?: 'alignEnd' | 'alignStart' | 'alignCenter';\n}","description":"Applies to a child of a flex layout, and aligns that child (and any adjacent children on the other side of it) to one side of the main axis"},{"name":"alignItems","type":"'start' | 'center' | 'baseline' | 'default' | 'end' | 'stretch'","description":"Vertical alignment of children"},{"name":"alignSelf","type":"'start' | 'center' | 'baseline' | 'default' | 'end' | 'stretch'","description":"Vertical alignment"},{"name":"children","type":"React.ReactNode","description":"Content to be rendered inside the data toolbar item"},{"name":"className","type":"string","description":"Classes applied to root element of the data toolbar item"},{"name":"columnGap","type":"{\n default?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n md?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n lg?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n xl?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n '2xl'?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n}","description":"Sets only the column gap at various breakpoints."},{"name":"gap","type":"{\n default?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n md?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n lg?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n xl?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n '2xl'?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n}","description":"Sets both the column and row gap at various breakpoints."},{"name":"id","type":"string","description":"id for this data toolbar item"},{"name":"isAllExpanded","type":"boolean","description":"Flag indicating if the expand-all variant is expanded or not"},{"name":"isOverflowContainer","type":"boolean","description":"Flag that modifies the toolbar item to hide overflow and respond to available space. Used for horizontal navigation."},{"name":"rowGap","type":"{\n default?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n md?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n lg?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n xl?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n '2xl'?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n}","description":"Sets only the row gap at various breakpoints."},{"name":"rowWrap","type":"{\n default?: 'wrap' | 'nowrap';\n sm?: 'wrap' | 'nowrap';\n md?: 'wrap' | 'nowrap';\n lg?: 'wrap' | 'nowrap';\n xl?: 'wrap' | 'nowrap';\n '2xl'?: 'wrap' | 'nowrap';\n}","description":"Value to set for row wrapping at various breakpoints"},{"name":"variant","type":"ToolbarItemVariant | 'pagination' | 'label' | 'label-group' | 'separator' | 'expand-all'","description":"A type modifier which modifies spacing specifically depending on the type of item"},{"name":"visibility","type":"{\n default?: 'hidden' | 'visible';\n md?: 'hidden' | 'visible';\n lg?: 'hidden' | 'visible';\n xl?: 'hidden' | 'visible';\n '2xl'?: 'hidden' | 'visible';\n}","description":"Visibility at various breakpoints."}]},"ToolbarItemProps":{"name":"ToolbarItemProps","description":"","props":[{"name":"align","type":"{\n default?: 'alignEnd' | 'alignStart' | 'alignCenter';\n md?: 'alignEnd' | 'alignStart' | 'alignCenter';\n lg?: 'alignEnd' | 'alignStart' | 'alignCenter';\n xl?: 'alignEnd' | 'alignStart' | 'alignCenter';\n '2xl'?: 'alignEnd' | 'alignStart' | 'alignCenter';\n }","description":"Applies to a child of a flex layout, and aligns that child (and any adjacent children on the other side of it) to one side of the main axis"},{"name":"alignItems","type":"'start' | 'center' | 'baseline' | 'default' | 'end' | 'stretch'","description":"Vertical alignment of children"},{"name":"alignSelf","type":"'start' | 'center' | 'baseline' | 'default' | 'end' | 'stretch'","description":"Vertical alignment"},{"name":"children","type":"React.ReactNode","description":"Content to be rendered inside the data toolbar item"},{"name":"className","type":"string","description":"Classes applied to root element of the data toolbar item"},{"name":"columnGap","type":"{\n default?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n md?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n lg?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n xl?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n '2xl'?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n }","description":"Sets only the column gap at various breakpoints."},{"name":"gap","type":"{\n default?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n md?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n lg?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n xl?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n '2xl'?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n }","description":"Sets both the column and row gap at various breakpoints."},{"name":"id","type":"string","description":"id for this data toolbar item"},{"name":"isAllExpanded","type":"boolean","description":"Flag indicating if the expand-all variant is expanded or not"},{"name":"isOverflowContainer","type":"boolean","description":"Flag that modifies the toolbar item to hide overflow and respond to available space. Used for horizontal navigation."},{"name":"rowGap","type":"{\n default?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n md?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n lg?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n xl?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n '2xl'?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n }","description":"Sets only the row gap at various breakpoints."},{"name":"rowWrap","type":"{\n default?: 'wrap' | 'nowrap';\n sm?: 'wrap' | 'nowrap';\n md?: 'wrap' | 'nowrap';\n lg?: 'wrap' | 'nowrap';\n xl?: 'wrap' | 'nowrap';\n '2xl'?: 'wrap' | 'nowrap';\n }","description":"Value to set for row wrapping at various breakpoints"},{"name":"variant","type":"ToolbarItemVariant | 'pagination' | 'label' | 'label-group' | 'separator' | 'expand-all'","description":"A type modifier which modifies spacing specifically depending on the type of item"},{"name":"visibility","type":"{\n default?: 'hidden' | 'visible';\n md?: 'hidden' | 'visible';\n lg?: 'hidden' | 'visible';\n xl?: 'hidden' | 'visible';\n '2xl'?: 'hidden' | 'visible';\n }","description":"Visibility at various breakpoints."}]},"ToolbarGroup":{"name":"ToolbarGroup","description":"","props":[{"name":"align","type":"{\n default?: 'alignEnd' | 'alignStart' | 'alignCenter';\n md?: 'alignEnd' | 'alignStart' | 'alignCenter';\n lg?: 'alignEnd' | 'alignStart' | 'alignCenter';\n xl?: 'alignEnd' | 'alignStart' | 'alignCenter';\n '2xl'?: 'alignEnd' | 'alignStart' | 'alignCenter';\n}","description":"Applies to a child of a flex layout, and aligns that child (and any adjacent children on the other side of it) to one side of the main axis"},{"name":"alignItems","type":"'start' | 'center' | 'baseline' | 'default' | 'end' | 'stretch'","description":"Vertical alignment of children"},{"name":"alignSelf","type":"'start' | 'center' | 'baseline' | 'default' | 'end' | 'stretch'","description":"Vertical alignment"},{"name":"children","type":"React.ReactNode","description":"Content to be rendered inside the data toolbar group"},{"name":"className","type":"string","description":"Classes applied to root element of the data toolbar group"},{"name":"columnGap","type":"{\n default?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n md?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n lg?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n xl?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n '2xl'?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n}","description":"Sets only the column gap at various breakpoints."},{"name":"gap","type":"{\n default?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n md?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n lg?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n xl?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n '2xl'?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n}","description":"Sets both the column and row gap at various breakpoints."},{"name":"isOverflowContainer","type":"boolean","description":"Flag that modifies the toolbar group to hide overflow and respond to available space. Used for horizontal navigation."},{"name":"rowGap","type":"{\n default?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n md?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n lg?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n xl?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n '2xl'?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n}","description":"Sets only the row gap at various breakpoints."},{"name":"rowWrap","type":"{\n default?: 'wrap' | 'nowrap';\n sm?: 'wrap' | 'nowrap';\n md?: 'wrap' | 'nowrap';\n lg?: 'wrap' | 'nowrap';\n xl?: 'wrap' | 'nowrap';\n '2xl'?: 'wrap' | 'nowrap';\n}","description":"Value to set for row wrapping at various breakpoints"},{"name":"variant","type":"| ToolbarGroupVariant\n| 'filter-group'\n| 'action-group'\n| 'action-group-inline'\n| 'action-group-plain'\n| 'label-group'","description":"A type modifier which modifies spacing specifically depending on the type of group"},{"name":"visibility","type":"{\n default?: 'hidden' | 'visible';\n md?: 'hidden' | 'visible';\n lg?: 'hidden' | 'visible';\n xl?: 'hidden' | 'visible';\n '2xl'?: 'hidden' | 'visible';\n}","description":"Visibility at various breakpoints."}]},"ToolbarGroupProps":{"name":"ToolbarGroupProps","description":"","props":[{"name":"align","type":"{\n default?: 'alignEnd' | 'alignStart' | 'alignCenter';\n md?: 'alignEnd' | 'alignStart' | 'alignCenter';\n lg?: 'alignEnd' | 'alignStart' | 'alignCenter';\n xl?: 'alignEnd' | 'alignStart' | 'alignCenter';\n '2xl'?: 'alignEnd' | 'alignStart' | 'alignCenter';\n }","description":"Applies to a child of a flex layout, and aligns that child (and any adjacent children on the other side of it) to one side of the main axis"},{"name":"alignItems","type":"'start' | 'center' | 'baseline' | 'default' | 'end' | 'stretch'","description":"Vertical alignment of children"},{"name":"alignSelf","type":"'start' | 'center' | 'baseline' | 'default' | 'end' | 'stretch'","description":"Vertical alignment"},{"name":"children","type":"React.ReactNode","description":"Content to be rendered inside the data toolbar group"},{"name":"className","type":"string","description":"Classes applied to root element of the data toolbar group"},{"name":"columnGap","type":"{\n default?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n md?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n lg?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n xl?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n '2xl'?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n }","description":"Sets only the column gap at various breakpoints."},{"name":"gap","type":"{\n default?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n md?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n lg?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n xl?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n '2xl'?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n }","description":"Sets both the column and row gap at various breakpoints."},{"name":"innerRef","type":"React.RefObject<any>","description":""},{"name":"isOverflowContainer","type":"boolean","description":"Flag that modifies the toolbar group to hide overflow and respond to available space. Used for horizontal navigation."},{"name":"rowGap","type":"{\n default?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n md?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n lg?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n xl?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n '2xl'?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n }","description":"Sets only the row gap at various breakpoints."},{"name":"rowWrap","type":"{\n default?: 'wrap' | 'nowrap';\n sm?: 'wrap' | 'nowrap';\n md?: 'wrap' | 'nowrap';\n lg?: 'wrap' | 'nowrap';\n xl?: 'wrap' | 'nowrap';\n '2xl'?: 'wrap' | 'nowrap';\n }","description":"Value to set for row wrapping at various breakpoints"},{"name":"variant","type":"| ToolbarGroupVariant\n | 'filter-group'\n | 'action-group'\n | 'action-group-inline'\n | 'action-group-plain'\n | 'label-group'","description":"A type modifier which modifies spacing specifically depending on the type of group"},{"name":"visibility","type":"{\n default?: 'hidden' | 'visible';\n md?: 'hidden' | 'visible';\n lg?: 'hidden' | 'visible';\n xl?: 'hidden' | 'visible';\n '2xl'?: 'hidden' | 'visible';\n }","description":"Visibility at various breakpoints."}]},"ToolbarFilter":{"name":"ToolbarFilter","description":"","props":[{"name":"align","type":"{\n default?: 'alignEnd' | 'alignStart' | 'alignCenter';\n md?: 'alignEnd' | 'alignStart' | 'alignCenter';\n lg?: 'alignEnd' | 'alignStart' | 'alignCenter';\n xl?: 'alignEnd' | 'alignStart' | 'alignCenter';\n '2xl'?: 'alignEnd' | 'alignStart' | 'alignCenter';\n}","description":"Applies to a child of a flex layout, and aligns that child (and any adjacent children on the other side of it) to one side of the main axis"},{"name":"alignItems","type":"'start' | 'center' | 'baseline' | 'default' | 'end' | 'stretch'","description":"Vertical alignment of children"},{"name":"alignSelf","type":"'start' | 'center' | 'baseline' | 'default' | 'end' | 'stretch'","description":"Vertical alignment"},{"name":"categoryName","type":"string | ToolbarLabelGroup","description":"Unique category name to be used as a label for the label group","required":true},{"name":"children","type":"React.ReactNode","description":"Content to be rendered inside the data toolbar item","required":true},{"name":"className","type":"string","description":"Classes applied to root element of the data toolbar item"},{"name":"columnGap","type":"{\n default?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n md?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n lg?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n xl?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n '2xl'?:\n | 'columnGapNone'\n | 'columnGapXs'\n | 'columnGapSm'\n | 'columnGapMd'\n | 'columnGapLg'\n | 'columnGapXl'\n | 'columnGap_2xl'\n | 'columnGap_3xl'\n | 'columnGap_4xl';\n}","description":"Sets only the column gap at various breakpoints."},{"name":"deleteLabel","type":"(category: string | ToolbarLabelGroup, label: ToolbarLabel | string) => void","description":"Callback passed by consumer used to delete a label from the labels[]"},{"name":"deleteLabelGroup","type":"(category: string | ToolbarLabelGroup) => void","description":"Callback passed by consumer used to close the entire label group"},{"name":"expandableLabelContainerRef","type":"React.RefObject<HTMLDivElement | null>","description":"Reference to a label container created with a custom expandable content group, for non-managed multiple toolbar toggle groups."},{"name":"gap","type":"{\n default?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n md?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n lg?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n xl?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n '2xl'?: 'gapNone' | 'gapXs' | 'gapSm' | 'gapMd' | 'gapLg' | 'gapXl' | 'gap_2xl' | 'gap_3xl' | 'gap_4xl';\n}","description":"Sets both the column and row gap at various breakpoints."},{"name":"id","type":"string","description":"id for this data toolbar item"},{"name":"isAllExpanded","type":"boolean","description":"Flag indicating if the expand-all variant is expanded or not"},{"name":"isExpanded","type":"boolean","description":"Flag indicating when toolbar toggle group is expanded for non-managed toolbar toggle groups."},{"name":"isOverflowContainer","type":"boolean","description":"Flag that modifies the toolbar item to hide overflow and respond to available space. Used for horizontal navigation."},{"name":"labelGroupCollapsedText","type":"string","description":"Customizable template string for the label group. Use variable \"${remaining}\" for the overflow label count."},{"name":"labelGroupExpandedText","type":"string","description":"Customizable \"Show Less\" text string for the label group"},{"name":"labels","type":"(string | ToolbarLabel)[]","description":"An array of strings to be displayed as labels in the expandable content","defaultValue":"[]"},{"name":"rowGap","type":"{\n default?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n md?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n lg?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n xl?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n '2xl'?:\n | 'rowGapNone'\n | 'rowGapXs'\n | 'rowGapSm'\n | 'rowGapMd'\n | 'rowGapLg'\n | 'rowGapXl'\n | 'rowGap_2xl'\n | 'rowGap_3xl'\n | 'rowGap_4xl';\n}","description":"Sets only the row gap at various breakpoints."},{"name":"rowWrap","type":"{\n default?: 'wrap' | 'nowrap';\n sm?: 'wrap' | 'nowrap';\n md?: 'wrap' | 'nowrap';\n lg?: 'wrap' | 'nowrap';\n xl?: 'wrap' | 'nowrap';\n '2xl'?: 'wrap' | 'nowrap';\n}","description":"Value to set for row wrapping at various breakpoints"},{"name":"showToolbarItem","type":"boolean","description":"Flag to show the toolbar item","defaultValue":"true"},{"name":"variant","type":"ToolbarItemVariant | 'pagination' | 'label' | 'label-group' | 'separator' | 'expand-all'","description":"A type modifier which modifies spacing specifically depending on the type of item"},{"name":"visibility","type":"{\n default?: 'hidden' | 'visible';\n md?: 'hidden' | 'visible';\n lg?: 'hidden' | 'visible';\n xl?: 'hidden' | 'visible';\n '2xl'?: 'hidden' | 'visible';\n}","description":"Visibility at various breakpoints."}]},"ToolbarLabelGroup":{"name":"ToolbarLabelGroup","description":"","props":[{"name":"key","type":"string","description":"A unique key to identify this label group category","required":true},{"name":"name","type":"string","description":"The category name to display for the label group","required":true}]},"ToolbarLabel":{"name":"ToolbarLabel","description":"","props":[{"name":"key","type":"string","description":"A unique key to identify this label","required":true},{"name":"node","type":"React.ReactNode","description":"The ReactNode to display in the label","required":true}]},"ToolbarFilterProps":{"name":"ToolbarFilterProps","description":"","props":[{"name":"categoryName","type":"string | ToolbarLabelGroup","description":"Unique category name to be used as a label for the label group","required":true},{"name":"children","type":"React.ReactNode","description":"Content to be rendered inside the data toolbar item associated with the label group","required":true},{"name":"deleteLabel","type":"(category: string | ToolbarLabelGroup, label: ToolbarLabel | string) => void","description":"Callback passed by consumer used to delete a label from the labels[]"},{"name":"deleteLabelGroup","type":"(category: string | ToolbarLabelGroup) => void","description":"Callback passed by consumer used to close the entire label group"},{"name":"expandableLabelContainerRef","type":"React.RefObject<HTMLDivElement | null>","description":"Reference to a label container created with a custom expandable content group, for non-managed multiple toolbar toggle groups."},{"name":"isExpanded","type":"boolean","description":"Flag indicating when toolbar toggle group is expanded for non-managed toolbar toggle groups."},{"name":"labelGroupCollapsedText","type":"string","description":"Customizable template string for the label group. Use variable \"${remaining}\" for the overflow label count."},{"name":"labelGroupExpandedText","type":"string","description":"Customizable \"Show Less\" text string for the label group"},{"name":"labels","type":"(string | ToolbarLabel)[]","description":"An array of strings to be displayed as labels in the expandable content"},{"name":"showToolbarItem","type":"boolean","description":"Flag to show the toolbar item"}]},"ToolbarFilterState":{"name":"ToolbarFilterState","description":"","props":[{"name":"isMounted","type":"boolean","description":null,"required":true}]},"ToolbarExpandableContent":{"name":"ToolbarExpandableContent","description":"","props":[{"name":"className","type":"string","description":"Classes added to the root element of the data toolbar expandable content"},{"name":"clearAllFilters","type":"() => void","description":"optional callback for clearing all filters in the toolbar"},{"name":"clearFiltersButtonText","type":"string","description":"Text to display in the clear all filters button","defaultValue":"'Clear all filters'"},{"name":"expandableContentRef","type":"RefObject<HTMLDivElement | null>","description":"Expandable content reference for passing to data toolbar children"},{"name":"isExpanded","type":"boolean","description":"Flag indicating the expandable content is expanded","defaultValue":"false"},{"name":"labelContainerRef","type":"RefObject<any>","description":"Label container reference for passing to data toolbar children"},{"name":"showClearFiltersButton","type":"boolean","description":"Flag indicating that the clear all filters button should be visible","required":true}]},"ToolbarExpandableContentProps":{"name":"ToolbarExpandableContentProps","description":"","props":[{"name":"className","type":"string","description":"Classes added to the root element of the data toolbar expandable content"},{"name":"clearAllFilters","type":"() => void","description":"optional callback for clearing all filters in the toolbar"},{"name":"clearFiltersButtonText","type":"string","description":"Text to display in the clear all filters button"},{"name":"expandableContentRef","type":"RefObject<HTMLDivElement | null>","description":"Expandable content reference for passing to data toolbar children"},{"name":"isExpanded","type":"boolean","description":"Flag indicating the expandable content is expanded"},{"name":"labelContainerRef","type":"RefObject<any>","description":"Label container reference for passing to data toolbar children"},{"name":"showClearFiltersButton","type":"boolean","description":"Flag indicating that the clear all filters button should be visible","required":true}]},"ToolbarExpandIconWrapper":{"name":"ToolbarExpandIconWrapper","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Icon content used for the expand all or collapse all indication."},{"name":"className","type":"string","description":"Additional classes added to the span"}]},"ToolbarExpandIconWrapperProps":{"name":"ToolbarExpandIconWrapperProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Icon content used for the expand all or collapse all indication."},{"name":"className","type":"string","description":"Additional classes added to the span"}]},"ToolbarContent":{"name":"ToolbarContent","description":"","props":[{"name":"alignItems","type":"'start' | 'center' | 'baseline' | 'default'","description":"Vertical alignment of children"},{"name":"children","type":"React.ReactNode","description":"Content to be rendered as children of the content row"},{"name":"className","type":"string","description":"Classes applied to root element of the data toolbar content row"},{"name":"clearAllFilters","type":"() => void","description":"Optional callback for clearing all filters in the toolbar"},{"name":"clearFiltersButtonText","type":"string","description":"Text to display in the clear all filters button"},{"name":"isExpanded","type":"boolean","description":"Flag indicating if a data toolbar toggle group's expandable content is expanded","defaultValue":"false"},{"name":"rowWrap","type":"{\n default?: 'wrap' | 'nowrap';\n sm?: 'wrap' | 'nowrap';\n md?: 'wrap' | 'nowrap';\n lg?: 'wrap' | 'nowrap';\n xl?: 'wrap' | 'nowrap';\n '2xl'?: 'wrap' | 'nowrap';\n}","description":"Value to set for content wrapping at various breakpoints"},{"name":"showClearFiltersButton","type":"boolean","description":"Flag indicating that the clear all filters button should be visible","defaultValue":"false"},{"name":"toolbarId","type":"string","description":"Id of the parent Toolbar component"},{"name":"visibility","type":"{\n default?: 'hidden' | 'visible';\n md?: 'hidden' | 'visible';\n lg?: 'hidden' | 'visible';\n xl?: 'hidden' | 'visible';\n '2xl'?: 'hidden' | 'visible';\n}","description":"Visibility at various breakpoints."}]},"ToolbarContentProps":{"name":"ToolbarContentProps","description":"","props":[{"name":"alignItems","type":"'start' | 'center' | 'baseline' | 'default'","description":"Vertical alignment of children"},{"name":"children","type":"React.ReactNode","description":"Content to be rendered as children of the content row"},{"name":"className","type":"string","description":"Classes applied to root element of the data toolbar content row"},{"name":"clearAllFilters","type":"() => void","description":"Optional callback for clearing all filters in the toolbar"},{"name":"clearFiltersButtonText","type":"string","description":"Text to display in the clear all filters button"},{"name":"isExpanded","type":"boolean","description":"Flag indicating if a data toolbar toggle group's expandable content is expanded"},{"name":"rowWrap","type":"{\n default?: 'wrap' | 'nowrap';\n sm?: 'wrap' | 'nowrap';\n md?: 'wrap' | 'nowrap';\n lg?: 'wrap' | 'nowrap';\n xl?: 'wrap' | 'nowrap';\n '2xl'?: 'wrap' | 'nowrap';\n }","description":"Value to set for content wrapping at various breakpoints"},{"name":"showClearFiltersButton","type":"boolean","description":"Flag indicating that the clear all filters button should be visible"},{"name":"toolbarId","type":"string","description":"Id of the parent Toolbar component"},{"name":"visibility","type":"{\n default?: 'hidden' | 'visible';\n md?: 'hidden' | 'visible';\n lg?: 'hidden' | 'visible';\n xl?: 'hidden' | 'visible';\n '2xl'?: 'hidden' | 'visible';\n }","description":"Visibility at various breakpoints."}]},"Toolbar":{"name":"Toolbar","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered as rows in the data toolbar"},{"name":"className","type":"string","description":"Classes applied to root element of the data toolbar"},{"name":"clearAllFilters","type":"() => void","description":"Optional callback for clearing all filters in the toolbar"},{"name":"clearFiltersButtonText","type":"string","description":"Text to display in the clear all filters button"},{"name":"collapseListedFiltersBreakpoint","type":"'all' | 'md' | 'lg' | 'xl' | '2xl'","description":"The breakpoint at which the listed filters in label groups are collapsed down to a summary"},{"name":"colorVariant","type":"ToolbarColorVariant | 'default' | 'no-background' | 'primary' | 'secondary'","description":"Background color variant of the toolbar"},{"name":"customLabelGroupContent","type":"React.ReactNode","description":"Custom content appended to the filter generated label group. To maintain spacing and styling, each node should be wrapped in a ToolbarItem or ToolbarGroup. This property will remove the default \"Clear all filters\" button."},{"name":"hasNoPadding","type":"boolean","description":"Flag indicating the toolbar padding is removed"},{"name":"id","type":"string","description":"Id of the data toolbar"},{"name":"inset","type":"{\n default?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n sm?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n md?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n lg?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n xl?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n '2xl'?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n}","description":"Insets at various breakpoints."},{"name":"isExpanded","type":"boolean","description":"Flag indicating if a data toolbar toggle group's expandable content is expanded"},{"name":"isFullHeight","type":"boolean","description":"Flag indicating the toolbar height should expand to the full height of the container"},{"name":"isStatic","type":"boolean","description":"Flag indicating the toolbar is static"},{"name":"isSticky","type":"boolean","description":"Flag indicating the toolbar should stick to the top of its container"},{"name":"numberOfFiltersText","type":"(numberOfFilters: number) => string","description":"Text to display in the total number of applied filters ToolbarFilter"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"toggleIsExpanded","type":"() => void","description":"A callback for setting the isExpanded flag"}]},"ToolbarProps":{"name":"ToolbarProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered as rows in the data toolbar"},{"name":"className","type":"string","description":"Classes applied to root element of the data toolbar"},{"name":"clearAllFilters","type":"() => void","description":"Optional callback for clearing all filters in the toolbar"},{"name":"clearFiltersButtonText","type":"string","description":"Text to display in the clear all filters button"},{"name":"collapseListedFiltersBreakpoint","type":"'all' | 'md' | 'lg' | 'xl' | '2xl'","description":"The breakpoint at which the listed filters in label groups are collapsed down to a summary"},{"name":"colorVariant","type":"ToolbarColorVariant | 'default' | 'no-background' | 'primary' | 'secondary'","description":"Background color variant of the toolbar"},{"name":"customLabelGroupContent","type":"React.ReactNode","description":"Custom content appended to the filter generated label group. To maintain spacing and styling, each node should be wrapped in a ToolbarItem or ToolbarGroup. This property will remove the default \"Clear all filters\" button."},{"name":"hasNoPadding","type":"boolean","description":"Flag indicating the toolbar padding is removed"},{"name":"id","type":"string","description":"Id of the data toolbar"},{"name":"inset","type":"{\n default?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n sm?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n md?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n lg?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n xl?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n '2xl'?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n }","description":"Insets at various breakpoints."},{"name":"isExpanded","type":"boolean","description":"Flag indicating if a data toolbar toggle group's expandable content is expanded"},{"name":"isFullHeight","type":"boolean","description":"Flag indicating the toolbar height should expand to the full height of the container"},{"name":"isStatic","type":"boolean","description":"Flag indicating the toolbar is static"},{"name":"isSticky","type":"boolean","description":"Flag indicating the toolbar should stick to the top of its container"},{"name":"numberOfFiltersText","type":"(numberOfFilters: number) => string","description":"Text to display in the total number of applied filters ToolbarFilter"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"toggleIsExpanded","type":"() => void","description":"A callback for setting the isExpanded flag"}]},"ToolbarState":{"name":"ToolbarState","description":"","props":[{"name":"filterInfo","type":"FilterInfo","description":"Object managing information about how many labels are in each label group","required":true},{"name":"isManagedToggleExpanded","type":"boolean","description":"Flag used if the user has opted NOT to manage the 'isExpanded' state of the toggle group.\nIndicates whether or not the toggle group is expanded.","required":true},{"name":"ouiaStateId","type":"string","description":null,"required":true},{"name":"windowWidth","type":"number","description":"Used to keep track of window width so we can collapse expanded content when window is resizing","required":true}]},"FilterInfo":{"name":"FilterInfo","description":"","props":[{"name":"[key: string]","type":"number","description":null,"required":true}]},"ToggleGroupItemElement":{"name":"ToggleGroupItemElement","description":"","props":[]},"ToggleGroupItemElementProps":{"name":"ToggleGroupItemElementProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the toggle group item"},{"name":"variant","type":"ToggleGroupItemVariant | 'icon' | 'text'","description":"Adds toggle group item variant styles"}]},"ToggleGroupItem":{"name":"ToggleGroupItem","description":"","props":[{"name":"aria-label","type":"string","description":"required when icon is used with no supporting text"},{"name":"buttonId","type":"string","description":"Optional id for the button within the toggle group item"},{"name":"className","type":"string","description":"Additional classes added to the toggle group item"},{"name":"icon","type":"React.ReactNode","description":"Icon rendered inside the toggle group item"},{"name":"iconPosition","type":"'start' | 'end'","description":"Sets position of the icon when text is also passed in","defaultValue":"'start'"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the toggle group item is disabled","defaultValue":"false"},{"name":"isSelected","type":"boolean","description":"Flag indicating if the toggle group item is selected","defaultValue":"false"},{"name":"onChange","type":"(event: React.MouseEvent<any> | React.KeyboardEvent | MouseEvent, selected: boolean) => void","description":"A callback for when the toggle group item selection changes.","defaultValue":"() => {}"},{"name":"text","type":"React.ReactNode","description":"Text rendered inside the toggle group item"}]},"ToggleGroupItemProps":{"name":"ToggleGroupItemProps","description":"","props":[{"name":"buttonId","type":"string","description":"Optional id for the button within the toggle group item"},{"name":"className","type":"string","description":"Additional classes added to the toggle group item"},{"name":"icon","type":"React.ReactNode","description":"Icon rendered inside the toggle group item"},{"name":"iconPosition","type":"'start' | 'end'","description":"Sets position of the icon when text is also passed in"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the toggle group item is disabled"},{"name":"isSelected","type":"boolean","description":"Flag indicating if the toggle group item is selected"},{"name":"onChange","type":"(event: React.MouseEvent<any> | React.KeyboardEvent | MouseEvent, selected: boolean) => void","description":"A callback for when the toggle group item selection changes."},{"name":"text","type":"React.ReactNode","description":"Text rendered inside the toggle group item"},{"name":"Unknown","type":"string","description":"required when icon is used with no supporting text"}]},"ToggleGroup":{"name":"ToggleGroup","description":"","props":[{"name":"areAllGroupsDisabled","type":"boolean","description":"Disable all toggle group items under this component.","defaultValue":"false"},{"name":"aria-label","type":"string","description":"Accessible label for the toggle group"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the toggle group"},{"name":"className","type":"string","description":"Additional classes added to the toggle group"},{"name":"isCompact","type":"boolean","description":"Modifies the toggle group to include compact styling.","defaultValue":"false"}]},"ToggleGroupProps":{"name":"ToggleGroupProps","description":"","props":[{"name":"areAllGroupsDisabled","type":"boolean","description":"Disable all toggle group items under this component."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the toggle group"},{"name":"className","type":"string","description":"Additional classes added to the toggle group"},{"name":"isCompact","type":"boolean","description":"Modifies the toggle group to include compact styling."},{"name":"Unknown","type":"string","description":"Accessible label for the toggle group"}]},"Title":{"name":"Title","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Title","defaultValue":"''"},{"name":"className","type":"string","description":"Additional classes added to the Title","defaultValue":"''"},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"The heading level to use","required":true},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"},{"name":"size","type":"'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl'","description":"The size of the Title"}]},"TitleProps":{"name":"TitleProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Title"},{"name":"className","type":"string","description":"Additional classes added to the Title"},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"The heading level to use","required":true},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"size","type":"Size","description":"The size of the Title"}]},"Size":{"name":"Size","description":"","props":[]},"Timestamp":{"name":"Timestamp","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Displays custom content inside the timestamp, such as a relative time. This prop will\noverride the default content that is displayed. Custom content will not be affected by\nany props that format or add to displayed content."},{"name":"className","type":"string","description":"Class to add to the outer span."},{"name":"customFormat","type":"{ [key: string]: string }","description":"Applies custom formatting to the displayed date and/or time. Passing this prop in will\noverride the dateFormat and timeFormat props."},{"name":"date","type":"Date","description":"Determines the default content that is displayed inside the timestamp and the value of\nthe inner time element's datetime attribute."},{"name":"dateFormat","type":"'full' | 'long' | 'medium' | 'short'","description":"Determines the format of the displayed date in the timestamp and UTC tooltip. Examples:\n\"Full\" => Tuesday, August 9, 2022;\n\"Long\" => August 9, 2022;\n\"Medium\" => Aug 9, 2022;\n\"Short\" => 8/9/22"},{"name":"displaySuffix","type":"string","description":"Applies a custom suffix to the displayed content, usually after the time, such as a\ncustom time zone.","defaultValue":"''"},{"name":"is12Hour","type":"boolean","description":"Flag for displaying the time in a 12 hour format. If this prop is not passed in,\nthe hour format will be based on the locale prop's value."},{"name":"locale","type":"string","description":"Determines which locale to use in the displayed content. Defaults to the current locale\nwhen this prop is not passed in. For more information about locale's:\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_identification_and_negotiation"},{"name":"shouldDisplayUTC","type":"boolean","description":"Flag indicating whether the default content should be displayed as a UTC string\ninstead of a local string."},{"name":"timeFormat","type":"'full' | 'long' | 'medium' | 'short'","description":"Determines the format of the displayed time in the timestamp and UTC tooltip. Examples:\n\"Full\" => 11:25:00 AM Eastern Daylight Time\n\"Long\" => 11:25:00 AM EDT\n\"Medium\" => 11:25:00 AM\n\"Short\" => 11:25 AM"},{"name":"tooltip","type":"TimestampTooltip","description":"Adds a tooltip to the timestamp."}]},"TimestampTooltip":{"name":"TimestampTooltip","description":"","props":[{"name":"content","type":"React.ReactNode","description":"Content displayed in the tooltip when using the \"custom\" variant."},{"name":"suffix","type":"string","description":"A custom suffix to apply to a \"default\" variant tooltip."},{"name":"tooltipProps","type":"any","description":"Additional props passed to the tooltip."},{"name":"variant","type":"'default' | 'custom'","description":"The variant of the tooltip. The \"default\" variant displays the date passed into\nthe timestamp's date prop as a UTC string.","required":true}]},"TimestampProps":{"name":"TimestampProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Displays custom content inside the timestamp, such as a relative time. This prop will\noverride the default content that is displayed. Custom content will not be affected by\nany props that format or add to displayed content."},{"name":"className","type":"string","description":"Class to add to the outer span."},{"name":"customFormat","type":"{ [key: string]: string }","description":"Applies custom formatting to the displayed date and/or time. Passing this prop in will\noverride the dateFormat and timeFormat props."},{"name":"date","type":"Date","description":"Determines the default content that is displayed inside the timestamp and the value of\nthe inner time element's datetime attribute."},{"name":"dateFormat","type":"'full' | 'long' | 'medium' | 'short'","description":"Determines the format of the displayed date in the timestamp and UTC tooltip. Examples:\n\"Full\" => Tuesday, August 9, 2022;\n\"Long\" => August 9, 2022;\n\"Medium\" => Aug 9, 2022;\n\"Short\" => 8/9/22"},{"name":"displaySuffix","type":"string","description":"Applies a custom suffix to the displayed content, usually after the time, such as a\ncustom time zone."},{"name":"is12Hour","type":"boolean","description":"Flag for displaying the time in a 12 hour format. If this prop is not passed in,\nthe hour format will be based on the locale prop's value."},{"name":"locale","type":"string","description":"Determines which locale to use in the displayed content. Defaults to the current locale\nwhen this prop is not passed in. For more information about locale's:\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_identification_and_negotiation"},{"name":"shouldDisplayUTC","type":"boolean","description":"Flag indicating whether the default content should be displayed as a UTC string\ninstead of a local string."},{"name":"timeFormat","type":"'full' | 'long' | 'medium' | 'short'","description":"Determines the format of the displayed time in the timestamp and UTC tooltip. Examples:\n\"Full\" => 11:25:00 AM Eastern Daylight Time\n\"Long\" => 11:25:00 AM EDT\n\"Medium\" => 11:25:00 AM\n\"Short\" => 11:25 AM"},{"name":"tooltip","type":"TimestampTooltip","description":"Adds a tooltip to the timestamp."}]},"TimePicker":{"name":"TimePicker","description":"","props":[{"name":"aria-label","type":"string","description":"Accessible label for the time picker","defaultValue":"'Time picker'"},{"name":"className","type":"string","description":"Additional classes added to the time picker.","defaultValue":"''"},{"name":"delimiter","type":"string","description":"Character to display between the hour and minute","defaultValue":"':'"},{"name":"id","type":"string","description":"Id of the time picker"},{"name":"includeSeconds","type":"boolean","description":"Includes number of seconds with the chosen time and allows users to manually edit the seconds value."},{"name":"inputProps","type":"TextInputProps","description":"Additional props for input field","defaultValue":"{}"},{"name":"invalidFormatErrorMessage","type":"string","description":"Error message to display when the time is provided in an invalid format.","defaultValue":"'Invalid time format'"},{"name":"invalidMinMaxErrorMessage","type":"string","description":"Error message to display when the time provided is not within the minTime/maxTime constraints","defaultValue":"'Invalid time entered'"},{"name":"is24Hour","type":"boolean","description":"True if the time is 24 hour time. False if the time is 12 hour time","defaultValue":"false"},{"name":"isDisabled","type":"boolean","description":"Flag indicating the time picker is disabled","defaultValue":"false"},{"name":"isOpen","type":"boolean","description":"Flag to control the opened state of the time picker menu","defaultValue":"false"},{"name":"maxTime","type":"string | Date","description":"A time string indicating the maximum value allowed. The format could be an ISO 8601 formatted date string or in 'HH{delimiter}MM' format","defaultValue":"''"},{"name":"menuAppendTo","type":"HTMLElement | (() => HTMLElement) | 'inline' | 'parent'","description":"The container to append the menu to. Defaults to 'inline'.\nIf your menu is being cut off you can append it to an element higher up the DOM tree.\nSome examples:\nmenuAppendTo=\"parent\"\nmenuAppendTo={() => document.body}\nmenuAppendTo={document.getElementById('target')}","defaultValue":"'inline'"},{"name":"minTime","type":"string | Date","description":"A time string indicating the minimum value allowed. The format could be an ISO 8601 formatted date string or in 'HH{delimiter}MM' format","defaultValue":"''"},{"name":"onChange","type":"(\n event: React.FormEvent<HTMLInputElement>,\n time: string,\n hour?: number,\n minute?: number,\n seconds?: number,\n isValid?: boolean\n) => void","description":"Optional event handler called each time the value in the time picker input changes."},{"name":"placeholder","type":"string","description":"String to display in the empty time picker field as a hint for the expected time format","defaultValue":"'hh:mm'"},{"name":"setIsOpen","type":"(isOpen?: boolean) => void","description":"Handler invoked each time the open state of time picker updates","defaultValue":"() => {}"},{"name":"stepMinutes","type":"number","description":"Size of step between time options in minutes.","defaultValue":"30"},{"name":"time","type":"string | Date","description":"A time string. The format could be an ISO 8601 formatted date string or in 'HH{delimiter}MM' format","defaultValue":"''"},{"name":"validateTime","type":"(time: string) => boolean","description":"Optional validator can be provided to override the internal time validator."},{"name":"width","type":"string","description":"Width of the time picker.","defaultValue":"'150px'"},{"name":"zIndex","type":"number","description":"z-index of the time picker","defaultValue":"9999"}]},"TimePickerProps":{"name":"TimePickerProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the time picker."},{"name":"delimiter","type":"string","description":"Character to display between the hour and minute"},{"name":"id","type":"string","description":"Id of the time picker"},{"name":"includeSeconds","type":"boolean","description":"Includes number of seconds with the chosen time and allows users to manually edit the seconds value."},{"name":"inputProps","type":"TextInputProps","description":"Additional props for input field"},{"name":"invalidFormatErrorMessage","type":"string","description":"Error message to display when the time is provided in an invalid format."},{"name":"invalidMinMaxErrorMessage","type":"string","description":"Error message to display when the time provided is not within the minTime/maxTime constraints"},{"name":"is24Hour","type":"boolean","description":"True if the time is 24 hour time. False if the time is 12 hour time"},{"name":"isDisabled","type":"boolean","description":"Flag indicating the time picker is disabled"},{"name":"isOpen","type":"boolean","description":"Flag to control the opened state of the time picker menu"},{"name":"maxTime","type":"string | Date","description":"A time string indicating the maximum value allowed. The format could be an ISO 8601 formatted date string or in 'HH{delimiter}MM' format"},{"name":"menuAppendTo","type":"HTMLElement | (() => HTMLElement) | 'inline' | 'parent'","description":"The container to append the menu to. Defaults to 'inline'.\nIf your menu is being cut off you can append it to an element higher up the DOM tree.\nSome examples:\nmenuAppendTo=\"parent\"\nmenuAppendTo={() => document.body}\nmenuAppendTo={document.getElementById('target')}"},{"name":"minTime","type":"string | Date","description":"A time string indicating the minimum value allowed. The format could be an ISO 8601 formatted date string or in 'HH{delimiter}MM' format"},{"name":"onChange","type":"(\n event: React.FormEvent<HTMLInputElement>,\n time: string,\n hour?: number,\n minute?: number,\n seconds?: number,\n isValid?: boolean\n ) => void","description":"Optional event handler called each time the value in the time picker input changes."},{"name":"placeholder","type":"string","description":"String to display in the empty time picker field as a hint for the expected time format"},{"name":"setIsOpen","type":"(isOpen?: boolean) => void","description":"Handler invoked each time the open state of time picker updates"},{"name":"stepMinutes","type":"number","description":"Size of step between time options in minutes."},{"name":"time","type":"string | Date","description":"A time string. The format could be an ISO 8601 formatted date string or in 'HH{delimiter}MM' format"},{"name":"Unknown","type":"string","description":"Accessible label for the time picker"},{"name":"validateTime","type":"(time: string) => boolean","description":"Optional validator can be provided to override the internal time validator."},{"name":"width","type":"string","description":"Width of the time picker."},{"name":"zIndex","type":"number","description":"z-index of the time picker"}]},"TimePickerState":{"name":"TimePickerState","description":"","props":[{"name":"focusedIndex","type":"number","description":null,"required":true},{"name":"isInvalid","type":"boolean","description":null,"required":true},{"name":"isTimeOptionsOpen","type":"boolean","description":null,"required":true},{"name":"maxTimeState","type":"string","description":null,"required":true},{"name":"minTimeState","type":"string","description":null,"required":true},{"name":"scrollIndex","type":"number","description":null,"required":true},{"name":"timeRegex","type":"RegExp","description":null,"required":true},{"name":"timeState","type":"string","description":null,"required":true}]},"TextInputGroupUtilities":{"name":"TextInputGroupUtilities","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the text input group utilities div"},{"name":"className","type":"string","description":"Additional classes applied to the text input group utilities container"}]},"TextInputGroupUtilitiesProps":{"name":"TextInputGroupUtilitiesProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the text input group utilities div"},{"name":"className","type":"string","description":"Additional classes applied to the text input group utilities container"}]},"TextInputGroupMain":{"name":"TextInputGroupMain","description":"","props":[{"name":"aria-activedescendant","type":"string","description":"The id of the active element. Required if role has a value of \"combobox\", and focus\nshould remain on the input."},{"name":"aria-controls","type":"string","description":"The id of the element(s) controlled by the input. Required if role has a value of \"combobox\"."},{"name":"aria-label","type":"string","description":"Accessibility label for the input"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the text input group main div"},{"name":"className","type":"string","description":"Additional classes applied to the text input group main container"},{"name":"hint","type":"string","description":"Suggestion that will show up like a placeholder even with text in the input"},{"name":"icon","type":"React.ReactNode","description":"Icon to be shown on the left side of the text input group main container"},{"name":"inputId","type":"string","description":"The id of the input element"},{"name":"inputProps","type":"any","description":"Additional props to spread to the input element."},{"name":"isExpanded","type":"boolean","description":"Flag for whether an associated element controlled by the input is visible. Required if\nrole has a value of \"combobox\"."},{"name":"name","type":"string","description":"Name for the input"},{"name":"onBlur","type":"(event?: any) => void","description":"Callback for when focus is lost on the input field"},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"Callback for when there is a change in the input field"},{"name":"onFocus","type":"(event?: any) => void","description":"Callback for when the input field is focused"},{"name":"placeholder","type":"string","description":"Placeholder value for the input"},{"name":"role","type":"string","description":"Determines the accessible role of the input."},{"name":"type","type":"| 'text'\n| 'date'\n| 'datetime-local'\n| 'email'\n| 'month'\n| 'number'\n| 'password'\n| 'search'\n| 'tel'\n| 'time'\n| 'url'","description":"Type that the input accepts."},{"name":"value","type":"string | number","description":"Value for the input"}]},"TextInputGroupMainProps":{"name":"TextInputGroupMainProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the text input group main div"},{"name":"className","type":"string","description":"Additional classes applied to the text input group main container"},{"name":"hint","type":"string","description":"Suggestion that will show up like a placeholder even with text in the input"},{"name":"icon","type":"React.ReactNode","description":"Icon to be shown on the left side of the text input group main container"},{"name":"innerRef","type":"React.RefObject<any>","description":""},{"name":"inputId","type":"string","description":"The id of the input element"},{"name":"inputProps","type":"any","description":"Additional props to spread to the input element."},{"name":"isExpanded","type":"boolean","description":"Flag for whether an associated element controlled by the input is visible. Required if\nrole has a value of \"combobox\"."},{"name":"name","type":"string","description":"Name for the input"},{"name":"onBlur","type":"(event?: any) => void","description":"Callback for when focus is lost on the input field"},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"Callback for when there is a change in the input field"},{"name":"onFocus","type":"(event?: any) => void","description":"Callback for when the input field is focused"},{"name":"placeholder","type":"string","description":"Placeholder value for the input"},{"name":"role","type":"string","description":"Determines the accessible role of the input."},{"name":"type","type":"| 'text'\n | 'date'\n | 'datetime-local'\n | 'email'\n | 'month'\n | 'number'\n | 'password'\n | 'search'\n | 'tel'\n | 'time'\n | 'url'","description":"Type that the input accepts."},{"name":"Unknown","type":"string","description":"The id of the element(s) controlled by the input. Required if role has a value of \"combobox\"."},{"name":"value","type":"string | number","description":"Value for the input"}]},"TextInputGroupIcon":{"name":"TextInputGroupIcon","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the text input group utilities div"},{"name":"className","type":"string","description":"Additional classes applied to the text input group utilities container"},{"name":"isStatus","type":"boolean","description":"Flag indicating if the icon is a status icon and should inherit status styling."}]},"TextInputGroupIconProps":{"name":"TextInputGroupIconProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the text input group utilities div"},{"name":"className","type":"string","description":"Additional classes applied to the text input group utilities container"},{"name":"isStatus","type":"boolean","description":"Flag indicating if the icon is a status icon and should inherit status styling."}]},"TextInputGroup":{"name":"TextInputGroup","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the text input group"},{"name":"className","type":"string","description":"Additional classes applied to the text input group container"},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling and a disabled context value which text input group main hooks into for the input itself"},{"name":"isPlain","type":"boolean","description":"Flag to indicate the toggle has no border or background"},{"name":"validated","type":"'success' | 'warning' | 'error'","description":"Status variant of the text input group."}]},"TextInputGroupProps":{"name":"TextInputGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the text input group"},{"name":"className","type":"string","description":"Additional classes applied to the text input group container"},{"name":"innerRef","type":"React.RefObject<any>","description":""},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling and a disabled context value which text input group main hooks into for the input itself"},{"name":"isPlain","type":"boolean","description":"Flag to indicate the toggle has no border or background"},{"name":"validated","type":"'success' | 'warning' | 'error'","description":"Status variant of the text input group."}]},"TextInputExpandedObj":{"name":"TextInputExpandedObj","description":"","props":[{"name":"ariaControls","type":"string","description":"Id of the element that the text input is controlling expansion of.","required":true},{"name":"isExpanded","type":"boolean","description":"Flag to apply expanded styling.","required":true}]},"TextInputProps":{"name":"TextInputProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the text input."},{"name":"customIcon","type":"React.ReactNode","description":"Custom icon to render. If the validated prop is also passed, this will render an icon in addition to a validated icon."},{"name":"expandedProps","type":"TextInputExpandedObj","description":"Prop to apply expanded styling to the text input and link it to the element it is controlling. This should be used when the input controls a menu and that menu is expandable."},{"name":"innerRef","type":"React.RefObject<any>","description":""},{"name":"isDisabled","type":"boolean","description":"Flag to show if the text input is disabled."},{"name":"isExpanded","type":"boolean","description":""},{"name":"isLeftTruncated","type":"boolean","description":""},{"name":"isRequired","type":"boolean","description":"Flag indicating whether the input is required"},{"name":"isStartTruncated","type":"boolean","description":"Trim text at start"},{"name":"onBlur","type":"(event?: any) => void","description":"Callback function when text input is blurred (focus leaves)"},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"A callback for when the text input value changes."},{"name":"onFocus","type":"(event?: any) => void","description":"Callback function when text input is focused"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"placeholder","type":"string","description":"Placeholder of the text input when there is no value"},{"name":"readOnlyVariant","type":"'plain' | 'default'","description":"Sets the input as readonly and determines the readonly styling."},{"name":"type","type":"| 'text'\n | 'date'\n | 'datetime-local'\n | 'email'\n | 'month'\n | 'number'\n | 'password'\n | 'search'\n | 'tel'\n | 'time'\n | 'url'","description":"Type that the text input accepts."},{"name":"Unknown","type":"string","description":"Aria-label. The text input requires an associated id or aria-label."},{"name":"validated","type":"'success' | 'warning' | 'error' | 'default'","description":"Value to indicate if the text input is modified to show that validation state.\nIf set to success, text input will be modified to indicate valid state.\nIf set to error, text input will be modified to indicate error state."},{"name":"value","type":"string | number","description":"Value of the text input."}]},"TextInputState":{"name":"TextInputState","description":"","props":[{"name":"ouiaStateId","type":"string","description":null,"required":true}]},"TextArea":{"name":"TextArea","description":"","props":[{"name":"aria-label","type":"string","description":"Custom flag to show that the text area requires an associated id or aria-label."},{"name":"autoResize","type":"boolean","description":"Flag to modify height based on contents."},{"name":"className","type":"string","description":"Additional classes added to the text area."},{"name":"isDisabled","type":"boolean","description":"Flag to show if the text area is disabled."},{"name":"isRequired","type":"boolean","description":"Flag to show if the text area is required."},{"name":"onChange","type":"(event: React.ChangeEvent<HTMLTextAreaElement>, value: string) => void","description":"A callback for when the text area value changes."},{"name":"readOnlyVariant","type":"'default' | 'plain'","description":"Read only variant."},{"name":"resizeOrientation","type":"'horizontal' | 'vertical' | 'both' | 'none'","description":"Sets the orientation to limit the resize to"},{"name":"validated","type":"'success' | 'warning' | 'error' | 'default'","description":"Value to indicate if the text area is modified to show that validation state.\nIf set to success, text area will be modified to indicate valid state.\nIf set to error, text area will be modified to indicate error state."},{"name":"value","type":"string | number","description":"Value of the text area."}]},"TextAreaProps":{"name":"TextAreaProps","description":"","props":[{"name":"autoResize","type":"boolean","description":"Flag to modify height based on contents."},{"name":"className","type":"string","description":"Additional classes added to the text area."},{"name":"innerRef","type":"React.RefObject<any>","description":""},{"name":"isDisabled","type":"boolean","description":"Flag to show if the text area is disabled."},{"name":"isRequired","type":"boolean","description":"Flag to show if the text area is required."},{"name":"onChange","type":"(event: React.ChangeEvent<HTMLTextAreaElement>, value: string) => void","description":"A callback for when the text area value changes."},{"name":"readOnlyVariant","type":"'default' | 'plain'","description":"Read only variant."},{"name":"resizeOrientation","type":"'horizontal' | 'vertical' | 'both' | 'none'","description":"Sets the orientation to limit the resize to"},{"name":"Unknown","type":"string","description":"Custom flag to show that the text area requires an associated id or aria-label."},{"name":"validated","type":"'success' | 'warning' | 'error' | 'default'","description":"Value to indicate if the text area is modified to show that validation state.\nIf set to success, text area will be modified to indicate valid state.\nIf set to error, text area will be modified to indicate error state."},{"name":"value","type":"string | number","description":"Value of the text area."}]},"Tabs":{"name":"Tabs","description":"","props":[{"name":"activeKey","type":"number | string","description":"The index of the active tab","defaultValue":"0"},{"name":"addButtonAriaLabel","type":"string","description":"Aria-label for the add button"},{"name":"aria-label","type":"string","description":"Provides an accessible label for the tabs. Labels should be unique for each set of tabs that are present on a page. When component is set to nav, this prop should be defined to differentiate the tabs from other navigation regions on the page."},{"name":"backScrollAriaLabel","type":"string","description":"Aria-label for the back scroll button","defaultValue":"'Scroll back'"},{"name":"children","type":"TabsChild | TabsChild[]","description":"Content rendered inside the tabs component. Only `Tab` components or expressions resulting in a falsy value are allowed here.","required":true},{"name":"className","type":"string","description":"Additional classes added to the tabs"},{"name":"component","type":"'div' | 'nav'","description":"Determines what tag is used around the tabs. Use \"nav\" to define the tabs inside a navigation region","defaultValue":"TabsComponent.div"},{"name":"defaultActiveKey","type":"number | string","description":"The index of the default active tab. Set this for uncontrolled Tabs"},{"name":"defaultIsExpanded","type":"boolean","description":"Flag indicating the default expanded state for uncontrolled expand/collapse of"},{"name":"expandable","type":"{\n default?: 'expandable' | 'nonExpandable';\n sm?: 'expandable' | 'nonExpandable';\n md?: 'expandable' | 'nonExpandable';\n lg?: 'expandable' | 'nonExpandable';\n xl?: 'expandable' | 'nonExpandable';\n '2xl'?: 'expandable' | 'nonExpandable';\n}","description":"Enable expandable vertical tabs at various breakpoints. (isVertical should be set to true for this to work)"},{"name":"forwardScrollAriaLabel","type":"string","description":"Aria-label for the forward scroll button","defaultValue":"'Scroll forward'"},{"name":"hasNoBorderBottom","type":"boolean","description":"Disables border bottom tab styling on tabs. Defaults to false. To remove the bottom border, set this prop to true.","defaultValue":"false"},{"name":"id","type":"string","description":"Uniquely identifies the tabs"},{"name":"inset","type":"{\n default?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n sm?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n md?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n lg?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n xl?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n '2xl'?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n}","description":"Insets at various breakpoints."},{"name":"isBox","type":"boolean","description":"Enables box styling to the tab component","defaultValue":"false"},{"name":"isExpanded","type":"boolean","description":"Flag to indicate if the vertical tabs are expanded"},{"name":"isFilled","type":"boolean","description":"Enables the filled tab list layout","defaultValue":"false"},{"name":"isOverflowHorizontal","type":"boolean | HorizontalOverflowObject","description":"Flag which places overflowing tabs into a menu triggered by the last tab. Additionally an object can be passed with custom settings for the overflow tab."},{"name":"isSubtab","type":"boolean","description":"Enables subtab tab styling","defaultValue":"false"},{"name":"isVertical","type":"boolean","description":"Enables vertical tab styling","defaultValue":"false"},{"name":"leftScrollAriaLabel","type":"string","description":"Please use backScrollAriaLabel. Aria-label for the left scroll button","defaultValue":"'Scroll left'","deprecated":true},{"name":"mountOnEnter","type":"boolean","description":"Waits until the first \"enter\" transition to mount tab children (add them to the DOM)","defaultValue":"false"},{"name":"onAdd","type":"(event: React.MouseEvent<HTMLElement, MouseEvent>) => void","description":"Callback for the add button. Passing this property inserts the add button"},{"name":"onClose","type":"(event: React.MouseEvent<HTMLElement, MouseEvent>, eventKey: number | string) => void","description":"Callback to handle tab closing and adds a basic close button to all tabs. This is overridden by the tab actions property."},{"name":"onSelect","type":"(event: React.MouseEvent<HTMLElement, MouseEvent>, eventKey: number | string) => void","description":"Callback to handle tab selection","defaultValue":"() => undefined as any"},{"name":"onToggle","type":"(event: React.MouseEvent, isExpanded: boolean) => void","description":"Callback function to toggle the expandable tabs.","defaultValue":"(_event: React.MouseEvent, _isExpanded: boolean): void => undefined"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"},{"name":"rightScrollAriaLabel","type":"string","description":"Please use forwardScrollAriaLabel. Aria-label for the right scroll button","defaultValue":"'Scroll right'","deprecated":true},{"name":"toggleAriaLabel","type":"string","description":"Aria-label for the expandable toggle"},{"name":"toggleText","type":"string","description":"Text that appears in the expandable toggle"},{"name":"unmountOnExit","type":"boolean","description":"Unmounts tab children (removes them from the DOM) when they are no longer visible","defaultValue":"false"},{"name":"usePageInsets","type":"boolean","description":"Flag indicates that the tabs should use page insets."},{"name":"variant","type":"'default' | 'secondary'","description":"Tabs background color variant","defaultValue":"'default'"}]},"HorizontalOverflowObject":{"name":"HorizontalOverflowObject","description":"","props":[{"name":"defaultTitleText","type":"string","description":"The text which displays when an overflowing tab isn't selected"},{"name":"showTabCount","type":"boolean","description":"Flag which shows the count of overflowing tabs when enabled"},{"name":"toggleAriaLabel","type":"string","description":"The aria label applied to the button which toggles the tab overflow menu"}]},"TabsProps":{"name":"TabsProps","description":"","props":[{"name":"activeKey","type":"number | string","description":"The index of the active tab"},{"name":"addButtonAriaLabel","type":"string","description":"Aria-label for the add button"},{"name":"backScrollAriaLabel","type":"string","description":"Aria-label for the back scroll button"},{"name":"children","type":"TabsChild | TabsChild[]","description":"Content rendered inside the tabs component. Only `Tab` components or expressions resulting in a falsy value are allowed here.","required":true},{"name":"className","type":"string","description":"Additional classes added to the tabs"},{"name":"component","type":"'div' | 'nav'","description":"Determines what tag is used around the tabs. Use \"nav\" to define the tabs inside a navigation region"},{"name":"defaultActiveKey","type":"number | string","description":"The index of the default active tab. Set this for uncontrolled Tabs"},{"name":"defaultIsExpanded","type":"boolean","description":"Flag indicating the default expanded state for uncontrolled expand/collapse of"},{"name":"expandable","type":"{\n default?: 'expandable' | 'nonExpandable';\n sm?: 'expandable' | 'nonExpandable';\n md?: 'expandable' | 'nonExpandable';\n lg?: 'expandable' | 'nonExpandable';\n xl?: 'expandable' | 'nonExpandable';\n '2xl'?: 'expandable' | 'nonExpandable';\n }","description":"Enable expandable vertical tabs at various breakpoints. (isVertical should be set to true for this to work)"},{"name":"forwardScrollAriaLabel","type":"string","description":"Aria-label for the forward scroll button"},{"name":"hasNoBorderBottom","type":"boolean","description":"Disables border bottom tab styling on tabs. Defaults to false. To remove the bottom border, set this prop to true."},{"name":"id","type":"string","description":"Uniquely identifies the tabs"},{"name":"inset","type":"{\n default?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n sm?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n md?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n lg?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n xl?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n '2xl'?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n }","description":"Insets at various breakpoints."},{"name":"isBox","type":"boolean","description":"Enables box styling to the tab component"},{"name":"isExpanded","type":"boolean","description":"Flag to indicate if the vertical tabs are expanded"},{"name":"isFilled","type":"boolean","description":"Enables the filled tab list layout"},{"name":"isOverflowHorizontal","type":"boolean | HorizontalOverflowObject","description":"Flag which places overflowing tabs into a menu triggered by the last tab. Additionally an object can be passed with custom settings for the overflow tab."},{"name":"isSubtab","type":"boolean","description":"Enables subtab tab styling"},{"name":"isVertical","type":"boolean","description":"Enables vertical tab styling"},{"name":"leftScrollAriaLabel","type":"string","description":""},{"name":"mountOnEnter","type":"boolean","description":"Waits until the first \"enter\" transition to mount tab children (add them to the DOM)"},{"name":"onAdd","type":"(event: React.MouseEvent<HTMLElement, MouseEvent>) => void","description":"Callback for the add button. Passing this property inserts the add button"},{"name":"onClose","type":"(event: React.MouseEvent<HTMLElement, MouseEvent>, eventKey: number | string) => void","description":"Callback to handle tab closing and adds a basic close button to all tabs. This is overridden by the tab actions property."},{"name":"onSelect","type":"(event: React.MouseEvent<HTMLElement, MouseEvent>, eventKey: number | string) => void","description":"Callback to handle tab selection"},{"name":"onToggle","type":"(event: React.MouseEvent, isExpanded: boolean) => void","description":"Callback function to toggle the expandable tabs."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"rightScrollAriaLabel","type":"string","description":""},{"name":"toggleAriaLabel","type":"string","description":"Aria-label for the expandable toggle"},{"name":"toggleText","type":"string","description":"Text that appears in the expandable toggle"},{"name":"Unknown","type":"string","description":"Provides an accessible label for the tabs. Labels should be unique for each set of tabs that are present on a page. When component is set to nav, this prop should be defined to differentiate the tabs from other navigation regions on the page."},{"name":"unmountOnExit","type":"boolean","description":"Unmounts tab children (removes them from the DOM) when they are no longer visible"},{"name":"usePageInsets","type":"boolean","description":"Flag indicates that the tabs should use page insets."},{"name":"variant","type":"'default' | 'secondary'","description":"Tabs background color variant"}]},"TabsState":{"name":"TabsState","description":"","props":[{"name":"disableBackScrollButton","type":"boolean","description":null,"required":true},{"name":"disableForwardScrollButton","type":"boolean","description":null,"required":true},{"name":"enableScrollButtons","type":"boolean","description":"Used to signal if the scroll buttons should be used","required":true},{"name":"ouiaStateId","type":"string","description":null,"required":true},{"name":"overflowingTabCount","type":"number","description":null,"required":true},{"name":"renderScrollButtons","type":"boolean","description":"Used to control if the scroll buttons should be rendered. Rendering must occur before the scroll buttons are\nshown and rendering must be stopped after they stop being shown to preserve CSS transitions.","required":true},{"name":"shownKeys","type":"(string | number)[]","description":null,"required":true},{"name":"showScrollButtons","type":"boolean","description":"Used to control if the scroll buttons should be shown to the user via the pf-m-scrollable class","required":true},{"name":"uncontrolledActiveKey","type":"number | string","description":null,"required":true},{"name":"uncontrolledIsExpandedLocal","type":"boolean","description":null,"required":true}]},"TabElement":{"name":"TabElement","description":"","props":[]},"TabsChild":{"name":"TabsChild","description":"","props":[]},"TabTitleText":{"name":"TabTitleText","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Text to be rendered inside the tab button title.","required":true},{"name":"className","type":"string","description":"additional classes added to the tab title text","defaultValue":"''"}]},"TabTitleTextProps":{"name":"TabTitleTextProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Text to be rendered inside the tab button title.","required":true},{"name":"className","type":"string","description":"additional classes added to the tab title text"}]},"TabTitleIcon":{"name":"TabTitleIcon","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Icon to be rendered inside the tab button title.","required":true},{"name":"className","type":"string","description":"additional classes added to the tab title icon","defaultValue":"''"}]},"TabTitleIconProps":{"name":"TabTitleIconProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Icon to be rendered inside the tab button title.","required":true},{"name":"className","type":"string","description":"additional classes added to the tab title icon"}]},"TabContentBody":{"name":"TabContentBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the tab content body.","required":true},{"name":"className","type":"string","description":"Additional classes added to the tab content body."},{"name":"hasPadding","type":"boolean","description":"Indicates if there should be padding around the tab content body"}]},"TabContentBodyProps":{"name":"TabContentBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the tab content body.","required":true},{"name":"className","type":"string","description":"Additional classes added to the tab content body."},{"name":"hasPadding","type":"boolean","description":"Indicates if there should be padding around the tab content body"}]},"TabContent":{"name":"TabContent","description":"","props":[{"name":"activeKey","type":"number | string","description":"Identifies the active Tab"},{"name":"aria-label","type":"string","description":"title of controlling Tab if used outside Tabs component"},{"name":"child","type":"React.ReactElement<any>","description":"Child to show in the content area"},{"name":"children","type":"any","description":"content rendered inside the tab content area if used outside Tabs component"},{"name":"className","type":"string","description":"class of tab content area if used outside Tabs component"},{"name":"eventKey","type":"number | string","description":"uniquely identifies the controlling Tab if used outside Tabs component"},{"name":"id","type":"string","description":"id passed from parent to identify the content section","required":true},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."}]},"TabContentProps":{"name":"TabContentProps","description":"","props":[{"name":"activeKey","type":"number | string","description":"Identifies the active Tab"},{"name":"child","type":"React.ReactElement<any>","description":"Child to show in the content area"},{"name":"children","type":"any","description":"content rendered inside the tab content area if used outside Tabs component"},{"name":"className","type":"string","description":"class of tab content area if used outside Tabs component"},{"name":"eventKey","type":"number | string","description":"uniquely identifies the controlling Tab if used outside Tabs component"},{"name":"id","type":"string","description":"id passed from parent to identify the content section","required":true},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"Unknown","type":"string","description":"title of controlling Tab if used outside Tabs component"}]},"TabButton":{"name":"TabButton","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Tab content area."},{"name":"className","type":"string","description":"additional classes added to the Tab"},{"name":"href","type":"string","description":"URL associated with the Tab. A Tab with an href will render as an <a> instead of a <button>. A Tab inside a <Tabs component=\"nav\"> should have an href."},{"name":"ouiaId","type":"number | string","description":""},{"name":"ouiaSafe","type":"boolean","description":""},{"name":"parentInnerRef","type":"React.Ref<any>","description":"Parents' innerRef passed down for properly displaying Tooltips"},{"name":"tabContentRef","type":"React.Ref<any>","description":"child reference for case in which a TabContent section is defined outside of a Tabs component"}]},"TabButtonProps":{"name":"TabButtonProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Tab content area."},{"name":"className","type":"string","description":"additional classes added to the Tab"},{"name":"href","type":"string","description":"URL associated with the Tab. A Tab with an href will render as an <a> instead of a <button>. A Tab inside a <Tabs component=\"nav\"> should have an href."},{"name":"parentInnerRef","type":"React.Ref<any>","description":"Parents' innerRef passed down for properly displaying Tooltips"},{"name":"tabContentRef","type":"React.Ref<any>","description":"child reference for case in which a TabContent section is defined outside of a Tabs component"}]},"TabAction":{"name":"TabAction","description":"","props":[{"name":"aria-label","type":"string","description":"Accessible label for the tab action"},{"name":"children","type":"React.ReactNode","description":"Content rendered in the tab action"},{"name":"className","type":"string","description":"Additional classes added to the tab action span"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the tab action is disabled"},{"name":"onClick","type":"(event: React.MouseEvent<HTMLElement, MouseEvent>) => void","description":"Click callback for tab action button"},{"name":"ouiaId","type":"number | string","description":""},{"name":"ouiaSafe","type":"boolean","description":""}]},"TabActionProps":{"name":"TabActionProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered in the tab action"},{"name":"className","type":"string","description":"Additional classes added to the tab action span"},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the tab action is disabled"},{"name":"onClick","type":"(event: React.MouseEvent<HTMLElement, MouseEvent>) => void","description":"Click callback for tab action button"},{"name":"Unknown","type":"string","description":"Accessible label for the tab action"}]},"Tab":{"name":"Tab","description":"","props":[{"name":"actions","type":"React.ReactNode","description":"Actions rendered beside the tab content"},{"name":"children","type":"React.ReactNode","description":"content rendered inside the Tab content area."},{"name":"className","type":"string","description":"additional classes added to the Tab"},{"name":"closeButtonAriaLabel","type":"string","description":"Aria-label for the close button added by passing the onClose property to Tabs."},{"name":"eventKey","type":"number | string","description":"uniquely identifies the tab","required":true},{"name":"href","type":"string","description":"URL associated with the Tab. A Tab with an href will render as an <a> instead of a <button>. A Tab inside a <Tabs component=\"nav\"> should have an href."},{"name":"inoperableEvents","type":"string[]","description":"Events to prevent when the button is in an aria-disabled state"},{"name":"isAriaDisabled","type":"boolean","description":"Adds disabled styling and communicates that the button is disabled using the aria-disabled html attribute"},{"name":"isCloseDisabled","type":"boolean","description":"Flag indicating the close button should be disabled"},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling and disables the button using the disabled html attribute"},{"name":"isHidden","type":"boolean","description":"whether to render the tab or not"},{"name":"ouiaId","type":"number | string","description":"Value to set the data-ouia-component-id for the tab button."},{"name":"ouiaSafe","type":"boolean","description":""},{"name":"tabContentId","type":"string | number","description":"child id for case in which a TabContent section is defined outside of a Tabs component"},{"name":"tabContentRef","type":"React.RefObject<any>","description":"child reference for case in which a TabContent section is defined outside of a Tabs component"},{"name":"title","type":"React.ReactNode","description":"Content rendered in the tab title. Should be <TabTitleText> and/or <TabTitleIcon> for proper styling.","required":true},{"name":"tooltip","type":"React.ReactElement<any>","description":"Optional Tooltip rendered to a Tab. Should be <Tooltip> with appropriate props for proper rendering."}]},"TabProps":{"name":"TabProps","description":"","props":[{"name":"actions","type":"React.ReactNode","description":"Actions rendered beside the tab content"},{"name":"children","type":"React.ReactNode","description":"content rendered inside the Tab content area."},{"name":"className","type":"string","description":"additional classes added to the Tab"},{"name":"closeButtonAriaLabel","type":"string","description":"Aria-label for the close button added by passing the onClose property to Tabs."},{"name":"eventKey","type":"number | string","description":"uniquely identifies the tab","required":true},{"name":"href","type":"string","description":"URL associated with the Tab. A Tab with an href will render as an <a> instead of a <button>. A Tab inside a <Tabs component=\"nav\"> should have an href."},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"inoperableEvents","type":"string[]","description":"Events to prevent when the button is in an aria-disabled state"},{"name":"isAriaDisabled","type":"boolean","description":"Adds disabled styling and communicates that the button is disabled using the aria-disabled html attribute"},{"name":"isCloseDisabled","type":"boolean","description":"Flag indicating the close button should be disabled"},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling and disables the button using the disabled html attribute"},{"name":"isHidden","type":"boolean","description":"whether to render the tab or not"},{"name":"ouiaId","type":"number | string","description":"Value to set the data-ouia-component-id for the tab button."},{"name":"tabContentId","type":"string | number","description":"child id for case in which a TabContent section is defined outside of a Tabs component"},{"name":"tabContentRef","type":"React.RefObject<any>","description":"child reference for case in which a TabContent section is defined outside of a Tabs component"},{"name":"title","type":"React.ReactNode","description":"Content rendered in the tab title. Should be <TabTitleText> and/or <TabTitleIcon> for proper styling.","required":true},{"name":"tooltip","type":"React.ReactElement<any>","description":"Optional Tooltip rendered to a Tab. Should be <Tooltip> with appropriate props for proper rendering."}]},"OverflowTab":{"name":"OverflowTab","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the overflow tab"},{"name":"defaultTitleText","type":"string","description":"The text which displays when an overflowing tab isn't selected","defaultValue":"'More'"},{"name":"focusTimeoutDelay","type":"number","description":"Time in ms to wait before firing the toggles' focus event. Defaults to 0","defaultValue":"0"},{"name":"overflowingTabs","type":"TabProps[]","description":"The tabs that should be displayed in the menu","defaultValue":"[]"},{"name":"shouldPreventScrollOnItemFocus","type":"boolean","description":"Flag indicating if scroll on focus of the first menu item should occur.","defaultValue":"true"},{"name":"showTabCount","type":"boolean","description":"Flag which shows the count of overflowing tabs when enabled"},{"name":"toggleAriaLabel","type":"string","description":"The aria label applied to the button which toggles the tab overflow menu"},{"name":"zIndex","type":"number","description":"z-index of the overflow tab","defaultValue":"9999"}]},"OverflowTabProps":{"name":"OverflowTabProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the overflow tab"},{"name":"defaultTitleText","type":"string","description":"The text which displays when an overflowing tab isn't selected"},{"name":"focusTimeoutDelay","type":"number","description":"Time in ms to wait before firing the toggles' focus event. Defaults to 0"},{"name":"overflowingTabs","type":"TabProps[]","description":"The tabs that should be displayed in the menu"},{"name":"shouldPreventScrollOnItemFocus","type":"boolean","description":"Flag indicating if scroll on focus of the first menu item should occur."},{"name":"showTabCount","type":"boolean","description":"Flag which shows the count of overflowing tabs when enabled"},{"name":"toggleAriaLabel","type":"string","description":"The aria label applied to the button which toggles the tab overflow menu"},{"name":"zIndex","type":"number","description":"z-index of the overflow tab"}]},"Switch":{"name":"Switch","description":"","props":[{"name":"aria-label","type":"string","description":"Adds an accessible name to the switch when the label prop is not passed, and must describe the isChecked=\"true\" state.","defaultValue":"undefined"},{"name":"aria-labelledby","type":"string","description":"Adds an accessible name to the switch via one or more referenced id(s). The computed accessible name must describe the isChecked=\"true\" state.","defaultValue":"undefined"},{"name":"className","type":"string","description":"Additional classes added to the switch"},{"name":"defaultChecked","type":"boolean","description":"Flag to set the default checked value of the switch when it is uncontrolled by React state.\nTo make the switch controlled instead use the isChecked prop, but do not use both."},{"name":"hasCheckIcon","type":"boolean","description":"Flag to show if the switch has a check icon."},{"name":"id","type":"string","description":"id for the label."},{"name":"isChecked","type":"boolean","description":"Flag to show if the switch is checked when it is controlled by React state.\nTo make the switch uncontrolled instead use the defaultChecked prop, but do not use both.","defaultValue":"true"},{"name":"isDisabled","type":"boolean","description":"Flag to show if the switch is disabled.","defaultValue":"false"},{"name":"isReversed","type":"boolean","description":"Flag to reverse the layout of toggle and label (label at start, toggle at end).","defaultValue":"false"},{"name":"label","type":"React.ReactNode","description":"Text value for the visible label"},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, checked: boolean) => void","description":"A callback for when the switch selection changes. (event, isChecked) => {}","defaultValue":"() => undefined as any"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."}]},"SwitchProps":{"name":"SwitchProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the switch"},{"name":"defaultChecked","type":"boolean","description":"Flag to set the default checked value of the switch when it is uncontrolled by React state.\nTo make the switch controlled instead use the isChecked prop, but do not use both."},{"name":"hasCheckIcon","type":"boolean","description":"Flag to show if the switch has a check icon."},{"name":"id","type":"string","description":"id for the label."},{"name":"isChecked","type":"boolean","description":"Flag to show if the switch is checked when it is controlled by React state.\nTo make the switch uncontrolled instead use the defaultChecked prop, but do not use both."},{"name":"isDisabled","type":"boolean","description":"Flag to show if the switch is disabled."},{"name":"isReversed","type":"boolean","description":"Flag to reverse the layout of toggle and label (label at start, toggle at end)."},{"name":"label","type":"React.ReactNode","description":"Text value for the visible label"},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, checked: boolean) => void","description":"A callback for when the switch selection changes. (event, isChecked) => {}"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"Unknown","type":"string","description":"Adds an accessible name to the switch via one or more referenced id(s). The computed accessible name must describe the isChecked=\"true\" state."}]},"Spinner":{"name":"Spinner","description":"","props":[{"name":"aria-label","type":"string","description":"Accessible label to describe what is loading"},{"name":"aria-labelledBy","type":"string","description":"Id of element which describes what is being loaded"},{"name":"aria-valuetext","type":"string","description":"Text describing that current loading status or progress","defaultValue":"'Loading...'"},{"name":"className","type":"string","description":"Additional classes added to the Spinner.","defaultValue":"''"},{"name":"diameter","type":"string","description":"Diameter of spinner set as CSS variable"},{"name":"isInline","type":"boolean","description":"Indicates the spinner is inline and the size should inherit the text font size. This will override the size prop.","defaultValue":"false"},{"name":"size","type":"'sm' | 'md' | 'lg' | 'xl'","description":"Size variant of progress.","defaultValue":"'xl'"}]},"SpinnerProps":{"name":"SpinnerProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the Spinner."},{"name":"diameter","type":"string","description":"Diameter of spinner set as CSS variable"},{"name":"isInline","type":"boolean","description":"Indicates the spinner is inline and the size should inherit the text font size. This will override the size prop."},{"name":"size","type":"'sm' | 'md' | 'lg' | 'xl'","description":"Size variant of progress."},{"name":"Unknown","type":"string","description":"Id of element which describes what is being loaded"}]},"SliderStep":{"name":"SliderStep","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the slider step."},{"name":"isActive","type":"boolean","description":"Flag indicating the step is active.","defaultValue":"false"},{"name":"isLabelHidden","type":"boolean","description":"Flag indicating that the label should be hidden.","defaultValue":"false"},{"name":"isTickHidden","type":"boolean","description":"Flag indicating that the tick should be hidden.","defaultValue":"false"},{"name":"label","type":"string","description":"Step label. *"},{"name":"value","type":"number","description":"Step value. *"}]},"SliderStepProps":{"name":"SliderStepProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the slider step."},{"name":"isActive","type":"boolean","description":"Flag indicating the step is active."},{"name":"isLabelHidden","type":"boolean","description":"Flag indicating that the label should be hidden."},{"name":"isTickHidden","type":"boolean","description":"Flag indicating that the tick should be hidden."},{"name":"label","type":"string","description":"Step label. *"},{"name":"value","type":"number","description":"Step value. *"}]},"Slider":{"name":"Slider","description":"The main slider component.","props":[{"name":"areCustomStepsContinuous","type":"boolean","description":"Flag indicating if the slider is discrete for custom steps. This will cause the slider\nto snap to the closest value.","defaultValue":"false"},{"name":"aria-describedby","type":"string","description":"One or more id's to use for the slider thumb's accessible description."},{"name":"aria-labelledby","type":"string","description":"One or more id's to use for the slider thumb's accessible label."},{"name":"className","type":"string","description":"Additional classes added to the slider."},{"name":"customSteps","type":"SliderStepObject[]","description":"Array of custom slider step objects (value and label of each step) for the slider."},{"name":"endActions","type":"React.ReactNode","description":"Actions placed at the end of the slider."},{"name":"hasTooltipOverThumb","type":"boolean","description":"","defaultValue":"false"},{"name":"inputAriaLabel","type":"string","description":"Accessible label for the input field.","defaultValue":"'Slider value input'"},{"name":"inputLabel","type":"string | number","description":"Text label that is place after the input field."},{"name":"inputPosition","type":"'aboveThumb' | 'right' | 'end'","description":"Position of the input. Note \"right\" is deprecated. Use \"end\" instead","defaultValue":"'end'"},{"name":"inputValue","type":"number","description":"Value displayed in the input field.","defaultValue":"0"},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling, and disables the slider and the input component if present.","defaultValue":"false"},{"name":"isInputVisible","type":"boolean","description":"Flag to show value input field.","defaultValue":"false"},{"name":"leftActions","type":"React.ReactNode","description":"Use startActions instead. Actions placed at the start of the slider.","deprecated":true},{"name":"max","type":"number","description":"The maximum permitted value.","defaultValue":"100"},{"name":"min","type":"number","description":"The minimum permitted value.","defaultValue":"0"},{"name":"onChange","type":"(\n event: SliderOnChangeEvent,\n value: number,\n inputValue?: number,\n setLocalInputValue?: React.Dispatch<React.SetStateAction<number>>\n) => void","description":"Value change callback. This is called when the slider value changes."},{"name":"rightActions","type":"React.ReactNode","description":"Use endActions instead. Actions placed to the right of the slider.","deprecated":true},{"name":"showBoundaries","type":"boolean","description":"Flag to indicate if boundaries should be shown for slider that does not have custom steps.","defaultValue":"true"},{"name":"showTicks","type":"boolean","description":"Flag to indicate if ticks should be shown for slider that does not have custom steps.","defaultValue":"false"},{"name":"startActions","type":"React.ReactNode","description":"Actions placed at the start of the slider."},{"name":"step","type":"number","description":"The step interval.","defaultValue":"1"},{"name":"thumbAriaLabel","type":"string","description":"","defaultValue":"'Value'"},{"name":"value","type":"number","description":"Current value of the slider.","defaultValue":"0"}]},"SliderStepObject":{"name":"SliderStepObject","description":"Properties for creating custom steps in a slider. These properties should be passed in as\nan object within an array to the slider component's customSteps property.","props":[{"name":"isLabelHidden","type":"boolean","description":"Flag to hide the label."},{"name":"label","type":"string","description":"The display label for the step value. This is also used for the aria-valuetext attribute.","required":true},{"name":"value","type":"number","description":"Value of the step. This value is a percentage of the slider where the tick is drawn.","required":true}]},"SliderProps":{"name":"SliderProps","description":"The main slider component.","props":[{"name":"areCustomStepsContinuous","type":"boolean","description":"Flag indicating if the slider is discrete for custom steps. This will cause the slider\nto snap to the closest value."},{"name":"className","type":"string","description":"Additional classes added to the slider."},{"name":"customSteps","type":"SliderStepObject[]","description":"Array of custom slider step objects (value and label of each step) for the slider."},{"name":"endActions","type":"React.ReactNode","description":"Actions placed at the end of the slider."},{"name":"hasTooltipOverThumb","type":"boolean","description":null},{"name":"inputAriaLabel","type":"string","description":"Accessible label for the input field."},{"name":"inputLabel","type":"string | number","description":"Text label that is place after the input field."},{"name":"inputPosition","type":"'aboveThumb' | 'right' | 'end'","description":"Position of the input. Note \"right\" is deprecated. Use \"end\" instead"},{"name":"inputValue","type":"number","description":"Value displayed in the input field."},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling, and disables the slider and the input component if present."},{"name":"isInputVisible","type":"boolean","description":"Flag to show value input field."},{"name":"leftActions","type":"React.ReactNode","description":""},{"name":"max","type":"number","description":"The maximum permitted value."},{"name":"min","type":"number","description":"The minimum permitted value."},{"name":"onChange","type":"(\n event: SliderOnChangeEvent,\n value: number,\n inputValue?: number,\n setLocalInputValue?: React.Dispatch<React.SetStateAction<number>>\n ) => void","description":"Value change callback. This is called when the slider value changes."},{"name":"rightActions","type":"React.ReactNode","description":""},{"name":"showBoundaries","type":"boolean","description":"Flag to indicate if boundaries should be shown for slider that does not have custom steps."},{"name":"showTicks","type":"boolean","description":"Flag to indicate if ticks should be shown for slider that does not have custom steps."},{"name":"startActions","type":"React.ReactNode","description":"Actions placed at the start of the slider."},{"name":"step","type":"number","description":"The step interval."},{"name":"thumbAriaLabel","type":"string","description":null},{"name":"Unknown","type":"string","description":"One or more id's to use for the slider thumb's accessible label."},{"name":"value","type":"number","description":"Current value of the slider."}]},"SliderOnChangeEvent":{"name":"SliderOnChangeEvent","description":"","props":[]},"SkipToContent":{"name":"SkipToContent","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to display within the skip to content component, typically a string.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional styles to apply to the skip to content component.","defaultValue":"''"},{"name":"href","type":"string","description":"The skip to content link.","required":true}]},"SkipToContentProps":{"name":"SkipToContentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to display within the skip to content component, typically a string."},{"name":"className","type":"string","description":"Additional styles to apply to the skip to content component."},{"name":"href","type":"string","description":"The skip to content link.","required":true}]},"Skeleton":{"name":"Skeleton","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the Skeleton"},{"name":"fontSize","type":"'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl'","description":"The font size height of the Skeleton"},{"name":"height","type":"string","description":"The height of the Skeleton. Must specify pixels or percentage."},{"name":"screenreaderText","type":"string","description":"Text read just to screen reader users"},{"name":"shape","type":"'circle' | 'square'","description":"The shape of the Skeleton"},{"name":"width","type":"string","description":"The width of the Skeleton. Must specify pixels or percentage."}]},"SkeletonProps":{"name":"SkeletonProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the Skeleton"},{"name":"fontSize","type":"'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl'","description":"The font size height of the Skeleton"},{"name":"height","type":"string","description":"The height of the Skeleton. Must specify pixels or percentage."},{"name":"screenreaderText","type":"string","description":"Text read just to screen reader users"},{"name":"shape","type":"'circle' | 'square'","description":"The shape of the Skeleton"},{"name":"width","type":"string","description":"The width of the Skeleton. Must specify pixels or percentage."}]},"SimpleListItem":{"name":"SimpleListItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the SimpleList item","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the SimpleList <li>","defaultValue":"''"},{"name":"component","type":"'button' | 'a'","description":"Component type of the SimpleList item","defaultValue":"'button'"},{"name":"componentClassName","type":"string","description":"Additional classes added to the SimpleList <a> or <button>","defaultValue":"''"},{"name":"componentProps","type":"any","description":"Additional props added to the SimpleList <a> or <button>"},{"name":"href","type":"string","description":"Default hyperlink location","defaultValue":"''"},{"name":"isActive","type":"boolean","description":"Indicates if the link is current/highlighted","defaultValue":"false"},{"name":"itemId","type":"number | string","description":"id for the item."},{"name":"onClick","type":"(event: React.MouseEvent | React.ChangeEvent) => void","description":"OnClick callback for the SimpleList item","defaultValue":"() => {}"},{"name":"type","type":"'button' | 'submit' | 'reset'","description":"Type of button SimpleList item","defaultValue":"'button'"}]},"SimpleListItemProps":{"name":"SimpleListItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the SimpleList item"},{"name":"className","type":"string","description":"Additional classes added to the SimpleList <li>"},{"name":"component","type":"'button' | 'a'","description":"Component type of the SimpleList item"},{"name":"componentClassName","type":"string","description":"Additional classes added to the SimpleList <a> or <button>"},{"name":"componentProps","type":"any","description":"Additional props added to the SimpleList <a> or <button>"},{"name":"href","type":"string","description":"Default hyperlink location"},{"name":"isActive","type":"boolean","description":"Indicates if the link is current/highlighted"},{"name":"itemId","type":"number | string","description":"id for the item."},{"name":"onClick","type":"(event: React.MouseEvent | React.ChangeEvent) => void","description":"OnClick callback for the SimpleList item"},{"name":"type","type":"'button' | 'submit' | 'reset'","description":"Type of button SimpleList item"}]},"SimpleListGroup":{"name":"SimpleListGroup","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the SimpleList group","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the SimpleList <ul>","defaultValue":"''"},{"name":"id","type":"string","description":"ID of SimpleList group","defaultValue":"''"},{"name":"title","type":"React.ReactNode","description":"Title of the SimpleList group","defaultValue":"''"},{"name":"titleClassName","type":"string","description":"Additional classes added to the SimpleList group title","defaultValue":"''"}]},"SimpleListGroupProps":{"name":"SimpleListGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the SimpleList group"},{"name":"className","type":"string","description":"Additional classes added to the SimpleList <ul>"},{"name":"id","type":"string","description":"ID of SimpleList group"},{"name":"title","type":"React.ReactNode","description":"Title of the SimpleList group"},{"name":"titleClassName","type":"string","description":"Additional classes added to the SimpleList group title"}]},"SimpleList":{"name":"SimpleList","description":"","props":[{"name":"aria-label","type":"string","description":"aria-label for the <ul> element that wraps the SimpleList items."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the SimpleList","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the SimpleList container","defaultValue":"''"},{"name":"isControlled","type":"boolean","description":"Indicates whether component is controlled by its internal state","defaultValue":"true"},{"name":"onSelect","type":"(\n ref: React.RefObject<HTMLButtonElement | null> | React.RefObject<HTMLAnchorElement | null>,\n props: SimpleListItemProps\n) => void","description":"Callback when an item is selected"}]},"SimpleListProps":{"name":"SimpleListProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the SimpleList"},{"name":"className","type":"string","description":"Additional classes added to the SimpleList container"},{"name":"isControlled","type":"boolean","description":"Indicates whether component is controlled by its internal state"},{"name":"onSelect","type":"(\n ref: React.RefObject<HTMLButtonElement | null> | React.RefObject<HTMLAnchorElement | null>,\n props: SimpleListItemProps\n ) => void","description":"Callback when an item is selected"},{"name":"Unknown","type":"string","description":"aria-label for the <ul> element that wraps the SimpleList items."}]},"SimpleListState":{"name":"SimpleListState","description":"","props":[{"name":"currentRef","type":"React.RefObject<HTMLButtonElement | null> | React.RefObject<HTMLAnchorElement | null>","description":"Ref of the current SimpleListItem","required":true}]},"SimpleListContextProps":{"name":"SimpleListContextProps","description":"","props":[{"name":"currentRef","type":"React.RefObject<HTMLButtonElement | null> | React.RefObject<HTMLAnchorElement | null>","description":null,"required":true},{"name":"isControlled","type":"boolean","description":null,"required":true},{"name":"updateCurrentRef","type":"(\n id: React.RefObject<HTMLButtonElement | null> | React.RefObject<HTMLAnchorElement | null>,\n props: SimpleListItemProps\n ) => void","description":null,"required":true}]},"SidebarPanel":{"name":"SidebarPanel","description":"","props":[{"name":"backgroundVariant","type":"'default' | 'secondary'","description":"Variant of the sidebar panel background.","defaultValue":"'default'"},{"name":"children","type":"React.ReactNode","description":"","required":true},{"name":"hasNoBackground","type":"boolean","description":"Removes the background color."},{"name":"hasPadding","type":"boolean","description":"Adds padding to the panel."},{"name":"variant","type":"'default' | 'sticky' | 'static'","description":"Indicates whether the panel is positioned statically or sticky to the top. Default is sticky on small screens when the orientation is stack, and static on medium and above screens when the orientation is split.","defaultValue":"'default'"},{"name":"width","type":"{\n default?: 'default' | 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n sm?: 'default' | 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n md?: 'default' | 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n lg?: 'default' | 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n xl?: 'default' | 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n '2xl'?: 'default' | 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n}","description":"Sets the panel width at various breakpoints. Default is 250px when the orientation is split."}]},"SidebarPanelProps":{"name":"SidebarPanelProps","description":"","props":[{"name":"backgroundVariant","type":"'default' | 'secondary'","description":"Variant of the sidebar panel background."},{"name":"children","type":"React.ReactNode","description":null,"required":true},{"name":"hasNoBackground","type":"boolean","description":"Removes the background color."},{"name":"hasPadding","type":"boolean","description":"Adds padding to the panel."},{"name":"variant","type":"'default' | 'sticky' | 'static'","description":"Indicates whether the panel is positioned statically or sticky to the top. Default is sticky on small screens when the orientation is stack, and static on medium and above screens when the orientation is split."},{"name":"width","type":"{\n default?: 'default' | 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n sm?: 'default' | 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n md?: 'default' | 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n lg?: 'default' | 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n xl?: 'default' | 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n '2xl'?: 'default' | 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n }","description":"Sets the panel width at various breakpoints. Default is 250px when the orientation is split."}]},"SidebarContent":{"name":"SidebarContent","description":"","props":[{"name":"backgroundVariant","type":"'default' | 'secondary'","description":"Variant of the sidebar content background.","defaultValue":"'default'"},{"name":"children","type":"React.ReactNode","description":"","required":true},{"name":"hasNoBackground","type":"boolean","description":"Removes the background color."},{"name":"hasPadding","type":"boolean","description":"Adds padding to the content."}]},"SidebarContentProps":{"name":"SidebarContentProps","description":"","props":[{"name":"backgroundVariant","type":"'default' | 'secondary'","description":"Variant of the sidebar content background."},{"name":"children","type":"React.ReactNode","description":null,"required":true},{"name":"hasNoBackground","type":"boolean","description":"Removes the background color."},{"name":"hasPadding","type":"boolean","description":"Adds padding to the content."}]},"Sidebar":{"name":"Sidebar","description":"","props":[{"name":"children","type":"React.ReactNode","description":""},{"name":"hasBorder","type":"boolean","description":"Adds a border between the panel and content."},{"name":"hasGutter","type":"boolean","description":"Adds space between the panel and content."},{"name":"hasNoBackground","type":"boolean","description":"Removes the background color."},{"name":"isPanelRight","type":"boolean","description":"Indicates that the panel is displayed to the right of the content when the oritentation is split.","defaultValue":"false"},{"name":"orientation","type":"'stack' | 'split'","description":"Indicates the direction of the layout. Default orientation is stack on small screens, and split on medium screens and above."}]},"SidebarProps":{"name":"SidebarProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":null},{"name":"hasBorder","type":"boolean","description":"Adds a border between the panel and content."},{"name":"hasGutter","type":"boolean","description":"Adds space between the panel and content."},{"name":"hasNoBackground","type":"boolean","description":"Removes the background color."},{"name":"isPanelRight","type":"boolean","description":"Indicates that the panel is displayed to the right of the content when the oritentation is split."},{"name":"orientation","type":"'stack' | 'split'","description":"Indicates the direction of the layout. Default orientation is stack on small screens, and split on medium screens and above."}]},"SelectOption":{"name":"SelectOption","description":"See the MenuItem section of the Menu documentation for additional props that may be passed.","props":[{"name":"children","type":"React.ReactNode","description":"Anything which can be rendered in a select option"},{"name":"className","type":"string","description":"Classes applied to root element of select option"},{"name":"description","type":"React.ReactNode","description":"Description of the option"},{"name":"hasCheckbox","type":"boolean","description":"Indicates the option has a checkbox"},{"name":"icon","type":"React.ReactNode","description":"Render option with icon"},{"name":"isDisabled","type":"boolean","description":"Indicates the option is disabled"},{"name":"isExternalLink","type":"boolean","description":"Render an external link icon on focus or hover, and set the link's\n\"target\" attribute to a value of \"_blank\"."},{"name":"isFocused","type":"boolean","description":"Indicates the option is focused"},{"name":"isSelected","type":"boolean","description":"Indicates the option is selected"},{"name":"value","type":"any","description":"Identifies the component in the Select onSelect callback"}]},"SelectOptionProps":{"name":"SelectOptionProps","description":"See the MenuItem section of the Menu documentation for additional props that may be passed.","props":[{"name":"children","type":"React.ReactNode","description":"Anything which can be rendered in a select option"},{"name":"className","type":"string","description":"Classes applied to root element of select option"},{"name":"description","type":"React.ReactNode","description":"Description of the option"},{"name":"hasCheckbox","type":"boolean","description":"Indicates the option has a checkbox"},{"name":"icon","type":"React.ReactNode","description":"Render option with icon"},{"name":"innerRef","type":"React.Ref<HTMLAnchorElement | HTMLButtonElement>","description":""},{"name":"isDisabled","type":"boolean","description":"Indicates the option is disabled"},{"name":"isExternalLink","type":"boolean","description":"Render an external link icon on focus or hover, and set the link's\n\"target\" attribute to a value of \"_blank\"."},{"name":"isFocused","type":"boolean","description":"Indicates the option is focused"},{"name":"isSelected","type":"boolean","description":"Indicates the option is selected"},{"name":"value","type":"any","description":"Identifies the component in the Select onSelect callback"}]},"SelectList":{"name":"SelectList","description":"","props":[{"name":"aria-label","type":"string","description":"Adds an accessible name to the menu."},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of menu list","required":true},{"name":"className","type":"string","description":"Additional classes added to the menu list"},{"name":"isAriaMultiselectable","type":"boolean","description":"Indicates to assistive technologies whether more than one item can be selected\nfor a non-checkbox menu. Only applies when the menu's role is \"listbox\".","defaultValue":"false"}]},"SelectListProps":{"name":"SelectListProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything which can be rendered in a select list","required":true},{"name":"className","type":"string","description":"Classes applied to root element of select list"},{"name":"isAriaMultiselectable","type":"boolean","description":"Indicates to assistive technologies whether more than one item can be selected for a non-checkbox select"}]},"SelectGroup":{"name":"SelectGroup","description":"See the MenuGroup section of the Menu documentation for additional props that may be passed.","props":[{"name":"children","type":"React.ReactNode","description":"Anything which can be rendered in a select group","required":true},{"name":"className","type":"string","description":"Classes applied to root element of select group"},{"name":"label","type":"React.ReactNode","description":"Label of the select group"}]},"SelectGroupProps":{"name":"SelectGroupProps","description":"See the MenuGroup section of the Menu documentation for additional props that may be passed.","props":[{"name":"children","type":"React.ReactNode","description":"Anything which can be rendered in a select group","required":true},{"name":"className","type":"string","description":"Classes applied to root element of select group"},{"name":"label","type":"React.ReactNode","description":"Label of the select group"}]},"Select":{"name":"Select","description":"See the Menu documentation for additional props that may be passed.","props":[{"name":"activeItemId","type":"string | number","description":"itemId of the currently active item. You can also specify isActive on the MenuItem."},{"name":"activeMenu","type":"string","description":"ID of the currently active menu for the drilldown variant"},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the Menu"},{"name":"className","type":"string","description":"Additional classes added to the Menu"},{"name":"containsDrilldown","type":"boolean","description":"Indicates if menu contains a drilldown menu"},{"name":"containsFlyout","type":"boolean","description":"Indicates if menu contains a flyout menu"},{"name":"drilldownItemPath","type":"string[]","description":"Indicates the path of drilled in menu itemIds"},{"name":"drilledInMenus","type":"string[]","description":"Array of menus that are drilled in"},{"name":"focusTimeoutDelay","type":"number","description":"Time in ms to wait before firing the toggles' focus event. Defaults to 0"},{"name":"id","type":"string","description":"ID of the menu"},{"name":"isMenuDrilledIn","type":"boolean","description":"Indicates if a menu is drilled into"},{"name":"isNavFlyout","type":"boolean","description":"Indicating that the menu should have nav flyout styling"},{"name":"isOpen","type":"boolean","description":"Flag to indicate if select is open"},{"name":"isPlain","type":"boolean","description":"Indicates if the menu should be without the outer box-shadow"},{"name":"isRootMenu","type":"boolean","description":"Internal flag indicating if the Menu is the root of a menu tree"},{"name":"isScrollable","type":"boolean","description":"Indicates if the menu should be srollable"},{"name":"maxMenuHeight","type":"string","description":"Maximum height of select menu"},{"name":"menuHeight","type":"string","description":"Height of the select menu"},{"name":"onActionClick","type":"(event?: any, itemId?: any, actionId?: any) => void","description":"Callback called when an MenuItems's action button is clicked. You can also specify it within a MenuItemAction."},{"name":"onDrillIn","type":"(\n event: React.KeyboardEvent | React.MouseEvent,\n fromItemId: string,\n toItemId: string,\n itemId: string\n) => void","description":"Callback for drilling into a submenu"},{"name":"onDrillOut","type":"(event: React.KeyboardEvent | React.MouseEvent, toItemId: string, itemId: string) => void","description":"Callback for drilling out of a submenu"},{"name":"onGetMenuHeight","type":"(menuId: string, height: number) => void","description":"Callback for collecting menu heights"},{"name":"onOpenChange","type":"(isOpen: boolean) => void","description":"Callback to allow the select component to change the open state of the menu.\nTriggered by clicking outside of the menu, or by pressing any keys specified in onOpenChangeKeys."},{"name":"onOpenChangeKeys","type":"string[]","description":"Keys that trigger onOpenChange, defaults to tab and escape. It is highly recommended to include Escape in the array, while Tab may be omitted if the menu contains non-menu items that are focusable."},{"name":"onSelect","type":"(event?: React.MouseEvent<Element, MouseEvent>, value?: string | number) => void","description":"Callback for updating when item selection changes. You can also specify onClick on the MenuItem."},{"name":"onToggleKeydown","type":"(event: KeyboardEvent) => void","description":"Callback to override the toggle keydown behavior. By default, when the toggle has focus and the menu is open, pressing the up/down arrow keys will focus a valid non-disabled menu item - the first item for the down arrow key and last item for the up arrow key."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"parentMenu","type":"string","description":"ID of parent menu for drilldown menus"},{"name":"popperProps","type":"SelectPopperProps","description":"Additional properties to pass to the popper"},{"name":"role","type":"string","description":"Determines the accessible role of the menu. For a non-checkbox menu that can have\none or more items selected, pass in \"listbox\"."},{"name":"selected","type":"any | any[]","description":"Single itemId for single select menus, or array of itemIds for multi select. You can also specify isSelected on the MenuItem."},{"name":"shouldFocusFirstItemOnOpen","type":"boolean","description":"Flag indicating the first menu item should be focused after opening the menu.","beta":true},{"name":"shouldFocusToggleOnSelect","type":"boolean","description":"Flag indicating the toggle should be focused after a selection. If this use case is too restrictive, the optional toggleRef property with a node toggle may be used to control focus."},{"name":"shouldPreventScrollOnItemFocus","type":"boolean","description":"Flag indicating if scroll on focus of the first menu item should occur."},{"name":"toggle","type":"SelectToggleProps | ((toggleRef: React.RefObject<any>) => React.ReactNode)","description":"Select toggle. The toggle should either be a renderer function which forwards the given toggle ref, or a direct ReactNode that should be passed along with the toggleRef property.","required":true},{"name":"variant","type":"'default' | 'typeahead'","description":"Select variant. For typeahead variant focus won't shift to menu items when pressing up/down arrows."},{"name":"zIndex","type":"number","description":"z-index of the select menu"}]},"SelectPopperProps":{"name":"SelectPopperProps","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement) | 'inline'","description":"The container to append the select to. Defaults to document.body.\nIf your select is being cut off you can append it to an element higher up the DOM tree.\nSome examples:\nappendTo=\"inline\"\nappendTo={() => document.body}\nappendTo={document.getElementById('target')}"},{"name":"direction","type":"'up' | 'down'","description":"Vertical direction of the popper. If enableFlip is set to true, this will set the initial direction before the popper flips."},{"name":"enableFlip","type":"boolean","description":"Enable to flip the popper when it reaches the boundary"},{"name":"maxWidth","type":"string | 'trigger'","description":"Maximum width of the popper. If the value is \"trigger\", it will set the max width to the select toggle's width"},{"name":"minWidth","type":"string | 'trigger'","description":"Minimum width of the popper. If the value is \"trigger\", it will set the min width to the select toggle's width"},{"name":"position","type":"'right' | 'left' | 'center' | 'start' | 'end'","description":"Horizontal position of the popper"},{"name":"preventOverflow","type":"boolean","description":"Flag to prevent the popper from overflowing its container and becoming partially obscured."},{"name":"width","type":"string | 'trigger'","description":"Custom width of the popper. If the value is \"trigger\", it will set the width to the select toggle's width"}]},"SelectToggleProps":{"name":"SelectToggleProps","description":"","props":[{"name":"toggleNode","type":"React.ReactNode","description":"Select toggle node.","required":true},{"name":"toggleRef","type":"React.RefObject<HTMLButtonElement | null>","description":"Reference to the toggle."}]},"SelectProps":{"name":"SelectProps","description":"See the Menu documentation for additional props that may be passed.","props":[{"name":"children","type":"React.ReactNode","description":"Anything which can be rendered in a select"},{"name":"className","type":"string","description":"Classes applied to root element of select"},{"name":"focusTimeoutDelay","type":"number","description":"Time in ms to wait before firing the toggles' focus event. Defaults to 0"},{"name":"innerRef","type":"React.Ref<HTMLDivElement>","description":""},{"name":"isOpen","type":"boolean","description":"Flag to indicate if select is open"},{"name":"isPlain","type":"boolean","description":"Indicates if the select should be without the outer box-shadow"},{"name":"isScrollable","type":"boolean","description":"Indicates if the select menu should be scrollable"},{"name":"maxMenuHeight","type":"string","description":"Maximum height of select menu"},{"name":"menuHeight","type":"string","description":"Height of the select menu"},{"name":"onOpenChange","type":"(isOpen: boolean) => void","description":"Callback to allow the select component to change the open state of the menu.\nTriggered by clicking outside of the menu, or by pressing any keys specified in onOpenChangeKeys."},{"name":"onOpenChangeKeys","type":"string[]","description":"Keys that trigger onOpenChange, defaults to tab and escape. It is highly recommended to include Escape in the array, while Tab may be omitted if the menu contains non-menu items that are focusable."},{"name":"onSelect","type":"(event?: React.MouseEvent<Element, MouseEvent>, value?: string | number) => void","description":"Function callback when user selects an option."},{"name":"onToggleKeydown","type":"(event: KeyboardEvent) => void","description":"Callback to override the toggle keydown behavior. By default, when the toggle has focus and the menu is open, pressing the up/down arrow keys will focus a valid non-disabled menu item - the first item for the down arrow key and last item for the up arrow key."},{"name":"popperProps","type":"SelectPopperProps","description":"Additional properties to pass to the popper"},{"name":"role","type":"string","description":"Determines the accessible role of the select. For a checkbox select pass in \"menu\"."},{"name":"selected","type":"any | any[]","description":"Single select option value for single select menus, or array of select option values for multi select. You can also specify isSelected on the SelectOption."},{"name":"shouldFocusFirstItemOnOpen","type":"boolean","description":""},{"name":"shouldFocusToggleOnSelect","type":"boolean","description":"Flag indicating the toggle should be focused after a selection. If this use case is too restrictive, the optional toggleRef property with a node toggle may be used to control focus."},{"name":"shouldPreventScrollOnItemFocus","type":"boolean","description":"Flag indicating if scroll on focus of the first menu item should occur."},{"name":"toggle","type":"SelectToggleProps | ((toggleRef: React.RefObject<any>) => React.ReactNode)","description":"Select toggle. The toggle should either be a renderer function which forwards the given toggle ref, or a direct ReactNode that should be passed along with the toggleRef property.","required":true},{"name":"variant","type":"'default' | 'typeahead'","description":"Select variant. For typeahead variant focus won't shift to menu items when pressing up/down arrows."},{"name":"zIndex","type":"number","description":"z-index of the select menu"}]},"SearchInput":{"name":"SearchInput","description":"The main search input component.","props":[{"name":"advancedSearchDelimiter","type":"string","description":"Delimiter in the query string for pairing attributes with search values.\nRequired whenever attributes are passed as props."},{"name":"appendTo","type":"HTMLElement | (() => HTMLElement) | 'inline'","description":"The container to append the menu to.\nIf your menu is being cut off you can append it to an element higher up the DOM tree.\nSome examples:\nappendTo={() => document.body}\nappendTo={document.getElementById('target')}"},{"name":"areUtilitiesDisplayed","type":"boolean","description":"Flag to indicate utilities should be displayed. By default if this prop is undefined or false, utilities will only be displayed when the search input has a value."},{"name":"aria-label","type":"string","description":"An accessible label for the search input."},{"name":"attributes","type":"string[] | SearchInputSearchAttribute[]","description":"Array of attribute values used for dynamically generated advanced search."},{"name":"className","type":"string","description":"Additional classes added to the search input."},{"name":"expandableInput","type":"SearchInputExpandable","description":"Object that makes the search input expandable/collapsible."},{"name":"formAdditionalItems","type":"React.ReactNode","description":""},{"name":"hasWordsAttrLabel","type":"React.ReactNode","description":"Attribute label for strings unassociated with one of the provided listed attributes."},{"name":"hint","type":"string","description":"A suggestion for autocompleting."},{"name":"inputProps","type":"any","description":"Additional props to spread to the search input element."},{"name":"isAdvancedSearchOpen","type":"boolean","description":"A flag for controlling the open state of a custom advanced search implementation."},{"name":"isDisabled","type":"boolean","description":"Flag indicating if search input is disabled."},{"name":"isNextNavigationButtonDisabled","type":"boolean","description":"Flag indicating if the next navigation button is disabled."},{"name":"isPreviousNavigationButtonDisabled","type":"boolean","description":"Flag indicating if the previous navigation button is disabled."},{"name":"name","type":"string","description":"Name attribute for the search input"},{"name":"nextNavigationButtonAriaLabel","type":"string","description":"Accessible label for the button to navigate to next result."},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"A callback for when the input value changes."},{"name":"onClear","type":"(event: React.SyntheticEvent<HTMLButtonElement>) => void","description":"A callback for when the user clicks the clear button."},{"name":"onNextClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>) => void","description":"A callback for when the user clicks to navigate to next result."},{"name":"onPreviousClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>) => void","description":"A callback for when the user clicks to navigate to previous result."},{"name":"onSearch","type":"(\n event: React.SyntheticEvent<HTMLButtonElement>,\n value: string,\n attrValueMap: { [key: string]: string }\n) => void","description":"A callback for when the search button is clicked."},{"name":"onToggleAdvancedSearch","type":"(event: React.SyntheticEvent<HTMLButtonElement>, isOpen?: boolean) => void","description":"A callback for when the open advanced search button is clicked."},{"name":"openMenuButtonAriaLabel","type":"string","description":"Accessible label for the button which opens the advanced search form menu."},{"name":"placeholder","type":"string","description":"Placeholder text of the search input."},{"name":"previousNavigationButtonAriaLabel","type":"string","description":"Accessible label for the button to navigate to previous result."},{"name":"resetButtonLabel","type":"string","description":"Label for the button which resets the advanced search form and clears the search input."},{"name":"resultsCount","type":"number | string","description":"The number of search results returned. Either a total number of results,\nor a string representing the current result over the total number of results. i.e. \"1 / 5\"."},{"name":"searchInputId","type":"string","description":"Id for the search input"},{"name":"submitSearchButtonLabel","type":"string","description":"Label for the button which calls the onSearch event handler."},{"name":"value","type":"string","description":"Value of the search input."},{"name":"zIndex","type":"number","description":"z-index of the advanced search form when appendTo is not inline."},{"name":"advancedSearchDelimiter","type":"string","description":"Delimiter in the query string for pairing attributes with search values.\nRequired whenever attributes are passed as props."},{"name":"attributes","type":"string[] | SearchInputSearchAttribute[]","description":"Array of attribute values used for dynamically generated advanced search.","defaultValue":"[]"},{"name":"className","type":"string","description":"Additional classes added to the advanced search menu."},{"name":"formAdditionalItems","type":"React.ReactNode","description":""},{"name":"getAttrValueMap","type":"() => { [key: string]: string }","description":"Function which builds an attribute-value map by parsing the value in the search input."},{"name":"hasWordsAttrLabel","type":"React.ReactNode","description":"Attribute label for strings unassociated with one of the provided listed attributes.","defaultValue":"'Has words'"},{"name":"isSearchMenuOpen","type":"boolean","description":"Flag for toggling the open/close state of the advanced search menu."},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"A callback for when the input value changes."},{"name":"onClear","type":"(event: React.SyntheticEvent<HTMLButtonElement>) => void","description":"A callback for when the user clicks the clear button."},{"name":"onSearch","type":"(\n event: React.SyntheticEvent<HTMLButtonElement>,\n value: string,\n attrValueMap: { [key: string]: string }\n) => void","description":"A callback for when the search button is clicked."},{"name":"onToggleAdvancedMenu","type":"(e: React.SyntheticEvent<HTMLButtonElement>) => void","description":"A callback for when the open advanced search button is clicked."},{"name":"parentInputRef","type":"React.RefObject<any>","description":"Ref of the input element within the search input."},{"name":"parentRef","type":"React.RefObject<any>","description":"Ref of the div wrapping the whole search input."},{"name":"resetButtonLabel","type":"string","description":"Label for the button which resets the advanced search form and clears the search input.","defaultValue":"'Reset'"},{"name":"submitSearchButtonLabel","type":"string","description":"Label for the button which calls the onSearch event handler.","defaultValue":"'Search'"},{"name":"value","type":"string","description":"Value of the search input.","defaultValue":"''"}]},"SearchInputSearchAttribute":{"name":"SearchInputSearchAttribute","description":"Properties for adding search attributes to an advanced search input. These properties must\nbe passed in as an object within an array to the search input component's attribute property.","props":[{"name":"attr","type":"string","description":"The search attribute's value to be provided in the search input's query string.\nIt should have no spaces and be unique for every attribute.","required":true},{"name":"display","type":"React.ReactNode","description":"The search attribute's display name. It is used to label the field in the advanced\nsearch menu.","required":true}]},"SearchInputExpandable":{"name":"SearchInputExpandable","description":"Properties for creating an expandable search input. These properties should be passed into\nthe search input component's expandableInput property.","props":[{"name":"isExpanded","type":"boolean","description":"Flag to indicate if the search input is expanded.","required":true},{"name":"onToggleExpand","type":"(event: React.SyntheticEvent<HTMLButtonElement>, isExpanded: boolean) => void","description":"Callback function to toggle the expandable search input.","required":true},{"name":"toggleAriaLabel","type":"string","description":"An accessible label for the expandable search input toggle.","required":true}]},"SearchInputProps":{"name":"SearchInputProps","description":"The main search input component.","props":[{"name":"advancedSearchDelimiter","type":"string","description":"Delimiter in the query string for pairing attributes with search values.\nRequired whenever attributes are passed as props."},{"name":"appendTo","type":"HTMLElement | (() => HTMLElement) | 'inline'","description":"The container to append the menu to.\nIf your menu is being cut off you can append it to an element higher up the DOM tree.\nSome examples:\nappendTo={() => document.body}\nappendTo={document.getElementById('target')}"},{"name":"areUtilitiesDisplayed","type":"boolean","description":"Flag to indicate utilities should be displayed. By default if this prop is undefined or false, utilities will only be displayed when the search input has a value."},{"name":"attributes","type":"string[] | SearchInputSearchAttribute[]","description":"Array of attribute values used for dynamically generated advanced search."},{"name":"className","type":"string","description":"Additional classes added to the search input."},{"name":"expandableInput","type":"SearchInputExpandable","description":"Object that makes the search input expandable/collapsible."},{"name":"formAdditionalItems","type":"React.ReactNode","description":null},{"name":"hasWordsAttrLabel","type":"React.ReactNode","description":"Attribute label for strings unassociated with one of the provided listed attributes."},{"name":"hint","type":"string","description":"A suggestion for autocompleting."},{"name":"innerRef","type":"React.RefObject<any>","description":""},{"name":"inputProps","type":"any","description":"Additional props to spread to the search input element."},{"name":"isAdvancedSearchOpen","type":"boolean","description":"A flag for controlling the open state of a custom advanced search implementation."},{"name":"isDisabled","type":"boolean","description":"Flag indicating if search input is disabled."},{"name":"isNextNavigationButtonDisabled","type":"boolean","description":"Flag indicating if the next navigation button is disabled."},{"name":"isPreviousNavigationButtonDisabled","type":"boolean","description":"Flag indicating if the previous navigation button is disabled."},{"name":"name","type":"string","description":"Name attribute for the search input"},{"name":"nextNavigationButtonAriaLabel","type":"string","description":"Accessible label for the button to navigate to next result."},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"A callback for when the input value changes."},{"name":"onClear","type":"(event: React.SyntheticEvent<HTMLButtonElement>) => void","description":"A callback for when the user clicks the clear button."},{"name":"onNextClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>) => void","description":"A callback for when the user clicks to navigate to next result."},{"name":"onPreviousClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>) => void","description":"A callback for when the user clicks to navigate to previous result."},{"name":"onSearch","type":"(\n event: React.SyntheticEvent<HTMLButtonElement>,\n value: string,\n attrValueMap: { [key: string]: string }\n ) => void","description":"A callback for when the search button is clicked."},{"name":"onToggleAdvancedSearch","type":"(event: React.SyntheticEvent<HTMLButtonElement>, isOpen?: boolean) => void","description":"A callback for when the open advanced search button is clicked."},{"name":"openMenuButtonAriaLabel","type":"string","description":"Accessible label for the button which opens the advanced search form menu."},{"name":"placeholder","type":"string","description":"Placeholder text of the search input."},{"name":"previousNavigationButtonAriaLabel","type":"string","description":"Accessible label for the button to navigate to previous result."},{"name":"resetButtonLabel","type":"string","description":"Label for the button which resets the advanced search form and clears the search input."},{"name":"resultsCount","type":"number | string","description":"The number of search results returned. Either a total number of results,\nor a string representing the current result over the total number of results. i.e. \"1 / 5\"."},{"name":"searchInputId","type":"string","description":"Id for the search input"},{"name":"submitSearchButtonLabel","type":"string","description":"Label for the button which calls the onSearch event handler."},{"name":"Unknown","type":"string","description":"An accessible label for the search input."},{"name":"value","type":"string","description":"Value of the search input."},{"name":"zIndex","type":"number","description":"z-index of the advanced search form when appendTo is not inline."}]},"AdvancedSearchMenuProps":{"name":"AdvancedSearchMenuProps","description":"","props":[{"name":"advancedSearchDelimiter","type":"string","description":"Delimiter in the query string for pairing attributes with search values.\nRequired whenever attributes are passed as props."},{"name":"attributes","type":"string[] | SearchInputSearchAttribute[]","description":"Array of attribute values used for dynamically generated advanced search."},{"name":"className","type":"string","description":"Additional classes added to the advanced search menu."},{"name":"formAdditionalItems","type":"React.ReactNode","description":null},{"name":"getAttrValueMap","type":"() => { [key: string]: string }","description":"Function which builds an attribute-value map by parsing the value in the search input."},{"name":"hasWordsAttrLabel","type":"React.ReactNode","description":"Attribute label for strings unassociated with one of the provided listed attributes."},{"name":"isSearchMenuOpen","type":"boolean","description":"Flag for toggling the open/close state of the advanced search menu."},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"A callback for when the input value changes."},{"name":"onClear","type":"(event: React.SyntheticEvent<HTMLButtonElement>) => void","description":"A callback for when the user clicks the clear button."},{"name":"onSearch","type":"(\n event: React.SyntheticEvent<HTMLButtonElement>,\n value: string,\n attrValueMap: { [key: string]: string }\n ) => void","description":"A callback for when the search button is clicked."},{"name":"onToggleAdvancedMenu","type":"(e: React.SyntheticEvent<HTMLButtonElement>) => void","description":"A callback for when the open advanced search button is clicked."},{"name":"parentInputRef","type":"React.RefObject<any>","description":"Ref of the input element within the search input."},{"name":"parentRef","type":"React.RefObject<any>","description":"Ref of the div wrapping the whole search input."},{"name":"resetButtonLabel","type":"string","description":"Label for the button which resets the advanced search form and clears the search input."},{"name":"submitSearchButtonLabel","type":"string","description":"Label for the button which calls the onSearch event handler."},{"name":"value","type":"string","description":"Value of the search input."}]},"Radio":{"name":"Radio","description":"","props":[{"name":"aria-label","type":"string","description":"Aria label for the radio."},{"name":"body","type":"React.ReactNode","description":"Body of the radio."},{"name":"checked","type":"boolean","description":"Flag to show if the radio is checked."},{"name":"className","type":"string","description":"Additional classes added to the radio wrapper. This wrapper will be div element by default. It will be a label element if\nisLabelWrapped is true, or it can be overridden by any element specified in the component prop.","defaultValue":"''"},{"name":"component","type":"React.ElementType","description":"Sets the radio wrapper component to render. Defaults to \"div\". If set to \"label\", behaves the same as if isLabelWrapped prop was specified."},{"name":"description","type":"React.ReactNode","description":"Description text of the radio."},{"name":"id","type":"string","description":"Id of the radio.","required":true},{"name":"inputClassName","type":"string","description":"Additional classes added to the radio input."},{"name":"isChecked","type":"boolean","description":"Flag to show if the radio is checked."},{"name":"isDisabled","type":"boolean","description":"Flag to show if the radio is disabled.","defaultValue":"false"},{"name":"isLabelWrapped","type":"boolean","description":"Flag to indicate whether the radio wrapper element is a native label element for the radio input. Will not apply if a component prop (with a value other than a \"label\") is specified."},{"name":"isValid","type":"boolean","description":"Flag to show if the radio selection is valid or invalid.","defaultValue":"true"},{"name":"label","type":"React.ReactNode","description":"Label text of the radio."},{"name":"labelPosition","type":"'start' | 'end'","description":"Sets the position of the label. Defaults to 'end' (after the radio input)."},{"name":"name","type":"string","description":"Name for group of radios","required":true},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, checked: boolean) => void","description":"A callback for when the radio selection changes.","defaultValue":"() => {}"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."}]},"RadioProps":{"name":"RadioProps","description":"","props":[{"name":"body","type":"React.ReactNode","description":"Body of the radio."},{"name":"checked","type":"boolean","description":"Flag to show if the radio is checked."},{"name":"className","type":"string","description":"Additional classes added to the radio wrapper. This wrapper will be div element by default. It will be a label element if\nisLabelWrapped is true, or it can be overridden by any element specified in the component prop."},{"name":"component","type":"React.ElementType","description":"Sets the radio wrapper component to render. Defaults to \"div\". If set to \"label\", behaves the same as if isLabelWrapped prop was specified."},{"name":"description","type":"React.ReactNode","description":"Description text of the radio."},{"name":"id","type":"string","description":"Id of the radio.","required":true},{"name":"inputClassName","type":"string","description":"Additional classes added to the radio input."},{"name":"isChecked","type":"boolean","description":"Flag to show if the radio is checked."},{"name":"isDisabled","type":"boolean","description":"Flag to show if the radio is disabled."},{"name":"isLabelWrapped","type":"boolean","description":"Flag to indicate whether the radio wrapper element is a native label element for the radio input. Will not apply if a component prop (with a value other than a \"label\") is specified."},{"name":"isValid","type":"boolean","description":"Flag to show if the radio selection is valid or invalid."},{"name":"label","type":"React.ReactNode","description":"Label text of the radio."},{"name":"labelPosition","type":"'start' | 'end'","description":"Sets the position of the label. Defaults to 'end' (after the radio input)."},{"name":"name","type":"string","description":"Name for group of radios","required":true},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, checked: boolean) => void","description":"A callback for when the radio selection changes."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"Unknown","type":"string","description":"Aria label for the radio."}]},"ProgressStepper":{"name":"ProgressStepper","description":"","props":[{"name":"aria-label","type":"string","description":"Adds an accessible label to the progress stepper."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the progress stepper."},{"name":"className","type":"string","description":"Additional classes applied to the progress stepper container."},{"name":"isCenterAligned","type":"boolean","description":"Flag indicating the progress stepper should be centered."},{"name":"isCompact","type":"boolean","description":"Flag indicating the progress stepper should be rendered compactly."},{"name":"isVertical","type":"boolean","description":"Flag indicating the progress stepper has a vertical layout."}]},"ProgressStepperProps":{"name":"ProgressStepperProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the progress stepper."},{"name":"className","type":"string","description":"Additional classes applied to the progress stepper container."},{"name":"isCenterAligned","type":"boolean","description":"Flag indicating the progress stepper should be centered."},{"name":"isCompact","type":"boolean","description":"Flag indicating the progress stepper should be rendered compactly."},{"name":"isVertical","type":"boolean","description":"Flag indicating the progress stepper has a vertical layout."},{"name":"Unknown","type":"string","description":"Adds an accessible label to the progress stepper."}]},"ProgressStep":{"name":"ProgressStep","description":"","props":[{"name":"aria-label","type":"string","description":"Accessible label for the progress step. Should communicate all information being communicated by the progress\nstep's icon, including the variant and the completed status."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the progress step."},{"name":"className","type":"string","description":"Additional classes applied to the progress step container."},{"name":"description","type":"React.ReactNode","description":"Description text of a progress step."},{"name":"icon","type":"React.ReactNode","description":"Custom icon of a progress step. Will override default icons provided by the variant."},{"name":"isCurrent","type":"boolean","description":"Flag indicating the progress step is the current step."},{"name":"popoverRender","type":"(stepRef: React.RefObject<any>) => React.ReactNode","description":"Forwards the step ref to rendered function. Use this prop to add a popover to the step."},{"name":"titleId","type":"string","description":"ID of the title of the progress step."},{"name":"variant","type":"'default' | 'success' | 'info' | 'pending' | 'warning' | 'danger'","description":"Variant of the progress step. Each variant has a default icon."}]},"ProgressStepProps":{"name":"ProgressStepProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the progress step."},{"name":"className","type":"string","description":"Additional classes applied to the progress step container."},{"name":"description","type":"React.ReactNode","description":"Description text of a progress step."},{"name":"icon","type":"React.ReactNode","description":"Custom icon of a progress step. Will override default icons provided by the variant."},{"name":"isCurrent","type":"boolean","description":"Flag indicating the progress step is the current step."},{"name":"popoverRender","type":"(stepRef: React.RefObject<any>) => React.ReactNode","description":"Forwards the step ref to rendered function. Use this prop to add a popover to the step."},{"name":"titleId","type":"string","description":"ID of the title of the progress step."},{"name":"Unknown","type":"string","description":"Accessible label for the progress step. Should communicate all information being communicated by the progress\nstep's icon, including the variant and the completed status."},{"name":"variant","type":"'default' | 'success' | 'info' | 'pending' | 'warning' | 'danger'","description":"Variant of the progress step. Each variant has a default icon."}]},"ProgressHelperText":{"name":"ProgressHelperText","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content which can be used to convey additional information about the progress component.\nWe recommend the helper text component as it was designed for this purpose."}]},"ProgressHelperTextProps":{"name":"ProgressHelperTextProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content which can be used to convey additional information about the progress component.\nWe recommend the helper text component as it was designed for this purpose."}]},"ProgressContainer":{"name":"ProgressContainer","description":"","props":[{"name":"helperText","type":"React.ReactNode","description":"Content which can be used to convey additional information about the progress component.\nWe recommend the helper text component as it was designed for this purpose."},{"name":"isTitleTruncated","type":"boolean","description":"Whether string title should be truncated","defaultValue":"false"},{"name":"label","type":"React.ReactNode","description":"Label to indicate what progress is showing.","defaultValue":"null"},{"name":"measureLocation","type":"'outside' | 'inside' | 'top' | 'none'","description":"Location of progress value.","defaultValue":"ProgressMeasureLocation.top"},{"name":"parentId","type":"string","description":"Progress component DOM ID.","required":true},{"name":"progressBarAriaProps","type":"AriaProps","description":"Properties needed for aria support"},{"name":"title","type":"React.ReactNode","description":"Progress title. The isTitleTruncated property will only affect string titles. Node title truncation must be handled manually.","defaultValue":"''"},{"name":"tooltipPosition","type":"| TooltipPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Position of the tooltip which is displayed if title is truncated"},{"name":"value","type":"number","description":"Actual progress value.","required":true},{"name":"variant","type":"'danger' | 'success' | 'warning'","description":"Type of progress status.","defaultValue":"null"}]},"ProgressContainerProps":{"name":"ProgressContainerProps","description":"","props":[{"name":"helperText","type":"React.ReactNode","description":"Content which can be used to convey additional information about the progress component.\nWe recommend the helper text component as it was designed for this purpose."},{"name":"isTitleTruncated","type":"boolean","description":"Whether string title should be truncated"},{"name":"label","type":"React.ReactNode","description":"Label to indicate what progress is showing."},{"name":"measureLocation","type":"'outside' | 'inside' | 'top' | 'none'","description":"Location of progress value."},{"name":"parentId","type":"string","description":"Progress component DOM ID.","required":true},{"name":"progressBarAriaProps","type":"AriaProps","description":"Properties needed for aria support"},{"name":"title","type":"React.ReactNode","description":"Progress title. The isTitleTruncated property will only affect string titles. Node title truncation must be handled manually."},{"name":"tooltipPosition","type":"| TooltipPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Position of the tooltip which is displayed if title is truncated"},{"name":"value","type":"number","description":"Actual progress value.","required":true},{"name":"variant","type":"'danger' | 'success' | 'warning'","description":"Type of progress status."}]},"ProgressBar":{"name":"ProgressBar","description":"","props":[{"name":"children","type":"React.ReactNode","description":"What should be rendered inside progress bar.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes for Progres bar.","defaultValue":"''"},{"name":"progressBarAriaProps","type":"AriaProps","description":"Minimal value of progress."},{"name":"value","type":"number","description":"Actual progress value.","required":true}]},"AriaProps":{"name":"AriaProps","description":"","props":[{"name":"Unknown","type":"string","description":null}]},"ProgressBarProps":{"name":"ProgressBarProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"What should be rendered inside progress bar."},{"name":"className","type":"string","description":"Additional classes for Progres bar."},{"name":"progressBarAriaProps","type":"AriaProps","description":"Minimal value of progress."},{"name":"value","type":"number","description":"Actual progress value.","required":true}]},"Progress":{"name":"Progress","description":"","props":[{"name":"aria-label","type":"string","description":"Adds accessible text to the ProgressBar. Required when title not used and there is not any label associated with the progress bar","defaultValue":"null"},{"name":"aria-labelledby","type":"string","description":"Associates the ProgressBar with it's label for accessibility purposes. Required when title not used","defaultValue":"null"},{"name":"className","type":"string","description":"Classname for progress component.","defaultValue":"''"},{"name":"helperText","type":"React.ReactNode","description":"Content which can be used to convey additional information about the progress component.\nWe recommend the helper text component as it was designed for this purpose."},{"name":"id","type":"string","description":"DOM id for progress component.","defaultValue":"''"},{"name":"isTitleTruncated","type":"boolean","description":"Indicate whether to truncate the string title","defaultValue":"false"},{"name":"label","type":"React.ReactNode","description":"Text description of current progress value to display instead of percentage.","defaultValue":"null"},{"name":"max","type":"number","description":"Maximum value of progress.","defaultValue":"100"},{"name":"measureLocation","type":"'outside' | 'inside' | 'top' | 'none'","description":"Where the measure percent will be located.","defaultValue":"ProgressMeasureLocation.top"},{"name":"min","type":"number","description":"Minimal value of progress.","defaultValue":"0"},{"name":"size","type":"'sm' | 'md' | 'lg'","description":"Size variant of progress.","defaultValue":"null"},{"name":"title","type":"React.ReactNode","description":"Title above progress. The isTitleTruncated property will only affect string titles. Node title truncation must be handled manually.","defaultValue":"''"},{"name":"tooltipPosition","type":"'auto' | 'top' | 'bottom' | 'left' | 'right'","description":"Position of the tooltip which is displayed if title is truncated","defaultValue":"'top'"},{"name":"value","type":"number","description":"Actual value of progress.","defaultValue":"0"},{"name":"valueText","type":"string","description":"Accessible text description of current progress value, for when value is not a percentage. Use with label.","defaultValue":"null"},{"name":"variant","type":"'danger' | 'success' | 'warning'","description":"Status variant of progress.","defaultValue":"null"}]},"ProgressProps":{"name":"ProgressProps","description":"","props":[{"name":"className","type":"string","description":"Classname for progress component."},{"name":"helperText","type":"React.ReactNode","description":"Content which can be used to convey additional information about the progress component.\nWe recommend the helper text component as it was designed for this purpose."},{"name":"id","type":"string","description":"DOM id for progress component."},{"name":"isTitleTruncated","type":"boolean","description":"Indicate whether to truncate the string title"},{"name":"label","type":"React.ReactNode","description":"Text description of current progress value to display instead of percentage."},{"name":"max","type":"number","description":"Maximum value of progress."},{"name":"measureLocation","type":"'outside' | 'inside' | 'top' | 'none'","description":"Where the measure percent will be located."},{"name":"min","type":"number","description":"Minimal value of progress."},{"name":"size","type":"'sm' | 'md' | 'lg'","description":"Size variant of progress."},{"name":"title","type":"React.ReactNode","description":"Title above progress. The isTitleTruncated property will only affect string titles. Node title truncation must be handled manually."},{"name":"tooltipPosition","type":"'auto' | 'top' | 'bottom' | 'left' | 'right'","description":"Position of the tooltip which is displayed if title is truncated"},{"name":"Unknown","type":"string","description":"Associates the ProgressBar with it's label for accessibility purposes. Required when title not used"},{"name":"value","type":"number","description":"Actual value of progress."},{"name":"valueText","type":"string","description":"Accessible text description of current progress value, for when value is not a percentage. Use with label."},{"name":"variant","type":"'danger' | 'success' | 'warning'","description":"Status variant of progress."}]},"PopoverHeaderText":{"name":"PopoverHeaderText","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content of the header text","required":true},{"name":"className","type":"string","description":"Class to be applied to the header text"},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Heading level of the header title","required":true}]},"PopoverHeaderTextProps":{"name":"PopoverHeaderTextProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content of the header text","required":true},{"name":"className","type":"string","description":"Class to be applied to the header text"},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Heading level of the header title","required":true}]},"PopoverHeaderIcon":{"name":"PopoverHeaderIcon","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content of the header icon","required":true},{"name":"className","type":"string","description":"Class to be applied to the header icon"}]},"PopoverHeaderIconProps":{"name":"PopoverHeaderIconProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content of the header icon","required":true},{"name":"className","type":"string","description":"Class to be applied to the header icon"}]},"PopoverHeader":{"name":"PopoverHeader","description":"","props":[{"name":"alertSeverityScreenReaderText","type":"string","description":"Text announced by screen reader when alert severity variant is set to indicate severity level"},{"name":"alertSeverityVariant","type":"'custom' | 'info' | 'warning' | 'success' | 'danger'","description":"Severity variants for an alert popover. This modifies the color of the header to match the severity."},{"name":"children","type":"React.ReactNode","description":"Content of the popover header.","required":true},{"name":"className","type":"string","description":"Class to be applied to the header."},{"name":"icon","type":"React.ReactNode","description":"Indicates the header contains an icon."},{"name":"id","type":"string","description":"Id of the header"},{"name":"titleHeadingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Heading level of the header title","defaultValue":"'h6'"}]},"PopoverHeaderProps":{"name":"PopoverHeaderProps","description":"","props":[{"name":"alertSeverityScreenReaderText","type":"string","description":"Text announced by screen reader when alert severity variant is set to indicate severity level"},{"name":"alertSeverityVariant","type":"'custom' | 'info' | 'warning' | 'success' | 'danger'","description":"Severity variants for an alert popover. This modifies the color of the header to match the severity."},{"name":"children","type":"React.ReactNode","description":"Content of the popover header.","required":true},{"name":"className","type":"string","description":"Class to be applied to the header."},{"name":"icon","type":"React.ReactNode","description":"Indicates the header contains an icon."},{"name":"id","type":"string","description":"Id of the header"},{"name":"titleHeadingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Heading level of the header title"}]},"PopoverFooter":{"name":"PopoverFooter","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Footer node","required":true},{"name":"className","type":"string","description":"Additional classes added to the Popover footer","defaultValue":"''"}]},"PopoverFooterProps":{"name":"PopoverFooterProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Footer node","required":true},{"name":"className","type":"string","description":"Additional classes added to the Popover footer"}]},"PopoverDialog":{"name":"PopoverDialog","description":"","props":[{"name":"children","type":"React.ReactNode","description":"PopoverDialog body","defaultValue":"null"},{"name":"className","type":"string","description":"PopoverDialog additional class","defaultValue":"null"},{"name":"position","type":"'top' | 'bottom' | 'left' | 'right'","description":"PopoverDialog position","defaultValue":"'top'"}]},"PopoverDialogProps":{"name":"PopoverDialogProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"PopoverDialog body","required":true},{"name":"className","type":"string","description":"PopoverDialog additional class"},{"name":"position","type":"'top' | 'bottom' | 'left' | 'right'","description":"PopoverDialog position"}]},"PopoverContextProps":{"name":"PopoverContextProps","description":"","props":[{"name":"headerComponent","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":null}]},"PopoverContent":{"name":"PopoverContent","description":"","props":[{"name":"children","type":"React.ReactNode","description":"PopoverContent content","required":true},{"name":"className","type":"string","description":"PopoverContent additional class","defaultValue":"null"}]},"PopoverContentProps":{"name":"PopoverContentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"PopoverContent content","required":true},{"name":"className","type":"string","description":"PopoverContent additional class"}]},"PopoverCloseButton":{"name":"PopoverCloseButton","description":"","props":[{"name":"aria-label","type":"string","description":"Aria label for the Close button","required":true},{"name":"onClose","type":"(event: any) => void","description":"PopoverCloseButton onClose function","defaultValue":"() => undefined as void"}]},"PopoverCloseButtonProps":{"name":"PopoverCloseButtonProps","description":"","props":[{"name":"onClose","type":"(event: any) => void","description":"PopoverCloseButton onClose function"},{"name":"Unknown","type":"string","description":"Aria label for the Close button","required":true}]},"PopoverBody":{"name":"PopoverBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Popover body content","required":true},{"name":"className","type":"string","description":"Classes to be applied to the popover body."},{"name":"id","type":"string","description":"Popover body id","required":true}]},"PopoverBodyProps":{"name":"PopoverBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Popover body content","required":true},{"name":"className","type":"string","description":"Classes to be applied to the popover body."},{"name":"id","type":"string","description":"Popover body id","required":true}]},"PopoverArrow":{"name":"PopoverArrow","description":"","props":[{"name":"className","type":"string","description":"Popover arrow additional className","defaultValue":"''"}]},"PopoverArrowProps":{"name":"PopoverArrowProps","description":"","props":[{"name":"className","type":"string","description":"Popover arrow additional className"}]},"Popover":{"name":"Popover","description":"The main popover component. The following properties can also be passed into another component\nthat has a property specifically for passing in popover properties.","props":[{"name":"alertSeverityScreenReaderText","type":"string","description":"Text announced by screen reader when alert severity variant is set to indicate\nseverity level."},{"name":"alertSeverityVariant","type":"'custom' | 'info' | 'warning' | 'success' | 'danger'","description":"Severity variants for an alert popover. This modifies the color of the header to\nmatch the severity."},{"name":"animationDuration","type":"number","description":"The duration of the CSS fade transition animation.","defaultValue":"300"},{"name":"appendTo","type":"HTMLElement | ((ref?: HTMLElement) => HTMLElement) | 'inline'","description":"The element to append the popover to. Defaults to \"inline\".","defaultValue":"() => document.body"},{"name":"aria-label","type":"string","description":"Accessible label for the popover, required when header is not present.","defaultValue":"''"},{"name":"bodyContent","type":"React.ReactNode | ((hide: () => void) => React.ReactNode)","description":"Body content of the popover. If you want to close the popover after an action within the\nbody content, you can use the isVisible prop for manual control, or you can provide a\nfunction which will receive a callback as an argument to hide the popover, i.e.\nbodyContent={hide => <Button onClick={() => hide()}>Close</Button>}","required":true},{"name":"children","type":"ReactElement<any>","description":"The trigger reference element to which the popover is relatively placed to. If you cannot wrap\nthe element with the Popover, you can use the triggerRef prop instead.\nUsage: <Popover><Button>Reference</Button></Popover>"},{"name":"className","type":"string","description":"Additional classes added to the popover.","defaultValue":"''"},{"name":"closeBtnAriaLabel","type":"string","description":"Accessible label for the close button.","defaultValue":"'Close'"},{"name":"distance","type":"number","description":"Distance of the popover to its target. Defaults to 25.","defaultValue":"25"},{"name":"elementToFocus","type":"HTMLElement | SVGElement | string","description":"The element to focus when the popover becomes visible. By default the first\nfocusable element will receive focus."},{"name":"enableFlip","type":"boolean","description":"If true, tries to keep the popover in view by flipping it if necessary.\nIf the position is set to 'auto', this prop is ignored.","defaultValue":"true"},{"name":"flipBehavior","type":"| 'flip'\n| (\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'\n )[]","description":"The desired position to flip the popover to if the initial position is not possible.\nBy setting this prop to 'flip' it attempts to flip the popover to the opposite side if\nthere is no space.\nYou can also pass an array of positions that determines the flip order. It should contain\nthe initial position followed by alternative positions if that position is unavailable.\nExample: Initial position is 'top'. Button with popover is in the top right corner.\n'flipBehavior' is set to ['top', 'right', 'left']. Since there is no space to the top, it\nchecks if right is available. There's also no space to the right, so it finally shows the\npopover on the left.","defaultValue":"[\n 'top',\n 'bottom',\n 'left',\n 'right',\n 'top-start',\n 'top-end',\n 'bottom-start',\n 'bottom-end',\n 'left-start',\n 'left-end',\n 'right-start',\n 'right-end'\n]"},{"name":"footerContent","type":"React.ReactNode | ((hide: () => void) => React.ReactNode)","description":"Footer content of the popover. If you want to close the popover after an action within the\nfooter content, you can use the isVisible prop for manual control, or you can provide a\nfunction which will receive a callback as an argument to hide the popover, i.e.\nfooterContent={hide => <Button onClick={() => hide()}>Close</Button>}","defaultValue":"null"},{"name":"hasAutoWidth","type":"boolean","description":"Removes fixed-width and allows width to be defined by contents.","defaultValue":"false"},{"name":"hasNoPadding","type":"boolean","description":"Allows content to touch edges of popover container.","defaultValue":"false"},{"name":"headerComponent","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Sets the heading level to use for the popover header. Defaults to h6.","defaultValue":"'h6'"},{"name":"headerContent","type":"React.ReactNode | ((hide: () => void) => React.ReactNode)","description":"Simple header content to be placed within a title. If you want to close the popover after\nan action within the header content, you can use the isVisible prop for manual control,\nor you can provide a function which will receive a callback as an argument to hide the\npopover, i.e. headerContent={hide => <Button onClick={() => hide()}>Close</Button>}","defaultValue":"null"},{"name":"headerIcon","type":"React.ReactNode","description":"Icon to be displayed in the popover header. *","defaultValue":"null"},{"name":"hideOnOutsideClick","type":"boolean","description":"Hides the popover when a click occurs outside (only works if isVisible is not controlled\nby the user).","defaultValue":"true"},{"name":"id","type":"string","description":"Id used as part of the various popover elements (popover-${id}-header/body/footer)."},{"name":"isVisible","type":"boolean","description":"True to show the popover programmatically. Used in conjunction with the shouldClose prop.\nBy default, the popover child element handles click events automatically. If you want to\ncontrol this programmatically, the popover will not auto-close if the close button is\nclicked, the escape key is used, or if a click occurs outside the popover. Instead, the\nconsumer is responsible for closing the popover themselves by adding a callback listener\nfor the shouldClose prop.","defaultValue":"null"},{"name":"maxWidth","type":"string","description":"Maximum width of the popover (default 18.75rem).","defaultValue":"popoverMaxWidth && popoverMaxWidth.value"},{"name":"minWidth","type":"string","description":"Minimum width of the popover (default 6.25rem).","defaultValue":"popoverMinWidth && popoverMinWidth.value"},{"name":"onHidden","type":"() => void","description":"Lifecycle function invoked when the popover has fully transitioned out.","defaultValue":"(): void => null"},{"name":"onHide","type":"(event: MouseEvent | KeyboardEvent) => void","description":"Lifecycle function invoked when the popover begins to transition out.","defaultValue":"(): void => null"},{"name":"onMount","type":"() => void","description":"Lifecycle function invoked when the popover has been mounted to the DOM.","defaultValue":"(): void => null"},{"name":"onShow","type":"(event: MouseEvent | KeyboardEvent) => void","description":"Lifecycle function invoked when the popover begins to transition in.","defaultValue":"(): void => null"},{"name":"onShown","type":"() => void","description":"Lifecycle function invoked when the popover has fully transitioned in.","defaultValue":"(): void => null"},{"name":"position","type":"| PopoverPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Popover position. Note: With the enableFlip property set to true, it will change the\nposition if there is not enough space for the starting position. The behavior of where it\nflips to can be controlled through the flipBehavior property.","defaultValue":"'top'"},{"name":"shouldClose","type":"(event: MouseEvent | KeyboardEvent, hideFunction?: () => void) => void","description":"Callback function that is only invoked when isVisible is also controlled. Called when the\npopover close button is clicked, the enter key was used on it, or the escape key is used.","defaultValue":"(): void => null"},{"name":"shouldOpen","type":"(event: MouseEvent | KeyboardEvent, showFunction?: () => void) => void","description":"Callback function that is only invoked when isVisible is also controlled. Called when the\nenter key is used on the focused trigger.","defaultValue":"(): void => null"},{"name":"showClose","type":"boolean","description":"Flag indicating whether the close button should be shown.","defaultValue":"true"},{"name":"triggerAction","type":"'click' | 'hover'","description":"Sets an interaction to open popover, defaults to \"click\"","defaultValue":"'click'"},{"name":"triggerRef","type":"HTMLElement | (() => HTMLElement) | React.RefObject<any>","description":"The trigger reference element to which the popover is relatively placed to. If you can wrap the\nelement with the popover, you can use the children prop instead, or both props together.\nWhen passed along with the trigger prop, the div element that wraps the trigger will be removed.\nUsage: <Popover triggerRef={() => document.getElementById('reference-element')} />"},{"name":"withFocusTrap","type":"boolean","description":"Whether to trap focus in the popover."},{"name":"zIndex","type":"number","description":"The z-index of the popover.","defaultValue":"9999"}]},"PopoverProps":{"name":"PopoverProps","description":"The main popover component. The following properties can also be passed into another component\nthat has a property specifically for passing in popover properties.","props":[{"name":"alertSeverityScreenReaderText","type":"string","description":"Text announced by screen reader when alert severity variant is set to indicate\nseverity level."},{"name":"alertSeverityVariant","type":"'custom' | 'info' | 'warning' | 'success' | 'danger'","description":"Severity variants for an alert popover. This modifies the color of the header to\nmatch the severity."},{"name":"animationDuration","type":"number","description":"The duration of the CSS fade transition animation."},{"name":"appendTo","type":"HTMLElement | ((ref?: HTMLElement) => HTMLElement) | 'inline'","description":"The element to append the popover to. Defaults to \"inline\"."},{"name":"bodyContent","type":"React.ReactNode | ((hide: () => void) => React.ReactNode)","description":"Body content of the popover. If you want to close the popover after an action within the\nbody content, you can use the isVisible prop for manual control, or you can provide a\nfunction which will receive a callback as an argument to hide the popover, i.e.\nbodyContent={hide => <Button onClick={() => hide()}>Close</Button>}","required":true},{"name":"children","type":"ReactElement<any>","description":"The trigger reference element to which the popover is relatively placed to. If you cannot wrap\nthe element with the Popover, you can use the triggerRef prop instead.\nUsage: <Popover><Button>Reference</Button></Popover>"},{"name":"className","type":"string","description":"Additional classes added to the popover."},{"name":"closeBtnAriaLabel","type":"string","description":"Accessible label for the close button."},{"name":"distance","type":"number","description":"Distance of the popover to its target. Defaults to 25."},{"name":"elementToFocus","type":"HTMLElement | SVGElement | string","description":"The element to focus when the popover becomes visible. By default the first\nfocusable element will receive focus."},{"name":"enableFlip","type":"boolean","description":"If true, tries to keep the popover in view by flipping it if necessary.\nIf the position is set to 'auto', this prop is ignored."},{"name":"flipBehavior","type":"| 'flip'\n | (\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'\n )[]","description":"The desired position to flip the popover to if the initial position is not possible.\nBy setting this prop to 'flip' it attempts to flip the popover to the opposite side if\nthere is no space.\nYou can also pass an array of positions that determines the flip order. It should contain\nthe initial position followed by alternative positions if that position is unavailable.\nExample: Initial position is 'top'. Button with popover is in the top right corner.\n'flipBehavior' is set to ['top', 'right', 'left']. Since there is no space to the top, it\nchecks if right is available. There's also no space to the right, so it finally shows the\npopover on the left."},{"name":"footerContent","type":"React.ReactNode | ((hide: () => void) => React.ReactNode)","description":"Footer content of the popover. If you want to close the popover after an action within the\nfooter content, you can use the isVisible prop for manual control, or you can provide a\nfunction which will receive a callback as an argument to hide the popover, i.e.\nfooterContent={hide => <Button onClick={() => hide()}>Close</Button>}"},{"name":"hasAutoWidth","type":"boolean","description":"Removes fixed-width and allows width to be defined by contents."},{"name":"hasNoPadding","type":"boolean","description":"Allows content to touch edges of popover container."},{"name":"headerComponent","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Sets the heading level to use for the popover header. Defaults to h6."},{"name":"headerContent","type":"React.ReactNode | ((hide: () => void) => React.ReactNode)","description":"Simple header content to be placed within a title. If you want to close the popover after\nan action within the header content, you can use the isVisible prop for manual control,\nor you can provide a function which will receive a callback as an argument to hide the\npopover, i.e. headerContent={hide => <Button onClick={() => hide()}>Close</Button>}"},{"name":"headerIcon","type":"React.ReactNode","description":"Icon to be displayed in the popover header. *"},{"name":"hideOnOutsideClick","type":"boolean","description":"Hides the popover when a click occurs outside (only works if isVisible is not controlled\nby the user)."},{"name":"id","type":"string","description":"Id used as part of the various popover elements (popover-${id}-header/body/footer)."},{"name":"isVisible","type":"boolean","description":"True to show the popover programmatically. Used in conjunction with the shouldClose prop.\nBy default, the popover child element handles click events automatically. If you want to\ncontrol this programmatically, the popover will not auto-close if the close button is\nclicked, the escape key is used, or if a click occurs outside the popover. Instead, the\nconsumer is responsible for closing the popover themselves by adding a callback listener\nfor the shouldClose prop."},{"name":"maxWidth","type":"string","description":"Maximum width of the popover (default 18.75rem)."},{"name":"minWidth","type":"string","description":"Minimum width of the popover (default 6.25rem)."},{"name":"onHidden","type":"() => void","description":"Lifecycle function invoked when the popover has fully transitioned out."},{"name":"onHide","type":"(event: MouseEvent | KeyboardEvent) => void","description":"Lifecycle function invoked when the popover begins to transition out."},{"name":"onMount","type":"() => void","description":"Lifecycle function invoked when the popover has been mounted to the DOM."},{"name":"onShow","type":"(event: MouseEvent | KeyboardEvent) => void","description":"Lifecycle function invoked when the popover begins to transition in."},{"name":"onShown","type":"() => void","description":"Lifecycle function invoked when the popover has fully transitioned in."},{"name":"position","type":"| PopoverPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Popover position. Note: With the enableFlip property set to true, it will change the\nposition if there is not enough space for the starting position. The behavior of where it\nflips to can be controlled through the flipBehavior property."},{"name":"shouldClose","type":"(event: MouseEvent | KeyboardEvent, hideFunction?: () => void) => void","description":"Callback function that is only invoked when isVisible is also controlled. Called when the\npopover close button is clicked, the enter key was used on it, or the escape key is used."},{"name":"shouldOpen","type":"(event: MouseEvent | KeyboardEvent, showFunction?: () => void) => void","description":"Callback function that is only invoked when isVisible is also controlled. Called when the\nenter key is used on the focused trigger."},{"name":"showClose","type":"boolean","description":"Flag indicating whether the close button should be shown."},{"name":"triggerAction","type":"'click' | 'hover'","description":"Sets an interaction to open popover, defaults to \"click\""},{"name":"triggerRef","type":"HTMLElement | (() => HTMLElement) | React.RefObject<any>","description":"The trigger reference element to which the popover is relatively placed to. If you can wrap the\nelement with the popover, you can use the children prop instead, or both props together.\nWhen passed along with the trigger prop, the div element that wraps the trigger will be removed.\nUsage: <Popover triggerRef={() => document.getElementById('reference-element')} />"},{"name":"Unknown","type":"string","description":"Accessible label for the popover, required when header is not present."},{"name":"withFocusTrap","type":"boolean","description":"Whether to trap focus in the popover."},{"name":"zIndex","type":"number","description":"The z-index of the popover."}]},"PanelMainBody":{"name":"PanelMainBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the panel main body div"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"PanelMainBodyProps":{"name":"PanelMainBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the panel main body div"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"PanelMain":{"name":"PanelMain","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the panel main div"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"maxHeight","type":"string","description":"Max height of the panel main div as a string with the value and unit"}]},"PanelMainProps":{"name":"PanelMainProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the panel main div"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"maxHeight","type":"string","description":"Max height of the panel main div as a string with the value and unit"}]},"PanelHeader":{"name":"PanelHeader","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the panel header"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"PanelHeaderProps":{"name":"PanelHeaderProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the panel header"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"PanelFooter":{"name":"PanelFooter","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the panel footer"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"PanelFooterProps":{"name":"PanelFooterProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the panel footer"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"Panel":{"name":"Panel","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the panel"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"isScrollable","type":"boolean","description":"Flag to add scrollable styling to the panel"},{"name":"variant","type":"'raised' | 'bordered' | 'secondary'","description":"Adds panel variant styles"}]},"PanelProps":{"name":"PanelProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the panel"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"isScrollable","type":"boolean","description":"Flag to add scrollable styling to the panel"},{"name":"variant","type":"'raised' | 'bordered' | 'secondary'","description":"Adds panel variant styles"}]},"ToggleTemplate":{"name":"ToggleTemplate","description":"","props":[{"name":"firstIndex","type":"number","description":"The first index of the items being paginated","defaultValue":"0"},{"name":"itemCount","type":"number","description":"The total number of items being paginated","defaultValue":"0"},{"name":"itemsTitle","type":"string","description":"The type or title of the items being paginated","defaultValue":"'items'"},{"name":"lastIndex","type":"number","description":"The last index of the items being paginated","defaultValue":"0"},{"name":"ofWord","type":"React.ReactNode","description":"The word that joins the index and itemCount/itemsTitle","defaultValue":"'of'"}]},"PaginationToggleTemplateProps":{"name":"PaginationToggleTemplateProps","description":"","props":[{"name":"firstIndex","type":"number","description":"The first index of the items being paginated"},{"name":"itemCount","type":"number","description":"The total number of items being paginated"},{"name":"itemsTitle","type":"string","description":"The type or title of the items being paginated"},{"name":"lastIndex","type":"number","description":"The last index of the items being paginated"},{"name":"ofWord","type":"React.ReactNode","description":"The word that joins the index and itemCount/itemsTitle"}]},"PaginationOptionsMenu":{"name":"PaginationOptionsMenu","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement) | 'inline'","description":"The container to append the pagination options menu to. Overrides the containerRef prop.","beta":true},{"name":"className","type":"string","description":"Custom class name added to the pagination options menu."},{"name":"containerRef","type":"React.RefObject<HTMLDivElement | null>","description":"React ref for the container to append the options menu to. This is a static ref provided by the main pagination component."},{"name":"dropDirection","type":"'up' | 'down'","description":"Menu will open up or open down from the options menu toggle.","defaultValue":"'down'"},{"name":"firstIndex","type":"number","description":"The first index of the items being paginated.","defaultValue":"0"},{"name":"focusTimeoutDelay","type":"number","description":"Time in ms to wait before firing the toggles' focus event. Defaults to 0","defaultValue":"0"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if pagination options menu is disabled.","defaultValue":"false"},{"name":"isLastFullPageShown","type":"boolean","description":"Flag to indicate whether to show last full page of results when user selects perPage\nvalue that is greater than remaining rows.","defaultValue":"false"},{"name":"itemCount","type":"number","description":"The total number of items being paginated."},{"name":"itemsPerPageTitle","type":"string","description":"The title of the pagination options menu.","defaultValue":"'Items per page'"},{"name":"itemsTitle","type":"string","description":"The type or title of the items being paginated.","defaultValue":"''"},{"name":"lastIndex","type":"number","description":"The last index of the items being paginated.","defaultValue":"0"},{"name":"lastPage","type":"number","description":"The number of the last page."},{"name":"minWidth","type":"string | 'trigger'","description":"Minimum width of the pagination options menu. If set to \"trigger\", the minimum width will be set to the toggle width."},{"name":"ofWord","type":"string","description":"Label for the English word \"of\".","defaultValue":"'of'"},{"name":"onPerPageSelect","type":"(\n event: React.MouseEvent | React.KeyboardEvent | MouseEvent,\n newPerPage: number,\n newPage: number,\n startIdx?: number,\n endIdx?: number\n) => void","description":"Function called when user selects number of items per page.","defaultValue":"() => null as any"},{"name":"optionsToggleAriaLabel","type":"string","description":"Accessible label for the options toggle."},{"name":"page","type":"number","description":"Current page number."},{"name":"perPage","type":"number","description":"The number of items to be displayed per page.","defaultValue":"0"},{"name":"perPageOptions","type":"PerPageOptions[]","description":"Array of titles and values which will be the options on the options menu dropdown.","defaultValue":"[]"},{"name":"perPageSuffix","type":"string","description":"The suffix to be displayed after each option on the options menu dropdown.","defaultValue":"'per page'"},{"name":"shouldPreventScrollOnItemFocus","type":"boolean","description":"Flag indicating if scroll on focus of the first menu item should occur.","defaultValue":"true"},{"name":"toggleTemplate","type":"((props: PaginationToggleTemplateProps) => React.ReactElement<any>) | string","description":"This will be shown in pagination toggle span. You can use firstIndex, lastIndex,\nitemCount, and/or itemsTitle props.","required":true},{"name":"widgetId","type":"string","description":"Id added to the title of the pagination options menu."}]},"PaginationOptionsMenuProps":{"name":"PaginationOptionsMenuProps","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement) | 'inline'","description":""},{"name":"className","type":"string","description":"Custom class name added to the pagination options menu."},{"name":"containerRef","type":"React.RefObject<HTMLDivElement | null>","description":"React ref for the container to append the options menu to. This is a static ref provided by the main pagination component."},{"name":"dropDirection","type":"'up' | 'down'","description":"Menu will open up or open down from the options menu toggle."},{"name":"firstIndex","type":"number","description":"The first index of the items being paginated."},{"name":"focusTimeoutDelay","type":"number","description":"Time in ms to wait before firing the toggles' focus event. Defaults to 0"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if pagination options menu is disabled."},{"name":"isLastFullPageShown","type":"boolean","description":"Flag to indicate whether to show last full page of results when user selects perPage\nvalue that is greater than remaining rows."},{"name":"itemCount","type":"number","description":"The total number of items being paginated."},{"name":"itemsPerPageTitle","type":"string","description":"The title of the pagination options menu."},{"name":"itemsTitle","type":"string","description":"The type or title of the items being paginated."},{"name":"lastIndex","type":"number","description":"The last index of the items being paginated."},{"name":"lastPage","type":"number","description":"The number of the last page."},{"name":"minWidth","type":"string | 'trigger'","description":"Minimum width of the pagination options menu. If set to \"trigger\", the minimum width will be set to the toggle width."},{"name":"ofWord","type":"string","description":"Label for the English word \"of\"."},{"name":"onPerPageSelect","type":"OnPerPageSelect","description":"Function called when user selects number of items per page."},{"name":"optionsToggleAriaLabel","type":"string","description":"Accessible label for the options toggle."},{"name":"page","type":"number","description":"Current page number."},{"name":"perPage","type":"number","description":"The number of items to be displayed per page."},{"name":"perPageOptions","type":"PerPageOptions[]","description":"Array of titles and values which will be the options on the options menu dropdown."},{"name":"perPageSuffix","type":"string","description":"The suffix to be displayed after each option on the options menu dropdown."},{"name":"shouldPreventScrollOnItemFocus","type":"boolean","description":"Flag indicating if scroll on focus of the first menu item should occur."},{"name":"toggleTemplate","type":"((props: PaginationToggleTemplateProps) => React.ReactElement<any>) | string","description":"This will be shown in pagination toggle span. You can use firstIndex, lastIndex,\nitemCount, and/or itemsTitle props.","required":true},{"name":"widgetId","type":"string","description":"Id added to the title of the pagination options menu."}]},"PaginationNavigation":{"name":"PaginationNavigation","description":"","props":[{"name":"className","type":"string","description":"Additional classes for the pagination navigation container.","defaultValue":"''"},{"name":"currPageAriaLabel","type":"string","description":"Accessible label for the input displaying the current page.","defaultValue":"'Current page'"},{"name":"firstPage","type":"number","description":"The number of first page where pagination starts.","defaultValue":"0"},{"name":"isCompact","type":"boolean","description":"Flag indicating if the pagination is compact.","defaultValue":"false"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the pagination is disabled.","defaultValue":"false"},{"name":"itemCount","type":"number","description":"Total number of items."},{"name":"lastPage","type":"number","description":"The number of the last page.","defaultValue":"0"},{"name":"ofWord","type":"string","description":"Label for the English word \"of\".","defaultValue":"'of'"},{"name":"onFirstClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks to navigate to first page.","defaultValue":"() => undefined as any"},{"name":"onLastClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks to navigate to last page.","defaultValue":"() => undefined as any"},{"name":"onNextClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks to navigate to next page.","defaultValue":"() => undefined as any"},{"name":"onPageInput","type":"(event: React.KeyboardEvent<HTMLInputElement>, page: number) => void","description":"Function called when user inputs page number.","defaultValue":"() => undefined as any"},{"name":"onPreviousClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks to navigate to previous page.","defaultValue":"() => undefined as any"},{"name":"onSetPage","type":"(\n event: React.MouseEvent | React.KeyboardEvent | MouseEvent,\n newPage: number,\n perPage?: number,\n startIdx?: number,\n endIdx?: number\n) => void","description":"Function called when page is changed.","required":true},{"name":"page","type":"number","description":"The number of the current page.","required":true},{"name":"pagesTitle","type":"string","description":"The title of a page displayed beside the page number.","defaultValue":"''"},{"name":"pagesTitlePlural","type":"string","description":"The title of a page displayed beside the page number (the plural form).","defaultValue":"''"},{"name":"paginationAriaLabel","type":"string","description":"Accessible label for the pagination component.","defaultValue":"'Pagination'"},{"name":"perPage","type":"number","description":"Number of items per page."},{"name":"toFirstPageAriaLabel","type":"string","description":"Accessible label for the button which moves to the first page.","defaultValue":"'Go to first page'"},{"name":"toLastPageAriaLabel","type":"string","description":"Accessible label for the button which moves to the last page.","defaultValue":"'Go to last page'"},{"name":"toNextPageAriaLabel","type":"string","description":"Accessible label for the button which moves to the next page.","defaultValue":"'Go to next page'"},{"name":"toPreviousPageAriaLabel","type":"string","description":"Accessible label for the button which moves to the previous page.","defaultValue":"'Go to previous page'"}]},"PaginationNavigationProps":{"name":"PaginationNavigationProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes for the pagination navigation container."},{"name":"currPageAriaLabel","type":"string","description":"Accessible label for the input displaying the current page."},{"name":"firstPage","type":"number","description":"The number of first page where pagination starts."},{"name":"isCompact","type":"boolean","description":"Flag indicating if the pagination is compact."},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the pagination is disabled."},{"name":"itemCount","type":"number","description":"Total number of items."},{"name":"lastPage","type":"number","description":"The number of the last page."},{"name":"ofWord","type":"string","description":"Label for the English word \"of\"."},{"name":"onFirstClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks to navigate to first page."},{"name":"onLastClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks to navigate to last page."},{"name":"onNextClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks to navigate to next page."},{"name":"onPageInput","type":"(event: React.KeyboardEvent<HTMLInputElement>, page: number) => void","description":"Function called when user inputs page number."},{"name":"onPreviousClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks to navigate to previous page."},{"name":"onSetPage","type":"OnSetPage","description":"Function called when page is changed.","required":true},{"name":"page","type":"number","description":"The number of the current page.","required":true},{"name":"pagesTitle","type":"string","description":"The title of a page displayed beside the page number."},{"name":"pagesTitlePlural","type":"string","description":"The title of a page displayed beside the page number (the plural form)."},{"name":"paginationAriaLabel","type":"string","description":"Accessible label for the pagination component."},{"name":"perPage","type":"number","description":"Number of items per page."},{"name":"toFirstPageAriaLabel","type":"string","description":"Accessible label for the button which moves to the first page."},{"name":"toLastPageAriaLabel","type":"string","description":"Accessible label for the button which moves to the last page."},{"name":"toNextPageAriaLabel","type":"string","description":"Accessible label for the button which moves to the next page."},{"name":"toPreviousPageAriaLabel","type":"string","description":"Accessible label for the button which moves to the previous page."}]},"PaginationNavigationState":{"name":"PaginationNavigationState","description":"","props":[{"name":"userInputPage","type":"number | string","description":null}]},"Pagination":{"name":"Pagination","description":"The main pagination component.","props":[{"name":"children","type":"React.ReactNode","description":"What should be rendered inside the pagination."},{"name":"className","type":"string","description":"Additional classes for the pagination container.","defaultValue":"''"},{"name":"dropDirection","type":"'up' | 'down'","description":"Direction of dropdown context menu."},{"name":"firstPage","type":"number","description":"Page to start at.","defaultValue":"1"},{"name":"inset","type":"{\n default?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n sm?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n md?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n lg?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n xl?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n '2xl'?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n}","description":"Insets at various breakpoints."},{"name":"isCompact","type":"boolean","description":"Flag indicating if pagination is compact.","defaultValue":"false"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if pagination is disabled.","defaultValue":"false"},{"name":"isLastFullPageShown","type":"boolean","description":"Indicate whether to show last full page of results when user selects perPage value\ngreater than remaining rows.","defaultValue":"false"},{"name":"isStatic","type":"boolean","description":"Flag indicating if pagination should not be sticky on mobile.","defaultValue":"false"},{"name":"isSticky","type":"boolean","description":"Flag indicating if pagination should stick to its position (based on variant).","defaultValue":"false"},{"name":"itemCount","type":"number","description":"Total number of items."},{"name":"itemsEnd","type":"number","description":"Last index of items on current page.","defaultValue":"null"},{"name":"itemsStart","type":"number","description":"First index of items on current page.","defaultValue":"null"},{"name":"menuAppendTo","type":"HTMLElement | (() => HTMLElement) | 'inline'","description":"The container to append the pagination options menu to.","beta":true},{"name":"offset","type":"number","description":"Start index of rows to display, used in place of providing page.","defaultValue":"null"},{"name":"onFirstClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks on navigate to first page.","defaultValue":"() => undefined"},{"name":"onLastClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks on navigate to last page.","defaultValue":"() => undefined"},{"name":"onNextClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks on navigate to next page.","defaultValue":"() => undefined"},{"name":"onPageInput","type":"(event: React.KeyboardEvent<HTMLInputElement>, page: number) => void","description":"Function called when user inputs page number.","defaultValue":"() => undefined"},{"name":"onPerPageSelect","type":"(\n event: React.MouseEvent | React.KeyboardEvent | MouseEvent,\n newPerPage: number,\n newPage: number,\n startIdx?: number,\n endIdx?: number\n) => void","description":"Function called when user selects number of items per page.","defaultValue":"() => undefined"},{"name":"onPreviousClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks on navigate to previous page.","defaultValue":"() => undefined"},{"name":"onSetPage","type":"(\n event: React.MouseEvent | React.KeyboardEvent | MouseEvent,\n newPage: number,\n perPage?: number,\n startIdx?: number,\n endIdx?: number\n) => void","description":"Function called when user sets page.","defaultValue":"() => undefined"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"},{"name":"page","type":"number","description":"Current page number.","defaultValue":"1"},{"name":"perPage","type":"number","description":"Number of items per page.","defaultValue":"defaultPerPageOptions[0].value"},{"name":"perPageOptions","type":"PerPageOptions[]","description":"Array of the number of items per page options.","defaultValue":"[\n {\n title: '10',\n value: 10\n },\n {\n title: '20',\n value: 20\n },\n {\n title: '50',\n value: 50\n },\n {\n title: '100',\n value: 100\n }\n]"},{"name":"titles","type":"PaginationTitles","description":"Object with titles to display in pagination.","defaultValue":"{\n items: '',\n page: '',\n pages: '',\n itemsPerPage: 'Items per page',\n perPageSuffix: 'per page',\n toFirstPageAriaLabel: 'Go to first page',\n toPreviousPageAriaLabel: 'Go to previous page',\n toLastPageAriaLabel: 'Go to last page',\n toNextPageAriaLabel: 'Go to next page',\n optionsToggleAriaLabel: '',\n currPageAriaLabel: 'Current page',\n paginationAriaLabel: 'Pagination',\n ofWord: 'of'\n}"},{"name":"toggleTemplate","type":"((props: PaginationToggleTemplateProps) => React.ReactElement<any>) | string","description":"This will be shown in pagination toggle span. You can use firstIndex, lastIndex,\nitemCount, itemsTitle, and/or ofWord props."},{"name":"usePageInsets","type":"boolean","description":"Flag indicating that pagination should use page insets."},{"name":"variant","type":"'top' | 'bottom' | PaginationVariant","description":"Position where pagination is rendered.","defaultValue":"PaginationVariant.top"},{"name":"widgetId","type":"string","description":"Id to identify widget on page.","defaultValue":"'options-menu'"}]},"PerPageOptions":{"name":"PerPageOptions","description":"Properties to customize the content and behavior of the pagination dropdown options. These\nproperties should be passed into the pagination component's perPageOptions property.","props":[{"name":"title","type":"string","description":"The text title of the option, which is rendered inside the pagination dropdown menu."},{"name":"value","type":"number","description":"The value of the option, which determines how many items are displayed per page."}]},"PaginationTitles":{"name":"PaginationTitles","description":"Properties to customize various pagination titles. The following properties should be\npassed into the pagination component's title property.","props":[{"name":"currPageAriaLabel","type":"string","description":"Accessible label for the input displaying the current page."},{"name":"items","type":"string","description":"The type or title of the items being paginated."},{"name":"itemsPerPage","type":"string","description":"The title of the pagination options menu."},{"name":"ofWord","type":"string","description":"Label for the English word \"of\"."},{"name":"optionsToggleAriaLabel","type":"string","description":"Accessible label for the options toggle."},{"name":"page","type":"string","description":"The title of a page displayed beside the page number."},{"name":"pages","type":"string","description":"The title of a page displayed beside the page number (plural form)."},{"name":"paginationAriaLabel","type":"string","description":"Accessible label for the pagination component."},{"name":"perPageSuffix","type":"string","description":"The suffix to be displayed after each option on the options menu dropdown."},{"name":"toFirstPageAriaLabel","type":"string","description":"Accessible label for the button which moves to the first page."},{"name":"toLastPageAriaLabel","type":"string","description":"Accessible label for the button which moves to the last page."},{"name":"toNextPageAriaLabel","type":"string","description":"Accessible label for the button which moves to the next page."},{"name":"toPreviousPageAriaLabel","type":"string","description":"Accessible label for the button which moves to the previous page."}]},"PaginationProps":{"name":"PaginationProps","description":"The main pagination component.","props":[{"name":"children","type":"React.ReactNode","description":"What should be rendered inside the pagination."},{"name":"className","type":"string","description":"Additional classes for the pagination container."},{"name":"dropDirection","type":"'up' | 'down'","description":"Direction of dropdown context menu."},{"name":"firstPage","type":"number","description":"Page to start at."},{"name":"inset","type":"{\n default?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n sm?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n md?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n lg?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n xl?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n '2xl'?: 'insetNone' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl';\n }","description":"Insets at various breakpoints."},{"name":"isCompact","type":"boolean","description":"Flag indicating if pagination is compact."},{"name":"isDisabled","type":"boolean","description":"Flag indicating if pagination is disabled."},{"name":"isLastFullPageShown","type":"boolean","description":"Indicate whether to show last full page of results when user selects perPage value\ngreater than remaining rows."},{"name":"isStatic","type":"boolean","description":"Flag indicating if pagination should not be sticky on mobile."},{"name":"isSticky","type":"boolean","description":"Flag indicating if pagination should stick to its position (based on variant)."},{"name":"itemCount","type":"number","description":"Total number of items."},{"name":"itemsEnd","type":"number","description":"Last index of items on current page."},{"name":"itemsStart","type":"number","description":"First index of items on current page."},{"name":"menuAppendTo","type":"HTMLElement | (() => HTMLElement) | 'inline'","description":""},{"name":"offset","type":"number","description":"Start index of rows to display, used in place of providing page."},{"name":"onFirstClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks on navigate to first page."},{"name":"onLastClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks on navigate to last page."},{"name":"onNextClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks on navigate to next page."},{"name":"onPageInput","type":"(event: React.KeyboardEvent<HTMLInputElement>, page: number) => void","description":"Function called when user inputs page number."},{"name":"onPerPageSelect","type":"OnPerPageSelect","description":"Function called when user selects number of items per page."},{"name":"onPreviousClick","type":"(event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void","description":"Function called when user clicks on navigate to previous page."},{"name":"onSetPage","type":"OnSetPage","description":"Function called when user sets page."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"page","type":"number","description":"Current page number."},{"name":"perPage","type":"number","description":"Number of items per page."},{"name":"perPageOptions","type":"PerPageOptions[]","description":"Array of the number of items per page options."},{"name":"titles","type":"PaginationTitles","description":"Object with titles to display in pagination."},{"name":"toggleTemplate","type":"((props: PaginationToggleTemplateProps) => React.ReactElement<any>) | string","description":"This will be shown in pagination toggle span. You can use firstIndex, lastIndex,\nitemCount, itemsTitle, and/or ofWord props."},{"name":"usePageInsets","type":"boolean","description":"Flag indicating that pagination should use page insets."},{"name":"variant","type":"'top' | 'bottom' | PaginationVariant","description":"Position where pagination is rendered."},{"name":"widgetId","type":"string","description":"Id to identify widget on page."}]},"OnSetPage":{"name":"OnSetPage","description":"","props":[]},"OnPerPageSelect":{"name":"OnPerPageSelect","description":"","props":[]},"PageToggleButton":{"name":"PageToggleButton","description":"","props":[{"name":"aria-label","type":"string","description":"Adds accessible text to the button."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the button"},{"name":"className","type":"string","description":"Additional classes added to the button"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to button"},{"name":"countOptions","type":"BadgeCountObject","description":"Adds count number to button"},{"name":"hasNoPadding","type":"boolean","description":"Applies no padding on a plain button variant. Use when plain button is placed inline with text"},{"name":"icon","type":"React.ReactNode | null","description":"Icon for the button."},{"name":"iconPosition","type":"'start' | 'end' | 'left' | 'right'","description":"Sets position of the icon. Note: \"left\" and \"right\" are deprecated. Use \"start\" and \"end\" instead"},{"name":"id","type":"string","description":"Button id","defaultValue":"'nav-toggle'"},{"name":"inoperableEvents","type":"string[]","description":"Events to prevent when the button is in an aria-disabled state"},{"name":"isAriaDisabled","type":"boolean","description":"Adds disabled styling and communicates that the button is disabled using the aria-disabled html attribute"},{"name":"isBlock","type":"boolean","description":"Adds block styling to button"},{"name":"isClicked","type":"boolean","description":"Adds clicked styling to button."},{"name":"isDanger","type":"boolean","description":"Adds danger styling to secondary or link button variants"},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling and disables the button using the disabled html attribute"},{"name":"isInline","type":"boolean","description":"Adds inline styling to a link button"},{"name":"isLoading","type":"boolean","description":"Adds progress styling to button"},{"name":"isSidebarOpen","type":"boolean","description":"True if the sidebar is shown","defaultValue":"true"},{"name":"onSidebarToggle","type":"() => void","description":"Callback function to handle the sidebar toggle button, managed by the Page component if the Page isManagedSidebar prop is set to true","defaultValue":"() => undefined as any"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"size","type":"'default' | 'sm' | 'lg'","description":"Adds styling which affects the size of the button"},{"name":"spinnerAriaLabel","type":"string","description":"Accessible label for the spinner to describe what is loading"},{"name":"spinnerAriaLabelledBy","type":"string","description":"Id of element which describes what is being loaded"},{"name":"spinnerAriaValueText","type":"string","description":"Text describing that current loading status or progress"},{"name":"state","type":"'read' | 'unread' | 'attention'","description":"Sets state of the stateful button variant. Default is \"unread\""},{"name":"tabIndex","type":"number","description":"Sets the button tabindex."},{"name":"type","type":"'button' | 'submit' | 'reset'","description":"Sets button type"},{"name":"variant","type":"'primary' | 'secondary' | 'tertiary' | 'danger' | 'warning' | 'link' | 'plain' | 'control' | 'stateful'","description":"Adds button variant styles"}]},"PageToggleButtonProps":{"name":"PageToggleButtonProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content of the page toggle button"},{"name":"id","type":"string","description":"Button id"},{"name":"isSidebarOpen","type":"boolean","description":"True if the sidebar is shown"},{"name":"onSidebarToggle","type":"() => void","description":"Callback function to handle the sidebar toggle button, managed by the Page component if the Page isManagedSidebar prop is set to true"}]},"PageSidebarBody":{"name":"PageSidebarBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the page sidebar body"},{"name":"className","type":"string","description":"Additional classes added to the page sidebar body"},{"name":"isContextSelector","type":"boolean","description":"Flag indicating that the page sidebar body is for a context selector/perspective switcher"},{"name":"isFilled","type":"boolean","description":"Flag indicating that the page sidebar body should fill the available vertical space."},{"name":"usePageInsets","type":"boolean","description":"Flag indicating that the page sidebar body should use page insets."}]},"PageSidebarBodyProps":{"name":"PageSidebarBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the page sidebar body"},{"name":"className","type":"string","description":"Additional classes added to the page sidebar body"},{"name":"isContextSelector","type":"boolean","description":"Flag indicating that the page sidebar body is for a context selector/perspective switcher"},{"name":"isFilled","type":"boolean","description":"Flag indicating that the page sidebar body should fill the available vertical space."},{"name":"usePageInsets","type":"boolean","description":"Flag indicating that the page sidebar body should use page insets."}]},"PageSidebar":{"name":"PageSidebar","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the page sidebar (e.g. <PageSidebarBody />"},{"name":"className","type":"string","description":"Additional classes added to the page sidebar","defaultValue":"''"},{"name":"id","type":"string","description":"Sidebar id","defaultValue":"'page-sidebar'"},{"name":"isManagedSidebar","type":"boolean","description":"If true, manages the sidebar open/close state and there is no need to pass the isSidebarOpen boolean into\nthe sidebar component or add a callback onSidebarToggle function into the Masthead component"},{"name":"isSidebarOpen","type":"boolean","description":"Programmatically manage if the sidebar is shown, if isManagedSidebar is set to true in the Page component, this prop is managed","defaultValue":"true"}]},"PageSidebarProps":{"name":"PageSidebarProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the page sidebar (e.g. <PageSidebarBody />"},{"name":"className","type":"string","description":"Additional classes added to the page sidebar"},{"name":"id","type":"string","description":"Sidebar id"},{"name":"isManagedSidebar","type":"boolean","description":"If true, manages the sidebar open/close state and there is no need to pass the isSidebarOpen boolean into\nthe sidebar component or add a callback onSidebarToggle function into the Masthead component"},{"name":"isSidebarOpen","type":"boolean","description":"Programmatically manage if the sidebar is shown, if isManagedSidebar is set to true in the Page component, this prop is managed"}]},"PageSidebarContextProps":{"name":"PageSidebarContextProps","description":"","props":[{"name":"isSidebarOpen","type":"boolean","description":null,"required":true}]},"PageSection":{"name":"PageSection","description":"","props":[{"name":"aria-label","type":"string","description":"Adds an accessible name to the page section. Required when the hasOverflowScroll prop is set to true.\nThis prop should also be passed in if a heading is not being used to describe the content of the page section."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the section"},{"name":"className","type":"string","description":"Additional classes added to the section","defaultValue":"''"},{"name":"component","type":"React.JSX.IntrinsicElements","description":"Sets the base component to render. Defaults to section","defaultValue":"'section'"},{"name":"hasBodyWrapper","type":"boolean","description":"Flag indicating whether children passed to the component should be wrapped by a PageBody.\nSet this to false in order to pass multiple, custom PageBody's as children.","defaultValue":"true","beta":true},{"name":"hasOverflowScroll","type":"boolean","description":"Flag indicating if the PageSection has a scrolling overflow","defaultValue":"false"},{"name":"hasShadowBottom","type":"boolean","description":"Modifier indicating if PageSection should have a shadow at the bottom","defaultValue":"false"},{"name":"hasShadowTop","type":"boolean","description":"Modifier indicating if PageSection should have a shadow at the top","defaultValue":"false"},{"name":"isCenterAligned","type":"boolean","description":"Flag indicating if the section content is center aligned. isWidthLimited must be set for this to work","defaultValue":"false"},{"name":"isFilled","type":"boolean","description":"Enables the page section to fill the available vertical space if true, or disable filling if false."},{"name":"isWidthLimited","type":"boolean","description":"Limits the width of the section","defaultValue":"false"},{"name":"padding","type":"{\n default?: 'padding' | 'noPadding';\n sm?: 'padding' | 'noPadding';\n md?: 'padding' | 'noPadding';\n lg?: 'padding' | 'noPadding';\n xl?: 'padding' | 'noPadding';\n '2xl'?: 'padding' | 'noPadding';\n}","description":"Padding at various breakpoints."},{"name":"stickyOnBreakpoint","type":"{\n default?: 'top' | 'bottom';\n sm?: 'top' | 'bottom';\n md?: 'top' | 'bottom';\n lg?: 'top' | 'bottom';\n xl?: 'top' | 'bottom';\n '2xl'?: 'top' | 'bottom';\n}","description":"Modifier indicating if the PageBreadcrumb is sticky to the top or bottom at various breakpoints"},{"name":"type","type":"'default' | 'subnav' | 'breadcrumb' | 'tabs' | 'wizard'","description":"Section type variant","defaultValue":"'default'"},{"name":"variant","type":"'default' | 'secondary'","description":"Section background color variant. This will only apply when the type prop has the \"default\" value.","defaultValue":"'default'"}]},"PageSectionProps":{"name":"PageSectionProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the section"},{"name":"className","type":"string","description":"Additional classes added to the section"},{"name":"component","type":"keyof React.JSX.IntrinsicElements","description":"Sets the base component to render. Defaults to section"},{"name":"hasBodyWrapper","type":"boolean","description":""},{"name":"hasOverflowScroll","type":"boolean","description":"Flag indicating if the PageSection has a scrolling overflow"},{"name":"hasShadowBottom","type":"boolean","description":"Modifier indicating if PageSection should have a shadow at the bottom"},{"name":"hasShadowTop","type":"boolean","description":"Modifier indicating if PageSection should have a shadow at the top"},{"name":"isCenterAligned","type":"boolean","description":"Flag indicating if the section content is center aligned. isWidthLimited must be set for this to work"},{"name":"isFilled","type":"boolean","description":"Enables the page section to fill the available vertical space if true, or disable filling if false."},{"name":"isWidthLimited","type":"boolean","description":"Limits the width of the section"},{"name":"padding","type":"{\n default?: 'padding' | 'noPadding';\n sm?: 'padding' | 'noPadding';\n md?: 'padding' | 'noPadding';\n lg?: 'padding' | 'noPadding';\n xl?: 'padding' | 'noPadding';\n '2xl'?: 'padding' | 'noPadding';\n }","description":"Padding at various breakpoints."},{"name":"stickyOnBreakpoint","type":"{\n default?: 'top' | 'bottom';\n sm?: 'top' | 'bottom';\n md?: 'top' | 'bottom';\n lg?: 'top' | 'bottom';\n xl?: 'top' | 'bottom';\n '2xl'?: 'top' | 'bottom';\n }","description":"Modifier indicating if the PageBreadcrumb is sticky to the top or bottom at various breakpoints"},{"name":"type","type":"'default' | 'subnav' | 'breadcrumb' | 'tabs' | 'wizard'","description":"Section type variant"},{"name":"Unknown","type":"string","description":"Adds an accessible name to the page section. Required when the hasOverflowScroll prop is set to true.\nThis prop should also be passed in if a heading is not being used to describe the content of the page section."},{"name":"variant","type":"'default' | 'secondary'","description":"Section background color variant. This will only apply when the type prop has the \"default\" value."}]},"PageGroup":{"name":"PageGroup","description":"","props":[{"name":"aria-label","type":"string","description":"Adds an accessible name to the page group when the hasOverflowScroll prop is set to true."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the PageGroup"},{"name":"className","type":"string","description":"Additional classes to apply to the PageGroup","defaultValue":"''"},{"name":"hasOverflowScroll","type":"boolean","description":"Flag indicating if the PageGroup has a scrolling overflow","defaultValue":"false"},{"name":"hasShadowBottom","type":"boolean","description":"Modifier indicating if PageGroup should have a shadow at the bottom","defaultValue":"false"},{"name":"hasShadowTop","type":"boolean","description":"Modifier indicating if PageGroup should have a shadow at the top","defaultValue":"false"},{"name":"isFilled","type":"boolean","description":"Enables the page group to fill the available vertical space if true, or disable filling if false."},{"name":"stickyOnBreakpoint","type":"{\n default?: 'top' | 'bottom';\n sm?: 'top' | 'bottom';\n md?: 'top' | 'bottom';\n lg?: 'top' | 'bottom';\n xl?: 'top' | 'bottom';\n '2xl'?: 'top' | 'bottom';\n}","description":"Modifier indicating if the PageBreadcrumb is sticky to the top or bottom at various breakpoints"}]},"PageGroupProps":{"name":"PageGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the PageGroup"},{"name":"className","type":"string","description":"Additional classes to apply to the PageGroup"},{"name":"hasOverflowScroll","type":"boolean","description":"Flag indicating if the PageGroup has a scrolling overflow"},{"name":"hasShadowBottom","type":"boolean","description":"Modifier indicating if PageGroup should have a shadow at the bottom"},{"name":"hasShadowTop","type":"boolean","description":"Modifier indicating if PageGroup should have a shadow at the top"},{"name":"isFilled","type":"boolean","description":"Enables the page group to fill the available vertical space if true, or disable filling if false."},{"name":"stickyOnBreakpoint","type":"{\n default?: 'top' | 'bottom';\n sm?: 'top' | 'bottom';\n md?: 'top' | 'bottom';\n lg?: 'top' | 'bottom';\n xl?: 'top' | 'bottom';\n '2xl'?: 'top' | 'bottom';\n }","description":"Modifier indicating if the PageBreadcrumb is sticky to the top or bottom at various breakpoints"},{"name":"Unknown","type":"string","description":"Adds an accessible name to the page group when the hasOverflowScroll prop is set to true."}]},"PageContextProps":{"name":"PageContextProps","description":"","props":[{"name":"getBreakpoint","type":"(width: number | null) => 'default' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'","description":null,"required":true},{"name":"getVerticalBreakpoint","type":"(height: number | null) => 'default' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'","description":null,"required":true},{"name":"height","type":"number","description":null,"required":true},{"name":"isManagedSidebar","type":"boolean","description":null,"required":true},{"name":"isSidebarOpen","type":"boolean","description":null,"required":true},{"name":"onSidebarToggle","type":"() => void","description":null,"required":true},{"name":"width","type":"number","description":null,"required":true}]},"PageBreadcrumb":{"name":"PageBreadcrumb","description":"","props":[{"name":"aria-label","type":"string","description":"Adds an accessible name to the breadcrumb section. Required when the hasOverflowScroll prop is set to true."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the PageBreadcrumb"},{"name":"className","type":"string","description":"Additional classes to apply to the PageBreadcrumb","defaultValue":"''"},{"name":"hasBodyWrapper","type":"boolean","description":"Flag indicating whether children passed to the component should be wrapped by a PageBody.\nSet this to false in order to pass multiple, custom PageBody's as children.","defaultValue":"true","beta":true},{"name":"hasOverflowScroll","type":"boolean","description":"Flag indicating if the PageBreadcrumb has a scrolling overflow","defaultValue":"false"},{"name":"hasShadowBottom","type":"boolean","description":"Flag indicating if PageBreadcrumb should have a shadow at the bottom","defaultValue":"false"},{"name":"hasShadowTop","type":"boolean","description":"Flag indicating if PageBreadcrumb should have a shadow at the top","defaultValue":"false"},{"name":"isWidthLimited","type":"boolean","description":"Limits the width of the breadcrumb"},{"name":"stickyOnBreakpoint","type":"{\n default?: 'top' | 'bottom';\n sm?: 'top' | 'bottom';\n md?: 'top' | 'bottom';\n lg?: 'top' | 'bottom';\n xl?: 'top' | 'bottom';\n '2xl'?: 'top' | 'bottom';\n}","description":"Modifier indicating if the PageBreadcrumb is sticky to the top or bottom at various breakpoints"}]},"PageBreadcrumbProps":{"name":"PageBreadcrumbProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the PageBreadcrumb"},{"name":"className","type":"string","description":"Additional classes to apply to the PageBreadcrumb"},{"name":"hasBodyWrapper","type":"boolean","description":""},{"name":"hasOverflowScroll","type":"boolean","description":"Flag indicating if the PageBreadcrumb has a scrolling overflow"},{"name":"hasShadowBottom","type":"boolean","description":"Flag indicating if PageBreadcrumb should have a shadow at the bottom"},{"name":"hasShadowTop","type":"boolean","description":"Flag indicating if PageBreadcrumb should have a shadow at the top"},{"name":"isWidthLimited","type":"boolean","description":"Limits the width of the breadcrumb"},{"name":"stickyOnBreakpoint","type":"{\n default?: 'top' | 'bottom';\n sm?: 'top' | 'bottom';\n md?: 'top' | 'bottom';\n lg?: 'top' | 'bottom';\n xl?: 'top' | 'bottom';\n '2xl'?: 'top' | 'bottom';\n }","description":"Modifier indicating if the PageBreadcrumb is sticky to the top or bottom at various breakpoints"},{"name":"Unknown","type":"string","description":"Adds an accessible name to the breadcrumb section. Required when the hasOverflowScroll prop is set to true."}]},"PageBody":{"name":"PageBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the section"},{"name":"className","type":"string","description":"Additional classes added to the section"}]},"PageBodyProps":{"name":"PageBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the section"},{"name":"className","type":"string","description":"Additional classes added to the section"}]},"Page":{"name":"Page","description":"","props":[{"name":"additionalGroupedContent","type":"React.ReactNode","description":"Additional content of the group"},{"name":"banner","type":"React.ReactNode","description":"Banner component for the page. This will be rendered above a breadcrumb if one is also passed."},{"name":"breadcrumb","type":"React.ReactNode","description":"Breadcrumb component for the page"},{"name":"breadcrumbProps","type":"PageBreadcrumbProps","description":"Additional props of the breadcrumb"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the main section of the page layout (e.g. <PageSection />)"},{"name":"className","type":"string","description":"Additional classes added to the page layout"},{"name":"defaultManagedSidebarIsOpen","type":"boolean","description":"If true, the managed sidebar is initially open for desktop view","defaultValue":"true"},{"name":"drawerDefaultSize","type":"string","description":"Sets default drawer size"},{"name":"drawerMaxSize","type":"string","description":"Sets the maximum drawer size"},{"name":"drawerMinSize","type":"string","description":"Sets the minimum drawer size"},{"name":"getBreakpoint","type":"(width: number | null) => 'default' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'","description":"The page resize observer uses the breakpoints returned from this function when adding the pf-m-breakpoint-[default|sm|md|lg|xl|2xl] class\nYou can override the default getBreakpoint function to return breakpoints at different sizes than the default\nYou can view the default getBreakpoint function here:\nhttps://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/helpers/util.ts","defaultValue":"(width: number): 'default' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' => {\n if (width === null) {\n return null;\n }\n if (width >= globalWidthBreakpoints['2xl']) {\n return '2xl';\n }\n if (width >= globalWidthBreakpoints.xl) {\n return 'xl';\n }\n if (width >= globalWidthBreakpoints.lg) {\n return 'lg';\n }\n if (width >= globalWidthBreakpoints.md) {\n return 'md';\n }\n if (width >= globalWidthBreakpoints.sm) {\n return 'sm';\n }\n return 'default';\n}"},{"name":"getVerticalBreakpoint","type":"(height: number | null) => 'default' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'","description":"The page resize observer uses the breakpoints returned from this function when adding the pf-m-breakpoint-[default|sm|md|lg|xl|2xl] class\nYou can override the default getVerticalBreakpoint function to return breakpoints at different sizes than the default\nYou can view the default getVerticalBreakpoint function here:\nhttps://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/helpers/util.ts","defaultValue":"(height: number): 'default' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' => {\n if (height === null) {\n return null;\n }\n if (height >= globalHeightBreakpoints['2xl']) {\n return '2xl';\n }\n if (height >= globalHeightBreakpoints.xl) {\n return 'xl';\n }\n if (height >= globalHeightBreakpoints.lg) {\n return 'lg';\n }\n if (height >= globalHeightBreakpoints.md) {\n return 'md';\n }\n if (height >= globalHeightBreakpoints.sm) {\n return 'sm';\n }\n return 'default';\n}"},{"name":"groupProps","type":"PageGroupProps","description":"Additional props of the group"},{"name":"horizontalSubnav","type":"React.ReactNode","description":"Horizontal sub navigation component for the page"},{"name":"isBreadcrumbGrouped","type":"boolean","description":"Flag indicating if the breadcrumb should be in a group"},{"name":"isBreadcrumbWidthLimited","type":"boolean","description":"Flag indicating if breadcrumb width should be limited","defaultValue":"false"},{"name":"isContentFilled","type":"boolean","description":"Enables children to fill the available vertical space. Child page sections or groups that should fill should be passed the isFilled property."},{"name":"isHorizontalSubnavGrouped","type":"boolean","description":"Flag indicating if the horizontal sub navigation should be in a group"},{"name":"isHorizontalSubnavWidthLimited","type":"boolean","description":"Flag indicating if horizontal sub navigation width should be limited"},{"name":"isManagedSidebar","type":"boolean","description":"If true, manages the sidebar open/close state and there is no need to pass the isSidebarOpen boolean into\nthe sidebar component or add a callback onSidebarToggle function into the Masthead component","defaultValue":"false"},{"name":"isNotificationDrawerExpanded","type":"boolean","description":"Flag indicating Notification drawer in expanded","defaultValue":"false"},{"name":"mainAriaLabel","type":"string","description":"Accessible label, can be used to name main section"},{"name":"mainComponent","type":"'main' | 'div'","description":"HTML component used as main component of the page. Defaults to 'main', only pass in 'div' if another 'main' element already exists.","defaultValue":"'main'"},{"name":"mainContainerId","type":"string","description":"an id to use for the [role=\"main\"] element"},{"name":"mainTabIndex","type":"number | null","description":"tabIndex to use for the [role=\"main\"] element, null to unset it","defaultValue":"-1"},{"name":"masthead","type":"React.ReactNode","description":"Masthead component (e.g. <Masthead />)"},{"name":"notificationDrawer","type":"React.ReactNode","description":"Notification drawer component for an optional notification drawer (e.g. <NotificationDrawer />)"},{"name":"onNotificationDrawerExpand","type":"(event: KeyboardEvent | React.MouseEvent | React.TransitionEvent) => void","description":"Callback when notification drawer panel is finished expanding.","defaultValue":"() => null"},{"name":"onPageResize","type":"((event: MouseEvent | TouchEvent | React.KeyboardEvent, object: any) => void) | null","description":"Can add callback to be notified when resize occurs, for example to set the sidebar isSidebarOpen prop to false for a width < 768px\nReturns object { mobileView: boolean, windowSize: number }"},{"name":"role","type":"string","description":"Sets the value for role on the <main> element"},{"name":"sidebar","type":"React.ReactNode","description":"Sidebar component for a side nav, recommended to be a PageSidebar. If set to null, the page grid layout\nwill render without a sidebar."},{"name":"skipToContent","type":"React.ReactElement<any>","description":"Skip to content component for the page"}]},"PageProps":{"name":"PageProps","description":"","props":[{"name":"additionalGroupedContent","type":"React.ReactNode","description":"Additional content of the group"},{"name":"banner","type":"React.ReactNode","description":"Banner component for the page. This will be rendered above a breadcrumb if one is also passed."},{"name":"breadcrumb","type":"React.ReactNode","description":"Breadcrumb component for the page"},{"name":"breadcrumbProps","type":"PageBreadcrumbProps","description":"Additional props of the breadcrumb"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the main section of the page layout (e.g. <PageSection />)"},{"name":"className","type":"string","description":"Additional classes added to the page layout"},{"name":"defaultManagedSidebarIsOpen","type":"boolean","description":"If true, the managed sidebar is initially open for desktop view"},{"name":"drawerDefaultSize","type":"string","description":"Sets default drawer size"},{"name":"drawerMaxSize","type":"string","description":"Sets the maximum drawer size"},{"name":"drawerMinSize","type":"string","description":"Sets the minimum drawer size"},{"name":"getBreakpoint","type":"(width: number | null) => 'default' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'","description":"The page resize observer uses the breakpoints returned from this function when adding the pf-m-breakpoint-[default|sm|md|lg|xl|2xl] class\nYou can override the default getBreakpoint function to return breakpoints at different sizes than the default\nYou can view the default getBreakpoint function here:\nhttps://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/helpers/util.ts"},{"name":"getVerticalBreakpoint","type":"(height: number | null) => 'default' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'","description":"The page resize observer uses the breakpoints returned from this function when adding the pf-m-breakpoint-[default|sm|md|lg|xl|2xl] class\nYou can override the default getVerticalBreakpoint function to return breakpoints at different sizes than the default\nYou can view the default getVerticalBreakpoint function here:\nhttps://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/helpers/util.ts"},{"name":"groupProps","type":"PageGroupProps","description":"Additional props of the group"},{"name":"horizontalSubnav","type":"React.ReactNode","description":"Horizontal sub navigation component for the page"},{"name":"isBreadcrumbGrouped","type":"boolean","description":"Flag indicating if the breadcrumb should be in a group"},{"name":"isBreadcrumbWidthLimited","type":"boolean","description":"Flag indicating if breadcrumb width should be limited"},{"name":"isContentFilled","type":"boolean","description":"Enables children to fill the available vertical space. Child page sections or groups that should fill should be passed the isFilled property."},{"name":"isHorizontalSubnavGrouped","type":"boolean","description":"Flag indicating if the horizontal sub navigation should be in a group"},{"name":"isHorizontalSubnavWidthLimited","type":"boolean","description":"Flag indicating if horizontal sub navigation width should be limited"},{"name":"isManagedSidebar","type":"boolean","description":"If true, manages the sidebar open/close state and there is no need to pass the isSidebarOpen boolean into\nthe sidebar component or add a callback onSidebarToggle function into the Masthead component"},{"name":"isNotificationDrawerExpanded","type":"boolean","description":"Flag indicating Notification drawer in expanded"},{"name":"mainAriaLabel","type":"string","description":"Accessible label, can be used to name main section"},{"name":"mainComponent","type":"'main' | 'div'","description":"HTML component used as main component of the page. Defaults to 'main', only pass in 'div' if another 'main' element already exists."},{"name":"mainContainerId","type":"string","description":"an id to use for the [role=\"main\"] element"},{"name":"mainTabIndex","type":"number | null","description":"tabIndex to use for the [role=\"main\"] element, null to unset it"},{"name":"masthead","type":"React.ReactNode","description":"Masthead component (e.g. <Masthead />)"},{"name":"notificationDrawer","type":"React.ReactNode","description":"Notification drawer component for an optional notification drawer (e.g. <NotificationDrawer />)"},{"name":"onNotificationDrawerExpand","type":"(event: KeyboardEvent | React.MouseEvent | React.TransitionEvent) => void","description":"Callback when notification drawer panel is finished expanding."},{"name":"onPageResize","type":"((event: MouseEvent | TouchEvent | React.KeyboardEvent, object: any) => void) | null","description":"Can add callback to be notified when resize occurs, for example to set the sidebar isSidebarOpen prop to false for a width < 768px\nReturns object { mobileView: boolean, windowSize: number }"},{"name":"role","type":"string","description":"Sets the value for role on the <main> element"},{"name":"sidebar","type":"React.ReactNode","description":"Sidebar component for a side nav, recommended to be a PageSidebar. If set to null, the page grid layout\nwill render without a sidebar."},{"name":"skipToContent","type":"React.ReactElement<any>","description":"Skip to content component for the page"}]},"PageState":{"name":"PageState","description":"","props":[{"name":"desktopIsSidebarOpen","type":"boolean","description":null,"required":true},{"name":"height","type":"number","description":null,"required":true},{"name":"mobileIsSidebarOpen","type":"boolean","description":null,"required":true},{"name":"mobileView","type":"boolean","description":null,"required":true},{"name":"width","type":"number","description":null,"required":true}]},"OverflowMenuItem":{"name":"OverflowMenuItem","description":"","props":[{"name":"children","type":"any","description":"Any elements that can be rendered in the menu"},{"name":"className","type":"string","description":"Additional classes added to the OverflowMenuItem"},{"name":"isPersistent","type":"boolean","description":"Modifies the overflow menu item visibility","defaultValue":"false"}]},"OverflowMenuItemProps":{"name":"OverflowMenuItemProps","description":"","props":[{"name":"children","type":"any","description":"Any elements that can be rendered in the menu"},{"name":"className","type":"string","description":"Additional classes added to the OverflowMenuItem"},{"name":"isPersistent","type":"boolean","description":"Modifies the overflow menu item visibility"}]},"OverflowMenuGroup":{"name":"OverflowMenuGroup","description":"","props":[{"name":"children","type":"any","description":"Any elements that can be rendered in the menu"},{"name":"className","type":"string","description":"Additional classes added to the OverflowMenuGroup"},{"name":"groupType","type":"'button' | 'icon'","description":"Indicates a button or icon group"},{"name":"isPersistent","type":"boolean","description":"Modifies the overflow menu group visibility","defaultValue":"false"}]},"OverflowMenuGroupProps":{"name":"OverflowMenuGroupProps","description":"","props":[{"name":"children","type":"any","description":"Any elements that can be rendered in the menu"},{"name":"className","type":"string","description":"Additional classes added to the OverflowMenuGroup"},{"name":"groupType","type":"'button' | 'icon'","description":"Indicates a button or icon group"},{"name":"isPersistent","type":"boolean","description":"Modifies the overflow menu group visibility"}]},"OverflowMenuDropdownItem":{"name":"OverflowMenuDropdownItem","description":"","props":[{"name":"isShared","type":"boolean","description":"Indicates when a dropdown item shows and hides the corresponding list item","defaultValue":"false"},{"name":"itemId","type":"string | number","description":"Identifies the component in the dropdown onSelect callback"}]},"OverflowMenuDropdownItemProps":{"name":"OverflowMenuDropdownItemProps","description":"","props":[{"name":"isShared","type":"boolean","description":"Indicates when a dropdown item shows and hides the corresponding list item"},{"name":"itemId","type":"string | number","description":"Identifies the component in the dropdown onSelect callback"}]},"OverflowMenuControl":{"name":"OverflowMenuControl","description":"","props":[{"name":"children","type":"any","description":"Any elements that can be rendered in the menu"},{"name":"className","type":"string","description":"Additional classes added to the OverflowMenuControl"},{"name":"hasAdditionalOptions","type":"boolean","description":"Triggers the overflow dropdown to persist at all viewport sizes"}]},"OverflowMenuControlProps":{"name":"OverflowMenuControlProps","description":"","props":[{"name":"children","type":"any","description":"Any elements that can be rendered in the menu"},{"name":"className","type":"string","description":"Additional classes added to the OverflowMenuControl"},{"name":"hasAdditionalOptions","type":"boolean","description":"Triggers the overflow dropdown to persist at all viewport sizes"}]},"OverflowMenuContent":{"name":"OverflowMenuContent","description":"","props":[{"name":"children","type":"any","description":"Any elements that can be rendered in the menu"},{"name":"className","type":"string","description":"Additional classes added to the OverflowMenuContent"},{"name":"isPersistent","type":"boolean","description":"Modifies the overflow menu content visibility"}]},"OverflowMenuContentProps":{"name":"OverflowMenuContentProps","description":"","props":[{"name":"children","type":"any","description":"Any elements that can be rendered in the menu"},{"name":"className","type":"string","description":"Additional classes added to the OverflowMenuContent"},{"name":"isPersistent","type":"boolean","description":"Modifies the overflow menu content visibility"}]},"OverflowMenu":{"name":"OverflowMenu","description":"","props":[{"name":"breakpoint","type":"'sm' | 'md' | 'lg' | 'xl' | '2xl'","description":"Indicates breakpoint at which to switch between horizontal menu and vertical dropdown","required":true},{"name":"breakpointReference","type":"HTMLElement | (() => HTMLElement) | React.RefObject<any>","description":"A container reference to base the specified breakpoint on instead of the viewport width."},{"name":"children","type":"any","description":"Any elements that can be rendered in the menu"},{"name":"className","type":"string","description":"Additional classes added to the OverflowMenu."}]},"OverflowMenuProps":{"name":"OverflowMenuProps","description":"","props":[{"name":"breakpoint","type":"'sm' | 'md' | 'lg' | 'xl' | '2xl'","description":"Indicates breakpoint at which to switch between horizontal menu and vertical dropdown","required":true},{"name":"breakpointReference","type":"HTMLElement | (() => HTMLElement) | React.RefObject<any>","description":"A container reference to base the specified breakpoint on instead of the viewport width."},{"name":"children","type":"any","description":"Any elements that can be rendered in the menu"},{"name":"className","type":"string","description":"Additional classes added to the OverflowMenu."}]},"OverflowMenuState":{"name":"OverflowMenuState","description":"","props":[{"name":"breakpointRef","type":"HTMLElement","description":null,"required":true},{"name":"isBelowBreakpoint","type":"boolean","description":null,"required":true}]},"NumberInput":{"name":"NumberInput","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the number input"},{"name":"inputAriaLabel","type":"string","description":"Aria label of the input","defaultValue":"'Input'"},{"name":"inputName","type":"string","description":"Name of the input"},{"name":"inputProps","type":"any","description":"Additional properties added to the text input"},{"name":"isDisabled","type":"boolean","description":"Indicates the whole number input should be disabled","defaultValue":"false"},{"name":"max","type":"number","description":"Maximum value of the number input, disabling the plus button when reached"},{"name":"min","type":"number","description":"Minimum value of the number input, disabling the minus button when reached"},{"name":"minusBtnAriaLabel","type":"string","description":"Aria label of the minus button","defaultValue":"'Minus'"},{"name":"minusBtnProps","type":"ButtonProps","description":"Additional properties added to the minus button"},{"name":"onBlur","type":"(event?: any) => void","description":"Callback function when text input is blurred (focus leaves)"},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>) => void","description":"Callback for the text input changing"},{"name":"onMinus","type":"(event: React.MouseEvent, name?: string) => void","description":"Callback for the minus button","defaultValue":"() => {}"},{"name":"onPlus","type":"(event: React.MouseEvent, name?: string) => void","description":"Callback for the plus button","defaultValue":"() => {}"},{"name":"plusBtnAriaLabel","type":"string","description":"Aria label of the plus button","defaultValue":"'Plus'"},{"name":"plusBtnProps","type":"ButtonProps","description":"Additional properties added to the plus button"},{"name":"unit","type":"React.ReactNode","description":"Adds the given unit to the number input"},{"name":"unitPosition","type":"'before' | 'after'","description":"Position of the number input unit in relation to the number input","defaultValue":"'after'"},{"name":"validated","type":"'default' | 'error' | 'warning' | 'success' | ValidatedOptions","description":"Value to indicate if the input is modified to show that validation state","defaultValue":"ValidatedOptions.default"},{"name":"value","type":"number | ''","description":"Value of the number input","defaultValue":"0"},{"name":"widthChars","type":"number","description":"Sets the width of the number input to a number of characters"}]},"NumberInputProps":{"name":"NumberInputProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the number input"},{"name":"inputAriaLabel","type":"string","description":"Aria label of the input"},{"name":"inputName","type":"string","description":"Name of the input"},{"name":"inputProps","type":"any","description":"Additional properties added to the text input"},{"name":"isDisabled","type":"boolean","description":"Indicates the whole number input should be disabled"},{"name":"max","type":"number","description":"Maximum value of the number input, disabling the plus button when reached"},{"name":"min","type":"number","description":"Minimum value of the number input, disabling the minus button when reached"},{"name":"minusBtnAriaLabel","type":"string","description":"Aria label of the minus button"},{"name":"minusBtnProps","type":"ButtonProps","description":"Additional properties added to the minus button"},{"name":"onBlur","type":"(event?: any) => void","description":"Callback function when text input is blurred (focus leaves)"},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>) => void","description":"Callback for the text input changing"},{"name":"onMinus","type":"(event: React.MouseEvent, name?: string) => void","description":"Callback for the minus button"},{"name":"onPlus","type":"(event: React.MouseEvent, name?: string) => void","description":"Callback for the plus button"},{"name":"plusBtnAriaLabel","type":"string","description":"Aria label of the plus button"},{"name":"plusBtnProps","type":"ButtonProps","description":"Additional properties added to the plus button"},{"name":"unit","type":"React.ReactNode","description":"Adds the given unit to the number input"},{"name":"unitPosition","type":"'before' | 'after'","description":"Position of the number input unit in relation to the number input"},{"name":"validated","type":"'default' | 'error' | 'warning' | 'success' | ValidatedOptions","description":"Value to indicate if the input is modified to show that validation state"},{"name":"value","type":"number | ''","description":"Value of the number input"},{"name":"widthChars","type":"number","description":"Sets the width of the number input to a number of characters"}]},"DefaultKeyDownHandlerArgs":{"name":"DefaultKeyDownHandlerArgs","description":"","props":[]},"NotificationDrawerListItemHeader":{"name":"NotificationDrawerListItemHeader","description":"","props":[{"name":"actionHasNoOffset","type":"boolean","description":"Removes the offset of the notification drawer actions.","defaultValue":"false"},{"name":"children","type":"React.ReactNode","description":"Actions rendered inside the notification drawer list item header"},{"name":"className","type":"string","description":"Additional classes for notification drawer list item header.","defaultValue":"''"},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Sets the heading level to use for the list item header title. Default is h2.","defaultValue":"'h2'"},{"name":"icon","type":"React.ReactNode","description":"Add custom icon for notification drawer list item header","defaultValue":"null"},{"name":"srTitle","type":"string","description":"Notification drawer list item header screen reader title"},{"name":"title","type":"string","description":"Notification drawer list item title","required":true},{"name":"tooltipPosition","type":"| TooltipPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Position of the tooltip which is displayed if text is truncated"},{"name":"truncateTitle","type":"number","description":"Truncate title to number of lines","defaultValue":"0"},{"name":"variant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom'","description":"Variant indicates the severity level","defaultValue":"'custom'"}]},"NotificationDrawerListItemHeaderProps":{"name":"NotificationDrawerListItemHeaderProps","description":"","props":[{"name":"actionHasNoOffset","type":"boolean","description":"Removes the offset of the notification drawer actions."},{"name":"children","type":"React.ReactNode","description":"Actions rendered inside the notification drawer list item header"},{"name":"className","type":"string","description":"Additional classes for notification drawer list item header."},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Sets the heading level to use for the list item header title. Default is h2."},{"name":"icon","type":"React.ReactNode","description":"Add custom icon for notification drawer list item header"},{"name":"srTitle","type":"string","description":"Notification drawer list item header screen reader title"},{"name":"title","type":"string","description":"Notification drawer list item title","required":true},{"name":"tooltipPosition","type":"| TooltipPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Position of the tooltip which is displayed if text is truncated"},{"name":"truncateTitle","type":"number","description":"Truncate title to number of lines"},{"name":"variant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom'","description":"Variant indicates the severity level"}]},"NotificationDrawerListItemBody":{"name":"NotificationDrawerListItemBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the list item body"},{"name":"className","type":"string","description":"Additional classes added to the list item body","defaultValue":"''"},{"name":"timestamp","type":"React.ReactNode","description":"List item timestamp"}]},"NotificationDrawerListItemBodyProps":{"name":"NotificationDrawerListItemBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the list item body"},{"name":"className","type":"string","description":"Additional classes added to the list item body"},{"name":"timestamp","type":"React.ReactNode","description":"List item timestamp"}]},"NotificationDrawerListItem":{"name":"NotificationDrawerListItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the list item","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the list item","defaultValue":"''"},{"name":"isHoverable","type":"boolean","description":"Modifies the list item to include hover styles on :hover","defaultValue":"true"},{"name":"isRead","type":"boolean","description":"Adds styling to the list item to indicate it has been read","defaultValue":"false"},{"name":"onClick","type":"(event: any) => void","description":"Callback for when a list item is clicked","defaultValue":"(event: React.MouseEvent) => undefined as any"},{"name":"readStateScreenReaderText","type":"string","description":"Visually hidden text that conveys the current read state of the notification list item"},{"name":"tabIndex","type":"number","description":"Tab index for the list item","defaultValue":"0"},{"name":"variant","type":"'custom' | 'success' | 'danger' | 'warning' | 'info'","description":"Variant indicates the severity level","defaultValue":"'custom'"}]},"NotificationDrawerListItemProps":{"name":"NotificationDrawerListItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the list item"},{"name":"className","type":"string","description":"Additional classes added to the list item"},{"name":"isHoverable","type":"boolean","description":"Modifies the list item to include hover styles on :hover"},{"name":"isRead","type":"boolean","description":"Adds styling to the list item to indicate it has been read"},{"name":"onClick","type":"(event: any) => void","description":"Callback for when a list item is clicked"},{"name":"readStateScreenReaderText","type":"string","description":"Visually hidden text that conveys the current read state of the notification list item"},{"name":"tabIndex","type":"number","description":"Tab index for the list item"},{"name":"variant","type":"'custom' | 'success' | 'danger' | 'warning' | 'info'","description":"Variant indicates the severity level"}]},"NotificationDrawerList":{"name":"NotificationDrawerList","description":"","props":[{"name":"aria-label","type":"string","description":"Adds an accessible label to the notification drawer list."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the notification drawer list body"},{"name":"className","type":"string","description":"Additional classes added to the notification drawer list body","defaultValue":"''"},{"name":"isHidden","type":"boolean","description":"Adds styling to the notification drawer list to indicate expand/hide state","defaultValue":"false"}]},"NotificationDrawerListProps":{"name":"NotificationDrawerListProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the notification drawer list body"},{"name":"className","type":"string","description":"Additional classes added to the notification drawer list body"},{"name":"isHidden","type":"boolean","description":"Adds styling to the notification drawer list to indicate expand/hide state"},{"name":"Unknown","type":"string","description":"Adds an accessible label to the notification drawer list."}]},"NotificationDrawerHeader":{"name":"NotificationDrawerHeader","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the drawer"},{"name":"className","type":"string","description":"Additional classes for notification drawer header.","defaultValue":"''"},{"name":"closeButtonAriaLabel","type":"string","description":"Adds custom accessible text to the notification drawer close button.","defaultValue":"'Close'"},{"name":"count","type":"number","description":"Notification drawer heading count"},{"name":"customText","type":"string","description":"Notification drawer heading custom text which can be used instead of providing count/unreadText"},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"Callback for when close button is clicked"},{"name":"title","type":"string","description":"Notification drawer heading title","defaultValue":"'Notifications'"},{"name":"unreadText","type":"string","description":"Notification drawer heading unread text used in combination with a count","defaultValue":"'unread'"}]},"NotificationDrawerHeaderProps":{"name":"NotificationDrawerHeaderProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the drawer"},{"name":"className","type":"string","description":"Additional classes for notification drawer header."},{"name":"closeButtonAriaLabel","type":"string","description":"Adds custom accessible text to the notification drawer close button."},{"name":"count","type":"number","description":"Notification drawer heading count"},{"name":"customText","type":"string","description":"Notification drawer heading custom text which can be used instead of providing count/unreadText"},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"Callback for when close button is clicked"},{"name":"title","type":"string","description":"Notification drawer heading title"},{"name":"unreadText","type":"string","description":"Notification drawer heading unread text used in combination with a count"}]},"NotificationDrawerGroupList":{"name":"NotificationDrawerGroupList","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the notification drawer list body"},{"name":"className","type":"string","description":"Additional classes added to the notification drawer list body","defaultValue":"''"}]},"NotificationDrawerGroupListProps":{"name":"NotificationDrawerGroupListProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the notification drawer list body"},{"name":"className","type":"string","description":"Additional classes added to the notification drawer list body"}]},"NotificationDrawerGroup":{"name":"NotificationDrawerGroup","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the group"},{"name":"className","type":"string","description":"Additional classes added to the group","defaultValue":"''"},{"name":"count","type":"number","description":"Notification drawer group count","required":true},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Sets the heading level to use for the group title. Default is h1.","defaultValue":"'h1'"},{"name":"isExpanded","type":"boolean","description":"Adds styling to the group to indicate expanded state","required":true},{"name":"isRead","type":"boolean","description":"Adds styling to the group to indicate whether it has been read","defaultValue":"false"},{"name":"onExpand","type":"(event: any, value: boolean) => void","description":"Callback for when group button is clicked to expand","defaultValue":"(event: any, expanded: boolean) => undefined as any"},{"name":"title","type":"React.ReactNode","description":"Notification drawer group title","required":true},{"name":"tooltipPosition","type":"| TooltipPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Position of the tooltip which is displayed if text is truncated"},{"name":"truncateTitle","type":"number","description":"Truncate title to number of lines","defaultValue":"0"}]},"NotificationDrawerGroupProps":{"name":"NotificationDrawerGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the group"},{"name":"className","type":"string","description":"Additional classes added to the group"},{"name":"count","type":"number","description":"Notification drawer group count","required":true},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Sets the heading level to use for the group title. Default is h1."},{"name":"isExpanded","type":"boolean","description":"Adds styling to the group to indicate expanded state","required":true},{"name":"isRead","type":"boolean","description":"Adds styling to the group to indicate whether it has been read"},{"name":"onExpand","type":"(event: any, value: boolean) => void","description":"Callback for when group button is clicked to expand"},{"name":"title","type":"React.ReactNode","description":"Notification drawer group title","required":true},{"name":"tooltipPosition","type":"| TooltipPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Position of the tooltip which is displayed if text is truncated"},{"name":"truncateTitle","type":"number","description":"Truncate title to number of lines"}]},"NotificationDrawerBody":{"name":"NotificationDrawerBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the body of the notification drawer"},{"name":"className","type":"string","description":"Additional classes added to the notification drawer body","defaultValue":"''"}]},"NotificationDrawerBodyProps":{"name":"NotificationDrawerBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the body of the notification drawer"},{"name":"className","type":"string","description":"Additional classes added to the notification drawer body"}]},"NotificationDrawer":{"name":"NotificationDrawer","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the notification drawer"},{"name":"className","type":"string","description":"Additional classes added to the notification drawer"}]},"NotificationDrawerProps":{"name":"NotificationDrawerProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the notification drawer"},{"name":"className","type":"string","description":"Additional classes added to the notification drawer"},{"name":"innerRef","type":"React.Ref<any>","description":""}]},"NotificationBadge":{"name":"NotificationBadge","description":"","props":[{"name":"aria-label","type":"string","description":"Adds an accessible label to the notification badge."},{"name":"attentionIcon","type":"React.ReactNode","description":"Icon to display for attention variant.","defaultValue":"<AttentionBellIcon />"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the notification badge."},{"name":"className","type":"string","description":"Additional classes added to the notification badge."},{"name":"count","type":"number","description":"A number displayed in the badge alongside the icon.","defaultValue":"0"},{"name":"icon","type":"React.ReactNode","description":"Icon to display in the notification badge.","defaultValue":"<BellIcon />"},{"name":"isExpanded","type":"boolean","description":"Flag for applying expanded styling and setting the aria-expanded attribute on the\nnotification badge.","defaultValue":"false"},{"name":"onAnimationEnd","type":"(event: React.AnimationEvent<HTMLButtonElement>) => void","description":"Callback for when the animation of the notification badge icon ends."},{"name":"shouldNotify","type":"boolean","description":"Flag indicating whether the notification badge animation should be triggered. Each\ntime this prop is true, the animation will be triggered a single time.","defaultValue":"false"},{"name":"variant","type":"NotificationBadgeVariant | 'read' | 'unread' | 'attention'","description":"Determines the variant of the notification badge.","defaultValue":"NotificationBadgeVariant.read"}]},"NotificationBadgeProps":{"name":"NotificationBadgeProps","description":"","props":[{"name":"attentionIcon","type":"React.ReactNode","description":"Icon to display for attention variant."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the notification badge."},{"name":"className","type":"string","description":"Additional classes added to the notification badge."},{"name":"count","type":"number","description":"A number displayed in the badge alongside the icon."},{"name":"icon","type":"React.ReactNode","description":"Icon to display in the notification badge."},{"name":"isExpanded","type":"boolean","description":"Flag for applying expanded styling and setting the aria-expanded attribute on the\nnotification badge."},{"name":"onAnimationEnd","type":"(event: React.AnimationEvent<HTMLButtonElement>) => void","description":"Callback for when the animation of the notification badge icon ends."},{"name":"shouldNotify","type":"boolean","description":"Flag indicating whether the notification badge animation should be triggered. Each\ntime this prop is true, the animation will be triggered a single time."},{"name":"Unknown","type":"string","description":"Adds an accessible label to the notification badge."},{"name":"variant","type":"NotificationBadgeVariant | 'read' | 'unread' | 'attention'","description":"Determines the variant of the notification badge."}]},"NavList":{"name":"NavList","description":"","props":[{"name":"backScrollAriaLabel","type":"string","description":"Aria-label for the back scroll button","defaultValue":"'Scroll back'"},{"name":"children","type":"React.ReactNode","description":"Children nodes"},{"name":"className","type":"string","description":"Additional classes added to the list"},{"name":"forwardScrollAriaLabel","type":"string","description":"Aria-label for the forward scroll button","defaultValue":"'Scroll foward'"}]},"NavListProps":{"name":"NavListProps","description":"","props":[{"name":"backScrollAriaLabel","type":"string","description":"Aria-label for the back scroll button"},{"name":"children","type":"React.ReactNode","description":"Children nodes"},{"name":"className","type":"string","description":"Additional classes added to the list"},{"name":"forwardScrollAriaLabel","type":"string","description":"Aria-label for the forward scroll button"}]},"NavItemSeparator":{"name":"NavItemSeparator","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the divider"},{"name":"component","type":"'hr' | 'li' | 'div'","description":"The component type to use","defaultValue":"'li'"},{"name":"inset","type":"{\n default?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n sm?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n md?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n lg?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n xl?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n '2xl'?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n}","description":"Insets at various breakpoints."},{"name":"orientation","type":"{\n default?: 'vertical' | 'horizontal';\n sm?: 'vertical' | 'horizontal';\n md?: 'vertical' | 'horizontal';\n lg?: 'vertical' | 'horizontal';\n xl?: 'vertical' | 'horizontal';\n '2xl'?: 'vertical' | 'horizontal';\n}","description":"Indicates how the divider will display at various breakpoints. Vertical divider must be in a flex layout."}]},"NavItem":{"name":"NavItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the nav item."},{"name":"className","type":"string","description":"Additional classes added to the nav item"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Component used to render NavItems if React.isValidElement(children) is false","defaultValue":"'a'"},{"name":"flyout","type":"React.ReactElement<any>","description":"Flyout of a nav item. This should be a Menu component. Should not be used if the to prop is defined."},{"name":"groupId","type":"string | number | null","description":"Group identifier, will be returned with the onToggle and onSelect callback passed to the Nav component","defaultValue":"null"},{"name":"icon","type":"React.ReactNode","description":"Icon added before the nav item children."},{"name":"isActive","type":"boolean","description":"Flag indicating whether the item is active","defaultValue":"false"},{"name":"itemId","type":"string | number | null","description":"Item identifier, will be returned with the onToggle and onSelect callback passed to the Nav component","defaultValue":"null"},{"name":"onClick","type":"(\n event: React.FormEvent<HTMLInputElement>,\n itemId: number | string,\n groupId: number | string,\n to: string\n) => void","description":"Callback for item click"},{"name":"onShowFlyout","type":"() => void","description":"Callback when flyout is opened or closed"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"preventDefault","type":"boolean","description":"If true prevents the default anchor link action to occur. Set to true if you want to handle navigation yourself.","defaultValue":"false"},{"name":"styleChildren","type":"boolean","description":"Whether to set className on children when React.isValidElement(children)","defaultValue":"true"},{"name":"to","type":"string","description":"Target navigation link. Should not be used if the flyout prop is defined."},{"name":"zIndex","type":"number","description":"z-index of the flyout nav item","defaultValue":"9999"}]},"NavItemProps":{"name":"NavItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the nav item."},{"name":"className","type":"string","description":"Additional classes added to the nav item"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Component used to render NavItems if React.isValidElement(children) is false"},{"name":"flyout","type":"React.ReactElement<any>","description":"Flyout of a nav item. This should be a Menu component. Should not be used if the to prop is defined."},{"name":"groupId","type":"string | number | null","description":"Group identifier, will be returned with the onToggle and onSelect callback passed to the Nav component"},{"name":"icon","type":"React.ReactNode","description":"Icon added before the nav item children."},{"name":"isActive","type":"boolean","description":"Flag indicating whether the item is active"},{"name":"itemId","type":"string | number | null","description":"Item identifier, will be returned with the onToggle and onSelect callback passed to the Nav component"},{"name":"onClick","type":"NavSelectClickHandler","description":"Callback for item click"},{"name":"onShowFlyout","type":"() => void","description":"Callback when flyout is opened or closed"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"preventDefault","type":"boolean","description":"If true prevents the default anchor link action to occur. Set to true if you want to handle navigation yourself."},{"name":"styleChildren","type":"boolean","description":"Whether to set className on children when React.isValidElement(children)"},{"name":"to","type":"string","description":"Target navigation link. Should not be used if the flyout prop is defined."},{"name":"zIndex","type":"number","description":"z-index of the flyout nav item"}]},"NavGroup":{"name":"NavGroup","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the group","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the container","defaultValue":"''"},{"name":"id","type":"string","description":"Identifier to use for the section aria label","defaultValue":"getUniqueId()"},{"name":"title","type":"string","description":"Title shown for the group"}]},"NavGroupProps":{"name":"NavGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the group"},{"name":"className","type":"string","description":"Additional classes added to the container"},{"name":"id","type":"string","description":"Identifier to use for the section aria label"},{"name":"title","type":"string","description":"Title shown for the group"}]},"NavExpandable":{"name":"NavExpandable","description":"","props":[{"name":"buttonProps","type":"any","description":"Additional props added to the NavExpandable <button>"},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the expandable list","defaultValue":"''"},{"name":"className","type":"string","description":"Additional classes added to the container","defaultValue":"''"},{"name":"groupId","type":"string | number","description":"Group identifier, will be returned with the onToggle and onSelect callback passed to the Nav component","defaultValue":"null"},{"name":"id","type":"string","description":"Identifier to use for the section aria label","defaultValue":"''"},{"name":"isActive","type":"boolean","description":"If true makes the expandable list title active","defaultValue":"false"},{"name":"isExpanded","type":"boolean","description":"Boolean to pragmatically expand or collapse section","defaultValue":"false"},{"name":"onExpand","type":"(event: React.MouseEvent<HTMLButtonElement, MouseEvent>, val: boolean) => void","description":"allow consumer to optionally override this callback and manage expand state externally. if passed will not call Nav's onToggle."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":""},{"name":"srText","type":"string","description":"If defined, screen readers will read this text instead of the list title","defaultValue":"''"},{"name":"title","type":"React.ReactNode","description":"Title content shown for the expandable list","required":true}]},"NavExpandableProps":{"name":"NavExpandableProps","description":"","props":[{"name":"buttonProps","type":"any","description":"Additional props added to the NavExpandable <button>"},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the expandable list"},{"name":"className","type":"string","description":"Additional classes added to the container"},{"name":"groupId","type":"string | number","description":"Group identifier, will be returned with the onToggle and onSelect callback passed to the Nav component"},{"name":"id","type":"string","description":"Identifier to use for the section aria label"},{"name":"isActive","type":"boolean","description":"If true makes the expandable list title active"},{"name":"isExpanded","type":"boolean","description":"Boolean to pragmatically expand or collapse section"},{"name":"onExpand","type":"(event: React.MouseEvent<HTMLButtonElement, MouseEvent>, val: boolean) => void","description":"allow consumer to optionally override this callback and manage expand state externally. if passed will not call Nav's onToggle."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"srText","type":"string","description":"If defined, screen readers will read this text instead of the list title"},{"name":"title","type":"React.ReactNode","description":"Title content shown for the expandable list","required":true}]},"NavExpandableState":{"name":"NavExpandableState","description":"","props":[{"name":"expandedState","type":"boolean","description":null,"required":true},{"name":"ouiaStateId","type":"string","description":null,"required":true}]},"Nav":{"name":"Nav","description":"","props":[{"name":"aria-label","type":"string","description":"Accessible label for the nav when there are multiple navs on the page"},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the nav"},{"name":"className","type":"string","description":"Additional classes added to the container"},{"name":"onSelect","type":"(\n event: React.FormEvent<HTMLInputElement>,\n selectedItem: {\n groupId: number | string;\n itemId: number | string;\n to: string;\n }\n) => void","description":"Callback for updating when item selection changes","defaultValue":"() => undefined"},{"name":"onToggle","type":"(\n event: React.MouseEvent<HTMLButtonElement>,\n toggledItem: {\n groupId: number | string;\n isExpanded: boolean;\n }\n) => void","description":"Callback for when a list is expanded or collapsed","defaultValue":"() => undefined"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"},{"name":"variant","type":"'default' | 'horizontal' | 'horizontal-subnav'","description":"For horizontal navs"}]},"NavProps":{"name":"NavProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the nav"},{"name":"className","type":"string","description":"Additional classes added to the container"},{"name":"onSelect","type":"(\n event: React.FormEvent<HTMLInputElement>,\n selectedItem: {\n groupId: number | string;\n itemId: number | string;\n to: string;\n }\n ) => void","description":"Callback for updating when item selection changes"},{"name":"onToggle","type":"(\n event: React.MouseEvent<HTMLButtonElement>,\n toggledItem: {\n groupId: number | string;\n isExpanded: boolean;\n }\n ) => void","description":"Callback for when a list is expanded or collapsed"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"Unknown","type":"string","description":"Accessible label for the nav when there are multiple navs on the page"},{"name":"variant","type":"'default' | 'horizontal' | 'horizontal-subnav'","description":"For horizontal navs"}]},"NavContextProps":{"name":"NavContextProps","description":"","props":[{"name":"flyoutRef","type":"React.Ref<HTMLLIElement>","description":null},{"name":"isHorizontal","type":"boolean","description":null},{"name":"navRef","type":"React.RefObject<HTMLElement | null>","description":null},{"name":"onSelect","type":"(\n event: React.FormEvent<HTMLInputElement>,\n groupId: number | string,\n itemId: number | string,\n to: string,\n preventDefault: boolean,\n onClick: NavSelectClickHandler\n ) => void","description":null},{"name":"onToggle","type":"(event: React.MouseEvent<HTMLButtonElement>, groupId: number | string, expanded: boolean) => void","description":null},{"name":"setFlyoutRef","type":"(ref: React.Ref<HTMLLIElement>) => void","description":null},{"name":"updateIsScrollable","type":"(isScrollable: boolean) => void","description":null}]},"NavSelectClickHandler":{"name":"NavSelectClickHandler","description":"","props":[]},"MultipleFileUploadTitleTextSeparator":{"name":"MultipleFileUploadTitleTextSeparator","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside multiple file upload title text separator"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"MultipleFileUploadTitleTextSeparatorProps":{"name":"MultipleFileUploadTitleTextSeparatorProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside multiple file upload title text separator"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"MultipleFileUploadTitleText":{"name":"MultipleFileUploadTitleText","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside multiple file upload title text"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"MultipleFileUploadTitleTextProps":{"name":"MultipleFileUploadTitleTextProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside multiple file upload title text"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"MultipleFileUploadTitleIcon":{"name":"MultipleFileUploadTitleIcon","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside multiple file upload title icon"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"MultipleFileUploadTitleIconProps":{"name":"MultipleFileUploadTitleIconProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside multiple file upload title icon"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"MultipleFileUploadTitle":{"name":"MultipleFileUploadTitle","description":"","props":[{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"icon","type":"React.ReactNode","description":"Content rendered inside the title icon div"},{"name":"text","type":"React.ReactNode","description":"Content rendered inside the title text div","defaultValue":"''"},{"name":"textSeparator","type":"React.ReactNode","description":"Content rendered inside the title text separator div","defaultValue":"''"}]},"MultipleFileUploadTitleProps":{"name":"MultipleFileUploadTitleProps","description":"","props":[{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"icon","type":"React.ReactNode","description":"Content rendered inside the title icon div"},{"name":"text","type":"React.ReactNode","description":"Content rendered inside the title text div"},{"name":"textSeparator","type":"React.ReactNode","description":"Content rendered inside the title text separator div"}]},"MultipleFileUploadStatusItem":{"name":"MultipleFileUploadStatusItem","description":"Automatically reads an uploaded file to render a visual representation of it, including\nits name, size, and read status. This sub-component also allows custom reading of files\nvia various callbacks which will override the automatic reading behavior.","props":[{"name":"buttonAriaLabel","type":"string","description":"Adds accessibility text to the status item deletion button","defaultValue":"'Remove from list'"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"customFileHandler","type":"(file: File) => void","description":"A callback to process file reading in a custom way"},{"name":"file","type":"File","description":"The file object being represented by the status item"},{"name":"fileIcon","type":"React.ReactNode","description":"A custom icon to show in place of the generic file icon"},{"name":"fileName","type":"string","description":"A custom name to display for the file rather than using built in functionality to auto-fill it"},{"name":"fileSize","type":"number","description":"A custom file size to display for the file rather than using built in functionality to auto-fill it"},{"name":"onClearClick","type":"React.MouseEventHandler<HTMLButtonElement>","description":"Clear button was clicked","defaultValue":"() => {}"},{"name":"onReadFail","type":"(error: DOMException, onReadFail: File) => void","description":"A callback for when the FileReader API fails","defaultValue":"() => {}"},{"name":"onReadFinished","type":"(fileHandle: File) => void","description":"A callback for when a selected file finishes loading","defaultValue":"() => {}"},{"name":"onReadStarted","type":"(fileHandle: File) => void","description":"A callback for when a selected file starts loading","defaultValue":"() => {}"},{"name":"onReadSuccess","type":"(data: string, file: File) => void","description":"A callback for when the FileReader successfully reads the file","defaultValue":"() => {}"},{"name":"progressAriaLabel","type":"string","description":"Adds accessible text to the progress bar. Required when title not used and there is not any label associated with the progress bar"},{"name":"progressAriaLabelledBy","type":"string","description":"Associates the progress bar with it's label for accessibility purposes. Required when title not used"},{"name":"progressAriaLiveMessage","type":"string | ((loadPercentage: number) => string)","description":"Modifies the text announced by assistive technologies when the progress bar updates."},{"name":"progressHelperText","type":"React.ReactNode","description":"Additional content related to the status item."},{"name":"progressId","type":"string","description":"Unique identifier for progress. Generated if not specified."},{"name":"progressValue","type":"number","description":"A custom value to display for the progress component rather than using built in functionality to auto-fill it"},{"name":"progressVariant","type":"'danger' | 'success' | 'warning'","description":"A custom variant to apply to the progress component rather than using built in functionality to auto-fill it"}]},"MultipleFileUploadStatusItemProps":{"name":"MultipleFileUploadStatusItemProps","description":"Automatically reads an uploaded file to render a visual representation of it, including\nits name, size, and read status. This sub-component also allows custom reading of files\nvia various callbacks which will override the automatic reading behavior.","props":[{"name":"buttonAriaLabel","type":"string","description":"Adds accessibility text to the status item deletion button"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"customFileHandler","type":"(file: File) => void","description":"A callback to process file reading in a custom way"},{"name":"file","type":"File","description":"The file object being represented by the status item"},{"name":"fileIcon","type":"React.ReactNode","description":"A custom icon to show in place of the generic file icon"},{"name":"fileName","type":"string","description":"A custom name to display for the file rather than using built in functionality to auto-fill it"},{"name":"fileSize","type":"number","description":"A custom file size to display for the file rather than using built in functionality to auto-fill it"},{"name":"onClearClick","type":"React.MouseEventHandler<HTMLButtonElement>","description":"Clear button was clicked"},{"name":"onReadFail","type":"(error: DOMException, onReadFail: File) => void","description":"A callback for when the FileReader API fails"},{"name":"onReadFinished","type":"(fileHandle: File) => void","description":"A callback for when a selected file finishes loading"},{"name":"onReadStarted","type":"(fileHandle: File) => void","description":"A callback for when a selected file starts loading"},{"name":"onReadSuccess","type":"(data: string, file: File) => void","description":"A callback for when the FileReader successfully reads the file"},{"name":"progressAriaLabel","type":"string","description":"Adds accessible text to the progress bar. Required when title not used and there is not any label associated with the progress bar"},{"name":"progressAriaLabelledBy","type":"string","description":"Associates the progress bar with it's label for accessibility purposes. Required when title not used"},{"name":"progressAriaLiveMessage","type":"string | ((loadPercentage: number) => string)","description":"Modifies the text announced by assistive technologies when the progress bar updates."},{"name":"progressHelperText","type":"React.ReactNode","description":"Additional content related to the status item."},{"name":"progressId","type":"string","description":"Unique identifier for progress. Generated if not specified."},{"name":"progressValue","type":"number","description":"A custom value to display for the progress component rather than using built in functionality to auto-fill it"},{"name":"progressVariant","type":"'danger' | 'success' | 'warning'","description":"A custom variant to apply to the progress component rather than using built in functionality to auto-fill it"}]},"MultipleFileUploadStatus":{"name":"MultipleFileUploadStatus","description":"Acts as an expandable container for all uploaded file statuses.\nAn optional text and/or icon can also be passed into this sub-component.\nThis sub-component can be conditionally rendered when at least 1 file has been\nattempted to be uploaded.","props":[{"name":"aria-label","type":"string","description":"Adds an accessible label to the list of status items."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside multi file upload status list"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"statusToggleIcon","type":"'danger' | 'success' | 'inProgress' | React.ReactNode","description":"Icon to show in the status toggle"},{"name":"statusToggleText","type":"string","description":"String to show in the status toggle"}]},"MultipleFileUploadStatusProps":{"name":"MultipleFileUploadStatusProps","description":"Acts as an expandable container for all uploaded file statuses.\nAn optional text and/or icon can also be passed into this sub-component.\nThis sub-component can be conditionally rendered when at least 1 file has been\nattempted to be uploaded.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside multi file upload status list"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"statusToggleIcon","type":"'danger' | 'success' | 'inProgress' | React.ReactNode","description":"Icon to show in the status toggle"},{"name":"statusToggleText","type":"string","description":"String to show in the status toggle"},{"name":"Unknown","type":"string","description":"Adds an accessible label to the list of status items."}]},"MultipleFileUploadMain":{"name":"MultipleFileUploadMain","description":"Creates the visual upload interface, including the area to drag and drop files,\nan optional upload button, and descriptive instructions.","props":[{"name":"browseButtonText","type":"string","description":"Visible text label for the upload button","defaultValue":"'Upload'"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"infoText","type":"React.ReactNode","description":"Content rendered inside the info div"},{"name":"isUploadButtonHidden","type":"boolean","description":"Flag to prevent the upload button from being rendered"},{"name":"titleIcon","type":"React.ReactNode","description":"Content rendered inside the title icon div"},{"name":"titleText","type":"React.ReactNode","description":"Content rendered inside the title text div"},{"name":"titleTextSeparator","type":"React.ReactNode","description":"Content rendered inside the title text separator div"}]},"MultipleFileUploadMainProps":{"name":"MultipleFileUploadMainProps","description":"Creates the visual upload interface, including the area to drag and drop files,\nan optional upload button, and descriptive instructions.","props":[{"name":"browseButtonText","type":"string","description":"Visible text label for the upload button"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"infoText","type":"React.ReactNode","description":"Content rendered inside the info div"},{"name":"isUploadButtonHidden","type":"boolean","description":"Flag to prevent the upload button from being rendered"},{"name":"titleIcon","type":"React.ReactNode","description":"Content rendered inside the title icon div"},{"name":"titleText","type":"React.ReactNode","description":"Content rendered inside the title text div"},{"name":"titleTextSeparator","type":"React.ReactNode","description":"Content rendered inside the title text separator div"}]},"MultipleFileUploadInfo":{"name":"MultipleFileUploadInfo","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside multiple file upload info"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"MultipleFileUploadInfoProps":{"name":"MultipleFileUploadInfoProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside multiple file upload info"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"MultipleFileUploadButton":{"name":"MultipleFileUploadButton","description":"","props":[{"name":"aria-label","type":"string","description":"Aria-label for the button"},{"name":"browseButtonText","type":"string","description":"Visible text label for the button","defaultValue":"'Upload'"},{"name":"className","type":"string","description":"Class to add to outer div"}]},"MultipleFileUploadButtonProps":{"name":"MultipleFileUploadButtonProps","description":"","props":[{"name":"browseButtonText","type":"string","description":"Visible text label for the button"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"Unknown","type":"string","description":"Aria-label for the button"}]},"MultipleFileUpload":{"name":"MultipleFileUpload","description":"Acts as a container for all other MultipleFileUpload sub-components. This sub-component\nalso provides the functionality for file uploads, and access to the uploaded files via\na callback.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the multi upload field"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"dropzoneProps","type":"DropzoneOptions","description":"Optional extra props to customize react-dropzone.","defaultValue":"{}"},{"name":"isHorizontal","type":"boolean","description":"Flag setting the component to horizontal styling mode"},{"name":"onFileDrop","type":"(event: DropEvent, data: File[]) => void","description":"When files are dropped or uploaded this callback will be called with all accepted files","defaultValue":"() => {}"}]},"MultipleFileUploadProps":{"name":"MultipleFileUploadProps","description":"Acts as a container for all other MultipleFileUpload sub-components. This sub-component\nalso provides the functionality for file uploads, and access to the uploaded files via\na callback.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the multi upload field"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"dropzoneProps","type":"DropzoneOptions","description":"Optional extra props to customize react-dropzone."},{"name":"isHorizontal","type":"boolean","description":"Flag setting the component to horizontal styling mode"},{"name":"onFileDrop","type":"(event: DropEvent, data: File[]) => void","description":"When files are dropped or uploaded this callback will be called with all accepted files"}]},"ModalHeader":{"name":"ModalHeader","description":"Renders content in the header of the modal","props":[{"name":"children","type":"React.ReactNode","description":"Custom content rendered inside the modal header. If children are supplied then the tile, tileIconVariant and titleScreenReaderText props are ignored."},{"name":"className","type":"string","description":"Additional classes added to the modal header."},{"name":"description","type":"React.ReactNode","description":"Description of the modal."},{"name":"descriptorId","type":"string","description":"Id of the modal description."},{"name":"help","type":"React.ReactNode","description":"Optional help section for the modal header."},{"name":"labelId","type":"string","description":"Id of the modal title."},{"name":"title","type":"React.ReactNode","description":"Content rendered inside the modal title."},{"name":"titleIconVariant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom' | React.ComponentType<any>","description":"Optional alert icon (or other) to show before the title. When the predefined alert types\nare used the default styling will be automatically applied."},{"name":"titleScreenReaderText","type":"string","description":"Optional title label text for screen readers."}]},"ModalHeaderProps":{"name":"ModalHeaderProps","description":"Renders content in the header of the modal","props":[{"name":"children","type":"React.ReactNode","description":"Custom content rendered inside the modal header. If children are supplied then the tile, tileIconVariant and titleScreenReaderText props are ignored."},{"name":"className","type":"string","description":"Additional classes added to the modal header."},{"name":"description","type":"React.ReactNode","description":"Description of the modal."},{"name":"descriptorId","type":"string","description":"Id of the modal description."},{"name":"help","type":"React.ReactNode","description":"Optional help section for the modal header."},{"name":"labelId","type":"string","description":"Id of the modal title."},{"name":"title","type":"React.ReactNode","description":"Content rendered inside the modal title."},{"name":"titleIconVariant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom' | React.ComponentType<any>","description":"Optional alert icon (or other) to show before the title. When the predefined alert types\nare used the default styling will be automatically applied."},{"name":"titleScreenReaderText","type":"string","description":"Optional title label text for screen readers."}]},"ModalFooter":{"name":"ModalFooter","description":"Renders content in the footer of the modal","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal footer."},{"name":"className","type":"string","description":"Additional classes added to the modal footer."}]},"ModalFooterProps":{"name":"ModalFooterProps","description":"Renders content in the footer of the modal","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal footer."},{"name":"className","type":"string","description":"Additional classes added to the modal footer."}]},"ModalContent":{"name":"ModalContent","description":"","props":[{"name":"aria-describedby","type":"string","description":"Id to use for the modal box description. This should match the ModalHeader labelId or descriptorId."},{"name":"aria-label","type":"string","description":"Accessible descriptor of the modal."},{"name":"aria-labelledby","type":"string","description":"Id to use for the modal box label. This should include the ModalHeader labelId."},{"name":"backdropClassName","type":"string","description":"Additional classes added to the modal backdrop."},{"name":"backdropId","type":"string","description":"Id of the backdrop."},{"name":"boxId","type":"string","description":"Id of the modal box container.","required":true},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal.","required":true},{"name":"className","type":"string","description":"Additional classes added to the modal box."},{"name":"disableFocusTrap","type":"boolean","description":"Flag to disable focus trap.","defaultValue":"false"},{"name":"elementToFocus","type":"HTMLElement | SVGElement | string","description":"The element to focus when the modal opens. By default the first\nfocusable element will receive focus."},{"name":"isOpen","type":"boolean","description":"Flag to show the modal.","defaultValue":"false"},{"name":"maxWidth","type":"number | string","description":"Maximum width of the modal."},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"A callback for when the close button is clicked."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"},{"name":"position","type":"'default' | 'top'","description":"Position of the modal. By default a modal will be positioned vertically and horizontally centered."},{"name":"positionOffset","type":"string","description":"Offset from alternate position. Can be any valid CSS length/percentage."},{"name":"variant","type":"'small' | 'medium' | 'large' | 'default'","description":"Variant of the modal.","defaultValue":"'default'"},{"name":"width","type":"number | string","description":"Default width of the modal."}]},"ModalContentProps":{"name":"ModalContentProps","description":"","props":[{"name":"backdropClassName","type":"string","description":"Additional classes added to the modal backdrop."},{"name":"backdropId","type":"string","description":"Id of the backdrop."},{"name":"boxId","type":"string","description":"Id of the modal box container.","required":true},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal.","required":true},{"name":"className","type":"string","description":"Additional classes added to the modal box."},{"name":"disableFocusTrap","type":"boolean","description":"Flag to disable focus trap."},{"name":"elementToFocus","type":"HTMLElement | SVGElement | string","description":"The element to focus when the modal opens. By default the first\nfocusable element will receive focus."},{"name":"isOpen","type":"boolean","description":"Flag to show the modal."},{"name":"maxWidth","type":"number | string","description":"Maximum width of the modal."},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"A callback for when the close button is clicked."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"position","type":"'default' | 'top'","description":"Position of the modal. By default a modal will be positioned vertically and horizontally centered."},{"name":"positionOffset","type":"string","description":"Offset from alternate position. Can be any valid CSS length/percentage."},{"name":"Unknown","type":"string","description":"Id to use for the modal box label. This should include the ModalHeader labelId."},{"name":"variant","type":"'small' | 'medium' | 'large' | 'default'","description":"Variant of the modal."},{"name":"width","type":"number | string","description":"Default width of the modal."}]},"ModalBoxTitle":{"name":"ModalBoxTitle","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the modal box title."},{"name":"id","type":"string","description":"Id of the modal box title."},{"name":"title","type":"React.ReactNode","description":"Content rendered inside the modal box title.","required":true},{"name":"titleIconVariant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom' | React.ComponentType<any>","description":"Optional alert icon (or other) to show before the title. When the predefined alert types\nare used the default styling will be automatically applied."},{"name":"titleScreenReaderText","type":"string","description":"Optional title label text for screen readers."}]},"ModalBoxTitleProps":{"name":"ModalBoxTitleProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the modal box title."},{"name":"id","type":"string","description":"Id of the modal box title."},{"name":"title","type":"React.ReactNode","description":"Content rendered inside the modal box title.","required":true},{"name":"titleIconVariant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom' | React.ComponentType<any>","description":"Optional alert icon (or other) to show before the title. When the predefined alert types\nare used the default styling will be automatically applied."},{"name":"titleScreenReaderText","type":"string","description":"Optional title label text for screen readers."}]},"ModalBoxDescription":{"name":"ModalBoxDescription","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the description.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the description.","defaultValue":"''"},{"name":"id","type":"string","description":"Id of the description.","defaultValue":"''"}]},"ModalBoxDescriptionProps":{"name":"ModalBoxDescriptionProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the description."},{"name":"className","type":"string","description":"Additional classes added to the description."},{"name":"id","type":"string","description":"Id of the description."}]},"ModalBoxCloseButton":{"name":"ModalBoxCloseButton","description":"","props":[{"name":"aria-label","type":"string","description":"Accessible descriptor of the close button.","defaultValue":"'Close'"},{"name":"className","type":"string","description":"Additional classes added to the close button."},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"A callback for when the close button is clicked."},{"name":"ouiaId","type":"number | string","description":"Value to set the data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":""}]},"ModalBoxCloseButtonProps":{"name":"ModalBoxCloseButtonProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the close button."},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"A callback for when the close button is clicked."},{"name":"ouiaId","type":"number | string","description":"Value to set the data-ouia-component-id."},{"name":"Unknown","type":"string","description":"Accessible descriptor of the close button."}]},"ModalBox":{"name":"ModalBox","description":"","props":[{"name":"aria-describedby","type":"string","description":"Id to use for the modal box description. This should match the ModalHeader labelId or descriptorId"},{"name":"aria-label","type":"string","description":"Adds an accessible name to the modal when there is no title in the ModalHeader."},{"name":"aria-labelledby","type":"string","description":"Id to use for the modal box label."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal box.","required":true},{"name":"className","type":"string","description":"Additional classes added to the modal box."},{"name":"position","type":"'default' | 'top'","description":"Position of the modal. By default a modal will be positioned vertically and horizontally centered."},{"name":"positionOffset","type":"string","description":"Offset from alternate position. Can be any valid CSS length/percentage."},{"name":"variant","type":"'small' | 'medium' | 'large' | 'default'","description":"Variant of the modal.","defaultValue":"'default'"}]},"ModalBoxProps":{"name":"ModalBoxProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal box.","required":true},{"name":"className","type":"string","description":"Additional classes added to the modal box."},{"name":"position","type":"'default' | 'top'","description":"Position of the modal. By default a modal will be positioned vertically and horizontally centered."},{"name":"positionOffset","type":"string","description":"Offset from alternate position. Can be any valid CSS length/percentage."},{"name":"Unknown","type":"string","description":"Id to use for the modal box label."},{"name":"variant","type":"'small' | 'medium' | 'large' | 'default'","description":"Variant of the modal."}]},"ModalBody":{"name":"ModalBody","description":"Renders content in the body of the modal","props":[{"name":"aria-label","type":"string","description":"Accessible label applied to the modal body. This should be used to communicate\nimportant information about the modal body div element if needed, such as when it is scrollable."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal body."},{"name":"className","type":"string","description":"Additional classes added to the modal body."},{"name":"role","type":"string","description":"Accessible role applied to the modal body. This will default to \"region\" if the\naria-label property is passed in. Set to a more appropriate role as applicable\nbased on the modal content and context."}]},"ModalBodyProps":{"name":"ModalBodyProps","description":"Renders content in the body of the modal","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal body."},{"name":"className","type":"string","description":"Additional classes added to the modal body."},{"name":"role","type":"string","description":"Accessible role applied to the modal body. This will default to \"region\" if the\naria-label property is passed in. Set to a more appropriate role as applicable\nbased on the modal content and context."},{"name":"Unknown","type":"string","description":"Accessible label applied to the modal body. This should be used to communicate\nimportant information about the modal body div element if needed, such as when it is scrollable."}]},"Modal":{"name":"Modal","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement)","description":"The parent container to append the modal to. Defaults to \"document.body\".","defaultValue":"() => document.body"},{"name":"aria-describedby","type":"string","description":"Id to use for the modal box description. This should match the ModalHeader labelId or descriptorId."},{"name":"aria-label","type":"string","description":"Adds an accessible name to the modal when there is no title in the ModalHeader."},{"name":"aria-labelledby","type":"string","description":"Id to use for the modal box label. This should include the ModalHeader labelId."},{"name":"backdropClassName","type":"string","description":"Additional classes added to the modal backdrop."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal.","required":true},{"name":"className","type":"string","description":"Additional classes added to the modal."},{"name":"disableFocusTrap","type":"boolean","description":"Flag to disable focus trap."},{"name":"elementToFocus","type":"HTMLElement | SVGElement | string","description":"The element to focus when the modal opens. By default the first\nfocusable element will receive focus."},{"name":"id","type":"string","description":"An id to use for the modal box container."},{"name":"isOpen","type":"boolean","description":"Flag to show the modal.","defaultValue":"false"},{"name":"maxWidth","type":"number | string","description":"Maximum width of the modal."},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"Add callback for when the close button is clicked. This prop needs to be passed to render the close button"},{"name":"onEscapePress","type":"(event: KeyboardEvent) => void","description":"Modal handles pressing of the escape key and closes the modal. If you want to handle\nthis yourself you can use this callback function."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"},{"name":"position","type":"'default' | 'top'","description":"Position of the modal. By default a modal will be positioned vertically and horizontally centered.","defaultValue":"'default'"},{"name":"positionOffset","type":"string","description":"Offset from alternate position. Can be any valid CSS length/percentage."},{"name":"variant","type":"'small' | 'medium' | 'large' | 'default'","description":"Variant of the modal.","defaultValue":"'default'"},{"name":"width","type":"number | string","description":"Default width of the modal."}]},"ModalProps":{"name":"ModalProps","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement)","description":"The parent container to append the modal to. Defaults to \"document.body\"."},{"name":"backdropClassName","type":"string","description":"Additional classes added to the modal backdrop."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal.","required":true},{"name":"className","type":"string","description":"Additional classes added to the modal."},{"name":"disableFocusTrap","type":"boolean","description":"Flag to disable focus trap."},{"name":"elementToFocus","type":"HTMLElement | SVGElement | string","description":"The element to focus when the modal opens. By default the first\nfocusable element will receive focus."},{"name":"id","type":"string","description":"An id to use for the modal box container."},{"name":"isOpen","type":"boolean","description":"Flag to show the modal."},{"name":"maxWidth","type":"number | string","description":"Maximum width of the modal."},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"Add callback for when the close button is clicked. This prop needs to be passed to render the close button"},{"name":"onEscapePress","type":"(event: KeyboardEvent) => void","description":"Modal handles pressing of the escape key and closes the modal. If you want to handle\nthis yourself you can use this callback function."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"position","type":"'default' | 'top'","description":"Position of the modal. By default a modal will be positioned vertically and horizontally centered."},{"name":"positionOffset","type":"string","description":"Offset from alternate position. Can be any valid CSS length/percentage."},{"name":"Unknown","type":"string","description":"Id to use for the modal box label. This should include the ModalHeader labelId."},{"name":"variant","type":"'small' | 'medium' | 'large' | 'default'","description":"Variant of the modal."},{"name":"width","type":"number | string","description":"Default width of the modal."}]},"ModalState":{"name":"ModalState","description":"","props":[{"name":"ouiaStateId","type":"string","description":null,"required":true}]},"MenuToggleCheckbox":{"name":"MenuToggleCheckbox","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Element to be rendered inside the <span>"},{"name":"className","type":"string","description":"Additional classes added to the MenuToggleCheckbox"},{"name":"defaultChecked","type":"boolean","description":"Flag to set the default checked value of the checkbox when it is uncontrolled by React state.\nTo make the checkbox controlled instead use the isChecked prop, but do not use both."},{"name":"id","type":"string","description":"Id of the checkbox","required":true},{"name":"isChecked","type":"boolean | null","description":"Flag to show if the checkbox is checked when it is controlled by React state.\nTo make the checkbox uncontrolled instead use the defaultChecked prop, but do not use both."},{"name":"isDisabled","type":"boolean","description":"Flag to show if the checkbox is disabled","defaultValue":"false"},{"name":"isValid","type":"boolean","description":"Flag to show if the checkbox selection is valid or invalid","defaultValue":"true"},{"name":"onChange","type":"(checked: boolean, event: React.FormEvent<HTMLInputElement>) => void","description":"A callback for when the checkbox selection changes","defaultValue":"() => undefined as any"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."}]},"MenuToggleCheckboxProps":{"name":"MenuToggleCheckboxProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Element to be rendered inside the <span>"},{"name":"className","type":"string","description":"Additional classes added to the MenuToggleCheckbox"},{"name":"defaultChecked","type":"boolean","description":"Flag to set the default checked value of the checkbox when it is uncontrolled by React state.\nTo make the checkbox controlled instead use the isChecked prop, but do not use both."},{"name":"id","type":"string","description":"Id of the checkbox","required":true},{"name":"isChecked","type":"boolean | null","description":"Flag to show if the checkbox is checked when it is controlled by React state.\nTo make the checkbox uncontrolled instead use the defaultChecked prop, but do not use both."},{"name":"isDisabled","type":"boolean","description":"Flag to show if the checkbox is disabled"},{"name":"isValid","type":"boolean","description":"Flag to show if the checkbox selection is valid or invalid"},{"name":"onChange","type":"(checked: boolean, event: React.FormEvent<HTMLInputElement>) => void","description":"A callback for when the checkbox selection changes"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."}]},"MenuToggleAction":{"name":"MenuToggleAction","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Element to be rendered inside the <button>"},{"name":"className","type":"string","description":"Additional classes added to the MenuToggleAction","defaultValue":"''"},{"name":"id","type":"string","description":"Id of the action button"},{"name":"isDisabled","type":"boolean","description":"Flag to show if the action button is disabled","defaultValue":"false"},{"name":"onClick","type":"(event: React.MouseEvent<HTMLButtonElement>) => void","description":"A callback for when the action button is clicked","defaultValue":"() => {}"}]},"MenuToggleActionProps":{"name":"MenuToggleActionProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Element to be rendered inside the <button>"},{"name":"className","type":"string","description":"Additional classes added to the MenuToggleAction"},{"name":"id","type":"string","description":"Id of the action button"},{"name":"isDisabled","type":"boolean","description":"Flag to show if the action button is disabled"},{"name":"onClick","type":"(event: React.MouseEvent<HTMLButtonElement>) => void","description":"A callback for when the action button is clicked"}]},"MenuToggle":{"name":"MenuToggle","description":"","props":[{"name":"badge","type":"BadgeProps | React.ReactNode","description":"Optional badge rendered inside the toggle, after the children content"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the toggle"},{"name":"className","type":"string","description":"Additional classes added to the toggle"},{"name":"icon","type":"React.ReactNode","description":"Optional icon or image rendered inside the toggle, before the children content. It is\nrecommended to wrap most basic icons in our icon component."},{"name":"isDisabled","type":"boolean","description":"Flag indicating the toggle is disabled"},{"name":"isExpanded","type":"boolean","description":"Flag indicating the toggle has expanded styling"},{"name":"isFullHeight","type":"boolean","description":"Flag indicating the toggle is full height"},{"name":"isFullWidth","type":"boolean","description":"Flag indicating the toggle takes up the full width of its parent"},{"name":"isPlaceholder","type":"boolean","description":"Flag indicating the toggle contains placeholder text"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id. It will always target the toggle button."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"size","type":"'default' | 'sm'","description":"Adds styling which affects the size of the menu toggle"},{"name":"splitButtonItems","type":"React.ReactNode[]","description":"Elements to display before the toggle button. When included, renders the menu toggle as a split button."},{"name":"status","type":"'success' | 'warning' | 'danger'","description":"Status styles of the menu toggle"},{"name":"statusIcon","type":"React.ReactNode","description":"Overrides the status icon"},{"name":"variant","type":"'default' | 'plain' | 'primary' | 'plainText' | 'secondary' | 'typeahead'","description":"Variant styles of the menu toggle"}]},"MenuToggleProps":{"name":"MenuToggleProps","description":"","props":[{"name":"badge","type":"BadgeProps | React.ReactNode","description":"Optional badge rendered inside the toggle, after the children content"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the toggle"},{"name":"className","type":"string","description":"Additional classes added to the toggle"},{"name":"icon","type":"React.ReactNode","description":"Optional icon or image rendered inside the toggle, before the children content. It is\nrecommended to wrap most basic icons in our icon component."},{"name":"innerRef","type":"React.Ref<MenuToggleElement>","description":""},{"name":"isDisabled","type":"boolean","description":"Flag indicating the toggle is disabled"},{"name":"isExpanded","type":"boolean","description":"Flag indicating the toggle has expanded styling"},{"name":"isFullHeight","type":"boolean","description":"Flag indicating the toggle is full height"},{"name":"isFullWidth","type":"boolean","description":"Flag indicating the toggle takes up the full width of its parent"},{"name":"isPlaceholder","type":"boolean","description":"Flag indicating the toggle contains placeholder text"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id. It will always target the toggle button."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"size","type":"'default' | 'sm'","description":"Adds styling which affects the size of the menu toggle"},{"name":"splitButtonItems","type":"React.ReactNode[]","description":"Elements to display before the toggle button. When included, renders the menu toggle as a split button."},{"name":"status","type":"'success' | 'warning' | 'danger'","description":"Status styles of the menu toggle"},{"name":"statusIcon","type":"React.ReactNode","description":"Overrides the status icon"},{"name":"variant","type":"'default' | 'plain' | 'primary' | 'plainText' | 'secondary' | 'typeahead'","description":"Variant styles of the menu toggle"}]},"MenuToggleState":{"name":"MenuToggleState","description":"","props":[{"name":"ouiaStateId","type":"string","description":null,"required":true}]},"MenuToggleElement":{"name":"MenuToggleElement","description":"","props":[]},"MenuSearchInput":{"name":"MenuSearchInput","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Items within input"}]},"MenuSearchInputProps":{"name":"MenuSearchInputProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Items within input"},{"name":"innerRef","type":"React.Ref<any>","description":""}]},"MenuSearch":{"name":"MenuSearch","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Items within search"}]},"MenuSearchProps":{"name":"MenuSearchProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Items within search"},{"name":"innerRef","type":"React.Ref<any>","description":""}]},"MenuList":{"name":"MenuList","description":"","props":[{"name":"aria-label","type":"string","description":"Adds an accessible name to the menu."},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of menu list","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the menu list"},{"name":"isAriaMultiselectable","type":"boolean","description":"Indicates to assistive technologies whether more than one item can be selected\nfor a non-checkbox menu. Only applies when the menu's role is \"listbox\".","defaultValue":"false"}]},"MenuListProps":{"name":"MenuListProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of menu list","required":true},{"name":"className","type":"string","description":"Additional classes added to the menu list"},{"name":"isAriaMultiselectable","type":"boolean","description":"Indicates to assistive technologies whether more than one item can be selected\nfor a non-checkbox menu. Only applies when the menu's role is \"listbox\"."},{"name":"Unknown","type":"string","description":"Adds an accessible name to the menu."}]},"MenuItemAction":{"name":"MenuItemAction","description":"","props":[{"name":"actionId","type":"any","description":"Identifies the action item in the onActionClick on the Menu"},{"name":"aria-label","type":"string","description":"Accessibility label","required":true},{"name":"className","type":"string","description":"Additional classes added to the action button"},{"name":"icon","type":"'favorites' | React.ReactNode","description":"The action icon to use"},{"name":"isDisabled","type":"boolean","description":"Disables action, can also be specified on the MenuItem instead"},{"name":"isFavorited","type":"boolean","description":"Flag indicating if the item is favorited"},{"name":"onClick","type":"(event?: any) => void","description":"Callback on action click, can also specify onActionClick on the Menu instead"}]},"MenuItemActionProps":{"name":"MenuItemActionProps","description":"","props":[{"name":"actionId","type":"any","description":"Identifies the action item in the onActionClick on the Menu"},{"name":"className","type":"string","description":"Additional classes added to the action button"},{"name":"icon","type":"'favorites' | React.ReactNode","description":"The action icon to use"},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"isDisabled","type":"boolean","description":"Disables action, can also be specified on the MenuItem instead"},{"name":"isFavorited","type":"boolean","description":"Flag indicating if the item is favorited"},{"name":"onClick","type":"(event?: any) => void","description":"Callback on action click, can also specify onActionClick on the Menu instead"},{"name":"Unknown","type":"string","description":"Accessibility label","required":true}]},"MenuItem":{"name":"MenuItem","description":"","props":[{"name":"actions","type":"React.ReactNode","description":"Render item with one or more actions"},{"name":"aria-label","type":"string","description":"Adds an accessible name to the menu item."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the menu list item."},{"name":"className","type":"string","description":"Additional classes added to the menu list item"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Component used to render the menu item"},{"name":"description","type":"React.ReactNode","description":"Description of the menu item"},{"name":"direction","type":"'down' | 'up'","description":"Sub menu direction"},{"name":"download","type":"string","description":"Navigation link download. Only set when the to property is present."},{"name":"drilldownMenu","type":"React.ReactNode | (() => React.ReactNode)","description":"Drilldown menu of the item. Should be a Menu or DrilldownMenu type."},{"name":"flyoutMenu","type":"React.ReactElement<any>","description":"Flyout menu. Should not be used if the to prop is defined."},{"name":"hasCheckbox","type":"boolean","description":"Flag indicating the item has a checkbox"},{"name":"icon","type":"React.ReactNode","description":"Render item with icon"},{"name":"id","type":"string","description":"Sets the id attribute on the menu item component."},{"name":"isActive","type":"boolean","description":"Flag indicating whether the item is active"},{"name":"isAriaDisabled","type":"boolean","description":"Render item as aria-disabled option"},{"name":"isDanger","type":"boolean","description":"Flag indicating the item is in danger state"},{"name":"isDisabled","type":"boolean","description":"Render item as disabled option"},{"name":"isExternalLink","type":"boolean","description":"Render an external link icon on focus or hover, and set the link's\n\"target\" attribute to a value of \"_blank\"."},{"name":"isFavorited","type":"boolean","description":"Flag indicating if the item is favorited"},{"name":"isFocused","type":"boolean","description":"Flag indicating the item is focused"},{"name":"isLoadButton","type":"boolean","description":"Flag indicating if the item causes a load"},{"name":"isLoading","type":"boolean","description":"Flag indicating a loading state"},{"name":"isOnPath","type":"boolean","description":"True if item is on current selection path"},{"name":"isSelected","type":"boolean","description":"Flag indicating if the option is selected"},{"name":"itemId","type":"any","description":"Identifies the component in the Menu onSelect or onActionClick callback"},{"name":"onClick","type":"(event?: any) => void","description":"Callback for item click"},{"name":"onShowFlyout","type":"(event?: any) => void","description":"Callback function when mouse leaves trigger"},{"name":"rel","type":"string","description":"Navigation link relationship. Only set when the to property is present."},{"name":"target","type":"string","description":"Navigation link target. Only set when the to property is present. If isExternalLink is also passed in, this property will be set to \"_blank\"."},{"name":"to","type":"string","description":"Target navigation link. Should not be used if the flyout prop is defined."},{"name":"tooltipProps","type":"TooltipProps","description":"Props for adding a tooltip to a menu item"}]},"MenuItemProps":{"name":"MenuItemProps","description":"","props":[{"name":"actions","type":"React.ReactNode","description":"Render item with one or more actions"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the menu list item."},{"name":"className","type":"string","description":"Additional classes added to the menu list item"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Component used to render the menu item"},{"name":"description","type":"React.ReactNode","description":"Description of the menu item"},{"name":"direction","type":"'down' | 'up'","description":"Sub menu direction"},{"name":"download","type":"string","description":"Navigation link download. Only set when the to property is present."},{"name":"drilldownMenu","type":"React.ReactNode | (() => React.ReactNode)","description":"Drilldown menu of the item. Should be a Menu or DrilldownMenu type."},{"name":"flyoutMenu","type":"React.ReactElement<any>","description":"Flyout menu. Should not be used if the to prop is defined."},{"name":"hasCheckbox","type":"boolean","description":"Flag indicating the item has a checkbox"},{"name":"icon","type":"React.ReactNode","description":"Render item with icon"},{"name":"id","type":"string","description":"Sets the id attribute on the menu item component."},{"name":"innerRef","type":"React.Ref<HTMLAnchorElement | HTMLButtonElement>","description":""},{"name":"isActive","type":"boolean","description":"Flag indicating whether the item is active"},{"name":"isAriaDisabled","type":"boolean","description":"Render item as aria-disabled option"},{"name":"isDanger","type":"boolean","description":"Flag indicating the item is in danger state"},{"name":"isDisabled","type":"boolean","description":"Render item as disabled option"},{"name":"isExternalLink","type":"boolean","description":"Render an external link icon on focus or hover, and set the link's\n\"target\" attribute to a value of \"_blank\"."},{"name":"isFavorited","type":"boolean","description":"Flag indicating if the item is favorited"},{"name":"isFocused","type":"boolean","description":"Flag indicating the item is focused"},{"name":"isLoadButton","type":"boolean","description":"Flag indicating if the item causes a load"},{"name":"isLoading","type":"boolean","description":"Flag indicating a loading state"},{"name":"isOnPath","type":"boolean","description":"True if item is on current selection path"},{"name":"isSelected","type":"boolean","description":"Flag indicating if the option is selected"},{"name":"itemId","type":"any","description":"Identifies the component in the Menu onSelect or onActionClick callback"},{"name":"onClick","type":"(event?: any) => void","description":"Callback for item click"},{"name":"onShowFlyout","type":"(event?: any) => void","description":"Callback function when mouse leaves trigger"},{"name":"rel","type":"string","description":"Navigation link relationship. Only set when the to property is present."},{"name":"target","type":"string","description":"Navigation link target. Only set when the to property is present. If isExternalLink is also passed in, this property will be set to \"_blank\"."},{"name":"to","type":"string","description":"Target navigation link. Should not be used if the flyout prop is defined."},{"name":"tooltipProps","type":"TooltipProps","description":"Props for adding a tooltip to a menu item"},{"name":"Unknown","type":"string","description":"Adds an accessible name to the menu item."}]},"MenuGroup":{"name":"MenuGroup","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Items within group"},{"name":"className","type":"string","description":"Additional classes added to the MenuGroup"},{"name":"label","type":"React.ReactNode","description":"Group label"},{"name":"labelHeadingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Group label heading level. Default is h1."},{"name":"titleId","type":"string","description":"ID for title label"}]},"MenuGroupProps":{"name":"MenuGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Items within group"},{"name":"className","type":"string","description":"Additional classes added to the MenuGroup"},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"label","type":"React.ReactNode","description":"Group label"},{"name":"labelHeadingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Group label heading level. Default is h1."},{"name":"titleId","type":"string","description":"ID for title label"}]},"MenuFooter":{"name":"MenuFooter","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the footer"},{"name":"className","type":"string","description":"Additional classes added to the footer","defaultValue":"''"}]},"MenuFooterProps":{"name":"MenuFooterProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the footer"},{"name":"className","type":"string","description":"Additional classes added to the footer"}]},"MenuContent":{"name":"MenuContent","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Items within group"},{"name":"getHeight","type":"(height: string) => void","description":"Callback to return the height of the menu content"},{"name":"maxMenuHeight","type":"string","description":"Maximum height of menu content"},{"name":"menuHeight","type":"string","description":"Height of the menu content"}]},"MenuContentProps":{"name":"MenuContentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Items within group"},{"name":"getHeight","type":"(height: string) => void","description":"Callback to return the height of the menu content"},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"maxMenuHeight","type":"string","description":"Maximum height of menu content"},{"name":"menuHeight","type":"string","description":"Height of the menu content"}]},"MenuContainer":{"name":"MenuContainer","description":"Container that links a menu and menu toggle together, to handle basic keyboard input and control the opening and closing of a menu.","props":[{"name":"focusTimeoutDelay","type":"number","description":"Time in ms to wait before firing the toggles' focus event. Defaults to 0","defaultValue":"0"},{"name":"isOpen","type":"boolean","description":"Flag to indicate if menu is opened.","required":true},{"name":"menu","type":"React.ReactElement<any, string | React.JSXElementConstructor<any>>","description":"Menu to be rendered","required":true},{"name":"menuRef","type":"React.RefObject<any>","description":"Reference to the menu","required":true},{"name":"onOpenChange","type":"(isOpen: boolean) => void","description":"Callback to change the open state of the menu.\nTriggered by clicking outside of the menu, or by pressing any keys specified in onOpenChangeKeys."},{"name":"onOpenChangeKeys","type":"string[]","description":"Keys that trigger onOpenChange, defaults to tab and escape. It is highly recommended to include Escape in the array, while Tab may be omitted if the menu contains non-menu items that are focusable.","defaultValue":"['Escape', 'Tab']"},{"name":"onToggleKeydown","type":"(event: KeyboardEvent) => void","description":"Callback to override the toggle keydown behavior. By default, when the toggle has focus and the menu is open, pressing the up/down arrow keys will focus a valid non-disabled menu item - the first item for the down arrow key and last item for the up arrow key."},{"name":"popperProps","type":"MenuPopperProps","description":"Additional properties to pass to the Popper"},{"name":"shouldFocusFirstItemOnOpen","type":"boolean","description":"Flag indicating the first menu item should be focused after opening the dropdown.","defaultValue":"false","beta":true},{"name":"shouldPreventScrollOnItemFocus","type":"boolean","description":"Flag indicating if scroll on focus of the first menu item should occur.","defaultValue":"true"},{"name":"toggle","type":"React.ReactNode","description":"Toggle to be rendered","required":true},{"name":"toggleRef","type":"React.RefObject<any>","description":"Reference to the toggle","required":true},{"name":"zIndex","type":"number","description":"z-index of the dropdown menu","defaultValue":"9999"}]},"MenuPopperProps":{"name":"MenuPopperProps","description":"","props":[{"name":"direction","type":"'up' | 'down'","description":"Vertical direction of the popper. If enableFlip is set to true, this will set the initial direction before the popper flips."},{"name":"enableFlip","type":"boolean","description":"Enable to flip the popper when it reaches the boundary"},{"name":"maxWidth","type":"string | 'trigger'","description":"Maximum width of the popper. If the value is \"trigger\", it will set the max width to the dropdown toggle's width"},{"name":"minWidth","type":"string | 'trigger'","description":"Minimum width of the popper. If the value is \"trigger\", it will set the min width to the dropdown toggle's width"},{"name":"position","type":"'right' | 'left' | 'center' | 'start' | 'end'","description":"Horizontal position of the popper"},{"name":"preventOverflow","type":"boolean","description":"Flag to prevent the popper from overflowing its container and becoming partially obscured."},{"name":"width","type":"string | 'trigger'","description":"Custom width of the popper. If the value is \"trigger\", it will set the width to the dropdown toggle's width"}]},"MenuContainerProps":{"name":"MenuContainerProps","description":"","props":[{"name":"focusTimeoutDelay","type":"number","description":"Time in ms to wait before firing the toggles' focus event. Defaults to 0"},{"name":"isOpen","type":"boolean","description":"Flag to indicate if menu is opened.","required":true},{"name":"menu","type":"React.ReactElement<any, string | React.JSXElementConstructor<any>>","description":"Menu to be rendered","required":true},{"name":"menuRef","type":"React.RefObject<any>","description":"Reference to the menu","required":true},{"name":"onOpenChange","type":"(isOpen: boolean) => void","description":"Callback to change the open state of the menu.\nTriggered by clicking outside of the menu, or by pressing any keys specified in onOpenChangeKeys."},{"name":"onOpenChangeKeys","type":"string[]","description":"Keys that trigger onOpenChange, defaults to tab and escape. It is highly recommended to include Escape in the array, while Tab may be omitted if the menu contains non-menu items that are focusable."},{"name":"onToggleKeydown","type":"(event: KeyboardEvent) => void","description":"Callback to override the toggle keydown behavior. By default, when the toggle has focus and the menu is open, pressing the up/down arrow keys will focus a valid non-disabled menu item - the first item for the down arrow key and last item for the up arrow key."},{"name":"popperProps","type":"MenuPopperProps","description":"Additional properties to pass to the Popper"},{"name":"shouldFocusFirstItemOnOpen","type":"boolean","description":""},{"name":"shouldPreventScrollOnItemFocus","type":"boolean","description":"Flag indicating if scroll on focus of the first menu item should occur."},{"name":"toggle","type":"React.ReactNode","description":"Toggle to be rendered","required":true},{"name":"toggleRef","type":"React.RefObject<any>","description":"Reference to the toggle","required":true},{"name":"zIndex","type":"number","description":"z-index of the dropdown menu"}]},"MenuBreadcrumb":{"name":"MenuBreadcrumb","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Items within breadcrumb menu container"}]},"MenuBreadcrumbProps":{"name":"MenuBreadcrumbProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Items within breadcrumb menu container"}]},"Menu":{"name":"Menu","description":"","props":[{"name":"activeItemId","type":"string | number","description":"itemId of the currently active item. You can also specify isActive on the MenuItem."},{"name":"activeMenu","type":"string","description":"ID of the currently active menu for the drilldown variant"},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the Menu"},{"name":"className","type":"string","description":"Additional classes added to the Menu"},{"name":"containsDrilldown","type":"boolean","description":"Indicates if menu contains a drilldown menu"},{"name":"containsFlyout","type":"boolean","description":"Indicates if menu contains a flyout menu"},{"name":"drilldownItemPath","type":"string[]","description":"Indicates the path of drilled in menu itemIds"},{"name":"drilledInMenus","type":"string[]","description":"Array of menus that are drilled in"},{"name":"id","type":"string","description":"ID of the menu"},{"name":"isMenuDrilledIn","type":"boolean","description":"Indicates if a menu is drilled into"},{"name":"isNavFlyout","type":"boolean","description":"Indicating that the menu should have nav flyout styling"},{"name":"isPlain","type":"boolean","description":"Indicates if the menu should be without the outer box-shadow"},{"name":"isRootMenu","type":"boolean","description":"Internal flag indicating if the Menu is the root of a menu tree"},{"name":"isScrollable","type":"boolean","description":"Indicates if the menu should be srollable"},{"name":"onActionClick","type":"(event?: any, itemId?: any, actionId?: any) => void","description":"Callback called when an MenuItems's action button is clicked. You can also specify it within a MenuItemAction."},{"name":"onDrillIn","type":"(\n event: React.KeyboardEvent | React.MouseEvent,\n fromItemId: string,\n toItemId: string,\n itemId: string\n) => void","description":"Callback for drilling into a submenu"},{"name":"onDrillOut","type":"(event: React.KeyboardEvent | React.MouseEvent, toItemId: string, itemId: string) => void","description":"Callback for drilling out of a submenu"},{"name":"onGetMenuHeight","type":"(menuId: string, height: number) => void","description":"Callback for collecting menu heights"},{"name":"onSelect","type":"(event?: React.MouseEvent, itemId?: string | number) => void","description":"Callback for updating when item selection changes. You can also specify onClick on the MenuItem."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"parentMenu","type":"string","description":"ID of parent menu for drilldown menus"},{"name":"role","type":"string","description":"Determines the accessible role of the menu. For a non-checkbox menu that can have\none or more items selected, pass in \"listbox\"."},{"name":"selected","type":"any | any[]","description":"Single itemId for single select menus, or array of itemIds for multi select. You can also specify isSelected on the MenuItem."}]},"MenuProps":{"name":"MenuProps","description":"","props":[{"name":"activeItemId","type":"string | number","description":"itemId of the currently active item. You can also specify isActive on the MenuItem."},{"name":"activeMenu","type":"string","description":"ID of the currently active menu for the drilldown variant"},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the Menu"},{"name":"className","type":"string","description":"Additional classes added to the Menu"},{"name":"containsDrilldown","type":"boolean","description":"Indicates if menu contains a drilldown menu"},{"name":"containsFlyout","type":"boolean","description":"Indicates if menu contains a flyout menu"},{"name":"drilldownItemPath","type":"string[]","description":"Indicates the path of drilled in menu itemIds"},{"name":"drilledInMenus","type":"string[]","description":"Array of menus that are drilled in"},{"name":"id","type":"string","description":"ID of the menu"},{"name":"innerRef","type":"React.Ref<HTMLDivElement>","description":""},{"name":"isMenuDrilledIn","type":"boolean","description":"Indicates if a menu is drilled into"},{"name":"isNavFlyout","type":"boolean","description":"Indicating that the menu should have nav flyout styling"},{"name":"isPlain","type":"boolean","description":"Indicates if the menu should be without the outer box-shadow"},{"name":"isRootMenu","type":"boolean","description":"Internal flag indicating if the Menu is the root of a menu tree"},{"name":"isScrollable","type":"boolean","description":"Indicates if the menu should be srollable"},{"name":"onActionClick","type":"(event?: any, itemId?: any, actionId?: any) => void","description":"Callback called when an MenuItems's action button is clicked. You can also specify it within a MenuItemAction."},{"name":"onDrillIn","type":"(\n event: React.KeyboardEvent | React.MouseEvent,\n fromItemId: string,\n toItemId: string,\n itemId: string\n ) => void","description":"Callback for drilling into a submenu"},{"name":"onDrillOut","type":"(event: React.KeyboardEvent | React.MouseEvent, toItemId: string, itemId: string) => void","description":"Callback for drilling out of a submenu"},{"name":"onGetMenuHeight","type":"(menuId: string, height: number) => void","description":"Callback for collecting menu heights"},{"name":"onSelect","type":"(event?: React.MouseEvent, itemId?: string | number) => void","description":"Callback for updating when item selection changes. You can also specify onClick on the MenuItem."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"parentMenu","type":"string","description":"ID of parent menu for drilldown menus"},{"name":"role","type":"string","description":"Determines the accessible role of the menu. For a non-checkbox menu that can have\none or more items selected, pass in \"listbox\"."},{"name":"selected","type":"any | any[]","description":"Single itemId for single select menus, or array of itemIds for multi select. You can also specify isSelected on the MenuItem."}]},"MenuState":{"name":"MenuState","description":"","props":[{"name":"currentDrilldownMenuId","type":"string","description":null,"required":true},{"name":"disableHover","type":"boolean","description":null,"required":true},{"name":"flyoutRef","type":"React.Ref<HTMLLIElement> | null","description":null,"required":true},{"name":"ouiaStateId","type":"string","description":null,"required":true},{"name":"transitionMoveTarget","type":"HTMLElement","description":null,"required":true}]},"DrilldownMenu":{"name":"DrilldownMenu","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Items within drilldown sub-menu"},{"name":"getHeight","type":"(height: string) => void","description":"Optional callback to get the height of the sub menu"},{"name":"id","type":"string","description":"ID of the drilldown sub-menu"},{"name":"isMenuDrilledIn","type":"boolean","description":"Flag indicating whether the menu is drilled in","defaultValue":"false"}]},"DrilldownMenuProps":{"name":"DrilldownMenuProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Items within drilldown sub-menu"},{"name":"getHeight","type":"(height: string) => void","description":"Optional callback to get the height of the sub menu"},{"name":"id","type":"string","description":"ID of the drilldown sub-menu"},{"name":"isMenuDrilledIn","type":"boolean","description":"Flag indicating whether the menu is drilled in"}]},"MastheadToggle":{"name":"MastheadToggle","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the masthead toggle."},{"name":"className","type":"string","description":"Additional classes added to the masthead toggle."}]},"MastheadToggleProps":{"name":"MastheadToggleProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the masthead toggle."},{"name":"className","type":"string","description":"Additional classes added to the masthead toggle."}]},"MastheadMain":{"name":"MastheadMain","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the masthead main block."},{"name":"className","type":"string","description":"Additional classes added to the masthead main."}]},"MastheadMainProps":{"name":"MastheadMainProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the masthead main block."},{"name":"className","type":"string","description":"Additional classes added to the masthead main."}]},"MastheadLogo":{"name":"MastheadLogo","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the masthead logo."},{"name":"className","type":"string","description":"Additional classes added to the masthead logo."},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Component type of the masthead logo."}]},"MastheadLogoProps":{"name":"MastheadLogoProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the masthead logo."},{"name":"className","type":"string","description":"Additional classes added to the masthead logo."},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Component type of the masthead logo."}]},"MastheadContent":{"name":"MastheadContent","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the masthead content block."},{"name":"className","type":"string","description":"Additional classes added to the masthead content."}]},"MastheadContentProps":{"name":"MastheadContentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the masthead content block."},{"name":"className","type":"string","description":"Additional classes added to the masthead content."}]},"MastheadBrand":{"name":"MastheadBrand","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the masthead brand."},{"name":"className","type":"string","description":"Additional classes added to the masthead brand."}]},"MastheadBrandProps":{"name":"MastheadBrandProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the masthead brand."},{"name":"className","type":"string","description":"Additional classes added to the masthead brand."}]},"Masthead":{"name":"Masthead","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the masthead"},{"name":"className","type":"string","description":"Additional classes added to the masthead"},{"name":"display","type":"{\n default?: 'inline' | 'stack';\n sm?: 'inline' | 'stack';\n md?: 'inline' | 'stack';\n lg?: 'inline' | 'stack';\n xl?: 'inline' | 'stack';\n '2xl'?: 'inline' | 'stack';\n}","description":"Display type at various breakpoints","defaultValue":"{\n md: 'inline'\n}"},{"name":"inset","type":"{\n default?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n sm?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n md?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n lg?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n xl?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n '2xl'?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n}","description":"Insets at various breakpoints"}]},"MastheadProps":{"name":"MastheadProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside of the masthead"},{"name":"className","type":"string","description":"Additional classes added to the masthead"},{"name":"display","type":"{\n default?: 'inline' | 'stack';\n sm?: 'inline' | 'stack';\n md?: 'inline' | 'stack';\n lg?: 'inline' | 'stack';\n xl?: 'inline' | 'stack';\n '2xl'?: 'inline' | 'stack';\n }","description":"Display type at various breakpoints"},{"name":"inset","type":"{\n default?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n sm?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n md?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n lg?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n xl?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n '2xl'?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n }","description":"Insets at various breakpoints"}]},"LoginPage":{"name":"LoginPage","description":"","props":[{"name":"backgroundImgSrc","type":"string","description":"Attribute that specifies the URL of the background image for the login page","defaultValue":"''"},{"name":"brandImgAlt","type":"string","description":"Attribute that specifies the alt text of the brand image for the login page","defaultValue":"''"},{"name":"brandImgSrc","type":"string","description":"Attribute that specifies the URL of the brand image for the login page","defaultValue":"''"},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the login page (e.g. <LoginPageForm>)","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the login page","defaultValue":"''"},{"name":"footerListItems","type":"React.ReactNode","description":"Items rendered inside of the footer list component of the login page","defaultValue":"null"},{"name":"footerListVariants","type":"ListVariant.inline","description":"Adds list variant styles for the footer list component of the login page. The only current value is'inline'"},{"name":"forgotCredentials","type":"React.ReactNode","description":"Content rendered inside of login main footer band to display a forgot credentials link.","defaultValue":"null"},{"name":"headerUtilities","type":"React.ReactNode","description":"Header utilities for the login main body header of the login page"},{"name":"loginSubtitle","type":"string","description":"Subtitle for the login main body header of the login page"},{"name":"loginTitle","type":"string","description":"Title for the login main body header of the login page","required":true},{"name":"signUpForAccountMessage","type":"React.ReactNode","description":"Content rendered inside of login main footer band to display a sign up for account message","defaultValue":"null"},{"name":"socialMediaLoginAriaLabel","type":"string","description":"Adds an accessible name to the social media login list."},{"name":"socialMediaLoginContent","type":"React.ReactNode","description":"Content rendered inside of social media login footer section","defaultValue":"null"},{"name":"textContent","type":"string","description":"Content rendered inside of the text component of the login page","defaultValue":"''"}]},"LoginPageProps":{"name":"LoginPageProps","description":"","props":[{"name":"backgroundImgSrc","type":"string","description":"Attribute that specifies the URL of the background image for the login page"},{"name":"brandImgAlt","type":"string","description":"Attribute that specifies the alt text of the brand image for the login page"},{"name":"brandImgSrc","type":"string","description":"Attribute that specifies the URL of the brand image for the login page"},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the login page (e.g. <LoginPageForm>)"},{"name":"className","type":"string","description":"Additional classes added to the login page"},{"name":"footerListItems","type":"React.ReactNode","description":"Items rendered inside of the footer list component of the login page"},{"name":"footerListVariants","type":"ListVariant.inline","description":"Adds list variant styles for the footer list component of the login page. The only current value is'inline'"},{"name":"forgotCredentials","type":"React.ReactNode","description":"Content rendered inside of login main footer band to display a forgot credentials link."},{"name":"headerUtilities","type":"React.ReactNode","description":"Header utilities for the login main body header of the login page"},{"name":"loginSubtitle","type":"string","description":"Subtitle for the login main body header of the login page"},{"name":"loginTitle","type":"string","description":"Title for the login main body header of the login page","required":true},{"name":"signUpForAccountMessage","type":"React.ReactNode","description":"Content rendered inside of login main footer band to display a sign up for account message"},{"name":"socialMediaLoginAriaLabel","type":"string","description":"Adds an accessible name to the social media login list."},{"name":"socialMediaLoginContent","type":"React.ReactNode","description":"Content rendered inside of social media login footer section"},{"name":"textContent","type":"string","description":"Content rendered inside of the text component of the login page"}]},"LoginMainHeader":{"name":"LoginMainHeader","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the login main header","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the login main header","defaultValue":"''"},{"name":"headerUtilities","type":"React.ReactNode","description":"Actions that render for the login main header","defaultValue":"null"},{"name":"subtitle","type":"string","description":"Subtitle that contains the text, URL, and URL text for the login main header","defaultValue":"''"},{"name":"title","type":"string","description":"Title for the login main header","defaultValue":"''"}]},"LoginMainHeaderProps":{"name":"LoginMainHeaderProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the login main header"},{"name":"className","type":"string","description":"Additional classes added to the login main header"},{"name":"headerUtilities","type":"React.ReactNode","description":"Actions that render for the login main header"},{"name":"subtitle","type":"string","description":"Subtitle that contains the text, URL, and URL text for the login main header"},{"name":"title","type":"string","description":"Title for the login main header"}]},"LoginMainFooterLinksItem":{"name":"LoginMainFooterLinksItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the footer link item","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the footer link item","defaultValue":"''"}]},"LoginMainFooterLinksItemProps":{"name":"LoginMainFooterLinksItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the footer link item"},{"name":"className","type":"string","description":"Additional classes added to the footer link item"}]},"LoginMainFooterBandItem":{"name":"LoginMainFooterBandItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the footer link item","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the footer link item","defaultValue":"''"}]},"LoginMainFooterBandItemProps":{"name":"LoginMainFooterBandItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the footer link item"},{"name":"className","type":"string","description":"Additional classes added to the footer link item"}]},"LoginMainFooter":{"name":"LoginMainFooter","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the login main footer","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the login main footer","defaultValue":"''"},{"name":"forgotCredentials","type":"React.ReactNode","description":"Content rendered inside of login main footer band do display a forgot credentials link*","defaultValue":"null"},{"name":"signUpForAccountMessage","type":"React.ReactNode","description":"Content rendered inside of login main footer band to display a sign up for account message","defaultValue":"null"},{"name":"socialMediaLoginAriaLabel","type":"string","description":"Adds an accessible name to the social media login list."},{"name":"socialMediaLoginContent","type":"React.ReactNode","description":"Content rendered inside the login main footer as social media links","defaultValue":"null"}]},"LoginMainFooterProps":{"name":"LoginMainFooterProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the login main footer"},{"name":"className","type":"string","description":"Additional classes added to the login main footer"},{"name":"forgotCredentials","type":"React.ReactNode","description":"Content rendered inside of login main footer band do display a forgot credentials link*"},{"name":"signUpForAccountMessage","type":"React.ReactNode","description":"Content rendered inside of login main footer band to display a sign up for account message"},{"name":"socialMediaLoginAriaLabel","type":"string","description":"Adds an accessible name to the social media login list."},{"name":"socialMediaLoginContent","type":"React.ReactNode","description":"Content rendered inside the login main footer as social media links"}]},"LoginMainBody":{"name":"LoginMainBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the login main body","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the login main body","defaultValue":"''"}]},"LoginMainBodyProps":{"name":"LoginMainBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the login main body"},{"name":"className","type":"string","description":"Additional classes added to the login main body"}]},"LoginHeader":{"name":"LoginHeader","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the header of the login layout","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the login header","defaultValue":"''"},{"name":"headerBrand","type":"React.ReactNode","description":"Header brand component (e.g. <LoginHeader />)","defaultValue":"null"}]},"LoginHeaderProps":{"name":"LoginHeaderProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the header of the login layout"},{"name":"className","type":"string","description":"Additional classes added to the login header"},{"name":"headerBrand","type":"React.ReactNode","description":"Header brand component (e.g. <LoginHeader />)"}]},"LoginForm":{"name":"LoginForm","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the login main body's form","defaultValue":"''"},{"name":"helperText","type":"React.ReactNode","description":"Content displayed in the helper text component *","defaultValue":"null"},{"name":"helperTextIcon","type":"React.ReactNode","description":"Icon displayed to the left in the helper text","defaultValue":"null"},{"name":"hidePasswordAriaLabel","type":"string","description":"Accessible label for the hide password button","defaultValue":"'Hide password'"},{"name":"isLoginButtonDisabled","type":"boolean","description":"Flag indicating if the login button is disabled","defaultValue":"false"},{"name":"isPasswordRequired","type":"boolean","description":"Flag indicating if password is required","defaultValue":"true"},{"name":"isRememberMeChecked","type":"boolean","description":"Flag indicating if the remember me checkbox is checked.","defaultValue":"false"},{"name":"isShowPasswordEnabled","type":"boolean","description":"Flag indicating if the user can toggle hiding the password","defaultValue":"false"},{"name":"isValidPassword","type":"boolean","description":"Flag indicating if the password is valid","defaultValue":"true"},{"name":"isValidUsername","type":"boolean","description":"Flag indicating if the username is valid","defaultValue":"true"},{"name":"loginButtonLabel","type":"string","description":"Label for the log in button input","defaultValue":"'Log In'"},{"name":"noAutoFocus","type":"boolean","description":"Flag to indicate if the first dropdown item should not gain initial focus","defaultValue":"false"},{"name":"onChangePassword","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"Function that handles the onChange event for the password","defaultValue":"() => undefined as any"},{"name":"onChangeRememberMe","type":"(event: React.FormEvent<HTMLInputElement>, checked: boolean) => void","description":"Function that handles the onChange event for the remember me checkbox","defaultValue":"() => undefined as any"},{"name":"onChangeUsername","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"Function that handles the onChange event for the username","defaultValue":"() => undefined as any"},{"name":"onLoginButtonClick","type":"(event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void","description":"Function that is called when the login button is clicked","defaultValue":"() => undefined as any"},{"name":"passwordLabel","type":"string","description":"Label for the password input field","defaultValue":"'Password'"},{"name":"passwordValue","type":"string","description":"Value for the password","defaultValue":"''"},{"name":"rememberMeLabel","type":"string","description":"Label for the remember me checkbox that indicates the user should be kept logged in. If the label is not provided, the checkbox will not show.","defaultValue":"''"},{"name":"showHelperText","type":"boolean","description":"Flag indicating the helper text is visible *","defaultValue":"false"},{"name":"showPasswordAriaLabel","type":"string","description":"Accessible label for the show password button","defaultValue":"'Show password'"},{"name":"usernameLabel","type":"string","description":"Label for the username input field","defaultValue":"'Username'"},{"name":"usernameValue","type":"string","description":"Value for the username","defaultValue":"''"}]},"LoginFormProps":{"name":"LoginFormProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the login main body's form"},{"name":"helperText","type":"React.ReactNode","description":"Content displayed in the helper text component *"},{"name":"helperTextIcon","type":"React.ReactNode","description":"Icon displayed to the left in the helper text"},{"name":"hidePasswordAriaLabel","type":"string","description":"Accessible label for the hide password button"},{"name":"isLoginButtonDisabled","type":"boolean","description":"Flag indicating if the login button is disabled"},{"name":"isPasswordRequired","type":"boolean","description":"Flag indicating if password is required"},{"name":"isRememberMeChecked","type":"boolean","description":"Flag indicating if the remember me checkbox is checked."},{"name":"isShowPasswordEnabled","type":"boolean","description":"Flag indicating if the user can toggle hiding the password"},{"name":"isValidPassword","type":"boolean","description":"Flag indicating if the password is valid"},{"name":"isValidUsername","type":"boolean","description":"Flag indicating if the username is valid"},{"name":"loginButtonLabel","type":"string","description":"Label for the log in button input"},{"name":"noAutoFocus","type":"boolean","description":"Flag to indicate if the first dropdown item should not gain initial focus"},{"name":"onChangePassword","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"Function that handles the onChange event for the password"},{"name":"onChangeRememberMe","type":"(event: React.FormEvent<HTMLInputElement>, checked: boolean) => void","description":"Function that handles the onChange event for the remember me checkbox"},{"name":"onChangeUsername","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"Function that handles the onChange event for the username"},{"name":"onLoginButtonClick","type":"(event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void","description":"Function that is called when the login button is clicked"},{"name":"passwordLabel","type":"string","description":"Label for the password input field"},{"name":"passwordValue","type":"string","description":"Value for the password"},{"name":"rememberMeLabel","type":"string","description":"Label for the remember me checkbox that indicates the user should be kept logged in. If the label is not provided, the checkbox will not show."},{"name":"showHelperText","type":"boolean","description":"Flag indicating the helper text is visible *"},{"name":"showPasswordAriaLabel","type":"string","description":"Accessible label for the show password button"},{"name":"usernameLabel","type":"string","description":"Label for the username input field"},{"name":"usernameValue","type":"string","description":"Value for the username"}]},"LoginFooterItem":{"name":"LoginFooterItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the footer link item","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the footer link item"},{"name":"href","type":"string","description":"The URL of the footer link item","defaultValue":"'#'"},{"name":"target","type":"string","description":"Specifies where to open the linked document","defaultValue":"'_blank'"}]},"LoginFooterItemProps":{"name":"LoginFooterItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the footer link item"},{"name":"className","type":"string","description":"Additional classes added to the footer link item"},{"name":"href","type":"string","description":"The URL of the footer link item"},{"name":"target","type":"string","description":"Specifies where to open the linked document"}]},"LoginFooter":{"name":"LoginFooter","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the footer of the login layout","defaultValue":"null"},{"name":"className","type":"string","description":"Additional props are spread to the container <footer>","defaultValue":"''"}]},"LoginFooterProps":{"name":"LoginFooterProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the footer of the login layout"},{"name":"className","type":"string","description":"Additional props are spread to the container <footer>"}]},"Login":{"name":"Login","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the main section of the login layout","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the login layout","defaultValue":"''"},{"name":"footer","type":"React.ReactNode","description":"Footer component (e.g. <LoginFooter />)","defaultValue":"null"},{"name":"header","type":"React.ReactNode","description":"Header component (e.g. <LoginHeader />)","defaultValue":"null"}]},"LoginProps":{"name":"LoginProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the main section of the login layout"},{"name":"className","type":"string","description":"Additional classes added to the login layout"},{"name":"footer","type":"React.ReactNode","description":"Footer component (e.g. <LoginFooter />)"},{"name":"header","type":"React.ReactNode","description":"Header component (e.g. <LoginHeader />)"}]},"ListItem":{"name":"ListItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of list item","defaultValue":"null"},{"name":"icon","type":"React.ReactNode | null","description":"Icon for the list item","defaultValue":"null"}]},"ListItemProps":{"name":"ListItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of list item","required":true},{"name":"icon","type":"React.ReactNode | null","description":"Icon for the list item"}]},"List":{"name":"List","description":"","props":[{"name":"aria-label","type":"string","description":"Adds an accessible label to the list."},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the list","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the list","defaultValue":"''"},{"name":"component","type":"'ol' | 'ul'","description":"Sets the type of the list component.","defaultValue":"ListComponent.ul"},{"name":"iconSize","type":"'default' | 'large'","description":"Modifies the size of the icons in the list","defaultValue":"'default'"},{"name":"isBordered","type":"boolean","description":"Modifies the list to add borders between items","defaultValue":"false"},{"name":"isPlain","type":"boolean","description":"Modifies the list to include plain styling","defaultValue":"false"},{"name":"ref","type":"No type info","defaultValue":"null"},{"name":"type","type":"OrderType","description":"Sets the way items are numbered if component is set to \"ol\".","defaultValue":"OrderType.number"},{"name":"variant","type":"ListVariant.inline","description":"Adds list variant styles","defaultValue":"null"}]},"ListProps":{"name":"ListProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the list"},{"name":"className","type":"string","description":"Additional classes added to the list"},{"name":"component","type":"'ol' | 'ul'","description":"Sets the type of the list component."},{"name":"iconSize","type":"'default' | 'large'","description":"Modifies the size of the icons in the list"},{"name":"isBordered","type":"boolean","description":"Modifies the list to add borders between items"},{"name":"isPlain","type":"boolean","description":"Modifies the list to include plain styling"},{"name":"type","type":"OrderType","description":"Sets the way items are numbered if component is set to \"ol\"."},{"name":"Unknown","type":"string","description":"Adds an accessible label to the list."},{"name":"variant","type":"ListVariant.inline","description":"Adds list variant styles"}]},"LabelGroup":{"name":"LabelGroup","description":"","props":[{"name":"addLabelControl","type":"React.ReactNode","description":"Control for adding new labels"},{"name":"aria-label","type":"string","description":"Aria label for label group that does not have a category name","defaultValue":"'Label group category'"},{"name":"categoryName","type":"string","description":"Category name text for the label group category. If this prop is supplied the label group with have a label and category styling applied","defaultValue":"''"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the label group. Should be <Label> elements."},{"name":"className","type":"string","description":"Additional classes added to the label item"},{"name":"closeBtnAriaLabel","type":"string","description":"Aria label for close button","defaultValue":"'Close label group'"},{"name":"collapsedText","type":"string","description":"Customizable template string. Use variable \"${remaining}\" for the overflow label count.","defaultValue":"'${remaining} more'"},{"name":"defaultIsOpen","type":"boolean","description":"Flag for having the label group default to expanded","defaultValue":"false"},{"name":"editableTextAreaProps","type":"any","description":"Additional props passed to the editable textarea."},{"name":"expandedText","type":"string","description":"Customizable \"Show Less\" text string","defaultValue":"'Show Less'"},{"name":"hasEditableTextArea","type":"boolean","description":"Flag indicating the editable label group should be appended with a textarea.","defaultValue":"false"},{"name":"isClosable","type":"boolean","description":"Flag if label group can be closed","defaultValue":"false"},{"name":"isCompact","type":"boolean","description":"Flag indicating the labels in the group are compact","defaultValue":"false"},{"name":"isEditable","type":"boolean","description":"Flag indicating contained labels are editable. Allows spacing for a text input after the labels.","defaultValue":"false"},{"name":"isVertical","type":"boolean","description":"Flag to implement a vertical layout","defaultValue":"false"},{"name":"numLabels","type":"number","description":"Set number of labels to show before overflow","defaultValue":"3"},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"Function that is called when clicking on the label group close button","defaultValue":"(_e: React.MouseEvent) => undefined as any"},{"name":"tooltipPosition","type":"| TooltipPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Position of the tooltip which is displayed if the category name text is longer","defaultValue":"'top'"}]},"LabelGroupProps":{"name":"LabelGroupProps","description":"","props":[{"name":"addLabelControl","type":"React.ReactNode","description":"Control for adding new labels"},{"name":"categoryName","type":"string","description":"Category name text for the label group category. If this prop is supplied the label group with have a label and category styling applied"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the label group. Should be <Label> elements."},{"name":"className","type":"string","description":"Additional classes added to the label item"},{"name":"closeBtnAriaLabel","type":"string","description":"Aria label for close button"},{"name":"collapsedText","type":"string","description":"Customizable template string. Use variable \"${remaining}\" for the overflow label count."},{"name":"defaultIsOpen","type":"boolean","description":"Flag for having the label group default to expanded"},{"name":"editableTextAreaProps","type":"any","description":"Additional props passed to the editable textarea."},{"name":"expandedText","type":"string","description":"Customizable \"Show Less\" text string"},{"name":"hasEditableTextArea","type":"boolean","description":"Flag indicating the editable label group should be appended with a textarea."},{"name":"isClosable","type":"boolean","description":"Flag if label group can be closed"},{"name":"isCompact","type":"boolean","description":"Flag indicating the labels in the group are compact"},{"name":"isEditable","type":"boolean","description":"Flag indicating contained labels are editable. Allows spacing for a text input after the labels."},{"name":"isVertical","type":"boolean","description":"Flag to implement a vertical layout"},{"name":"numLabels","type":"number","description":"Set number of labels to show before overflow"},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"Function that is called when clicking on the label group close button"},{"name":"tooltipPosition","type":"| TooltipPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Position of the tooltip which is displayed if the category name text is longer"},{"name":"Unknown","type":"string","description":"Aria label for label group that does not have a category name"}]},"LabelGroupState":{"name":"LabelGroupState","description":"","props":[{"name":"isOpen","type":"boolean","description":null,"required":true},{"name":"isTooltipVisible","type":"boolean","description":null,"required":true}]},"Label":{"name":"Label","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the label."},{"name":"className","type":"string","description":"Additional classes added to the label.","defaultValue":"''"},{"name":"closeBtn","type":"React.ReactNode","description":"Node for custom close button."},{"name":"closeBtnAriaLabel","type":"string","description":"Aria label for close button"},{"name":"closeBtnProps","type":"any","description":"Additional properties for the default close button."},{"name":"color","type":"'blue' | 'teal' | 'green' | 'orange' | 'purple' | 'red' | 'orangered' | 'grey' | 'yellow'","description":"Color of the label.","defaultValue":"'grey'"},{"name":"editableProps","type":"any","description":"Additional props passed to the editable label text div. Optionally passing onInput and onBlur callbacks will allow finer custom text input control."},{"name":"href","type":"string","description":"Href for a label that is a link. If present, the label will change to an anchor element. This should not be passed in if the onClick prop is also passed in."},{"name":"icon","type":"React.ReactNode","description":"Icon added to the left of the label text. Overrides the icon set by the status property."},{"name":"isClickable","type":"boolean","description":"Flag indicating the label is clickable. This flag will automatically be set if a href is passed, or if an onClick handler is passed and the label is not an overflow or add variant. This should be manually set when using the render prop.","defaultValue":"false"},{"name":"isCompact","type":"boolean","description":"Flag indicating the label is compact.","defaultValue":"false"},{"name":"isDisabled","type":"boolean","description":"Flag indicating the label is disabled. Works only on clickable labels, so either href or onClick props must be passed in.","defaultValue":"false"},{"name":"isEditable","type":"boolean","description":"Flag indicating the label is editable.","defaultValue":"false"},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"Callback for when the label is clicked. This should not be passed in if the href or isEditable props are also passed in."},{"name":"onClose","type":"(event: React.MouseEvent) => void","description":"Close click callback for removable labels. If present, label will have a close button."},{"name":"onEditCancel","type":"(event: KeyboardEvent, previousText: string) => void","description":"Callback when an editable label cancels an edit."},{"name":"onEditComplete","type":"(event: MouseEvent | KeyboardEvent, newText: string) => void","description":"Callback when an editable label completes an edit."},{"name":"render","type":"({\n className,\n content,\n componentRef\n}: {\n className: string;\n content: React.ReactNode;\n componentRef: any;\n}) => React.ReactNode","description":"Forwards the label content and className to rendered function. Use this prop for react router support."},{"name":"status","type":"'success' | 'warning' | 'danger' | 'info' | 'custom'","description":"Status of the label with a respective icon and color. Overrides the color set by the color property."},{"name":"textMaxWidth","type":"string","description":"The max width of the label before it is truncated. Can be any valid CSS unit, such as '100%', '100px', or '16ch'."},{"name":"tooltipPosition","type":"| TooltipPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Position of the tooltip which is displayed if text is truncated"},{"name":"variant","type":"'outline' | 'filled' | 'overflow' | 'add'","description":"Variant of the label.","defaultValue":"'filled'"}]},"LabelProps":{"name":"LabelProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the label."},{"name":"className","type":"string","description":"Additional classes added to the label."},{"name":"closeBtn","type":"React.ReactNode","description":"Node for custom close button."},{"name":"closeBtnAriaLabel","type":"string","description":"Aria label for close button"},{"name":"closeBtnProps","type":"any","description":"Additional properties for the default close button."},{"name":"color","type":"'blue' | 'teal' | 'green' | 'orange' | 'purple' | 'red' | 'orangered' | 'grey' | 'yellow'","description":"Color of the label."},{"name":"editableProps","type":"any","description":"Additional props passed to the editable label text div. Optionally passing onInput and onBlur callbacks will allow finer custom text input control."},{"name":"href","type":"string","description":"Href for a label that is a link. If present, the label will change to an anchor element. This should not be passed in if the onClick prop is also passed in."},{"name":"icon","type":"React.ReactNode","description":"Icon added to the left of the label text. Overrides the icon set by the status property."},{"name":"isClickable","type":"boolean","description":"Flag indicating the label is clickable. This flag will automatically be set if a href is passed, or if an onClick handler is passed and the label is not an overflow or add variant. This should be manually set when using the render prop."},{"name":"isCompact","type":"boolean","description":"Flag indicating the label is compact."},{"name":"isDisabled","type":"boolean","description":"Flag indicating the label is disabled. Works only on clickable labels, so either href or onClick props must be passed in."},{"name":"isEditable","type":"boolean","description":"Flag indicating the label is editable."},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"Callback for when the label is clicked. This should not be passed in if the href or isEditable props are also passed in."},{"name":"onClose","type":"(event: React.MouseEvent) => void","description":"Close click callback for removable labels. If present, label will have a close button."},{"name":"onEditCancel","type":"(event: KeyboardEvent, previousText: string) => void","description":"Callback when an editable label cancels an edit."},{"name":"onEditComplete","type":"(event: MouseEvent | KeyboardEvent, newText: string) => void","description":"Callback when an editable label completes an edit."},{"name":"render","type":"({\n className,\n content,\n componentRef\n }: {\n className: string;\n content: React.ReactNode;\n componentRef: any;\n }) => React.ReactNode","description":"Forwards the label content and className to rendered function. Use this prop for react router support."},{"name":"status","type":"'success' | 'warning' | 'danger' | 'info' | 'custom'","description":"Status of the label with a respective icon and color. Overrides the color set by the color property."},{"name":"textMaxWidth","type":"string","description":"The max width of the label before it is truncated. Can be any valid CSS unit, such as '100%', '100px', or '16ch'."},{"name":"tooltipPosition","type":"| TooltipPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Position of the tooltip which is displayed if text is truncated"},{"name":"variant","type":"'outline' | 'filled' | 'overflow' | 'add'","description":"Variant of the label."}]},"JumpLinksList":{"name":"JumpLinksList","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Text to be rendered inside span"},{"name":"className","type":"string","description":"Classname to add to ul."}]},"JumpLinksListProps":{"name":"JumpLinksListProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Text to be rendered inside span"},{"name":"className","type":"string","description":"Classname to add to ul."}]},"JumpLinksItem":{"name":"JumpLinksItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Text to be rendered inside span"},{"name":"className","type":"string","description":"Class to add to li"},{"name":"href","type":"string","description":"Href for this link","required":true},{"name":"isActive","type":"boolean","description":"Whether this item is active. Parent JumpLinks component sets this when passed a `scrollableSelector`."},{"name":"node","type":"string | HTMLElement","description":"Selector or HTMLElement to spy on"},{"name":"onClick","type":"(ev: React.MouseEvent) => void","description":"Click handler for anchor tag. Parent JumpLinks components tap into this."}]},"JumpLinksItemProps":{"name":"JumpLinksItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Text to be rendered inside span"},{"name":"className","type":"string","description":"Class to add to li"},{"name":"href","type":"string","description":"Href for this link","required":true},{"name":"isActive","type":"boolean","description":"Whether this item is active. Parent JumpLinks component sets this when passed a `scrollableSelector`."},{"name":"node","type":"string | HTMLElement","description":"Selector or HTMLElement to spy on"},{"name":"onClick","type":"(ev: React.MouseEvent) => void","description":"Click handler for anchor tag. Parent JumpLinks components tap into this."}]},"JumpLinks":{"name":"JumpLinks","description":"","props":[{"name":"activeIndex","type":"number","description":"The index of the child Jump link to make active.","defaultValue":"0"},{"name":"alwaysShowLabel","type":"boolean","description":"Flag to always show the label when using `expandable`","defaultValue":"true"},{"name":"aria-label","type":"string","description":"Adds an accessible label to the internal nav element. Defaults to the value of the label prop.","defaultValue":"typeof label === 'string' ? label : null"},{"name":"children","type":"React.ReactNode","description":"Children nodes"},{"name":"className","type":"string","description":"Class for nav"},{"name":"expandable","type":"{\n default?: 'expandable' | 'nonExpandable';\n sm?: 'expandable' | 'nonExpandable';\n md?: 'expandable' | 'nonExpandable';\n lg?: 'expandable' | 'nonExpandable';\n xl?: 'expandable' | 'nonExpandable';\n '2xl'?: 'expandable' | 'nonExpandable';\n}","description":"When to collapse/expand at different breakpoints"},{"name":"isCentered","type":"boolean","description":"Whether to center children."},{"name":"isExpanded","type":"boolean","description":"On mobile whether or not the JumpLinks starts out expanded","defaultValue":"false"},{"name":"isVertical","type":"boolean","description":"Whether the layout of children is vertical or horizontal."},{"name":"label","type":"React.ReactNode","description":"Label to add to nav element."},{"name":"offset","type":"number","description":"Offset to add to `scrollPosition`, potentially for a masthead which content scrolls under.","defaultValue":"0"},{"name":"scrollableRef","type":"HTMLElement | (() => HTMLElement) | React.RefObject<HTMLElement | null>","description":"Reference to the scrollable element to spy on. Takes precedence over scrollableSelector. Not passing a scrollableRef or scrollableSelector disables spying."},{"name":"scrollableSelector","type":"string","description":"Selector for the scrollable element to spy on. Not passing a scrollableSelector or scrollableRef disables spying."},{"name":"shouldReplaceNavHistory","type":"boolean","description":"Whether the current entry in the navigation history should be replaced when a JumpLinksItem is clicked. By default a new entry will be pushed to the navigation history.","defaultValue":"false"},{"name":"toggleAriaLabel","type":"string","description":"Aria label for expandable toggle","defaultValue":"'Toggle jump links'"}]},"JumpLinksProps":{"name":"JumpLinksProps","description":"","props":[{"name":"activeIndex","type":"number","description":"The index of the child Jump link to make active."},{"name":"alwaysShowLabel","type":"boolean","description":"Flag to always show the label when using `expandable`"},{"name":"children","type":"React.ReactNode","description":"Children nodes"},{"name":"className","type":"string","description":"Class for nav"},{"name":"expandable","type":"{\n default?: 'expandable' | 'nonExpandable';\n sm?: 'expandable' | 'nonExpandable';\n md?: 'expandable' | 'nonExpandable';\n lg?: 'expandable' | 'nonExpandable';\n xl?: 'expandable' | 'nonExpandable';\n '2xl'?: 'expandable' | 'nonExpandable';\n }","description":"When to collapse/expand at different breakpoints"},{"name":"isCentered","type":"boolean","description":"Whether to center children."},{"name":"isExpanded","type":"boolean","description":"On mobile whether or not the JumpLinks starts out expanded"},{"name":"isVertical","type":"boolean","description":"Whether the layout of children is vertical or horizontal."},{"name":"label","type":"React.ReactNode","description":"Label to add to nav element."},{"name":"offset","type":"number","description":"Offset to add to `scrollPosition`, potentially for a masthead which content scrolls under."},{"name":"scrollableRef","type":"HTMLElement | (() => HTMLElement) | React.RefObject<HTMLElement | null>","description":"Reference to the scrollable element to spy on. Takes precedence over scrollableSelector. Not passing a scrollableRef or scrollableSelector disables spying."},{"name":"scrollableSelector","type":"string","description":"Selector for the scrollable element to spy on. Not passing a scrollableSelector or scrollableRef disables spying."},{"name":"shouldReplaceNavHistory","type":"boolean","description":"Whether the current entry in the navigation history should be replaced when a JumpLinksItem is clicked. By default a new entry will be pushed to the navigation history."},{"name":"toggleAriaLabel","type":"string","description":"Aria label for expandable toggle"},{"name":"Unknown","type":"string","description":"Adds an accessible label to the internal nav element. Defaults to the value of the label prop."}]},"InputGroupText":{"name":"InputGroupText","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the input group text.","required":true},{"name":"className","type":"string","description":"Additional classes added to the input group text."},{"name":"component","type":"React.ReactNode","description":"Component that wraps the input group text.","defaultValue":"'span'"},{"name":"isDisabled","type":"boolean","description":"Flag to indicate if the input group text is disabled."},{"name":"isPlain","type":"boolean","description":"Flag to to indicate if the input group item is plain."}]},"InputGroupTextProps":{"name":"InputGroupTextProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the input group text.","required":true},{"name":"className","type":"string","description":"Additional classes added to the input group text."},{"name":"component","type":"React.ReactNode","description":"Component that wraps the input group text."},{"name":"isDisabled","type":"boolean","description":"Flag to indicate if the input group text is disabled."},{"name":"isPlain","type":"boolean","description":"Flag to to indicate if the input group item is plain."}]},"InputGroupItem":{"name":"InputGroupItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the input group item.","required":true},{"name":"className","type":"string","description":"Additional classes added to the input group item."},{"name":"isBox","type":"boolean","description":"Enables box styling to the input group item","defaultValue":"false"},{"name":"isDisabled","type":"boolean","description":"Flag to indicate if the input group item is disabled."},{"name":"isFill","type":"boolean","description":"Flag to indicate if the input group item should fill the available horizontal space","defaultValue":"false"},{"name":"isPlain","type":"boolean","description":"Flag to indicate if the input group item is plain."}]},"InputGroupItemProps":{"name":"InputGroupItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the input group item.","required":true},{"name":"className","type":"string","description":"Additional classes added to the input group item."},{"name":"isBox","type":"boolean","description":"Enables box styling to the input group item"},{"name":"isDisabled","type":"boolean","description":"Flag to indicate if the input group item is disabled."},{"name":"isFill","type":"boolean","description":"Flag to indicate if the input group item should fill the available horizontal space"},{"name":"isPlain","type":"boolean","description":"Flag to indicate if the input group item is plain."}]},"InputGroupProps":{"name":"InputGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the input group.","required":true},{"name":"className","type":"string","description":"Additional classes added to the input group."},{"name":"innerRef","type":"React.Ref<any>","description":""}]},"Icon":{"name":"Icon","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Icon content"},{"name":"className","type":"string","description":"Additional classes applied to the icon container"},{"name":"defaultProgressArialabel","type":"string","description":"Aria-label for the default progress icon","defaultValue":"'Loading...'"},{"name":"iconSize","type":"| 'sm'\n| 'md'\n| 'lg'\n| 'xl'\n| '2xl'\n| '3xl'\n| 'headingSm'\n| 'headingMd'\n| 'headingLg'\n| 'headingXl'\n| 'heading_2xl'\n| 'heading_3xl'\n| 'bodySm'\n| 'bodyDefault'\n| 'bodyLg'","description":"Size of icon. Overrides the icon size set by the size property."},{"name":"isInline","type":"boolean","description":"Indicates the icon is inline and should inherit the text font size and color. Overriden by size and iconSize properties.","defaultValue":"false"},{"name":"isInProgress","type":"boolean","description":"Indicates the icon is in progress. Setting this property to true will swap the icon with the progressIcon.","defaultValue":"false"},{"name":"progressIcon","type":"React.ReactNode","description":"Icon when isInProgress is set to true. Defaults to a 1em spinner."},{"name":"progressIconSize","type":"| 'sm'\n| 'md'\n| 'lg'\n| 'xl'\n| '2xl'\n| '3xl'\n| 'headingSm'\n| 'headingMd'\n| 'headingLg'\n| 'headingXl'\n| 'heading_2xl'\n| 'heading_3xl'\n| 'bodySm'\n| 'bodyDefault'\n| 'bodyLg'","description":"Size of progress icon. Overrides the icon size set by the size property."},{"name":"shouldMirrorRTL","type":"boolean","description":"Flag indicating whether the icon passed as children should be mirrored for\nright to left (RTL) languages. This will not mirror the icon passed to progressIcon.","defaultValue":"false"},{"name":"size","type":"| 'sm'\n| 'md'\n| 'lg'\n| 'xl'\n| '2xl'\n| '3xl'\n| 'headingSm'\n| 'headingMd'\n| 'headingLg'\n| 'headingXl'\n| 'heading_2xl'\n| 'heading_3xl'\n| 'bodySm'\n| 'bodyDefault'\n| 'bodyLg'","description":"Size of the icon component container and icon."},{"name":"status","type":"'custom' | 'info' | 'success' | 'warning' | 'danger'","description":"Status color of the icon"}]},"IconComponentProps":{"name":"IconComponentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Icon content"},{"name":"className","type":"string","description":"Additional classes applied to the icon container"},{"name":"defaultProgressArialabel","type":"string","description":"Aria-label for the default progress icon"},{"name":"iconSize","type":"IconSize","description":"Size of icon. Overrides the icon size set by the size property."},{"name":"isInline","type":"boolean","description":"Indicates the icon is inline and should inherit the text font size and color. Overriden by size and iconSize properties."},{"name":"isInProgress","type":"boolean","description":"Indicates the icon is in progress. Setting this property to true will swap the icon with the progressIcon."},{"name":"progressIcon","type":"React.ReactNode","description":"Icon when isInProgress is set to true. Defaults to a 1em spinner."},{"name":"progressIconSize","type":"IconSize","description":"Size of progress icon. Overrides the icon size set by the size property."},{"name":"shouldMirrorRTL","type":"boolean","description":"Flag indicating whether the icon passed as children should be mirrored for\nright to left (RTL) languages. This will not mirror the icon passed to progressIcon."},{"name":"size","type":"IconSize","description":"Size of the icon component container and icon."},{"name":"status","type":"'custom' | 'info' | 'success' | 'warning' | 'danger'","description":"Status color of the icon"}]},"IconSize":{"name":"IconSize","description":"","props":[]},"HintTitle":{"name":"HintTitle","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the hint title."},{"name":"className","type":"string","description":"Additional classes applied to the hint title."}]},"HintTitleProps":{"name":"HintTitleProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the hint title."},{"name":"className","type":"string","description":"Additional classes applied to the hint title."}]},"HintFooter":{"name":"HintFooter","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the hint footer."},{"name":"className","type":"string","description":"Additional classes applied to the hint footer."}]},"HintFooterProps":{"name":"HintFooterProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the hint footer."},{"name":"className","type":"string","description":"Additional classes applied to the hint footer."}]},"HintBody":{"name":"HintBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the hint body."},{"name":"className","type":"string","description":"Additional classes applied to the hint body."}]},"HintBodyProps":{"name":"HintBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the hint body."},{"name":"className","type":"string","description":"Additional classes applied to the hint body."}]},"Hint":{"name":"Hint","description":"","props":[{"name":"actions","type":"React.ReactNode","description":"Actions of the hint."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the hint."},{"name":"className","type":"string","description":"Additional classes applied to the hint."},{"name":"hasNoActionsOffset","type":"boolean","description":"Flag indicating that the actions have no offset","defaultValue":"false"}]},"HintProps":{"name":"HintProps","description":"","props":[{"name":"actions","type":"React.ReactNode","description":"Actions of the hint."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the hint."},{"name":"className","type":"string","description":"Additional classes applied to the hint."},{"name":"hasNoActionsOffset","type":"boolean","description":"Flag indicating that the actions have no offset"}]},"HelperTextItem":{"name":"HelperTextItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the helper text item."},{"name":"className","type":"string","description":"Additional classes applied to the helper text item."},{"name":"component","type":"'div' | 'li'","description":"Sets the component type of the helper text item.","defaultValue":"'div'"},{"name":"icon","type":"React.ReactNode","description":"Custom icon prefixing the helper text. This property will override the default icon when the variant property is passed in."},{"name":"id","type":"string","description":"ID for the helper text item. The value of this prop can be passed into a form component's\naria-describedby prop when you intend for only specific helper text items to be announced to\nassistive technologies."},{"name":"screenReaderText","type":"string","description":"Text that is only accessible to screen readers in order to announce the variant of a helper text item.\nThis prop can only be used when the variant prop has a value other than \"default\"."},{"name":"variant","type":"'default' | 'indeterminate' | 'warning' | 'success' | 'error'","description":"Variant styling of the helper text item. Will also render a default icon, which can be overridden\nwith the icon prop.","defaultValue":"'default'"}]},"HelperTextItemProps":{"name":"HelperTextItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the helper text item."},{"name":"className","type":"string","description":"Additional classes applied to the helper text item."},{"name":"component","type":"'div' | 'li'","description":"Sets the component type of the helper text item."},{"name":"icon","type":"React.ReactNode","description":"Custom icon prefixing the helper text. This property will override the default icon when the variant property is passed in."},{"name":"id","type":"string","description":"ID for the helper text item. The value of this prop can be passed into a form component's\naria-describedby prop when you intend for only specific helper text items to be announced to\nassistive technologies."},{"name":"screenReaderText","type":"string","description":"Text that is only accessible to screen readers in order to announce the variant of a helper text item.\nThis prop can only be used when the variant prop has a value other than \"default\"."},{"name":"variant","type":"'default' | 'indeterminate' | 'warning' | 'success' | 'error'","description":"Variant styling of the helper text item. Will also render a default icon, which can be overridden\nwith the icon prop."}]},"HelperText":{"name":"HelperText","description":"","props":[{"name":"aria-label","type":"string","description":"Adds an accessible label to the helper text when component is a \"ul\"."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the helper text container."},{"name":"className","type":"string","description":"Additional classes applied to the helper text container."},{"name":"component","type":"'div' | 'ul'","description":"Component type of the helper text container","defaultValue":"'div'"},{"name":"id","type":"string","description":"ID for the helper text container. The value of this prop can be passed into a form component's\naria-describedby prop when you intend for all helper text items to be announced to\nassistive technologies."},{"name":"isLiveRegion","type":"boolean","description":"Flag for indicating whether the helper text container is a live region. Use this prop when you\nexpect or intend for any helper text items within the container to be dynamically updated.","defaultValue":"false"}]},"HelperTextProps":{"name":"HelperTextProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the helper text container."},{"name":"className","type":"string","description":"Additional classes applied to the helper text container."},{"name":"component","type":"'div' | 'ul'","description":"Component type of the helper text container"},{"name":"id","type":"string","description":"ID for the helper text container. The value of this prop can be passed into a form component's\naria-describedby prop when you intend for all helper text items to be announced to\nassistive technologies."},{"name":"isLiveRegion","type":"boolean","description":"Flag for indicating whether the helper text container is a live region. Use this prop when you\nexpect or intend for any helper text items within the container to be dynamically updated."},{"name":"Unknown","type":"string","description":"Adds an accessible label to the helper text when component is a \"ul\"."}]},"FormSelectOptionGroup":{"name":"FormSelectOptionGroup","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Select Option Group","defaultValue":"null"},{"name":"className","type":"string","description":"additional classes added to the Select Option","defaultValue":"''"},{"name":"isDisabled","type":"boolean","description":"flag indicating if the Option Group is disabled","defaultValue":"false"},{"name":"label","type":"string","description":"the label for the option","required":true}]},"FormSelectOptionGroupProps":{"name":"FormSelectOptionGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Select Option Group"},{"name":"className","type":"string","description":"additional classes added to the Select Option"},{"name":"isDisabled","type":"boolean","description":"flag indicating if the Option Group is disabled"},{"name":"label","type":"string","description":"the label for the option","required":true}]},"FormSelectOption":{"name":"FormSelectOption","description":"","props":[{"name":"className","type":"string","description":"additional classes added to the Select Option","defaultValue":"''"},{"name":"isDisabled","type":"boolean","description":"flag indicating if the option is disabled","defaultValue":"false"},{"name":"isPlaceholder","type":"boolean","description":"flag indicating if option will have placeholder styling applied when selected *","defaultValue":"false"},{"name":"label","type":"string","description":"the label for the option","required":true},{"name":"value","type":"any","description":"the value for the option","defaultValue":"''"}]},"FormSelectOptionProps":{"name":"FormSelectOptionProps","description":"","props":[{"name":"className","type":"string","description":"additional classes added to the Select Option"},{"name":"isDisabled","type":"boolean","description":"flag indicating if the option is disabled"},{"name":"isPlaceholder","type":"boolean","description":"flag indicating if option will have placeholder styling applied when selected *"},{"name":"label","type":"string","description":"the label for the option","required":true},{"name":"value","type":"any","description":"the value for the option"}]},"FormSelect":{"name":"FormSelect","description":"","props":[{"name":"aria-label","type":"string","description":"Custom flag to show that the FormSelect requires an associated id or aria-label."},{"name":"children","type":"React.ReactNode","description":"content rendered inside the FormSelect","required":true},{"name":"className","type":"string","description":"additional classes added to the FormSelect control","defaultValue":"''"},{"name":"isDisabled","type":"boolean","description":"Flag indicating the FormSelect is disabled","defaultValue":"false"},{"name":"isRequired","type":"boolean","description":"Sets the FormSelect required.","defaultValue":"false"},{"name":"onBlur","type":"(event: React.FormEvent<HTMLSelectElement>) => void","description":"Optional callback for updating when selection loses focus","defaultValue":"(): any => undefined"},{"name":"onChange","type":"(event: React.FormEvent<HTMLSelectElement>, value: string) => void","description":"Optional callback for updating when selection changes","defaultValue":"(): any => undefined"},{"name":"onFocus","type":"(event: React.FormEvent<HTMLSelectElement>) => void","description":"Optional callback for updating when selection gets focus","defaultValue":"(): any => undefined"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"},{"name":"validated","type":"'success' | 'warning' | 'error' | 'default'","description":"Value to indicate if the select is modified to show that validation state.\nIf set to success, select will be modified to indicate valid state.\nIf set to error, select will be modified to indicate error state.","defaultValue":"'default'"},{"name":"value","type":"any","description":"value of selected option","defaultValue":"''"}]},"FormSelectProps":{"name":"FormSelectProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the FormSelect","required":true},{"name":"className","type":"string","description":"additional classes added to the FormSelect control"},{"name":"isDisabled","type":"boolean","description":"Flag indicating the FormSelect is disabled"},{"name":"isRequired","type":"boolean","description":"Sets the FormSelect required."},{"name":"onBlur","type":"(event: React.FormEvent<HTMLSelectElement>) => void","description":"Optional callback for updating when selection loses focus"},{"name":"onChange","type":"(event: React.FormEvent<HTMLSelectElement>, value: string) => void","description":"Optional callback for updating when selection changes"},{"name":"onFocus","type":"(event: React.FormEvent<HTMLSelectElement>) => void","description":"Optional callback for updating when selection gets focus"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"Unknown","type":"string","description":"Custom flag to show that the FormSelect requires an associated id or aria-label."},{"name":"validated","type":"'success' | 'warning' | 'error' | 'default'","description":"Value to indicate if the select is modified to show that validation state.\nIf set to success, select will be modified to indicate valid state.\nIf set to error, select will be modified to indicate error state."},{"name":"value","type":"any","description":"value of selected option"}]},"FormControlIcon":{"name":"FormControlIcon","description":"","props":[{"name":"className","type":"string","description":"Additional class names added to the text input icon wrapper."},{"name":"customIcon","type":"React.ReactNode","description":"A custom icon to render instead of a status icon."},{"name":"status","type":"'success' | 'error' | 'warning'","description":"The status icon to render."}]},"FormControlIconProps":{"name":"FormControlIconProps","description":"","props":[{"name":"className","type":"string","description":"Additional class names added to the text input icon wrapper."},{"name":"customIcon","type":"React.ReactNode","description":"A custom icon to render instead of a status icon."},{"name":"status","type":"'success' | 'error' | 'warning'","description":"The status icon to render."}]},"InternalFormFieldGroup":{"name":"InternalFormFieldGroup","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered as form field group content."},{"name":"className","type":"string","description":"Additional classes added to the form field group."},{"name":"header","type":"any","description":"Form field group header"},{"name":"isExpandable","type":"boolean","description":"Flag indicating if the field group is expandable"},{"name":"isExpanded","type":"boolean","description":"Flag indicate if the form field group is expanded. Modifies the card to be expandable."},{"name":"onToggle","type":"() => void","description":"Function callback called when user clicks toggle button"},{"name":"toggleAriaLabel","type":"string","description":"Aria-label to use on the form field group toggle button"}]},"InternalFormFieldGroupProps":{"name":"InternalFormFieldGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered as form field group content."},{"name":"className","type":"string","description":"Additional classes added to the form field group."},{"name":"header","type":"any","description":"Form field group header"},{"name":"isExpandable","type":"boolean","description":"Flag indicating if the field group is expandable"},{"name":"isExpanded","type":"boolean","description":"Flag indicate if the form field group is expanded. Modifies the card to be expandable."},{"name":"onToggle","type":"() => void","description":"Function callback called when user clicks toggle button"},{"name":"toggleAriaLabel","type":"string","description":"Aria-label to use on the form field group toggle button"}]},"FormSection":{"name":"FormSection","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the section"},{"name":"className","type":"string","description":"Additional classes added to the section","defaultValue":"''"},{"name":"title","type":"React.ReactNode","description":"Title for the section","defaultValue":"''"},{"name":"titleElement","type":"'div' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Element to wrap the section title","defaultValue":"'div'"}]},"FormSectionProps":{"name":"FormSectionProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the section"},{"name":"className","type":"string","description":"Additional classes added to the section"},{"name":"title","type":"React.ReactNode","description":"Title for the section"},{"name":"titleElement","type":"'div' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Element to wrap the section title"}]},"FormHelperText":{"name":"FormHelperText","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the helper text wrapper","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the helper text wrapper","defaultValue":"''"}]},"FormHelperTextProps":{"name":"FormHelperTextProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the helper text wrapper"},{"name":"className","type":"string","description":"Additional classes added to the helper text wrapper"}]},"FormGroupLabelHelp":{"name":"FormGroupLabelHelp","description":"A help button to be passed to the FormGroup's labelHelp property. This should be wrapped or linked\nto our Popover component.","props":[{"name":"aria-label","type":"string","description":"Adds accessible text to the button.","required":true},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the button"},{"name":"className","type":"string","description":"Additional classes added to the button"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to button"},{"name":"countOptions","type":"BadgeCountObject","description":"Adds count number to button"},{"name":"hasNoPadding","type":"boolean","description":"Applies no padding on a plain button variant. Use when plain button is placed inline with text"},{"name":"icon","type":"React.ReactNode | null","description":"Icon for the button."},{"name":"iconPosition","type":"'start' | 'end' | 'left' | 'right'","description":"Sets position of the icon. Note: \"left\" and \"right\" are deprecated. Use \"start\" and \"end\" instead"},{"name":"inoperableEvents","type":"string[]","description":"Events to prevent when the button is in an aria-disabled state"},{"name":"isAriaDisabled","type":"boolean","description":"Adds disabled styling and communicates that the button is disabled using the aria-disabled html attribute"},{"name":"isBlock","type":"boolean","description":"Adds block styling to button"},{"name":"isClicked","type":"boolean","description":"Adds clicked styling to button."},{"name":"isDanger","type":"boolean","description":"Adds danger styling to secondary or link button variants"},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling and disables the button using the disabled html attribute"},{"name":"isInline","type":"boolean","description":"Adds inline styling to a link button"},{"name":"isLoading","type":"boolean","description":"Adds progress styling to button"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"size","type":"'default' | 'sm' | 'lg'","description":"Adds styling which affects the size of the button"},{"name":"spinnerAriaLabel","type":"string","description":"Accessible label for the spinner to describe what is loading"},{"name":"spinnerAriaLabelledBy","type":"string","description":"Id of element which describes what is being loaded"},{"name":"spinnerAriaValueText","type":"string","description":"Text describing that current loading status or progress"},{"name":"state","type":"'read' | 'unread' | 'attention'","description":"Sets state of the stateful button variant. Default is \"unread\""},{"name":"tabIndex","type":"number","description":"Sets the button tabindex."},{"name":"type","type":"'button' | 'submit' | 'reset'","description":"Sets button type"},{"name":"variant","type":"'primary' | 'secondary' | 'tertiary' | 'danger' | 'warning' | 'link' | 'plain' | 'control' | 'stateful'","description":"Adds button variant styles"}]},"FormGroupLabelHelpProps":{"name":"FormGroupLabelHelpProps","description":"A help button to be passed to the FormGroup's labelHelp property. This should be wrapped or linked\nto our Popover component.","props":[{"name":"className","type":"string","description":"Additional classes added to the help button."},{"name":"innerRef","type":"React.Ref<HTMLSpanElement>","description":""},{"name":"Unknown","type":"string","description":"Adds an accessible name for the help button.","required":true}]},"FormGroup":{"name":"FormGroup","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered as FormGroup content.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the FormGroup.","defaultValue":"''"},{"name":"fieldId","type":"string","description":"ID of an individual field or a group of multiple fields. Required when a role of \"group\" or \"radiogroup\" is passed in.\nIf only one field is included, its ID attribute and this prop must be the same."},{"name":"hasNoPaddingTop","type":"boolean","description":"Removes top spacer from label.","defaultValue":"false"},{"name":"isInline","type":"boolean","description":"Sets the FormGroup isInline.","defaultValue":"false"},{"name":"isRequired","type":"boolean","description":"Sets the FormGroup required.","defaultValue":"false"},{"name":"isStack","type":"boolean","description":"Sets the FormGroupControl to be stacked","defaultValue":"false"},{"name":"label","type":"React.ReactNode","description":"Label text before the field."},{"name":"labelHelp","type":"React.ReactElement<any>","description":"A help button for the label. We recommend using FormGroupLabelHelp element as a help icon button. The help button should be wrapped or linked to our popover component."},{"name":"labelInfo","type":"React.ReactNode","description":"Additional label information displayed after the label."},{"name":"role","type":"string","description":"Sets the role of the form group. Pass in \"radiogroup\" when the form group contains multiple\nradio inputs, or pass in \"group\" when the form group contains multiple of any other input type."}]},"FormGroupProps":{"name":"FormGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered as FormGroup content."},{"name":"className","type":"string","description":"Additional classes added to the FormGroup."},{"name":"fieldId","type":"string","description":"ID of an individual field or a group of multiple fields. Required when a role of \"group\" or \"radiogroup\" is passed in.\nIf only one field is included, its ID attribute and this prop must be the same."},{"name":"hasNoPaddingTop","type":"boolean","description":"Removes top spacer from label."},{"name":"isInline","type":"boolean","description":"Sets the FormGroup isInline."},{"name":"isRequired","type":"boolean","description":"Sets the FormGroup required."},{"name":"isStack","type":"boolean","description":"Sets the FormGroupControl to be stacked"},{"name":"label","type":"React.ReactNode","description":"Label text before the field."},{"name":"labelHelp","type":"React.ReactElement<any>","description":"A help button for the label. We recommend using FormGroupLabelHelp element as a help icon button. The help button should be wrapped or linked to our popover component."},{"name":"labelInfo","type":"React.ReactNode","description":"Additional label information displayed after the label."},{"name":"role","type":"string","description":"Sets the role of the form group. Pass in \"radiogroup\" when the form group contains multiple\nradio inputs, or pass in \"group\" when the form group contains multiple of any other input type."}]},"FormFieldGroupToggle":{"name":"FormFieldGroupToggle","description":"","props":[{"name":"aria-label","type":"string","description":"Aria label of the toggle button"},{"name":"aria-labelledby","type":"string","description":"Sets the aria-labelledby attribute on the toggle button element"},{"name":"className","type":"string","description":"Additional classes added to the section"},{"name":"isExpanded","type":"boolean","description":"Flag indicating if the toggle is expanded","required":true},{"name":"onToggle","type":"() => void","description":"Callback for onClick","required":true},{"name":"toggleId","type":"string","description":"The id applied to the toggle button"}]},"FormFieldGroupToggleProps":{"name":"FormFieldGroupToggleProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the section"},{"name":"isExpanded","type":"boolean","description":"Flag indicating if the toggle is expanded","required":true},{"name":"onToggle","type":"() => void","description":"Callback for onClick","required":true},{"name":"toggleId","type":"string","description":"The id applied to the toggle button"},{"name":"Unknown","type":"string","description":"Sets the aria-labelledby attribute on the toggle button element"}]},"FormFieldGroupHeader":{"name":"FormFieldGroupHeader","description":"","props":[{"name":"actions","type":"React.ReactNode","description":"Field group header actions"},{"name":"className","type":"string","description":"Additional classes added to the section"},{"name":"titleDescription","type":"React.ReactNode","description":"Field group header title description"},{"name":"titleText","type":"FormFieldGroupHeaderTitleTextObject","description":"Field group header title text"}]},"FormFieldGroupHeaderTitleTextObject":{"name":"FormFieldGroupHeaderTitleTextObject","description":"","props":[{"name":"id","type":"string","description":"The id applied to the title div for accessibility","required":true},{"name":"text","type":"React.ReactNode","description":"Title text.","required":true}]},"FormFieldGroupHeaderProps":{"name":"FormFieldGroupHeaderProps","description":"","props":[{"name":"actions","type":"React.ReactNode","description":"Field group header actions"},{"name":"className","type":"string","description":"Additional classes added to the section"},{"name":"titleDescription","type":"React.ReactNode","description":"Field group header title description"},{"name":"titleText","type":"FormFieldGroupHeaderTitleTextObject","description":"Field group header title text"}]},"FormFieldGroupExpandable":{"name":"FormFieldGroupExpandable","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered as form field group content."},{"name":"className","type":"string","description":"Additional classes added to the form field group."},{"name":"header","type":"React.ReactNode","description":"Form field group header"},{"name":"isExpanded","type":"boolean","description":"Flag indicating if the form field group is initially expanded","defaultValue":"false"},{"name":"toggleAriaLabel","type":"string","description":"Aria-label to use on the form field group toggle button"}]},"FormFieldGroupExpandableProps":{"name":"FormFieldGroupExpandableProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered as form field group content."},{"name":"className","type":"string","description":"Additional classes added to the form field group."},{"name":"header","type":"React.ReactNode","description":"Form field group header"},{"name":"isExpanded","type":"boolean","description":"Flag indicating if the form field group is initially expanded"},{"name":"toggleAriaLabel","type":"string","description":"Aria-label to use on the form field group toggle button"}]},"FormFieldGroup":{"name":"FormFieldGroup","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered as form field group content."},{"name":"className","type":"string","description":"Additional classes added to the form field group."},{"name":"header","type":"React.ReactNode","description":"Form field group header"}]},"FormFieldGroupProps":{"name":"FormFieldGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered as form field group content."},{"name":"className","type":"string","description":"Additional classes added to the form field group."},{"name":"header","type":"React.ReactNode","description":"Form field group header"}]},"FormContextProvider":{"name":"FormContextProvider","description":"","props":[]},"FormContextProps":{"name":"FormContextProps","description":"","props":[{"name":"errors","type":"Record<string, string>","description":"Record of errors for all fieldIds","required":true},{"name":"getError","type":"string","description":"Get the error message for a given fieldId","required":true},{"name":"getValue","type":"string","description":"Get the value for a given fieldId","required":true},{"name":"isTouched","type":"boolean","description":"Used to determine touched state for a given fieldId","required":true},{"name":"isValid","type":"boolean","description":"Flag to determine the overall validity. True if the record of errors is empty.","required":true},{"name":"setError","type":"void","description":"Set the error message for a given fieldId","required":true},{"name":"setErrors","type":"Dispatch<SetStateAction<Record<string, string>>>","description":"Set multiple errors within the managed record of errors","required":true},{"name":"setTouched","type":"void","description":"Used to update the touched state for a given fieldId","required":true},{"name":"setValidator","type":"void","description":"Set a validator for a specific fieldId","required":true},{"name":"setValue","type":"void","description":"Set the value for a given fieldId","required":true},{"name":"setValues","type":"Dispatch<SetStateAction<Record<string, string>>>","description":"Set multiple values within the managed record of values","required":true},{"name":"touched","type":"Record<string, boolean>","description":"Record of touched state for all fieldIds","required":true},{"name":"validate","type":"Record<string, string | null>","description":"Triggers all fieldId-specific validators","required":true},{"name":"values","type":"Record<string, string>","description":"Record of values for all fieldIds","required":true}]},"FormContextProviderProps":{"name":"FormContextProviderProps","description":"","props":[{"name":"children","type":"React.ReactNode | ((props: FormContextProps) => React.ReactNode)","description":"Any react node. Can optionally use render function to return context props."},{"name":"initialValues","type":"Record<string, string>","description":"Record of initial values"}]},"FormAlert":{"name":"FormAlert","description":"","props":[{"name":"children","type":"React.ReactNode","description":"An inline PatternFly Alert.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the FormGroup.","defaultValue":"''"}]},"FormAlertProps":{"name":"FormAlertProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"An inline PatternFly Alert."},{"name":"className","type":"string","description":"Additional classes added to the FormGroup."}]},"Form":{"name":"Form","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered as Form content."},{"name":"className","type":"string","description":"Additional classes added to the Form."},{"name":"isHorizontal","type":"boolean","description":"Sets the Form to horizontal."},{"name":"isWidthLimited","type":"boolean","description":"Limits the max-width of the form."},{"name":"maxWidth","type":"string","description":"Sets a custom max-width for the form."}]},"FormProps":{"name":"FormProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered as Form content."},{"name":"className","type":"string","description":"Additional classes added to the Form."},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"isHorizontal","type":"boolean","description":"Sets the Form to horizontal."},{"name":"isWidthLimited","type":"boolean","description":"Limits the max-width of the form."},{"name":"maxWidth","type":"string","description":"Sets a custom max-width for the form."}]},"ActionGroup":{"name":"ActionGroup","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered as ActionGroup content.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the ActionGroup.","defaultValue":"''"}]},"ActionGroupProps":{"name":"ActionGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered as ActionGroup content."},{"name":"className","type":"string","description":"Additional classes added to the ActionGroup."}]},"FileUploadHelperText":{"name":"FileUploadHelperText","description":"A container for helper text content. This sub-component should be passed as a child to\nthe main file upload or file upload field component.","props":[{"name":"children","type":"React.ReactNode","description":"Content to render inside the file upload helper text container. Typically this will be\nthe helper text component.","required":true},{"name":"className","type":"string","description":"Additional classes added to the file upload helper text container element."}]},"FileUploadHelperTextProps":{"name":"FileUploadHelperTextProps","description":"A container for helper text content. This sub-component should be passed as a child to\nthe main file upload or file upload field component.","props":[{"name":"children","type":"React.ReactNode","description":"Content to render inside the file upload helper text container. Typically this will be\nthe helper text component.","required":true},{"name":"className","type":"string","description":"Additional classes added to the file upload helper text container element."}]},"FileUploadField":{"name":"FileUploadField","description":"A more customizable file upload component for implementing custom logic. Drag and drop\nfunctionality is not built in by default.","props":[{"name":"allowEditingUploadedText","type":"boolean","description":"Flag to allow editing of a text file's contents after it is selected from disk.","defaultValue":"false"},{"name":"aria-label","type":"string","description":"Aria-label for the text area.","defaultValue":"'File upload'"},{"name":"browseButtonAriaDescribedby","type":"string","description":"ID or ID's of elements that describe the browse button. Typically this should refer\nto elements such as helper text when there are file restrictions."},{"name":"browseButtonText","type":"string","description":"Text for the browse button.","defaultValue":"'Browse...'"},{"name":"children","type":"React.ReactNode","description":"Additional children to render after (or instead of) the file preview.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the file upload field container element.","defaultValue":"''"},{"name":"clearButtonText","type":"string","description":"Text for the clear button.","defaultValue":"'Clear'"},{"name":"containerRef","type":"React.Ref<HTMLDivElement>","description":"A reference object to attach to the file upload field container element.","defaultValue":"null"},{"name":"filename","type":"string","description":"Value to be shown in the read-only filename field.","defaultValue":"''"},{"name":"filenameAriaLabel","type":"string","description":"Aria-label for the read-only filename field.","defaultValue":"filename ? 'Read only filename' : filenamePlaceholder"},{"name":"filenamePlaceholder","type":"string","description":"Placeholder string to display in the empty filename field.","defaultValue":"'Drag a file here or browse to upload'"},{"name":"hideDefaultPreview","type":"boolean","description":"Flag to hide the built-in preview of the file (where available). If true, you can use\nthe children property to render an alternate preview.","defaultValue":"false"},{"name":"id","type":"string","description":"Unique id for the text area. Also used to generate ids for accessible labels.","required":true},{"name":"isBrowseButtonDisabled","type":"boolean","description":"Flag to disable the browse button.","defaultValue":"false"},{"name":"isClearButtonDisabled","type":"boolean","description":"Flag to disable the clear button.","defaultValue":"!filename && !value"},{"name":"isDisabled","type":"boolean","description":"Flag to show if the field is disabled.","defaultValue":"false"},{"name":"isDragActive","type":"boolean","description":"Flag to show if a file is being dragged over the file upload field.","defaultValue":"false"},{"name":"isLoading","type":"boolean","description":"Flag to show if a file is being loaded.","defaultValue":"false"},{"name":"isReadOnly","type":"boolean","description":"Flag to show if the field is read only.","defaultValue":"false"},{"name":"isRequired","type":"boolean","description":"Flag to show if the field is required.","defaultValue":"false"},{"name":"name","type":"string","description":"Name property for the text input."},{"name":"onBrowseButtonClick","type":"(event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void","description":"A callback for when the browse button is clicked.","defaultValue":"() => {}"},{"name":"onClearButtonClick","type":"(event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void","description":"A callback for when the clear button is clicked.","defaultValue":"() => {}"},{"name":"onTextAreaBlur","type":"(event?: any) => void","description":"Callback for when focus is lost on the text area field."},{"name":"onTextAreaClick","type":"(event: React.MouseEvent<HTMLTextAreaElement, MouseEvent>) => void","description":"A callback for when the text area is clicked. Can also be set via the onClick property\nof the file upload component."},{"name":"onTextChange","type":"(event: React.ChangeEvent<HTMLTextAreaElement>, text: string) => void","description":"Text area text changed."},{"name":"spinnerAriaValueText","type":"string","description":"Aria-valuetext for the loading spinner."},{"name":"textAreaPlaceholder","type":"string","description":"Placeholder string to display in the empty text area field.","defaultValue":"''"},{"name":"type","type":"'text' | 'dataURL'","description":"What type of file. Determines what is is expected by the value property (a string for\n'text' and 'dataURL', or a File object otherwise)."},{"name":"validated","type":"'success' | 'error' | 'default'","description":"Value to indicate if the field is modified to show that validation state.\nIf set to success, field will be modified to indicate valid state.\nIf set to error, field will be modified to indicate error state.","defaultValue":"'default'"},{"name":"value","type":"string | File","description":"Value of the file's contents (string if text file, File object otherwise).","defaultValue":"''"}]},"FileUploadFieldProps":{"name":"FileUploadFieldProps","description":"A more customizable file upload component for implementing custom logic. Drag and drop\nfunctionality is not built in by default.","props":[{"name":"allowEditingUploadedText","type":"boolean","description":"Flag to allow editing of a text file's contents after it is selected from disk."},{"name":"browseButtonAriaDescribedby","type":"string","description":"ID or ID's of elements that describe the browse button. Typically this should refer\nto elements such as helper text when there are file restrictions."},{"name":"browseButtonText","type":"string","description":"Text for the browse button."},{"name":"children","type":"React.ReactNode","description":"Additional children to render after (or instead of) the file preview."},{"name":"className","type":"string","description":"Additional classes added to the file upload field container element."},{"name":"clearButtonText","type":"string","description":"Text for the clear button."},{"name":"containerRef","type":"React.Ref<HTMLDivElement>","description":"A reference object to attach to the file upload field container element."},{"name":"filename","type":"string","description":"Value to be shown in the read-only filename field."},{"name":"filenameAriaLabel","type":"string","description":"Aria-label for the read-only filename field."},{"name":"filenamePlaceholder","type":"string","description":"Placeholder string to display in the empty filename field."},{"name":"hideDefaultPreview","type":"boolean","description":"Flag to hide the built-in preview of the file (where available). If true, you can use\nthe children property to render an alternate preview."},{"name":"id","type":"string","description":"Unique id for the text area. Also used to generate ids for accessible labels.","required":true},{"name":"isBrowseButtonDisabled","type":"boolean","description":"Flag to disable the browse button."},{"name":"isClearButtonDisabled","type":"boolean","description":"Flag to disable the clear button."},{"name":"isDisabled","type":"boolean","description":"Flag to show if the field is disabled."},{"name":"isDragActive","type":"boolean","description":"Flag to show if a file is being dragged over the file upload field."},{"name":"isLoading","type":"boolean","description":"Flag to show if a file is being loaded."},{"name":"isReadOnly","type":"boolean","description":"Flag to show if the field is read only."},{"name":"isRequired","type":"boolean","description":"Flag to show if the field is required."},{"name":"name","type":"string","description":"Name property for the text input."},{"name":"onBrowseButtonClick","type":"(event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void","description":"A callback for when the browse button is clicked."},{"name":"onClearButtonClick","type":"(event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void","description":"A callback for when the clear button is clicked."},{"name":"onTextAreaBlur","type":"(event?: any) => void","description":"Callback for when focus is lost on the text area field."},{"name":"onTextAreaClick","type":"(event: React.MouseEvent<HTMLTextAreaElement, MouseEvent>) => void","description":"A callback for when the text area is clicked. Can also be set via the onClick property\nof the file upload component."},{"name":"onTextChange","type":"(event: React.ChangeEvent<HTMLTextAreaElement>, text: string) => void","description":"Text area text changed."},{"name":"spinnerAriaValueText","type":"string","description":"Aria-valuetext for the loading spinner."},{"name":"textAreaPlaceholder","type":"string","description":"Placeholder string to display in the empty text area field."},{"name":"type","type":"'text' | 'dataURL'","description":"What type of file. Determines what is is expected by the value property (a string for\n'text' and 'dataURL', or a File object otherwise)."},{"name":"Unknown","type":"string","description":"Aria-label for the text area."},{"name":"validated","type":"'success' | 'error' | 'default'","description":"Value to indicate if the field is modified to show that validation state.\nIf set to success, field will be modified to indicate valid state.\nIf set to error, field will be modified to indicate error state."},{"name":"value","type":"string | File","description":"Value of the file's contents (string if text file, File object otherwise)."}]},"FileUpload":{"name":"FileUpload","description":"","props":[{"name":"allowEditingUploadedText","type":"boolean","description":"Flag to allow editing of a text file's contents after it is selected from disk."},{"name":"aria-label","type":"string","description":"Aria-label for the text area."},{"name":"browseButtonAriaDescribedby","type":"string","description":"ID or ID's of elements that describe the browse button. Typically this should refer\nto elements such as helper text when there are file restrictions."},{"name":"browseButtonText","type":"string","description":"Text for the browse button."},{"name":"children","type":"React.ReactNode","description":"Additional children to render after (or instead of) the file preview.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the file upload container element."},{"name":"clearButtonText","type":"string","description":"Text for the clear button."},{"name":"dropzoneProps","type":"Partial<DropzoneOptions>","description":"Optional extra props to customize react-dropzone.","defaultValue":"{}"},{"name":"filename","type":"string","description":"Value to be shown in the read-only filename field.","defaultValue":"''"},{"name":"filenameAriaLabel","type":"string","description":"Aria-label for the read-only filename field."},{"name":"filenamePlaceholder","type":"string","description":"Placeholder string to display in the empty filename field."},{"name":"hideDefaultPreview","type":"boolean","description":"Flag to hide the built-in preview of the file (where available). If true, you can use\nthe children property to render an alternate preview."},{"name":"id","type":"string","description":"Unique id for the text area. Also used to generate ids for accessible labels.","required":true},{"name":"isDisabled","type":"boolean","description":"Flag to show if the field is disabled."},{"name":"isLoading","type":"boolean","description":"Flag to show if a file is being loaded."},{"name":"isReadOnly","type":"boolean","description":"Flag to show if the field is read only."},{"name":"isRequired","type":"boolean","description":"Flag to show if the field is required."},{"name":"onClearClick","type":"React.MouseEventHandler<HTMLButtonElement>","description":"Clear button was clicked."},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"Callback for clicking on the file upload field text area. By default, prevents a click\nin the text area from opening file dialog.","defaultValue":"(event) => event.preventDefault()"},{"name":"onDataChange","type":"(event: DropEvent, data: string) => void","description":"On data changed - if type='text' or type='dataURL' and file was loaded it will call this method"},{"name":"onFileInputChange","type":"(event: DropEvent, file: File) => void","description":"Change event emitted from the hidden \\<input type=\"file\" \\> field associated with the component","defaultValue":"null"},{"name":"onReadFailed","type":"(event: DropEvent, error: DOMException, fileHandle: File) => void","description":"A callback for when the FileReader API fails.","defaultValue":"() => {}"},{"name":"onReadFinished","type":"(event: DropEvent, fileHandle: File) => void","description":"A callback for when a selected file finishes loading.","defaultValue":"() => {}"},{"name":"onReadStarted","type":"(event: DropEvent, fileHandle: File) => void","description":"A callback for when a selected file starts loading.","defaultValue":"() => {}"},{"name":"onTextChange","type":"(event: React.ChangeEvent<HTMLTextAreaElement>, text: string) => void","description":"Text area text changed."},{"name":"spinnerAriaValueText","type":"string","description":"Aria-valuetext for the loading spinner."},{"name":"type","type":"'text' | 'dataURL'","description":"What type of file. Determines whether 'onDataChange` is called and what is\nexpected by the value property (a string for 'text' and 'dataURL', or a File object otherwise."},{"name":"validated","type":"'success' | 'error' | 'default'","description":"Value to indicate if the field is modified to show that validation state.\nIf set to success, field will be modified to indicate valid state.\nIf set to error, field will be modified to indicate error state."},{"name":"value","type":"string | File","description":"Value of the file's contents (string if text file, File object otherwise).","defaultValue":"type === fileReaderType.text || type === fileReaderType.dataURL ? '' : null"}]},"FileUploadProps":{"name":"FileUploadProps","description":"","props":[{"name":"allowEditingUploadedText","type":"boolean","description":"Flag to allow editing of a text file's contents after it is selected from disk."},{"name":"browseButtonAriaDescribedby","type":"string","description":"ID or ID's of elements that describe the browse button. Typically this should refer\nto elements such as helper text when there are file restrictions."},{"name":"browseButtonText","type":"string","description":"Text for the browse button."},{"name":"children","type":"React.ReactNode","description":"Additional children to render after (or instead of) the file preview."},{"name":"className","type":"string","description":"Additional classes added to the file upload container element."},{"name":"clearButtonText","type":"string","description":"Text for the clear button."},{"name":"dropzoneProps","type":"Partial<DropzoneOptions>","description":"Optional extra props to customize react-dropzone."},{"name":"filename","type":"string","description":"Value to be shown in the read-only filename field."},{"name":"filenameAriaLabel","type":"string","description":"Aria-label for the read-only filename field."},{"name":"filenamePlaceholder","type":"string","description":"Placeholder string to display in the empty filename field."},{"name":"hideDefaultPreview","type":"boolean","description":"Flag to hide the built-in preview of the file (where available). If true, you can use\nthe children property to render an alternate preview."},{"name":"id","type":"string","description":"Unique id for the text area. Also used to generate ids for accessible labels.","required":true},{"name":"isDisabled","type":"boolean","description":"Flag to show if the field is disabled."},{"name":"isLoading","type":"boolean","description":"Flag to show if a file is being loaded."},{"name":"isReadOnly","type":"boolean","description":"Flag to show if the field is read only."},{"name":"isRequired","type":"boolean","description":"Flag to show if the field is required."},{"name":"onClearClick","type":"React.MouseEventHandler<HTMLButtonElement>","description":"Clear button was clicked."},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"Callback for clicking on the file upload field text area. By default, prevents a click\nin the text area from opening file dialog."},{"name":"onDataChange","type":"(event: DropEvent, data: string) => void","description":"On data changed - if type='text' or type='dataURL' and file was loaded it will call this method"},{"name":"onFileInputChange","type":"(event: DropEvent, file: File) => void","description":"Change event emitted from the hidden \\<input type=\"file\" \\> field associated with the component"},{"name":"onReadFailed","type":"(event: DropEvent, error: DOMException, fileHandle: File) => void","description":"A callback for when the FileReader API fails."},{"name":"onReadFinished","type":"(event: DropEvent, fileHandle: File) => void","description":"A callback for when a selected file finishes loading."},{"name":"onReadStarted","type":"(event: DropEvent, fileHandle: File) => void","description":"A callback for when a selected file starts loading."},{"name":"onTextChange","type":"(event: React.ChangeEvent<HTMLTextAreaElement>, text: string) => void","description":"Text area text changed."},{"name":"spinnerAriaValueText","type":"string","description":"Aria-valuetext for the loading spinner."},{"name":"type","type":"'text' | 'dataURL'","description":"What type of file. Determines whether 'onDataChange` is called and what is\nexpected by the value property (a string for 'text' and 'dataURL', or a File object otherwise."},{"name":"Unknown","type":"string","description":"Aria-label for the text area."},{"name":"validated","type":"'success' | 'error' | 'default'","description":"Value to indicate if the field is modified to show that validation state.\nIf set to success, field will be modified to indicate valid state.\nIf set to error, field will be modified to indicate error state."},{"name":"value","type":"string | File","description":"Value of the file's contents (string if text file, File object otherwise)."}]},"ExpandableSectionToggle":{"name":"ExpandableSectionToggle","description":"Acts as the toggle sub-component when the main expandable section component has the isDetached\nproperty passed in. Allows for more custom control over the expandable section's toggle.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the expandable toggle."},{"name":"className","type":"string","description":"Additional classes added to the expandable toggle.","defaultValue":"''"},{"name":"contentId","type":"string","description":"Id of the toggle's respective expandable section content. The value passed into this\nproperty should match the contentId property of the main expandable section component."},{"name":"direction","type":"'up' | 'down'","description":"Direction the toggle arrow should point when the expandable section is expanded.","defaultValue":"'down'"},{"name":"hasTruncatedContent","type":"boolean","description":"Flag to determine toggle styling when the expandable content is truncated.","defaultValue":"false"},{"name":"isExpanded","type":"boolean","description":"Flag indicating if the expandable section is expanded.","defaultValue":"false"},{"name":"onToggle","type":"(isExpanded: boolean) => void","description":"Callback function to toggle the expandable content."},{"name":"toggleId","type":"string","description":"Id of the toggle. The value passed into this property should match the aria-labelledby\nproperty of the main expandable section component."}]},"ExpandableSectionToggleProps":{"name":"ExpandableSectionToggleProps","description":"Acts as the toggle sub-component when the main expandable section component has the isDetached\nproperty passed in. Allows for more custom control over the expandable section's toggle.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the expandable toggle."},{"name":"className","type":"string","description":"Additional classes added to the expandable toggle."},{"name":"contentId","type":"string","description":"Id of the toggle's respective expandable section content. The value passed into this\nproperty should match the contentId property of the main expandable section component."},{"name":"direction","type":"'up' | 'down'","description":"Direction the toggle arrow should point when the expandable section is expanded."},{"name":"hasTruncatedContent","type":"boolean","description":"Flag to determine toggle styling when the expandable content is truncated."},{"name":"isExpanded","type":"boolean","description":"Flag indicating if the expandable section is expanded."},{"name":"onToggle","type":"(isExpanded: boolean) => void","description":"Callback function to toggle the expandable content."},{"name":"toggleId","type":"string","description":"Id of the toggle. The value passed into this property should match the aria-labelledby\nproperty of the main expandable section component."}]},"ExpandableSection":{"name":"ExpandableSection","description":"The main expandable section component.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the expandable section."},{"name":"className","type":"string","description":"Additional classes added to the expandable section.","defaultValue":"''"},{"name":"contentId","type":"string","description":"Id of the content of the expandable section. When passing in the isDetached property, this\nproperty's value should match the contentId property of the expandable section toggle sub-component."},{"name":"displaySize","type":"'default' | 'lg'","description":"Display size variant. Set to \"lg\" for disclosure styling.","defaultValue":"'default'"},{"name":"isDetached","type":"boolean","description":"Indicates the expandable section has a detached toggle.","defaultValue":"false"},{"name":"isExpanded","type":"boolean","description":"Flag to indicate if the content is expanded."},{"name":"isIndented","type":"boolean","description":"Flag to indicate if the content is indented.","defaultValue":"false"},{"name":"isWidthLimited","type":"boolean","description":"Flag to indicate the width of the component is limited. Set to \"true\" for disclosure styling.","defaultValue":"false"},{"name":"onToggle","type":"(event: React.MouseEvent, isExpanded: boolean) => void","description":"Callback function to toggle the expandable section. Detached expandable sections should\nuse the onToggle property of the expandable section toggle sub-component.","defaultValue":"(event, isExpanded): void => undefined"},{"name":"toggleContent","type":"React.ReactNode","description":"React node that appears in the attached toggle in place of the toggleText property."},{"name":"toggleId","type":"string","description":"Id of the toggle of the expandable section, which provides an accessible name to the\nexpandable section content via the aria-labelledby attribute. When the isDetached property\nis also passed in, the value of this property must match the toggleId property of the\nexpandable section toggle sub-component."},{"name":"toggleText","type":"string","description":"Text that appears in the attached toggle.","defaultValue":"''"},{"name":"toggleTextCollapsed","type":"string","description":"Text that appears in the attached toggle when collapsed (will override toggleText if\nboth are specified; used for uncontrolled expandable with dynamic toggle text).","defaultValue":"''"},{"name":"toggleTextExpanded","type":"string","description":"Text that appears in the attached toggle when expanded (will override toggleText if\nboth are specified; used for uncontrolled expandable with dynamic toggle text).","defaultValue":"''"},{"name":"truncateMaxLines","type":"number","description":"Truncates the expandable content to the specified number of lines when using the\n\"truncate\" variant."},{"name":"variant","type":"'default' | 'truncate'","description":"Determines the variant of the expandable section. When passing in \"truncate\" as the\nvariant, the expandable content will be truncated after 3 lines by default.","defaultValue":"'default'"}]},"ExpandableSectionProps":{"name":"ExpandableSectionProps","description":"The main expandable section component.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the expandable section."},{"name":"className","type":"string","description":"Additional classes added to the expandable section."},{"name":"contentId","type":"string","description":"Id of the content of the expandable section. When passing in the isDetached property, this\nproperty's value should match the contentId property of the expandable section toggle sub-component."},{"name":"displaySize","type":"'default' | 'lg'","description":"Display size variant. Set to \"lg\" for disclosure styling."},{"name":"isDetached","type":"boolean","description":"Indicates the expandable section has a detached toggle."},{"name":"isExpanded","type":"boolean","description":"Flag to indicate if the content is expanded."},{"name":"isIndented","type":"boolean","description":"Flag to indicate if the content is indented."},{"name":"isWidthLimited","type":"boolean","description":"Flag to indicate the width of the component is limited. Set to \"true\" for disclosure styling."},{"name":"onToggle","type":"(event: React.MouseEvent, isExpanded: boolean) => void","description":"Callback function to toggle the expandable section. Detached expandable sections should\nuse the onToggle property of the expandable section toggle sub-component."},{"name":"toggleContent","type":"React.ReactNode","description":"React node that appears in the attached toggle in place of the toggleText property."},{"name":"toggleId","type":"string","description":"Id of the toggle of the expandable section, which provides an accessible name to the\nexpandable section content via the aria-labelledby attribute. When the isDetached property\nis also passed in, the value of this property must match the toggleId property of the\nexpandable section toggle sub-component."},{"name":"toggleText","type":"string","description":"Text that appears in the attached toggle."},{"name":"toggleTextCollapsed","type":"string","description":"Text that appears in the attached toggle when collapsed (will override toggleText if\nboth are specified; used for uncontrolled expandable with dynamic toggle text)."},{"name":"toggleTextExpanded","type":"string","description":"Text that appears in the attached toggle when expanded (will override toggleText if\nboth are specified; used for uncontrolled expandable with dynamic toggle text)."},{"name":"truncateMaxLines","type":"number","description":"Truncates the expandable content to the specified number of lines when using the\n\"truncate\" variant."},{"name":"variant","type":"'default' | 'truncate'","description":"Determines the variant of the expandable section. When passing in \"truncate\" as the\nvariant, the expandable content will be truncated after 3 lines by default."}]},"ExpandableSectionState":{"name":"ExpandableSectionState","description":"","props":[{"name":"hasToggle","type":"boolean","description":null,"required":true},{"name":"isExpanded","type":"boolean","description":null,"required":true},{"name":"previousWidth","type":"number","description":null,"required":true}]},"EmptyStateIcon":{"name":"EmptyStateIcon","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the empty state icon"},{"name":"icon","type":"React.ComponentType<any>","description":"Icon component to be rendered. Can also be a spinner component","required":true}]},"EmptyStateIconProps":{"name":"EmptyStateIconProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the empty state icon"},{"name":"icon","type":"React.ComponentType<any>","description":"Icon component to be rendered. Can also be a spinner component","required":true}]},"EmptyStateHeader":{"name":"EmptyStateHeader","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the empty state header"},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"The heading level to use, default is h1","defaultValue":"EmptyStateHeadingLevel.h1"},{"name":"icon","type":"React.ComponentType<any>","description":"Empty state icon element to be rendered. Can also be a spinner component"},{"name":"titleClassName","type":"string","description":"Additional classes added to the title inside empty state header"},{"name":"titleText","type":"React.ReactNode","description":"Text of the title inside empty state header, will be wrapped in headingLevel"}]},"EmptyStateHeaderProps":{"name":"EmptyStateHeaderProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the empty state header"},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"The heading level to use, default is h1"},{"name":"icon","type":"React.ComponentType<any>","description":"Empty state icon element to be rendered. Can also be a spinner component"},{"name":"titleClassName","type":"string","description":"Additional classes added to the title inside empty state header"},{"name":"titleText","type":"React.ReactNode","description":"Text of the title inside empty state header, will be wrapped in headingLevel"}]},"EmptyStateFooter":{"name":"EmptyStateFooter","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the empty state footer"},{"name":"className","type":"string","description":"Additional classes added to the empty state footer"}]},"EmptyStateFooterProps":{"name":"EmptyStateFooterProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the empty state footer"},{"name":"className","type":"string","description":"Additional classes added to the empty state footer"}]},"EmptyStateBody":{"name":"EmptyStateBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the empty state body"},{"name":"className","type":"string","description":"Additional classes added to the empty state body"}]},"EmptyStateBodyProps":{"name":"EmptyStateBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the empty state body"},{"name":"className","type":"string","description":"Additional classes added to the empty state body"}]},"EmptyStateActions":{"name":"EmptyStateActions","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the empty state actions"},{"name":"className","type":"string","description":"Additional classes added to the empty state actions"}]},"EmptyStateActionsProps":{"name":"EmptyStateActionsProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the empty state actions"},{"name":"className","type":"string","description":"Additional classes added to the empty state actions"}]},"EmptyState":{"name":"EmptyState","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the empty state"},{"name":"className","type":"string","description":"Additional classes added to the empty state"},{"name":"headerClassName","type":"string","description":"Additional class names to apply to the empty state header"},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"The heading level to use, default is h1"},{"name":"icon","type":"React.ComponentType<any>","description":"Empty state icon element to be rendered. Can also be a spinner component"},{"name":"isFullHeight","type":"boolean","description":"Cause component to consume the available height of its container"},{"name":"status","type":"'danger' | 'warning' | 'success' | 'info' | 'custom'","description":"Status of the empty state, will set a default status icon and color. Icon can be overwritten using the icon prop"},{"name":"titleClassName","type":"string","description":"Additional classes added to the title inside empty state header"},{"name":"titleText","type":"React.ReactNode","description":"Text of the title inside empty state header, will be wrapped in headingLevel"},{"name":"variant","type":"'xs' | 'sm' | 'lg' | 'xl' | 'full'","description":"Modifies empty state max-width and sizes of icon, title and body","defaultValue":"EmptyStateVariant.full"}]},"EmptyStateProps":{"name":"EmptyStateProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the empty state"},{"name":"className","type":"string","description":"Additional classes added to the empty state"},{"name":"headerClassName","type":"string","description":"Additional class names to apply to the empty state header"},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"The heading level to use, default is h1"},{"name":"icon","type":"React.ComponentType<any>","description":"Empty state icon element to be rendered. Can also be a spinner component"},{"name":"isFullHeight","type":"boolean","description":"Cause component to consume the available height of its container"},{"name":"status","type":"'danger' | 'warning' | 'success' | 'info' | 'custom'","description":"Status of the empty state, will set a default status icon and color. Icon can be overwritten using the icon prop"},{"name":"titleClassName","type":"string","description":"Additional classes added to the title inside empty state header"},{"name":"titleText","type":"React.ReactNode","description":"Text of the title inside empty state header, will be wrapped in headingLevel"},{"name":"variant","type":"'xs' | 'sm' | 'lg' | 'xl' | 'full'","description":"Modifies empty state max-width and sizes of icon, title and body"}]},"DualListSelectorTreeItemBase":{"name":"DualListSelectorTreeItemBase","description":"","props":[{"name":"badgeProps","type":"any","description":"Additional properties to pass to the option badge."},{"name":"checkProps","type":"any","description":"Additional properties to pass to the option checkbox."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the dual list selector."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"defaultExpanded","type":"boolean","description":"Flag indicating this option is expanded by default."},{"name":"hasBadge","type":"boolean","description":"Flag indicating this option has a badge."},{"name":"id","type":"string","description":"ID of the option.","required":true},{"name":"isChecked","type":"boolean","description":"Flag indicating if this open is checked."},{"name":"isDisabled","type":"boolean","description":"Flag indicating whether the component is disabled.","defaultValue":"false"},{"name":"itemData","type":"DualListSelectorTreeItemData","description":"Raw data of the option."},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n isChecked: boolean,\n itemData: DualListSelectorTreeItemData\n) => void","description":"Callback fired when an option is checked."},{"name":"text","type":"string","description":"Text of the option.","required":true},{"name":"useMemo","type":"boolean","description":"Flag indicating the DualListSelector tree should utilize memoization to help render large data sets."}]},"DualListSelectorTreeItemProps":{"name":"DualListSelectorTreeItemProps","description":"","props":[{"name":"badgeProps","type":"any","description":"Additional properties to pass to the option badge."},{"name":"checkProps","type":"any","description":"Additional properties to pass to the option checkbox."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the dual list selector."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"defaultExpanded","type":"boolean","description":"Flag indicating this option is expanded by default."},{"name":"hasBadge","type":"boolean","description":"Flag indicating this option has a badge."},{"name":"id","type":"string","description":"ID of the option.","required":true},{"name":"isChecked","type":"boolean","description":"Flag indicating if this open is checked."},{"name":"isDisabled","type":"boolean","description":"Flag indicating whether the component is disabled."},{"name":"itemData","type":"DualListSelectorTreeItemData","description":"Raw data of the option."},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n isChecked: boolean,\n itemData: DualListSelectorTreeItemData\n ) => void","description":"Callback fired when an option is checked."},{"name":"text","type":"string","description":"Text of the option.","required":true},{"name":"useMemo","type":"boolean","description":"Flag indicating the DualListSelector tree should utilize memoization to help render large data sets."}]},"DualListSelectorTree":{"name":"DualListSelectorTree","description":"Used in place of the DualListSelectorListItem sub-component when building a\ncomposable dual list selector with a tree.","props":[{"name":"data","type":"DualListSelectorTreeItemData[] | (() => DualListSelectorTreeItemData[])","description":"Data of the tree view.","required":true},{"name":"defaultAllExpanded","type":"boolean","description":"Sets the default expanded behavior.","defaultValue":"false"},{"name":"hasBadges","type":"boolean","description":"Flag indicating if all options should have badges.","defaultValue":"false"},{"name":"id","type":"string","description":"ID of the tree view."},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the dual list selector tree is in the disabled state.","defaultValue":"false"},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n isChecked: boolean,\n itemData: DualListSelectorTreeItemData\n) => void","description":"Callback fired when an option is checked."}]},"DualListSelectorTreeItemData":{"name":"DualListSelectorTreeItemData","description":"","props":[{"name":"badgeProps","type":"any","description":"Additional properties to pass to the option badge."},{"name":"checkProps","type":"any","description":"Additional properties to pass to the option checkbox."},{"name":"children","type":"DualListSelectorTreeItemData[]","description":"Content rendered inside the dual list selector."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"defaultExpanded","type":"boolean","description":"Flag indicating this option is expanded by default."},{"name":"hasBadge","type":"boolean","description":"Flag indicating this option has a badge."},{"name":"id","type":"string","description":"ID of the option.","required":true},{"name":"isChecked","type":"boolean","description":"Checked state of the option.","required":true},{"name":"isDisabled","type":"boolean","description":"Flag indicating whether the component is disabled."},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n isChecked: boolean,\n isChosen: boolean,\n itemData: DualListSelectorTreeItemData\n ) => void","description":"Callback fired when an option is checked."},{"name":"parentId","type":"string","description":"Parent ID of an option."},{"name":"text","type":"string","description":"Text of the option.","required":true}]},"DualListSelectorTreeProps":{"name":"DualListSelectorTreeProps","description":"Used in place of the DualListSelectorListItem sub-component when building a\ncomposable dual list selector with a tree.","props":[{"name":"data","type":"DualListSelectorTreeItemData[] | (() => DualListSelectorTreeItemData[])","description":"Data of the tree view.","required":true},{"name":"defaultAllExpanded","type":"boolean","description":"Sets the default expanded behavior."},{"name":"hasBadges","type":"boolean","description":"Flag indicating if all options should have badges."},{"name":"id","type":"string","description":"ID of the tree view."},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the dual list selector tree is in the disabled state."},{"name":"isNested","type":"boolean","description":""},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n isChecked: boolean,\n itemData: DualListSelectorTreeItemData\n ) => void","description":"Callback fired when an option is checked."}]},"DualListSelectorPane":{"name":"DualListSelectorPane","description":"Acts as the container for a list of options that are either available or chosen,\ndepending on the pane type (available or chosen). A search input and other actions,\nsuch as sorting, can also be passed into this sub-component.","props":[{"name":"actions","type":"React.ReactNode[]","description":"Actions to place above the pane."},{"name":"children","type":"React.ReactNode","description":"A dual list selector list or dual list selector tree to be rendered in the pane."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector pane.","defaultValue":"''"},{"name":"id","type":"string","description":"ID of the pane.","defaultValue":"getUniqueId('dual-list-selector-pane')"},{"name":"isChosen","type":"boolean","description":"Flag indicating if this pane is the chosen pane.","defaultValue":"false"},{"name":"isDisabled","type":"boolean","description":"Flag indicating whether the component is disabled.","defaultValue":"false"},{"name":"listMinHeight","type":"string","description":"Minimum height of the list of options rendered in the pane. *"},{"name":"onSearch","type":"(event: React.ChangeEvent<HTMLInputElement>) => void","description":"Callback for search input. To be used when isSearchable is true."},{"name":"searchInput","type":"React.ReactNode","description":"A search input placed above the list at the top of the pane, before actions."},{"name":"status","type":"string","description":"Status to display above the pane.","defaultValue":"''"},{"name":"title","type":"React.ReactNode","description":"Title of the pane.","defaultValue":"''"}]},"DualListSelectorPaneProps":{"name":"DualListSelectorPaneProps","description":"Acts as the container for a list of options that are either available or chosen,\ndepending on the pane type (available or chosen). A search input and other actions,\nsuch as sorting, can also be passed into this sub-component.","props":[{"name":"actions","type":"React.ReactNode[]","description":"Actions to place above the pane."},{"name":"children","type":"React.ReactNode","description":"A dual list selector list or dual list selector tree to be rendered in the pane."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector pane."},{"name":"id","type":"string","description":"ID of the pane."},{"name":"isChosen","type":"boolean","description":"Flag indicating if this pane is the chosen pane."},{"name":"isDisabled","type":"boolean","description":"Flag indicating whether the component is disabled."},{"name":"listMinHeight","type":"string","description":"Minimum height of the list of options rendered in the pane. *"},{"name":"onSearch","type":"(event: React.ChangeEvent<HTMLInputElement>) => void","description":"Callback for search input. To be used when isSearchable is true."},{"name":"searchInput","type":"React.ReactNode","description":"A search input placed above the list at the top of the pane, before actions."},{"name":"status","type":"string","description":"Status to display above the pane."},{"name":"title","type":"React.ReactNode","description":"Title of the pane."}]},"DualListSelectorListWrapperProps":{"name":"DualListSelectorListWrapperProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the list."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"displayOption","type":"(option: React.ReactNode) => boolean","description":""},{"name":"id","type":"string","description":"ID of the dual list selector list."},{"name":"innerRef","type":"React.RefObject<HTMLDivElement | null>","description":""},{"name":"isDisabled","type":"boolean","description":"Flag indicating whether the component is disabled."},{"name":"options","type":"React.ReactNode[]","description":""},{"name":"selectedOptions","type":"string[] | number[]","description":""},{"name":"Unknown","type":"string","description":"Accessibly label for the list.","required":true}]},"DualListSelectorListItemProps":{"name":"DualListSelectorListItemProps","description":"Creates an individual option that can be selected and moved between the\ndual list selector panes. This is contained within the DualListSelectorList sub-component.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the dual list selector."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"draggableButtonAriaLabel","type":"string","description":"Accessible label for the draggable button on draggable list items."},{"name":"id","type":"string","description":"ID of the option."},{"name":"innerRef","type":"React.RefObject<HTMLLIElement | null>","description":""},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the dual list selector is in a disabled state."},{"name":"isDraggable","type":"boolean","description":"Flag indicating this item is draggable for reordering."},{"name":"isSelected","type":"boolean","description":"Flag indicating the list item is currently selected."},{"name":"onOptionSelect","type":"(event: React.MouseEvent | React.ChangeEvent | React.KeyboardEvent, id?: string) => void","description":"Callback fired when an option is selected."},{"name":"orderIndex","type":"number","description":""}]},"DualListSelectorListProps":{"name":"DualListSelectorListProps","description":"Acts as the container for DualListSelectorListItem sub-components.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the dual list selector list."},{"name":"innerRef","type":"React.RefObject<HTMLUListElement | null>","description":""}]},"DualListSelectorControlsWrapperProps":{"name":"DualListSelectorControlsWrapperProps","description":"Acts as the container for the DualListSelectorControl sub-components.","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered inside of the controls wrapper."},{"name":"className","type":"string","description":"Additional classes added to the wrapper."},{"name":"innerRef","type":"React.RefObject<HTMLDivElement | null>","description":""},{"name":"Unknown","type":"string","description":"Accessible label for the dual list selector controls wrapper."}]},"DualListSelectorControlProps":{"name":"DualListSelectorControlProps","description":"Renders an individual control button for moving selected options between each\ndual list selector pane.","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the dual list selector control."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector control."},{"name":"icon","type":"React.ReactNode","description":"Icon to be rendered in the dual list selector control."},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"isDisabled","type":"boolean","description":"Flag indicating the control is disabled."},{"name":"onClick","type":"(event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void","description":"Callback fired when dual list selector control is selected."},{"name":"tooltipContent","type":"React.ReactNode","description":"Content to be displayed in a tooltip on hover of control."},{"name":"tooltipProps","type":"any","description":"Additional tooltip properties passed to the tooltip."},{"name":"Unknown","type":"string","description":"Accessible label for the dual list selector control."}]},"DualListSelector":{"name":"DualListSelector","description":"Acts as a container for all other DualListSelector sub-components when using a\ncomposable dual list selector.","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the dual list selector.","defaultValue":"''"},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"id","type":"string","description":"ID of the dual list selector."},{"name":"isTree","type":"boolean","description":"Flag indicating if the dual list selector uses trees instead of simple lists.","defaultValue":"false"}]},"DualListSelectorProps":{"name":"DualListSelectorProps","description":"Acts as a container for all other DualListSelector sub-components when using a\ncomposable dual list selector.","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the dual list selector."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"id","type":"string","description":"ID of the dual list selector."},{"name":"isTree","type":"boolean","description":"Flag indicating if the dual list selector uses trees instead of simple lists."}]},"DropdownList":{"name":"DropdownList","description":"","props":[{"name":"aria-label","type":"string","description":"Adds an accessible name to the menu."},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of menu list","required":true},{"name":"className","type":"string","description":"Additional classes added to the menu list"},{"name":"isAriaMultiselectable","type":"boolean","description":"Indicates to assistive technologies whether more than one item can be selected\nfor a non-checkbox menu. Only applies when the menu's role is \"listbox\"."}]},"DropdownListProps":{"name":"DropdownListProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything which can be rendered in a dropdown list","required":true},{"name":"className","type":"string","description":"Classes applied to root element of dropdown list"}]},"DropdownItem":{"name":"DropdownItem","description":"See the MenuItem section of the Menu documentation for additional props that may be passed.","props":[{"name":"children","type":"React.ReactNode","description":"Anything which can be rendered in a dropdown item"},{"name":"className","type":"string","description":"Classes applied to root element of dropdown item"},{"name":"description","type":"React.ReactNode","description":"Description of the dropdown item"},{"name":"isAriaDisabled","type":"boolean","description":"Render item as aria-disabled option"},{"name":"isDisabled","type":"boolean","description":"Render item as disabled option"},{"name":"onClick","type":"(event?: any) => void","description":"Callback for item click"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"tooltipProps","type":"TooltipProps","description":"Props for adding a tooltip to a menu item"},{"name":"value","type":"any","description":"Identifies the component in the dropdown onSelect callback"}]},"DropdownItemProps":{"name":"DropdownItemProps","description":"See the MenuItem section of the Menu documentation for additional props that may be passed.","props":[{"name":"children","type":"React.ReactNode","description":"Anything which can be rendered in a dropdown item"},{"name":"className","type":"string","description":"Classes applied to root element of dropdown item"},{"name":"description","type":"React.ReactNode","description":"Description of the dropdown item"},{"name":"innerRef","type":"React.Ref<HTMLAnchorElement | HTMLButtonElement>","description":""},{"name":"isAriaDisabled","type":"boolean","description":"Render item as aria-disabled option"},{"name":"isDisabled","type":"boolean","description":"Render item as disabled option"},{"name":"onClick","type":"(event?: any) => void","description":"Callback for item click"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"tooltipProps","type":"TooltipProps","description":"Props for adding a tooltip to a menu item"},{"name":"value","type":"any","description":"Identifies the component in the dropdown onSelect callback"}]},"DropdownGroup":{"name":"DropdownGroup","description":"See the MenuGroup section of the Menu documentation for additional props that may be passed.","props":[{"name":"children","type":"React.ReactNode","description":"Anything which can be rendered in a dropdown group.","required":true},{"name":"className","type":"string","description":"Classes applied to root element of dropdown group"},{"name":"label","type":"React.ReactNode","description":"Label of the dropdown group"},{"name":"labelHeadingLevel","type":"No type info","defaultValue":"'h1'"}]},"DropdownGroupProps":{"name":"DropdownGroupProps","description":"See the MenuGroup section of the Menu documentation for additional props that may be passed.","props":[{"name":"children","type":"React.ReactNode","description":"Anything which can be rendered in a dropdown group.","required":true},{"name":"className","type":"string","description":"Classes applied to root element of dropdown group"},{"name":"label","type":"React.ReactNode","description":"Label of the dropdown group"}]},"Dropdown":{"name":"Dropdown","description":"See the Menu documentation for additional props that may be passed.","props":[{"name":"activeItemId","type":"string | number","description":"itemId of the currently active item. You can also specify isActive on the MenuItem."},{"name":"activeMenu","type":"string","description":"ID of the currently active menu for the drilldown variant"},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the Menu"},{"name":"className","type":"string","description":"Additional classes added to the Menu"},{"name":"containsDrilldown","type":"boolean","description":"Indicates if menu contains a drilldown menu"},{"name":"containsFlyout","type":"boolean","description":"Indicates if menu contains a flyout menu"},{"name":"drilldownItemPath","type":"string[]","description":"Indicates the path of drilled in menu itemIds"},{"name":"drilledInMenus","type":"string[]","description":"Array of menus that are drilled in"},{"name":"focusTimeoutDelay","type":"number","description":"Time in ms to wait before firing the toggles' focus event. Defaults to 0"},{"name":"id","type":"string","description":"ID of the menu"},{"name":"isMenuDrilledIn","type":"boolean","description":"Indicates if a menu is drilled into"},{"name":"isNavFlyout","type":"boolean","description":"Indicating that the menu should have nav flyout styling"},{"name":"isOpen","type":"boolean","description":"Flag to indicate if menu is opened."},{"name":"isPlain","type":"boolean","description":"Indicates if the menu should be without the outer box-shadow"},{"name":"isRootMenu","type":"boolean","description":"Internal flag indicating if the Menu is the root of a menu tree"},{"name":"isScrollable","type":"boolean","description":"Indicates if the menu should be srollable"},{"name":"maxMenuHeight","type":"string","description":"Maximum height of dropdown menu"},{"name":"menuHeight","type":"string","description":"Height of the dropdown menu"},{"name":"onActionClick","type":"(event?: any, itemId?: any, actionId?: any) => void","description":"Callback called when an MenuItems's action button is clicked. You can also specify it within a MenuItemAction."},{"name":"onDrillIn","type":"(\n event: React.KeyboardEvent | React.MouseEvent,\n fromItemId: string,\n toItemId: string,\n itemId: string\n) => void","description":"Callback for drilling into a submenu"},{"name":"onDrillOut","type":"(event: React.KeyboardEvent | React.MouseEvent, toItemId: string, itemId: string) => void","description":"Callback for drilling out of a submenu"},{"name":"onGetMenuHeight","type":"(menuId: string, height: number) => void","description":"Callback for collecting menu heights"},{"name":"onOpenChange","type":"(isOpen: boolean) => void","description":"Callback to allow the dropdown component to change the open state of the menu.\nTriggered by clicking outside of the menu, or by pressing any keys specified in onOpenChangeKeys."},{"name":"onOpenChangeKeys","type":"string[]","description":"Keys that trigger onOpenChange, defaults to tab and escape. It is highly recommended to include Escape in the array, while Tab may be omitted if the menu contains non-menu items that are focusable."},{"name":"onSelect","type":"(event?: React.MouseEvent<Element, MouseEvent>, value?: string | number) => void","description":"Callback for updating when item selection changes. You can also specify onClick on the MenuItem."},{"name":"onToggleKeydown","type":"(event: KeyboardEvent) => void","description":"Callback to override the toggle keydown behavior. By default, when the toggle has focus and the menu is open, pressing the up/down arrow keys will focus a valid non-disabled menu item - the first item for the down arrow key and last item for the up arrow key."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"parentMenu","type":"string","description":"ID of parent menu for drilldown menus"},{"name":"popperProps","type":"DropdownPopperProps","description":"Additional properties to pass to the Popper"},{"name":"role","type":"string","description":"Determines the accessible role of the menu. For a non-checkbox menu that can have\none or more items selected, pass in \"listbox\"."},{"name":"selected","type":"any | any[]","description":"Single itemId for single select menus, or array of itemIds for multi select. You can also specify isSelected on the MenuItem."},{"name":"shouldFocusFirstItemOnOpen","type":"boolean","description":"Flag indicating the first menu item should be focused after opening the dropdown.","beta":true},{"name":"shouldFocusToggleOnSelect","type":"boolean","description":"Flag indicating the toggle should be focused after a selection. If this use case is too restrictive, the optional toggleRef property with a node toggle may be used to control focus."},{"name":"shouldPreventScrollOnItemFocus","type":"boolean","description":"Flag indicating if scroll on focus of the first menu item should occur."},{"name":"toggle","type":"DropdownToggleProps | ((toggleRef: React.RefObject<any>) => React.ReactNode)","description":"Dropdown toggle. The toggle should either be a renderer function which forwards the given toggle ref, or a direct ReactNode that should be passed along with the toggleRef property.","required":true},{"name":"zIndex","type":"number","description":"z-index of the dropdown menu"}]},"DropdownPopperProps":{"name":"DropdownPopperProps","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement) | 'inline'","description":"The container to append the popper to. Defaults to document.body."},{"name":"direction","type":"'up' | 'down'","description":"Vertical direction of the popper. If enableFlip is set to true, this will set the initial direction before the popper flips."},{"name":"enableFlip","type":"boolean","description":"Enable to flip the popper when it reaches the boundary"},{"name":"maxWidth","type":"string | 'trigger'","description":"Maximum width of the popper. If the value is \"trigger\", it will set the max width to the dropdown toggle's width"},{"name":"minWidth","type":"string | 'trigger'","description":"Minimum width of the popper. If the value is \"trigger\", it will set the min width to the dropdown toggle's width"},{"name":"position","type":"'right' | 'left' | 'center' | 'start' | 'end'","description":"Horizontal position of the popper"},{"name":"preventOverflow","type":"boolean","description":"Flag to prevent the popper from overflowing its container and becoming partially obscured."},{"name":"width","type":"string | 'trigger'","description":"Custom width of the popper. If the value is \"trigger\", it will set the width to the dropdown toggle's width"}]},"DropdownToggleProps":{"name":"DropdownToggleProps","description":"","props":[{"name":"toggleNode","type":"React.ReactNode","description":"Dropdown toggle node.","required":true},{"name":"toggleRef","type":"React.RefObject<HTMLButtonElement | null>","description":"Reference to the toggle."}]},"DropdownProps":{"name":"DropdownProps","description":"See the Menu documentation for additional props that may be passed.","props":[{"name":"children","type":"React.ReactNode","description":"Anything which can be rendered in a dropdown."},{"name":"className","type":"string","description":"Classes applied to root element of dropdown."},{"name":"focusTimeoutDelay","type":"number","description":"Time in ms to wait before firing the toggles' focus event. Defaults to 0"},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"isOpen","type":"boolean","description":"Flag to indicate if menu is opened."},{"name":"isPlain","type":"boolean","description":"Indicates if the menu should be without the outer box-shadow."},{"name":"isScrollable","type":"boolean","description":"Indicates if the menu should be scrollable."},{"name":"maxMenuHeight","type":"string","description":"Maximum height of dropdown menu"},{"name":"menuHeight","type":"string","description":"Height of the dropdown menu"},{"name":"onOpenChange","type":"(isOpen: boolean) => void","description":"Callback to allow the dropdown component to change the open state of the menu.\nTriggered by clicking outside of the menu, or by pressing any keys specified in onOpenChangeKeys."},{"name":"onOpenChangeKeys","type":"string[]","description":"Keys that trigger onOpenChange, defaults to tab and escape. It is highly recommended to include Escape in the array, while Tab may be omitted if the menu contains non-menu items that are focusable."},{"name":"onSelect","type":"(event?: React.MouseEvent<Element, MouseEvent>, value?: string | number) => void","description":"Function callback called when user selects item."},{"name":"onToggleKeydown","type":"(event: KeyboardEvent) => void","description":"Callback to override the toggle keydown behavior. By default, when the toggle has focus and the menu is open, pressing the up/down arrow keys will focus a valid non-disabled menu item - the first item for the down arrow key and last item for the up arrow key."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"popperProps","type":"DropdownPopperProps","description":"Additional properties to pass to the Popper"},{"name":"shouldFocusFirstItemOnOpen","type":"boolean","description":""},{"name":"shouldFocusToggleOnSelect","type":"boolean","description":"Flag indicating the toggle should be focused after a selection. If this use case is too restrictive, the optional toggleRef property with a node toggle may be used to control focus."},{"name":"shouldPreventScrollOnItemFocus","type":"boolean","description":"Flag indicating if scroll on focus of the first menu item should occur."},{"name":"toggle","type":"DropdownToggleProps | ((toggleRef: React.RefObject<any>) => React.ReactNode)","description":"Dropdown toggle. The toggle should either be a renderer function which forwards the given toggle ref, or a direct ReactNode that should be passed along with the toggleRef property.","required":true},{"name":"zIndex","type":"number","description":"z-index of the dropdown menu"}]},"DrawerSection":{"name":"DrawerSection","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer section."},{"name":"className","type":"string","description":"Additional classes added to the drawer section.","defaultValue":"''"},{"name":"colorVariant","type":"DrawerColorVariant | 'no-background' | 'default' | 'secondary'","description":"Color variant of the background of the drawer Section","defaultValue":"DrawerColorVariant.default"}]},"DrawerSectionProps":{"name":"DrawerSectionProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer section."},{"name":"className","type":"string","description":"Additional classes added to the drawer section."},{"name":"colorVariant","type":"DrawerColorVariant | 'no-background' | 'default' | 'secondary'","description":"Color variant of the background of the drawer Section"}]},"DrawerPanelDescription":{"name":"DrawerPanelDescription","description":"Provides a description within the drawer panel. This should typically follow the drawer head.","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer description","required":true},{"name":"className","type":"string","description":"Additional classes added to the drawer description."}]},"DrawerPanelDescriptionProps":{"name":"DrawerPanelDescriptionProps","description":"Provides a description within the drawer panel. This should typically follow the drawer head.","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer description","required":true},{"name":"className","type":"string","description":"Additional classes added to the drawer description."}]},"DrawerPanelContent":{"name":"DrawerPanelContent","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer panel."},{"name":"className","type":"string","description":"Additional classes added to the drawer."},{"name":"colorVariant","type":"DrawerColorVariant | 'no-background' | 'default' | 'secondary'","description":"Color variant of the background of the drawer panel","defaultValue":"DrawerColorVariant.default"},{"name":"defaultSize","type":"string","description":"The starting size of a drawer."},{"name":"focusTrap","type":"DrawerPanelFocusTrapObject","description":"Adds and customizes a focus trap on the drawer panel content."},{"name":"hasNoBorder","type":"boolean","description":"Flag indicating that the drawer panel should not have a border.","defaultValue":"false"},{"name":"id","type":"string","description":"ID of the drawer panel"},{"name":"increment","type":"number","description":"The increment amount for keyboard drawer resizing.","defaultValue":"5"},{"name":"isResizable","type":"boolean","description":"Flag indicating that the drawer panel should be resizable.","defaultValue":"false"},{"name":"maxSize","type":"string","description":"The maximum size of a drawer."},{"name":"minSize","type":"string","description":"The minimum size of a drawer."},{"name":"onResize","type":"(event: MouseEvent | TouchEvent | React.KeyboardEvent, width: number, id: string) => void","description":"Callback for resize end."},{"name":"resizeAriaLabel","type":"string","description":"Aria label for the resizable drawer splitter.","defaultValue":"'Resize'"},{"name":"widths","type":"{\n default?: 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n lg?: 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n xl?: 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n '2xl'?: 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n}","description":"Width for drawer panel at various breakpoints. Overridden by resizable drawer minSize and defaultSize."}]},"DrawerPanelFocusTrapObject":{"name":"DrawerPanelFocusTrapObject","description":"","props":[{"name":"elementToFocusOnExpand","type":"HTMLElement | SVGElement | string","description":"The element to focus when the drawer panel content expands. By default the\nfirst focusable element will receive focus. If there are no focusable elements, the\npanel itself will receive focus."},{"name":"enabled","type":"boolean","description":"Enables a focus trap on the drawer panel content. This will also automatically\nhandle focus management when the panel expands and when it collapses. Do not pass\nthis prop if the isStatic prop on the drawer component is true."},{"name":"Unknown","type":"string","description":"One or more id's to use for the drawer panel content's accessible label."}]},"DrawerPanelContentProps":{"name":"DrawerPanelContentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer panel."},{"name":"className","type":"string","description":"Additional classes added to the drawer."},{"name":"colorVariant","type":"DrawerColorVariant | 'no-background' | 'default' | 'secondary'","description":"Color variant of the background of the drawer panel"},{"name":"defaultSize","type":"string","description":"The starting size of a drawer."},{"name":"focusTrap","type":"DrawerPanelFocusTrapObject","description":"Adds and customizes a focus trap on the drawer panel content."},{"name":"hasNoBorder","type":"boolean","description":"Flag indicating that the drawer panel should not have a border."},{"name":"id","type":"string","description":"ID of the drawer panel"},{"name":"increment","type":"number","description":"The increment amount for keyboard drawer resizing."},{"name":"isResizable","type":"boolean","description":"Flag indicating that the drawer panel should be resizable."},{"name":"maxSize","type":"string","description":"The maximum size of a drawer."},{"name":"minSize","type":"string","description":"The minimum size of a drawer."},{"name":"onResize","type":"(event: MouseEvent | TouchEvent | React.KeyboardEvent, width: number, id: string) => void","description":"Callback for resize end."},{"name":"resizeAriaLabel","type":"string","description":"Aria label for the resizable drawer splitter."},{"name":"widths","type":"{\n default?: 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n lg?: 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n xl?: 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n '2xl'?: 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100';\n }","description":"Width for drawer panel at various breakpoints. Overridden by resizable drawer minSize and defaultSize."}]},"DrawerPanelBody":{"name":"DrawerPanelBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer"},{"name":"className","type":"string","description":"Additional classes added to the Drawer.","defaultValue":"''"},{"name":"hasNoPadding","type":"boolean","description":"Indicates if there should be no padding around the drawer panel body","defaultValue":"false"}]},"DrawerPanelBodyProps":{"name":"DrawerPanelBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer"},{"name":"className","type":"string","description":"Additional classes added to the Drawer."},{"name":"hasNoPadding","type":"boolean","description":"Indicates if there should be no padding around the drawer panel body"}]},"DrawerMain":{"name":"DrawerMain","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer main wrapper"},{"name":"className","type":"string","description":"Additional classes added to the drawer main wrapper.","defaultValue":"''"}]},"DrawerMainProps":{"name":"DrawerMainProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer main wrapper"},{"name":"className","type":"string","description":"Additional classes added to the drawer main wrapper."}]},"DrawerHead":{"name":"DrawerHead","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer head"},{"name":"className","type":"string","description":"Additional classes added to the drawer head.","defaultValue":"''"}]},"DrawerHeadProps":{"name":"DrawerHeadProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer head"},{"name":"className","type":"string","description":"Additional classes added to the drawer head."}]},"DrawerContentBody":{"name":"DrawerContentBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer"},{"name":"className","type":"string","description":"Additional classes added to the Drawer.","defaultValue":"''"},{"name":"hasPadding","type":"boolean","description":"Indicates if there should be padding around the drawer content body","defaultValue":"false"}]},"DrawerContentBodyProps":{"name":"DrawerContentBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer"},{"name":"className","type":"string","description":"Additional classes added to the Drawer."},{"name":"hasPadding","type":"boolean","description":"Indicates if there should be padding around the drawer content body"}]},"DrawerContent":{"name":"DrawerContent","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer."},{"name":"className","type":"string","description":"Additional classes added to the Drawer."},{"name":"colorVariant","type":"DrawerContentColorVariant | 'default' | 'primary' | 'secondary'","description":"Color variant of the background of the drawer panel","defaultValue":"DrawerContentColorVariant.default"},{"name":"panelContent","type":"React.ReactNode","description":"Content rendered in the drawer panel.","required":true}]},"DrawerContentProps":{"name":"DrawerContentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the drawer."},{"name":"className","type":"string","description":"Additional classes added to the Drawer."},{"name":"colorVariant","type":"DrawerContentColorVariant | 'default' | 'primary' | 'secondary'","description":"Color variant of the background of the drawer panel"},{"name":"panelContent","type":"React.ReactNode","description":"Content rendered in the drawer panel.","required":true}]},"DrawerCloseButton":{"name":"DrawerCloseButton","description":"","props":[{"name":"aria-label","type":"string","description":"Accessible label for the drawer close button","defaultValue":"'Close drawer panel'"},{"name":"className","type":"string","description":"Additional classes added to the drawer close button outer <div>.","defaultValue":"''"},{"name":"onClose","type":"() => void","description":"A callback for when the close button is clicked","defaultValue":"() => undefined as any"}]},"DrawerCloseButtonProps":{"name":"DrawerCloseButtonProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the drawer close button outer <div>."},{"name":"onClose","type":"() => void","description":"A callback for when the close button is clicked"},{"name":"Unknown","type":"string","description":"Accessible label for the drawer close button"}]},"DrawerActions":{"name":"DrawerActions","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Actions to be rendered in the panel head."},{"name":"className","type":"string","description":"Additional classes added to the drawer actions button.","defaultValue":"''"}]},"DrawerActionsProps":{"name":"DrawerActionsProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Actions to be rendered in the panel head."},{"name":"className","type":"string","description":"Additional classes added to the drawer actions button."}]},"Drawer":{"name":"Drawer","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered in the drawer panel"},{"name":"className","type":"string","description":"Additional classes added to the Drawer.","defaultValue":"''"},{"name":"isExpanded","type":"boolean","description":"Indicates if the drawer is expanded","defaultValue":"false"},{"name":"isInline","type":"boolean","description":"Indicates if the content element and panel element are displayed side by side.","defaultValue":"false"},{"name":"isStatic","type":"boolean","description":"Indicates if the drawer will always show both content and panel.","defaultValue":"false"},{"name":"onExpand","type":"(event: KeyboardEvent | React.MouseEvent | React.TransitionEvent) => void","description":"Callback when drawer panel is expanded after waiting 250ms for animation to complete.","defaultValue":"() => {}"},{"name":"position","type":"'start' | 'end' | 'bottom' | 'left' | 'right'","description":"Position of the drawer panel. left and right are deprecated, use start and end instead.","defaultValue":"'end'"}]},"DrawerProps":{"name":"DrawerProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered in the drawer panel"},{"name":"className","type":"string","description":"Additional classes added to the Drawer."},{"name":"isExpanded","type":"boolean","description":"Indicates if the drawer is expanded"},{"name":"isInline","type":"boolean","description":"Indicates if the content element and panel element are displayed side by side."},{"name":"isStatic","type":"boolean","description":"Indicates if the drawer will always show both content and panel."},{"name":"onExpand","type":"(event: KeyboardEvent | React.MouseEvent | React.TransitionEvent) => void","description":"Callback when drawer panel is expanded after waiting 250ms for animation to complete."},{"name":"position","type":"'start' | 'end' | 'bottom' | 'left' | 'right'","description":"Position of the drawer panel. left and right are deprecated, use start and end instead."}]},"DrawerContextProps":{"name":"DrawerContextProps","description":"","props":[{"name":"drawerContentRef","type":"React.RefObject<HTMLDivElement | null>","description":null},{"name":"drawerRef","type":"React.RefObject<HTMLDivElement | null>","description":null},{"name":"isExpanded","type":"boolean","description":null,"required":true},{"name":"isInline","type":"boolean","description":null,"required":true},{"name":"isStatic","type":"boolean","description":null,"required":true},{"name":"onExpand","type":"(event: KeyboardEvent | React.MouseEvent | React.TransitionEvent) => void","description":null},{"name":"position","type":"string","description":null}]},"Divider":{"name":"Divider","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the divider"},{"name":"component","type":"'hr' | 'li' | 'div'","description":"The component type to use","defaultValue":"DividerVariant.hr"},{"name":"inset","type":"{\n default?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n sm?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n md?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n lg?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n xl?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n '2xl'?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n}","description":"Insets at various breakpoints."},{"name":"orientation","type":"{\n default?: 'vertical' | 'horizontal';\n sm?: 'vertical' | 'horizontal';\n md?: 'vertical' | 'horizontal';\n lg?: 'vertical' | 'horizontal';\n xl?: 'vertical' | 'horizontal';\n '2xl'?: 'vertical' | 'horizontal';\n}","description":"Indicates how the divider will display at various breakpoints. Vertical divider must be in a flex layout."}]},"DividerProps":{"name":"DividerProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the divider"},{"name":"component","type":"'hr' | 'li' | 'div'","description":"The component type to use"},{"name":"inset","type":"{\n default?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n sm?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n md?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n lg?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n xl?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n '2xl'?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n }","description":"Insets at various breakpoints."},{"name":"orientation","type":"{\n default?: 'vertical' | 'horizontal';\n sm?: 'vertical' | 'horizontal';\n md?: 'vertical' | 'horizontal';\n lg?: 'vertical' | 'horizontal';\n xl?: 'vertical' | 'horizontal';\n '2xl'?: 'vertical' | 'horizontal';\n }","description":"Indicates how the divider will display at various breakpoints. Vertical divider must be in a flex layout."}]},"DescriptionListTermHelpTextButton":{"name":"DescriptionListTermHelpTextButton","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of list term","required":true},{"name":"className","type":"string","description":"Additional classes added to the DescriptionListTerm"}]},"DescriptionListTermHelpTextButtonProps":{"name":"DescriptionListTermHelpTextButtonProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of list term","required":true},{"name":"className","type":"string","description":"Additional classes added to the DescriptionListTerm"}]},"DescriptionListTermHelpText":{"name":"DescriptionListTermHelpText","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of list term","required":true},{"name":"className","type":"string","description":"Additional classes added to the DescriptionListTermHelpText"}]},"DescriptionListTermHelpTextProps":{"name":"DescriptionListTermHelpTextProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of list term","required":true},{"name":"className","type":"string","description":"Additional classes added to the DescriptionListTermHelpText"}]},"DescriptionListTerm":{"name":"DescriptionListTerm","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of list term","required":true},{"name":"className","type":"string","description":"Additional classes added to the DescriptionListTerm"},{"name":"icon","type":"React.ReactNode","description":"Icon that is rendered inside of list term to the left side of the children"}]},"DescriptionListTermProps":{"name":"DescriptionListTermProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of list term","required":true},{"name":"className","type":"string","description":"Additional classes added to the DescriptionListTerm"},{"name":"icon","type":"React.ReactNode","description":"Icon that is rendered inside of list term to the left side of the children"}]},"DescriptionListGroup":{"name":"DescriptionListGroup","description":"","props":[{"name":"children","type":"any","description":"Any elements that can be rendered in the list group"},{"name":"className","type":"string","description":"Additional classes added to the DescriptionListGroup"}]},"DescriptionListGroupProps":{"name":"DescriptionListGroupProps","description":"","props":[{"name":"children","type":"any","description":"Any elements that can be rendered in the list group"},{"name":"className","type":"string","description":"Additional classes added to the DescriptionListGroup"}]},"DescriptionListDescription":{"name":"DescriptionListDescription","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of list description","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the DescriptionListDescription"}]},"DescriptionListDescriptionProps":{"name":"DescriptionListDescriptionProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of list description","required":true},{"name":"className","type":"string","description":"Additional classes added to the DescriptionListDescription"}]},"DescriptionList":{"name":"DescriptionList","description":"","props":[{"name":"autoFitMinModifier","type":"{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}","description":"Sets the minimum column size for the auto-fit (isAutoFit) layout at various breakpoints."},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the list","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the list","defaultValue":"''"},{"name":"columnModifier","type":"{\n default?: '1Col' | '2Col' | '3Col';\n sm?: '1Col' | '2Col' | '3Col';\n md?: '1Col' | '2Col' | '3Col';\n lg?: '1Col' | '2Col' | '3Col';\n xl?: '1Col' | '2Col' | '3Col';\n '2xl'?: '1Col' | '2Col' | '3Col';\n}","description":"Sets the number of columns on the description list at various breakpoints"},{"name":"displaySize","type":"'default' | 'lg' | '2xl'","description":"Sets the display size of the descriptions in the description list.","defaultValue":"'default'"},{"name":"horizontalTermWidthModifier","type":"{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}","description":"Sets the horizontal description list's term column width at various breakpoints."},{"name":"isAutoColumnWidths","type":"boolean","description":"Sets the description list to format automatically."},{"name":"isAutoFit","type":"boolean","description":"Sets the description list to auto fit."},{"name":"isCompact","type":"boolean","description":"Sets the description list to compact styling."},{"name":"isFillColumns","type":"boolean","description":"Sets the the default placement of description list groups to fill from top to bottom."},{"name":"isFluid","type":"boolean","description":"Sets a horizontal description list to have fluid styling."},{"name":"isHorizontal","type":"boolean","description":"Sets the description list component term and description pair to a horizontal layout.","defaultValue":"false"},{"name":"isInlineGrid","type":"boolean","description":"Modifies the description list display to inline-grid."},{"name":"orientation","type":"{\n sm?: 'vertical' | 'horizontal';\n md?: 'vertical' | 'horizontal';\n lg?: 'vertical' | 'horizontal';\n xl?: 'vertical' | 'horizontal';\n '2xl'?: 'vertical' | 'horizontal';\n}","description":"Indicates how the menu will align at various breakpoints."},{"name":"termWidth","type":"string","description":"Sets the description list's term column width."}]},"BreakpointModifiers":{"name":"BreakpointModifiers","description":"","props":[{"name":"default","type":"string","description":null},{"name":"lg","type":"string","description":null},{"name":"md","type":"string","description":null},{"name":"Unknown","type":"string","description":null},{"name":"xl","type":"string","description":null}]},"DescriptionListProps":{"name":"DescriptionListProps","description":"","props":[{"name":"autoFitMinModifier","type":"{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n }","description":"Sets the minimum column size for the auto-fit (isAutoFit) layout at various breakpoints."},{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the list"},{"name":"className","type":"string","description":"Additional classes added to the list"},{"name":"columnModifier","type":"{\n default?: '1Col' | '2Col' | '3Col';\n sm?: '1Col' | '2Col' | '3Col';\n md?: '1Col' | '2Col' | '3Col';\n lg?: '1Col' | '2Col' | '3Col';\n xl?: '1Col' | '2Col' | '3Col';\n '2xl'?: '1Col' | '2Col' | '3Col';\n }","description":"Sets the number of columns on the description list at various breakpoints"},{"name":"displaySize","type":"'default' | 'lg' | '2xl'","description":"Sets the display size of the descriptions in the description list."},{"name":"horizontalTermWidthModifier","type":"{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n }","description":"Sets the horizontal description list's term column width at various breakpoints."},{"name":"isAutoColumnWidths","type":"boolean","description":"Sets the description list to format automatically."},{"name":"isAutoFit","type":"boolean","description":"Sets the description list to auto fit."},{"name":"isCompact","type":"boolean","description":"Sets the description list to compact styling."},{"name":"isFillColumns","type":"boolean","description":"Sets the the default placement of description list groups to fill from top to bottom."},{"name":"isFluid","type":"boolean","description":"Sets a horizontal description list to have fluid styling."},{"name":"isHorizontal","type":"boolean","description":"Sets the description list component term and description pair to a horizontal layout."},{"name":"isInlineGrid","type":"boolean","description":"Modifies the description list display to inline-grid."},{"name":"orientation","type":"{\n sm?: 'vertical' | 'horizontal';\n md?: 'vertical' | 'horizontal';\n lg?: 'vertical' | 'horizontal';\n xl?: 'vertical' | 'horizontal';\n '2xl'?: 'vertical' | 'horizontal';\n }","description":"Indicates how the menu will align at various breakpoints."},{"name":"termWidth","type":"string","description":"Sets the description list's term column width."}]},"DatePicker":{"name":"DatePicker","description":"The main date picker component.","props":[{"name":"appendTo","type":"HTMLElement | ((ref?: HTMLElement) => HTMLElement) | 'inline'","description":"The container to append the menu to. Defaults to 'inline'.\nIf your menu is being cut off you can append it to an element higher up the DOM tree.\nSome examples:\nmenuAppendTo={() => document.body};\nmenuAppendTo={document.getElementById('target')}","defaultValue":"'inline'"},{"name":"aria-label","type":"string","description":"Accessible label for the date picker.","defaultValue":"'Date picker'"},{"name":"buttonAriaLabel","type":"string","description":"Accessible label for the button to open the date picker.","defaultValue":"'Toggle date picker'"},{"name":"cellAriaLabel","type":"(date: Date) => string","description":"Accessible label for the date cells."},{"name":"className","type":"string","description":"Additional classes added to the date picker."},{"name":"dateFormat","type":"(date: Date) => string","description":"How to format the date in the text input.","defaultValue":"(date: Date) =>\n`${date.getFullYear()}-${(date.getMonth() + 1).toString().padStart(2, '0')}-${date\n .getDate()\n .toString()\n .padStart(2, '0')}`"},{"name":"dateParse","type":"(value: string) => Date","description":"How to parse the date in the text input.","defaultValue":"(val: string) => (val.split('-').length === 3 ? new Date(`${val}T00:00:00`) : new Date(undefined))"},{"name":"dayFormat","type":"(date: Date) => React.ReactNode","description":"How to format days in buttons in table cells."},{"name":"helperText","type":"React.ReactNode","description":"Helper text to display alongside the date picker. Expects a HelperText component."},{"name":"inlineProps","type":"CalendarMonthInlineProps","description":"Props used to ensure accessibility when displaying the calendar month inline."},{"name":"inputProps","type":"TextInputProps","description":"Additional props for the text input.","defaultValue":"{}"},{"name":"invalidFormatText","type":"string","description":"Error message to display when the text input contains a non-empty value in an invalid format.","defaultValue":"'Invalid date'"},{"name":"isDisabled","type":"boolean","description":"Flag indicating the date picker is disabled.","defaultValue":"false"},{"name":"locale","type":"string","description":"If using the default formatters which locale to use. Undefined defaults to current locale.\nSee https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_identification_and_negotiation","defaultValue":"undefined"},{"name":"longWeekdayFormat","type":"(date: Date) => React.ReactNode","description":"How to format days in header for screen readers."},{"name":"monthFormat","type":"(date: Date) => React.ReactNode","description":"How to format months in month select."},{"name":"nextMonthAriaLabel","type":"string","description":"Accessible label for the next month button."},{"name":"onBlur","type":"(event: any, value: string, date?: Date) => void","description":"Callback called every time the text input loses focus.","defaultValue":"(): any => undefined"},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, value: string, date?: Date) => void","description":"Callback called every time the text input value changes.","defaultValue":"(): any => undefined"},{"name":"placeholder","type":"string","description":"String to display in the empty text input as a hint for the expected date format.","defaultValue":"'YYYY-MM-DD'"},{"name":"popoverProps","type":"Partial<Omit<PopoverProps, 'appendTo'>>","description":"Props to pass to the popover that contains the calendar month component."},{"name":"prevMonthAriaLabel","type":"string","description":"Accessible label for the previous month button."},{"name":"rangeStart","type":"Date","description":"Which date to start range styles from."},{"name":"requiredDateOptions","type":"DatePickerRequiredObject","description":"Options to customize the requirement of a date"},{"name":"style","type":"No type info","defaultValue":"{}"},{"name":"validators","type":"((date: Date) => string)[]","description":"Functions that returns an error message if a date is invalid.","defaultValue":"[]"},{"name":"value","type":"string","description":"Value of the text input.","defaultValue":"''"},{"name":"weekdayFormat","type":"(date: Date) => React.ReactNode","description":"How to format week days in header."},{"name":"weekStart","type":"0 | 1 | 2 | 3 | 4 | 5 | 6 | Weekday","description":"Day of week that starts the week. 0 is Sunday, 6 is Saturday."},{"name":"yearInputAriaLabel","type":"string","description":"Accessible label for the year input."}]},"DatePickerRequiredObject":{"name":"DatePickerRequiredObject","description":"Props that customize the requirement of a date","props":[{"name":"emptyDateText","type":"string","description":"Error message to display when the text input is empty and the isRequired prop is also passed in."},{"name":"isRequired","type":"boolean","description":"Flag indicating the date is required."}]},"DatePickerProps":{"name":"DatePickerProps","description":"The main date picker component.","props":[{"name":"appendTo","type":"HTMLElement | ((ref?: HTMLElement) => HTMLElement) | 'inline'","description":"The container to append the menu to. Defaults to 'inline'.\nIf your menu is being cut off you can append it to an element higher up the DOM tree.\nSome examples:\nmenuAppendTo={() => document.body};\nmenuAppendTo={document.getElementById('target')}"},{"name":"buttonAriaLabel","type":"string","description":"Accessible label for the button to open the date picker."},{"name":"className","type":"string","description":"Additional classes added to the date picker."},{"name":"dateFormat","type":"(date: Date) => string","description":"How to format the date in the text input."},{"name":"dateParse","type":"(value: string) => Date","description":"How to parse the date in the text input."},{"name":"helperText","type":"React.ReactNode","description":"Helper text to display alongside the date picker. Expects a HelperText component."},{"name":"inputProps","type":"TextInputProps","description":"Additional props for the text input."},{"name":"invalidFormatText","type":"string","description":"Error message to display when the text input contains a non-empty value in an invalid format."},{"name":"isDisabled","type":"boolean","description":"Flag indicating the date picker is disabled."},{"name":"onBlur","type":"(event: any, value: string, date?: Date) => void","description":"Callback called every time the text input loses focus."},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, value: string, date?: Date) => void","description":"Callback called every time the text input value changes."},{"name":"placeholder","type":"string","description":"String to display in the empty text input as a hint for the expected date format."},{"name":"popoverProps","type":"Partial<Omit<PopoverProps, 'appendTo'>>","description":"Props to pass to the popover that contains the calendar month component."},{"name":"requiredDateOptions","type":"DatePickerRequiredObject","description":"Options to customize the requirement of a date"},{"name":"Unknown","type":"string","description":"Accessible label for the date picker."},{"name":"validators","type":"((date: Date) => string)[]","description":"Functions that returns an error message if a date is invalid."},{"name":"value","type":"string","description":"Value of the text input."}]},"DatePickerRef":{"name":"DatePickerRef","description":"Allows finer control over the calendar's open state when a React ref is passed into the\ndate picker component. Accessed via ref.current[property], e.g. ref.current.toggleCalendar().","props":[{"name":"isCalendarOpen","type":"boolean","description":"Current calendar open status.","required":true},{"name":"setCalendarOpen","type":"(isOpen: boolean) => void","description":"Sets the calendar open status.","required":true},{"name":"toggleCalendar","type":"(isOpen?: boolean) => void","description":"Toggles the calendar open status. If no parameters are passed, the calendar will simply\ntoggle its open status.\nIf the isOpen parameter is passed, that will set the calendar open status to the value\nof the isOpen parameter.\nIf the eventKey parameter is set to 'Escape', that will invoke the date pickers\nonEscapePress event to toggle the correct control appropriately.","required":true}]},"DataListToggle":{"name":"DataListToggle","description":"","props":[{"name":"aria-controls","type":"string","description":"Allows users of some screen readers to shift focus to the controlled element. Should be used when the controlled contents are not adjacent to the toggle that controls them.","defaultValue":"''"},{"name":"aria-label","type":"string","description":"Adds accessible text to the DataList toggle","defaultValue":"'Details'"},{"name":"aria-labelledby","type":"string","description":"Adds accessible text to the DataList toggle"},{"name":"buttonProps","type":"ButtonProps","description":"Additional properties spread to the toggle button"},{"name":"className","type":"string","description":"Additional classes added to the DataList cell","defaultValue":"''"},{"name":"id","type":"string","description":"Identify the DataList toggle number","required":true},{"name":"isExpanded","type":"boolean","description":"Flag to show if the expanded content of the DataList item is visible","defaultValue":"false"},{"name":"rowid","type":"string","description":"Id for the row","defaultValue":"''"}]},"DataListToggleProps":{"name":"DataListToggleProps","description":"","props":[{"name":"buttonProps","type":"ButtonProps","description":"Additional properties spread to the toggle button"},{"name":"className","type":"string","description":"Additional classes added to the DataList cell"},{"name":"id","type":"string","description":"Identify the DataList toggle number","required":true},{"name":"isExpanded","type":"boolean","description":"Flag to show if the expanded content of the DataList item is visible"},{"name":"rowid","type":"string","description":"Id for the row"},{"name":"Unknown","type":"string","description":"Allows users of some screen readers to shift focus to the controlled element. Should be used when the controlled contents are not adjacent to the toggle that controls them."}]},"DataListText":{"name":"DataListText","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered within the data list text","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the data list text","defaultValue":"''"},{"name":"component","type":"React.ReactNode","description":"Determines which element to render as a data list text. Usually div or span","defaultValue":"'span'"},{"name":"onMouseEnter","type":"(event: any) => void","description":"callback used to create the tooltip if text is truncated","defaultValue":"() => {}"},{"name":"tooltip","type":"string","description":"text to display on the tooltip","defaultValue":"''"},{"name":"wrapModifier","type":"DataListWrapModifier | 'nowrap' | 'truncate' | 'breakWord'","description":"Determines which wrapping modifier to apply to the data list text","defaultValue":"null"}]},"DataListTextProps":{"name":"DataListTextProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered within the data list text"},{"name":"className","type":"string","description":"Additional classes added to the data list text"},{"name":"component","type":"React.ReactNode","description":"Determines which element to render as a data list text. Usually div or span"},{"name":"onMouseEnter","type":"(event: any) => void","description":"callback used to create the tooltip if text is truncated"},{"name":"tooltip","type":"string","description":"text to display on the tooltip"},{"name":"wrapModifier","type":"DataListWrapModifier | 'nowrap' | 'truncate' | 'breakWord'","description":"Determines which wrapping modifier to apply to the data list text"}]},"DataListItemRow":{"name":"DataListItemRow","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the DataListItemRow","required":true},{"name":"className","type":"string","description":"Additional classes added to the DataListItemRow","defaultValue":"''"},{"name":"rowid","type":"string","description":"Id for the row item","defaultValue":"''"},{"name":"wrapModifier","type":"DataListWrapModifier | 'nowrap' | 'truncate' | 'breakWord'","description":"Determines which wrapping modifier to apply to the DataListItemRow","defaultValue":"null"}]},"DataListItemRowProps":{"name":"DataListItemRowProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the DataListItemRow","required":true},{"name":"className","type":"string","description":"Additional classes added to the DataListItemRow"},{"name":"rowid","type":"string","description":"Id for the row item"},{"name":"wrapModifier","type":"DataListWrapModifier | 'nowrap' | 'truncate' | 'breakWord'","description":"Determines which wrapping modifier to apply to the DataListItemRow"}]},"DataListItemCells":{"name":"DataListItemCells","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the DataList item Content Wrapper. Children should be one ore more <DataListCell> nodes","defaultValue":"''"},{"name":"dataListCells","type":"React.ReactNode","description":"Array of <DataListCell> nodes that are rendered one after the other."},{"name":"rowid","type":"string","description":"Id for the row","defaultValue":"''"}]},"DataListItemCellsProps":{"name":"DataListItemCellsProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the DataList item Content Wrapper. Children should be one ore more <DataListCell> nodes"},{"name":"dataListCells","type":"React.ReactNode","description":"Array of <DataListCell> nodes that are rendered one after the other."},{"name":"rowid","type":"string","description":"Id for the row"}]},"DataListItem":{"name":"DataListItem","description":"","props":[{"name":"aria-labelledby","type":"string","description":"Adds an accessible name to the selectable input if one is rendered","defaultValue":"''"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the DataList item","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the DataList item should be either <DataListItemRow> or <DataListContent>","defaultValue":"''"},{"name":"id","type":"string","description":"Unique id for the DataList item","defaultValue":"''"},{"name":"isExpanded","type":"boolean","description":"Flag to show if the expanded content of the DataList item is visible","defaultValue":"false"},{"name":"selectableInputAriaLabel","type":"string","description":"Aria label to apply to the selectable input if one is rendered"}]},"DataListItemProps":{"name":"DataListItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the DataList item","required":true},{"name":"className","type":"string","description":"Additional classes added to the DataList item should be either <DataListItemRow> or <DataListContent>"},{"name":"id","type":"string","description":"Unique id for the DataList item"},{"name":"isExpanded","type":"boolean","description":"Flag to show if the expanded content of the DataList item is visible"},{"name":"selectableInputAriaLabel","type":"string","description":"Aria label to apply to the selectable input if one is rendered"},{"name":"Unknown","type":"string","description":"Adds an accessible name to the selectable input if one is rendered","required":true}]},"DataListItemChildProps":{"name":"DataListItemChildProps","description":"","props":[{"name":"rowid","type":"string","description":"Id for the row","required":true}]},"DataListDragButton":{"name":"DataListDragButton","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the drag button","defaultValue":"''"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if drag is disabled for the item","defaultValue":"false"},{"name":"type","type":"'button' | 'submit' | 'reset'","description":"Sets button type"}]},"DataListDragButtonProps":{"name":"DataListDragButtonProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the drag button"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if drag is disabled for the item"},{"name":"type","type":"'button' | 'submit' | 'reset'","description":"Sets button type"}]},"DataListControl":{"name":"DataListControl","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Children of the data list control"},{"name":"className","type":"string","description":"Additional classes added to the DataList item control","defaultValue":"''"}]},"DataListControlProps":{"name":"DataListControlProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Children of the data list control"},{"name":"className","type":"string","description":"Additional classes added to the DataList item control"}]},"DataListContent":{"name":"DataListContent","description":"","props":[{"name":"aria-label","type":"string","description":"Adds accessible text to the DataList toggle","required":true},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the DataList item","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the DataList cell","defaultValue":"''"},{"name":"hasNoPadding","type":"boolean","description":"Flag to remove padding from the expandable content","defaultValue":"false"},{"name":"id","type":"string","description":"Identify the DataListContent item","defaultValue":"''"},{"name":"isHidden","type":"boolean","description":"Flag to show if the expanded content of the DataList item is visible","defaultValue":"false"},{"name":"rowid","type":"string","description":"Id for the row","defaultValue":"''"}]},"DataListContentProps":{"name":"DataListContentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the DataList item"},{"name":"className","type":"string","description":"Additional classes added to the DataList cell"},{"name":"hasNoPadding","type":"boolean","description":"Flag to remove padding from the expandable content"},{"name":"id","type":"string","description":"Identify the DataListContent item"},{"name":"isHidden","type":"boolean","description":"Flag to show if the expanded content of the DataList item is visible"},{"name":"rowid","type":"string","description":"Id for the row"},{"name":"Unknown","type":"string","description":"Adds accessible text to the DataList toggle","required":true}]},"DataListCheck":{"name":"DataListCheck","description":"","props":[{"name":"aria-labelledby","type":"string","description":"Aria-labelledby of the DataList checkbox","required":true},{"name":"checked","type":"boolean","description":"Flag to show if the DataList checkbox is checked when it is controlled by React state. Both isChecked and checked are valid,\nbut only use one.\nTo make the DataList checkbox uncontrolled, instead use the defaultChecked prop, but do not use both."},{"name":"className","type":"string","description":"Additional classes added to the DataList item checkbox"},{"name":"defaultChecked","type":"boolean","description":"Flag to set default value of DataList checkbox when it is uncontrolled by React state.\nTo make the DataList checkbox controlled, instead use the isChecked prop, but do not use both."},{"name":"id","type":"string","description":"Id of the DataList checkbox."},{"name":"isChecked","type":"boolean","description":"Flag to show if the DataList checkbox is checked when it is controlled by React state. Both isChecked and checked are valid,\nbut only use one.\nTo make the DataList checkbox uncontrolled, instead use the defaultChecked prop, but do not use both."},{"name":"isDisabled","type":"boolean","description":"Flag to show if the DataList checkbox is disabled","defaultValue":"false"},{"name":"isValid","type":"boolean","description":"Flag to show if the DataList checkbox selection is valid or invalid","defaultValue":"true"},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, checked: boolean) => void","description":"A callback for when the DataList checkbox selection changes"},{"name":"otherControls","type":"boolean","description":"Flag to indicate if other controls are used in the DataListItem","defaultValue":"false"}]},"DataListCheckProps":{"name":"DataListCheckProps","description":"","props":[{"name":"checked","type":"boolean","description":"Flag to show if the DataList checkbox is checked when it is controlled by React state. Both isChecked and checked are valid,\nbut only use one.\nTo make the DataList checkbox uncontrolled, instead use the defaultChecked prop, but do not use both."},{"name":"className","type":"string","description":"Additional classes added to the DataList item checkbox"},{"name":"defaultChecked","type":"boolean","description":"Flag to set default value of DataList checkbox when it is uncontrolled by React state.\nTo make the DataList checkbox controlled, instead use the isChecked prop, but do not use both."},{"name":"id","type":"string","description":"Id of the DataList checkbox."},{"name":"isChecked","type":"boolean","description":"Flag to show if the DataList checkbox is checked when it is controlled by React state. Both isChecked and checked are valid,\nbut only use one.\nTo make the DataList checkbox uncontrolled, instead use the defaultChecked prop, but do not use both."},{"name":"isDisabled","type":"boolean","description":"Flag to show if the DataList checkbox is disabled"},{"name":"isValid","type":"boolean","description":"Flag to show if the DataList checkbox selection is valid or invalid"},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, checked: boolean) => void","description":"A callback for when the DataList checkbox selection changes"},{"name":"otherControls","type":"boolean","description":"Flag to indicate if other controls are used in the DataListItem"},{"name":"Unknown","type":"string","description":"Aria-labelledby of the DataList checkbox","required":true}]},"DataListCell":{"name":"DataListCell","description":"","props":[{"name":"alignRight","type":"boolean","description":"Aligns the cell content to the right of its parent.","defaultValue":"false"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the DataList cell","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the DataList cell","defaultValue":"''"},{"name":"isFilled","type":"boolean","description":"Enables the body Content to fill the height of the card","defaultValue":"true"},{"name":"isIcon","type":"boolean","description":"Set to true if the cell content is an Icon","defaultValue":"false"},{"name":"width","type":"1 | 2 | 3 | 4 | 5","description":"Width (from 1-5) to the DataList cell","defaultValue":"1"},{"name":"wrapModifier","type":"DataListWrapModifier | 'nowrap' | 'truncate' | 'breakWord'","description":"Determines which wrapping modifier to apply to the DataListCell","defaultValue":"null"}]},"DataListCellProps":{"name":"DataListCellProps","description":"","props":[{"name":"alignRight","type":"boolean","description":"Aligns the cell content to the right of its parent."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the DataList cell"},{"name":"className","type":"string","description":"Additional classes added to the DataList cell"},{"name":"isFilled","type":"boolean","description":"Enables the body Content to fill the height of the card"},{"name":"isIcon","type":"boolean","description":"Set to true if the cell content is an Icon"},{"name":"width","type":"1 | 2 | 3 | 4 | 5","description":"Width (from 1-5) to the DataList cell"},{"name":"wrapModifier","type":"DataListWrapModifier | 'nowrap' | 'truncate' | 'breakWord'","description":"Determines which wrapping modifier to apply to the DataListCell"}]},"DataListAction":{"name":"DataListAction","description":"","props":[{"name":"aria-label","type":"string","description":"Adds accessible text to the DataList Action","required":true},{"name":"aria-labelledby","type":"string","description":"Adds accessible text to the DataList Action","required":true},{"name":"children","type":"React.ReactNode","description":"Content rendered as DataList Action (e.g <Button> or <Dropdown>)","required":true},{"name":"className","type":"string","description":"Additional classes added to the DataList Action"},{"name":"id","type":"string","description":"Identify the DataList toggle number","required":true},{"name":"visibility","type":"{\n default?: 'hidden' | 'visible';\n sm?: 'hidden' | 'visible';\n md?: 'hidden' | 'visible';\n lg?: 'hidden' | 'visible';\n xl?: 'hidden' | 'visible';\n '2xl'?: 'hidden' | 'visible';\n}","description":"What breakpoints to hide/show the data list action"}]},"DataListActionProps":{"name":"DataListActionProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered as DataList Action (e.g <Button> or <Dropdown>)","required":true},{"name":"className","type":"string","description":"Additional classes added to the DataList Action"},{"name":"id","type":"string","description":"Identify the DataList toggle number","required":true},{"name":"Unknown","type":"string","description":"Adds accessible text to the DataList Action","required":true},{"name":"visibility","type":"{\n default?: 'hidden' | 'visible';\n sm?: 'hidden' | 'visible';\n md?: 'hidden' | 'visible';\n lg?: 'hidden' | 'visible';\n xl?: 'hidden' | 'visible';\n '2xl'?: 'hidden' | 'visible';\n }","description":"What breakpoints to hide/show the data list action"}]},"DataListProps":{"name":"DataListProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the DataList list"},{"name":"className","type":"string","description":"Additional classes added to the DataList list"},{"name":"gridBreakpoint","type":"'none' | 'always' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'","description":"Specifies the grid breakpoints"},{"name":"innerRef","type":"React.RefObject<HTMLUListElement | null>","description":""},{"name":"isCompact","type":"boolean","description":"Flag indicating if DataList should have compact styling"},{"name":"onSelectableRowChange","type":"(event: React.FormEvent<HTMLInputElement>, id: string) => void","description":"Object that causes the data list to render hidden inputs which improve selectable item a11y"},{"name":"onSelectDataListItem","type":"(event: React.MouseEvent | React.KeyboardEvent, id: string) => void","description":"Optional callback to make DataList selectable, fired when DataListItem selected"},{"name":"selectedDataListItemId","type":"string","description":"Id of DataList item currently selected"},{"name":"Unknown","type":"string","description":"Adds accessible text to the DataList list","required":true},{"name":"wrapModifier","type":"DataListWrapModifier | 'nowrap' | 'truncate' | 'breakWord'","description":"Determines which wrapping modifier to apply to the DataList"}]},"DataListContextProps":{"name":"DataListContextProps","description":"","props":[{"name":"isSelectable","type":"boolean","description":null,"required":true},{"name":"onSelectableRowChange","type":"(event: React.FormEvent<HTMLInputElement>, id: string) => void","description":null},{"name":"selectedDataListItemId","type":"string","description":null,"required":true},{"name":"updateSelectedDataListItem","type":"(event: React.MouseEvent | React.KeyboardEvent, id: string) => void","description":null,"required":true}]},"Content":{"name":"Content","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Children rendered within the Content."},{"name":"className","type":"string","description":"Additional classes added to the Content.","defaultValue":"''"},{"name":"component","type":"| 'h1'\n| 'h2'\n| 'h3'\n| 'h4'\n| 'h5'\n| 'h6'\n| 'p'\n| 'a'\n| 'small'\n| 'blockquote'\n| 'pre'\n| 'hr'\n| 'ul'\n| 'ol'\n| 'dl'\n| 'li'\n| 'dt'\n| 'dd'","description":"The content component. If none provided, it will be a 'div' and styling will be applied to all its child components."},{"name":"isEditorial","type":"boolean","description":"Flag to indicate the content has editorial styling. This styling increases the font size of body text and small text by one tier, increasing body text to large and small text to the previous body text size.","defaultValue":"false"},{"name":"isPlainList","type":"boolean","description":"Modifies the list (ul, ol and dl components) to have plain styling.","defaultValue":"false"},{"name":"isVisitedLink","type":"boolean","description":"Flag to indicate the link (or all links within the content) has visited styles applied if the browser determines the link has been visited.","defaultValue":"false"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"}]},"ContentProps":{"name":"ContentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Children rendered within the Content."},{"name":"className","type":"string","description":"Additional classes added to the Content."},{"name":"component","type":"| 'h1'\n | 'h2'\n | 'h3'\n | 'h4'\n | 'h5'\n | 'h6'\n | 'p'\n | 'a'\n | 'small'\n | 'blockquote'\n | 'pre'\n | 'hr'\n | 'ul'\n | 'ol'\n | 'dl'\n | 'li'\n | 'dt'\n | 'dd'","description":"The content component. If none provided, it will be a 'div' and styling will be applied to all its child components."},{"name":"isEditorial","type":"boolean","description":"Flag to indicate the content has editorial styling. This styling increases the font size of body text and small text by one tier, increasing body text to large and small text to the previous body text size."},{"name":"isPlainList","type":"boolean","description":"Modifies the list (ul, ol and dl components) to have plain styling."},{"name":"isVisitedLink","type":"boolean","description":"Flag to indicate the link (or all links within the content) has visited styles applied if the browser determines the link has been visited."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."}]},"CodeBlockCode":{"name":"CodeBlockCode","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Code rendered inside the code block","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes passed to the code block pre wrapper"},{"name":"codeClassName","type":"string","description":"Additional classes passed to the code block code"}]},"CodeBlockCodeProps":{"name":"CodeBlockCodeProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Code rendered inside the code block"},{"name":"className","type":"string","description":"Additional classes passed to the code block pre wrapper"},{"name":"codeClassName","type":"string","description":"Additional classes passed to the code block code"}]},"CodeBlockAction":{"name":"CodeBlockAction","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the code block action","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes passed to the code block action"}]},"CodeBlockActionProps":{"name":"CodeBlockActionProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the code block action"},{"name":"className","type":"string","description":"Additional classes passed to the code block action"}]},"CodeBlock":{"name":"CodeBlock","description":"","props":[{"name":"actions","type":"React.ReactNode","description":"Actions in the code block header. Should be wrapped with CodeBlockAction.","defaultValue":"null"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the code block","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes passed to the code block wrapper"}]},"CodeBlockProps":{"name":"CodeBlockProps","description":"","props":[{"name":"actions","type":"React.ReactNode","description":"Actions in the code block header. Should be wrapped with CodeBlockAction."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the code block"},{"name":"className","type":"string","description":"Additional classes passed to the code block wrapper"}]},"ClipboardCopyToggle":{"name":"ClipboardCopyToggle","description":"","props":[{"name":"className","type":"string","description":""},{"name":"contentId","type":"string","description":"","required":true},{"name":"id","type":"string","description":"","required":true},{"name":"isExpanded","type":"boolean","description":"","defaultValue":"false"},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"","required":true},{"name":"textId","type":"string","description":"","required":true}]},"ClipboardCopyToggleProps":{"name":"ClipboardCopyToggleProps","description":"","props":[{"name":"className","type":"string","description":null},{"name":"contentId","type":"string","description":null,"required":true},{"name":"id","type":"string","description":null,"required":true},{"name":"isExpanded","type":"boolean","description":null},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":null,"required":true},{"name":"textId","type":"string","description":null,"required":true}]},"ClipboardCopyExpanded":{"name":"ClipboardCopyExpanded","description":"","props":[{"name":"className","type":"string","description":"","defaultValue":"''"},{"name":"isCode","type":"boolean","description":"","defaultValue":"false"},{"name":"isReadOnly","type":"boolean","description":"","defaultValue":"false"},{"name":"onChange","type":"(e: React.FormEvent<HTMLDivElement>, text: string) => void","description":"","defaultValue":"(): any => undefined"}]},"ClipboardCopyExpandedProps":{"name":"ClipboardCopyExpandedProps","description":"","props":[{"name":"className","type":"string","description":null},{"name":"isCode","type":"boolean","description":null},{"name":"isReadOnly","type":"boolean","description":null},{"name":"onChange","type":"(e: React.FormEvent<HTMLDivElement>, text: string) => void","description":null}]},"ClipboardCopyButton":{"name":"ClipboardCopyButton","description":"","props":[{"name":"aria-label","type":"string","description":"Aria-label for the copy button","defaultValue":"'Copyable input'"},{"name":"children","type":"React.ReactNode","description":"Content of the copy button","required":true},{"name":"className","type":"string","description":"Additional classes added to the copy button"},{"name":"entryDelay","type":"number","description":"Entry delay on the copy button tooltip","defaultValue":"300"},{"name":"exitDelay","type":"number","description":"Exit delay on the copy button tooltip","defaultValue":"0"},{"name":"hasNoPadding","type":"boolean","description":"Removes padding from clipboard copy button. This is used for inline-compact variant","defaultValue":"false"},{"name":"id","type":"string","description":"ID of the copy button","required":true},{"name":"maxWidth","type":"string","description":"Max width of the copy button tooltip","defaultValue":"'100px'"},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"Callback for the copy when the button is clicked","required":true},{"name":"onTooltipHidden","type":"() => void","description":"Callback when tooltip's hide transition has finished executing","defaultValue":"() => {}"},{"name":"position","type":"| TooltipPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Position of the copy button tooltip","defaultValue":"'top'"},{"name":"textId","type":"string","description":"ID of the content that is being copied","required":true},{"name":"variant","type":"'control' | 'plain'","description":"Variant of the copy button","defaultValue":"'control'"}]},"ClipboardCopyButtonProps":{"name":"ClipboardCopyButtonProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content of the copy button","required":true},{"name":"className","type":"string","description":"Additional classes added to the copy button"},{"name":"entryDelay","type":"number","description":"Entry delay on the copy button tooltip"},{"name":"exitDelay","type":"number","description":"Exit delay on the copy button tooltip"},{"name":"hasNoPadding","type":"boolean","description":"Removes padding from clipboard copy button. This is used for inline-compact variant"},{"name":"id","type":"string","description":"ID of the copy button","required":true},{"name":"maxWidth","type":"string","description":"Max width of the copy button tooltip"},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"Callback for the copy when the button is clicked","required":true},{"name":"onTooltipHidden","type":"() => void","description":"Callback when tooltip's hide transition has finished executing"},{"name":"position","type":"| TooltipPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Position of the copy button tooltip"},{"name":"textId","type":"string","description":"ID of the content that is being copied","required":true},{"name":"Unknown","type":"string","description":"Aria-label for the copy button"},{"name":"variant","type":"'control' | 'plain'","description":"Variant of the copy button"}]},"ClipboardCopyAction":{"name":"ClipboardCopyAction","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the clipboard copy action.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the clipboard copy action.","defaultValue":"''"}]},"ClipboardCopyActionProps":{"name":"ClipboardCopyActionProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the clipboard copy action."},{"name":"className","type":"string","description":"Additional classes added to the clipboard copy action."}]},"ClipboardCopy":{"name":"ClipboardCopy","description":"","props":[{"name":"additionalActions","type":"React.ReactNode","description":"Additional actions for inline clipboard copy. Should be wrapped with ClipboardCopyAction.","defaultValue":"null"},{"name":"children","type":"string | string[]","description":"The text which is copied.","required":true},{"name":"className","type":"string","description":"Additional classes added to the clipboard copy container."},{"name":"clickTip","type":"string","description":"Tooltip message to display when clicking the copy button","defaultValue":"'Successfully copied to clipboard!'"},{"name":"entryDelay","type":"number","description":"Delay in ms before the tooltip appears.","defaultValue":"300"},{"name":"exitDelay","type":"number","description":"Delay in ms before the tooltip disappears.","defaultValue":"1500"},{"name":"hoverTip","type":"string","description":"Tooltip message to display when hover the copy button","defaultValue":"'Copy to clipboard'"},{"name":"isBlock","type":"boolean","description":"Flag to determine if inline clipboard copy should be block styling"},{"name":"isCode","type":"boolean","description":"Flag to determine if clipboard copy content includes code","defaultValue":"false"},{"name":"isExpanded","type":"boolean","description":"Flag to determine if clipboard copy is in the expanded state initially","defaultValue":"false"},{"name":"isReadOnly","type":"boolean","description":"Flag to show if the input is read only.","defaultValue":"false"},{"name":"maxWidth","type":"string","description":"Maximum width of the tooltip (default 150px).","defaultValue":"'150px'"},{"name":"onChange","type":"(event: React.FormEvent, text?: string) => void","description":"A function that is triggered on changing the text.","defaultValue":"(): any => undefined"},{"name":"onCopy","type":"(event: React.ClipboardEvent<HTMLDivElement>, text?: React.ReactNode) => void","description":"A function that is triggered on clicking the copy button. This will replace the existing clipboard copy functionality entirely.","defaultValue":"(_event: React.ClipboardEvent<HTMLDivElement>, text?: React.ReactNode) => {\n try {\n navigator.clipboard.writeText(text.toString());\n } catch (error) {\n // eslint-disable-next-line no-console\n console.warn(\n \"Clipboard API not found, this copy function will not work. This is likely because you're using an\",\n \"unsupported browser or you're not using HTTPS. \\n\\nIf you're a developer building an application which needs\",\n \"to support copying to the clipboard without the clipboard API, you'll have to create your own copy\",\n 'function and pass it to the ClipboardCopy component as the onCopy prop. For more information see',\n 'https://developer.mozilla.org/en-US/docs/Web/API/Navigator/clipboard'\n );\n\n // eslint-disable-next-line no-console\n console.error(error);\n }\n}"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"},{"name":"position","type":"| TooltipPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Copy button tooltip position.","defaultValue":"TooltipPosition.top"},{"name":"textAriaLabel","type":"string","description":"Aria-label to use on the TextInput.","defaultValue":"'Copyable input'"},{"name":"toggleAriaLabel","type":"string","description":"Aria-label to use on the ClipboardCopyToggle.","defaultValue":"'Show content'"},{"name":"truncation","type":"boolean | Omit<TruncateProps, 'content'>","description":"Enables and customizes truncation for an inline-compact ClipboardCopy.","defaultValue":"false"},{"name":"variant","type":"typeof ClipboardCopyVariant | 'inline' | 'expansion' | 'inline-compact'","description":"Adds Clipboard Copy variant styles.","defaultValue":"'inline'"}]},"ClipboardCopyState":{"name":"ClipboardCopyState","description":"","props":[{"name":"copied","type":"boolean","description":null,"required":true},{"name":"expanded","type":"boolean","description":null,"required":true},{"name":"text","type":"string","description":null,"required":true},{"name":"textWhenExpanded","type":"string","description":null,"required":true}]},"ClipboardCopyProps":{"name":"ClipboardCopyProps","description":"","props":[{"name":"additionalActions","type":"React.ReactNode","description":"Additional actions for inline clipboard copy. Should be wrapped with ClipboardCopyAction."},{"name":"children","type":"string | string[]","description":"The text which is copied.","required":true},{"name":"className","type":"string","description":"Additional classes added to the clipboard copy container."},{"name":"clickTip","type":"string","description":"Tooltip message to display when clicking the copy button"},{"name":"entryDelay","type":"number","description":"Delay in ms before the tooltip appears."},{"name":"exitDelay","type":"number","description":"Delay in ms before the tooltip disappears."},{"name":"hoverTip","type":"string","description":"Tooltip message to display when hover the copy button"},{"name":"isBlock","type":"boolean","description":"Flag to determine if inline clipboard copy should be block styling"},{"name":"isCode","type":"boolean","description":"Flag to determine if clipboard copy content includes code"},{"name":"isExpanded","type":"boolean","description":"Flag to determine if clipboard copy is in the expanded state initially"},{"name":"isReadOnly","type":"boolean","description":"Flag to show if the input is read only."},{"name":"maxWidth","type":"string","description":"Maximum width of the tooltip (default 150px)."},{"name":"onChange","type":"(event: React.FormEvent, text?: string) => void","description":"A function that is triggered on changing the text."},{"name":"onCopy","type":"(event: React.ClipboardEvent<HTMLDivElement>, text?: React.ReactNode) => void","description":"A function that is triggered on clicking the copy button. This will replace the existing clipboard copy functionality entirely."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"position","type":"| TooltipPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Copy button tooltip position."},{"name":"textAriaLabel","type":"string","description":"Aria-label to use on the TextInput."},{"name":"toggleAriaLabel","type":"string","description":"Aria-label to use on the ClipboardCopyToggle."},{"name":"truncation","type":"boolean | Omit<TruncateProps, 'content'>","description":"Enables and customizes truncation for an inline-compact ClipboardCopy."},{"name":"variant","type":"typeof ClipboardCopyVariant | 'inline' | 'expansion' | 'inline-compact'","description":"Adds Clipboard Copy variant styles."}]},"Checkbox":{"name":"Checkbox","description":"","props":[{"name":"aria-label","type":"string","description":"Aria-label of the checkbox."},{"name":"body","type":"React.ReactNode","description":"Body text of the checkbox"},{"name":"checked","type":"boolean","description":""},{"name":"className","type":"string","description":"Additional classes added to the checkbox wrapper. This wrapper will be div element by default. It will be a label element if\nisLabelWrapped is true, or it can be overridden by any element specified in the component prop.","defaultValue":"''"},{"name":"component","type":"React.ElementType","description":"Sets the checkbox wrapper component to render. Defaults to \"div\". If set to \"label\", behaves the same as if isLabelWrapped prop was specified."},{"name":"description","type":"React.ReactNode","description":"Description text of the checkbox."},{"name":"id","type":"string","description":"Id of the checkbox.","required":true},{"name":"inputClassName","type":"string","description":"Additional classes added to the checkbox input."},{"name":"isChecked","type":"boolean | null","description":"Flag to show if the checkbox is checked. If null, the checkbox will be indeterminate (partially checked).","defaultValue":"false"},{"name":"isDisabled","type":"boolean","description":"Flag to show if the checkbox is disabled.","defaultValue":"false"},{"name":"isLabelWrapped","type":"boolean","description":"Flag to indicate whether the checkbox wrapper element is a <label> element for the checkbox input. Will not apply if a component prop (with a value other than a \"label\") is specified.","defaultValue":"false"},{"name":"isRequired","type":"boolean","description":"Flag to show if the checkbox is required.","defaultValue":"false"},{"name":"isValid","type":"boolean","description":"Flag to show if the checkbox selection is valid or invalid.","defaultValue":"true"},{"name":"label","type":"React.ReactNode","description":"Label text of the checkbox."},{"name":"labelPosition","type":"'start' | 'end'","description":"Sets the position of the label. Defaults to 'end' (after the checkbox input)."},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, checked: boolean) => void","description":"A callback for when the checkbox selection changes.","defaultValue":"() => {}"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"}]},"CheckboxProps":{"name":"CheckboxProps","description":"","props":[{"name":"body","type":"React.ReactNode","description":"Body text of the checkbox"},{"name":"checked","type":"boolean","description":null},{"name":"className","type":"string","description":"Additional classes added to the checkbox wrapper. This wrapper will be div element by default. It will be a label element if\nisLabelWrapped is true, or it can be overridden by any element specified in the component prop."},{"name":"component","type":"React.ElementType","description":"Sets the checkbox wrapper component to render. Defaults to \"div\". If set to \"label\", behaves the same as if isLabelWrapped prop was specified."},{"name":"description","type":"React.ReactNode","description":"Description text of the checkbox."},{"name":"id","type":"string","description":"Id of the checkbox.","required":true},{"name":"inputClassName","type":"string","description":"Additional classes added to the checkbox input."},{"name":"isChecked","type":"boolean | null","description":"Flag to show if the checkbox is checked. If null, the checkbox will be indeterminate (partially checked)."},{"name":"isDisabled","type":"boolean","description":"Flag to show if the checkbox is disabled."},{"name":"isLabelWrapped","type":"boolean","description":"Flag to indicate whether the checkbox wrapper element is a <label> element for the checkbox input. Will not apply if a component prop (with a value other than a \"label\") is specified."},{"name":"isRequired","type":"boolean","description":"Flag to show if the checkbox is required."},{"name":"isValid","type":"boolean","description":"Flag to show if the checkbox selection is valid or invalid."},{"name":"label","type":"React.ReactNode","description":"Label text of the checkbox."},{"name":"labelPosition","type":"'start' | 'end'","description":"Sets the position of the label. Defaults to 'end' (after the checkbox input)."},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, checked: boolean) => void","description":"A callback for when the checkbox selection changes."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"Unknown","type":"string","description":"Aria-label of the checkbox."}]},"CheckboxState":{"name":"CheckboxState","description":"","props":[{"name":"ouiaStateId","type":"string","description":null,"required":true}]},"CardTitle":{"name":"CardTitle","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the CardTitle"},{"name":"className","type":"string","description":"Additional classes added to the CardTitle"},{"name":"component","type":"React.JSX.IntrinsicElements","description":"Sets the base component to render. defaults to div","defaultValue":"'div'"}]},"CardTitleProps":{"name":"CardTitleProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the CardTitle"},{"name":"className","type":"string","description":"Additional classes added to the CardTitle"},{"name":"component","type":"keyof React.JSX.IntrinsicElements","description":"Sets the base component to render. defaults to div"}]},"CardSelectableActions":{"name":"CardSelectableActions","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the card action"},{"name":"className","type":"string","description":"Additional classes added to the action"}]},"CardActionsProps":{"name":"CardActionsProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the card action"},{"name":"className","type":"string","description":"Additional classes added to the action"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the card action"},{"name":"className","type":"string","description":"Additional classes added to the action"},{"name":"hasNoOffset","type":"boolean","description":"Flag indicating that the actions have no offset"}]},"CardHeaderMain":{"name":"CardHeaderMain","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Card Head Main"},{"name":"className","type":"string","description":"Additional classes added to the Card Head Main"}]},"CardHeaderMainProps":{"name":"CardHeaderMainProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Card Head Main"},{"name":"className","type":"string","description":"Additional classes added to the Card Head Main"}]},"CardHeader":{"name":"CardHeader","description":"","props":[{"name":"actions","type":"CardHeaderActionsObject","description":"Actions of the card header"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the card header"},{"name":"className","type":"string","description":"Additional classes added to the card header"},{"name":"hasWrap","type":"boolean","description":"Flag indicating that header wrapping is enabled"},{"name":"id","type":"string","description":"ID of the card header."},{"name":"isToggleRightAligned","type":"boolean","description":"Whether to right-align expandable toggle button"},{"name":"onExpand","type":"(event: React.MouseEvent, id: string) => void","description":"Callback expandable card"},{"name":"selectableActions","type":"CardHeaderSelectableActionsObject","description":"Selectable actions of the card header"},{"name":"toggleButtonProps","type":"any","description":"Additional props for expandable toggle button"}]},"CardHeaderActionsObject":{"name":"CardHeaderActionsObject","description":"","props":[{"name":"actions","type":"React.ReactNode","description":"Actions of the card header","required":true},{"name":"className","type":"string","description":"Additional classes added to the actions wrapper"},{"name":"hasNoOffset","type":"boolean","description":"Flag indicating that the actions have no offset"}]},"CardHeaderSelectableActionsObject":{"name":"CardHeaderSelectableActionsObject","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the selectable actions wrapper"},{"name":"hasNoOffset","type":"boolean","description":"Flag indicating that the actions have no offset"},{"name":"isChecked","type":"boolean","description":""},{"name":"isExternalLink","type":"boolean","description":"Flag to indicate whether a clickable-only card's link should open in a new tab/window."},{"name":"isHidden","type":"boolean","description":"Flag indicating the action is hidden"},{"name":"name","type":"string","description":"Name for the input element of a selectable card."},{"name":"onChange","type":"(event: React.FormEvent<HTMLInputElement>, checked: boolean) => void","description":"Callback for when a selectable card input changes"},{"name":"onClickAction","type":"(event: React.MouseEvent) => void","description":"Action to call when a clickable-only card is clicked. This cannot be combined with the to prop."},{"name":"selectableActionAriaLabel","type":"string","description":"Adds an accessible name to the input of a selectable card or clickable button/anchor of a clickable-only card.\nThis or selectableActionAriaLabelledby is required for clickable-only cards."},{"name":"selectableActionAriaLabelledby","type":"string","description":"A single or list of space-delimited ID's that provide an accessible name to the input of a selectable card\nor clickable button/anchor of a clickable-only card. This or selectableActionAriaLabelledby is required\nfor clickable-only cards."},{"name":"selectableActionId","type":"string","description":"Custom ID passed to the selectable card's input or a clickable-only card's button/anchor.\nIf omitted, a random unique ID will be assigned to a selectable card's input."},{"name":"selectableActionProps","type":"any","description":"Additional props spread to a selectable card input or clickable-only card's button/anchor."},{"name":"to","type":"string","description":"Link to navigate to when a clickable-only card is clicked. This cannot be combined with the onClickAction prop."},{"name":"variant","type":"'single' | 'multiple'","description":"Determines the type of input to be used for a selectable card."}]},"CardHeaderProps":{"name":"CardHeaderProps","description":"","props":[{"name":"actions","type":"CardHeaderActionsObject","description":"Actions of the card header"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the card header"},{"name":"className","type":"string","description":"Additional classes added to the card header"},{"name":"hasWrap","type":"boolean","description":"Flag indicating that header wrapping is enabled"},{"name":"id","type":"string","description":"ID of the card header."},{"name":"isToggleRightAligned","type":"boolean","description":"Whether to right-align expandable toggle button"},{"name":"onExpand","type":"(event: React.MouseEvent, id: string) => void","description":"Callback expandable card"},{"name":"selectableActions","type":"CardHeaderSelectableActionsObject","description":"Selectable actions of the card header"},{"name":"toggleButtonProps","type":"any","description":"Additional props for expandable toggle button"}]},"CardFooter":{"name":"CardFooter","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Card Footer"},{"name":"className","type":"string","description":"Additional classes added to the Footer"},{"name":"component","type":"JSX.IntrinsicElements","description":"Sets the base component to render. defaults to div","defaultValue":"'div'"}]},"CardFooterProps":{"name":"CardFooterProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Card Footer"},{"name":"className","type":"string","description":"Additional classes added to the Footer"},{"name":"component","type":"keyof JSX.IntrinsicElements","description":"Sets the base component to render. defaults to div"}]},"CardExpandableContent":{"name":"CardExpandableContent","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Card Body"},{"name":"className","type":"string","description":"Additional classes added to the Card Body"}]},"CardExpandableContentProps":{"name":"CardExpandableContentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Card Body"},{"name":"className","type":"string","description":"Additional classes added to the Card Body"}]},"CardBody":{"name":"CardBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Card Body"},{"name":"className","type":"string","description":"Additional classes added to the Card Body"},{"name":"component","type":"JSX.IntrinsicElements","description":"Sets the base component to render. defaults to div","defaultValue":"'div'"},{"name":"isFilled","type":"boolean","description":"Enables the body Content to fill the height of the card","defaultValue":"true"}]},"CardBodyProps":{"name":"CardBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Card Body"},{"name":"className","type":"string","description":"Additional classes added to the Card Body"},{"name":"component","type":"keyof JSX.IntrinsicElements","description":"Sets the base component to render. defaults to div"},{"name":"isFilled","type":"boolean","description":"Enables the body Content to fill the height of the card"}]},"CardActions":{"name":"CardActions","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the card action"},{"name":"className","type":"string","description":"Additional classes added to the action"},{"name":"hasNoOffset","type":"boolean","description":"Flag indicating that the actions have no offset","defaultValue":"false"}]},"Card":{"name":"Card","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Card"},{"name":"className","type":"string","description":"Additional classes added to the Card"},{"name":"component","type":"React.JSX.IntrinsicElements","description":"Sets the base component to render. defaults to div","defaultValue":"'div'"},{"name":"id","type":"string","description":"ID of the Card. Also passed back in the CardHeader onExpand callback.","defaultValue":"''"},{"name":"isClickable","type":"boolean","description":"Flag indicating that the card is clickable and contains some action that triggers on click.","defaultValue":"false"},{"name":"isClicked","type":"boolean","description":"Flag indicating whether a card that is either only clickable or that is both clickable and selectable\nis currently clicked and has clicked styling.","defaultValue":"false"},{"name":"isCompact","type":"boolean","description":"Modifies the card to include compact styling. Should not be used with isLarge.","defaultValue":"false"},{"name":"isDisabled","type":"boolean","description":"Flag indicating that a clickable or selectable card is disabled.","defaultValue":"false"},{"name":"isExpanded","type":"boolean","description":"Flag indicating if a card is expanded. Modifies the card to be expandable.","defaultValue":"false"},{"name":"isFullHeight","type":"boolean","description":"Cause component to consume the available height of its container","defaultValue":"false"},{"name":"isLarge","type":"boolean","description":"Modifies the card to be large. Should not be used with isCompact.","defaultValue":"false"},{"name":"isPlain","type":"boolean","description":"Modifies the card to include plain styling; this removes border and background","defaultValue":"false"},{"name":"isSelectable","type":"boolean","description":"Flag indicating that the card is selectable.","defaultValue":"false"},{"name":"isSelected","type":"boolean","description":"Flag indicating whether a card that is either selectable only or both clickable and selectable is\ncurrently selected and has selected styling.","defaultValue":"false"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"},{"name":"variant","type":"'default' | 'secondary'","description":"Card background color variant","defaultValue":"'default'"}]},"CardProps":{"name":"CardProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Card"},{"name":"className","type":"string","description":"Additional classes added to the Card"},{"name":"component","type":"keyof React.JSX.IntrinsicElements","description":"Sets the base component to render. defaults to div"},{"name":"id","type":"string","description":"ID of the Card. Also passed back in the CardHeader onExpand callback."},{"name":"isClickable","type":"boolean","description":"Flag indicating that the card is clickable and contains some action that triggers on click."},{"name":"isClicked","type":"boolean","description":"Flag indicating whether a card that is either only clickable or that is both clickable and selectable\nis currently clicked and has clicked styling."},{"name":"isCompact","type":"boolean","description":"Modifies the card to include compact styling. Should not be used with isLarge."},{"name":"isDisabled","type":"boolean","description":"Flag indicating that a clickable or selectable card is disabled."},{"name":"isExpanded","type":"boolean","description":"Flag indicating if a card is expanded. Modifies the card to be expandable."},{"name":"isFullHeight","type":"boolean","description":"Cause component to consume the available height of its container"},{"name":"isLarge","type":"boolean","description":"Modifies the card to be large. Should not be used with isCompact."},{"name":"isPlain","type":"boolean","description":"Modifies the card to include plain styling; this removes border and background"},{"name":"isSelectable","type":"boolean","description":"Flag indicating that the card is selectable."},{"name":"isSelected","type":"boolean","description":"Flag indicating whether a card that is either selectable only or both clickable and selectable is\ncurrently selected and has selected styling."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"variant","type":"'default' | 'secondary'","description":"Card background color variant"}]},"CardContextProps":{"name":"CardContextProps","description":"","props":[{"name":"cardId","type":"string","description":null,"required":true},{"name":"isClickable","type":"boolean","description":null,"required":true},{"name":"isClicked","type":"boolean","description":null,"required":true},{"name":"isDisabled","type":"boolean","description":null,"required":true},{"name":"isExpanded","type":"boolean","description":null,"required":true},{"name":"isSelectable","type":"boolean","description":null,"required":true},{"name":"isSelected","type":"boolean","description":null,"required":true}]},"CalendarMonth":{"name":"CalendarMonth","description":"The main calendar month component.","props":[{"name":"cellAriaLabel","type":"(date: Date) => string","description":"Accessible label for the date cells."},{"name":"className","type":"string","description":"Additional classes to add to the outer div of the calendar month."},{"name":"date","type":"Date","description":"Month/year to base other dates around."},{"name":"dayFormat","type":"(date: Date) => React.ReactNode","description":"How to format days in buttons in table cells.","defaultValue":"(date) => date.getDate()"},{"name":"inlineProps","type":"CalendarMonthInlineProps","description":"Props used to ensure accessibility when displaying the calendar month inline."},{"name":"isDateFocused","type":"boolean","description":"Flag to set browser focus on the passed date. *","defaultValue":"false"},{"name":"locale","type":"string","description":"If using the default formatters which locale to use. Undefined defaults to current locale.\nSee https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_identification_and_negotiation","defaultValue":"undefined"},{"name":"longWeekdayFormat","type":"(date: Date) => React.ReactNode","description":"How to format days in header for screen readers.","defaultValue":"(date) => date.toLocaleDateString(locale, { weekday: 'long' })"},{"name":"monthFormat","type":"(date: Date) => React.ReactNode","description":"How to format months in month select.","defaultValue":"(date) => date.toLocaleDateString(locale, { month: 'long' })"},{"name":"nextMonthAriaLabel","type":"string","description":"Accessible label for the next month button.","defaultValue":"'Next month'"},{"name":"onChange","type":"(event: React.MouseEvent<HTMLButtonElement, MouseEvent>, date: Date) => void","description":"Callback when date is selected.","defaultValue":"() => {}"},{"name":"onMonthChange","type":"(\n event?: React.MouseEvent | React.ChangeEvent | React.FormEvent<HTMLInputElement>,\n newDate?: Date\n) => void","description":"Callback when month or year is changed.","defaultValue":"() => {}"},{"name":"prevMonthAriaLabel","type":"string","description":"Accessible label for the previous month button.","defaultValue":"'Previous month'"},{"name":"rangeStart","type":"Date","description":"Which date to start range styles from."},{"name":"validators","type":"((date: Date) => boolean)[]","description":"Functions that returns if a date is valid and selectable.","defaultValue":"[() => true]"},{"name":"weekdayFormat","type":"(date: Date) => React.ReactNode","description":"How to format week days in header.","defaultValue":"(date) => date.toLocaleDateString(locale, { weekday: 'narrow' })"},{"name":"weekStart","type":"0 | 1 | 2 | 3 | 4 | 5 | 6 | Weekday","description":"Day of week that starts the week. 0 is Sunday, 6 is Saturday.","defaultValue":"0"},{"name":"yearInputAriaLabel","type":"string","description":"Accessible label for the year input.","defaultValue":"'Select year'"}]},"CalendarMonthInlineProps":{"name":"CalendarMonthInlineProps","description":"","props":[{"name":"ariaLabelledby","type":"string","description":"Id of the accessible label of the calendar month. Recommended to map to the title."},{"name":"component","type":"keyof React.JSX.IntrinsicElements","description":"Component wrapping the calendar month when used inline. Recommended to be 'article'."},{"name":"title","type":"React.ReactNode","description":"Title of the calendar rendered above the inline calendar month. Recommended to be a 'title' component."}]},"CalendarFormat":{"name":"CalendarFormat","description":"Additional properties that extend from and can be passed to the main component. These\nproperties allow customizing the calendar formatting and aria-labels.","props":[{"name":"cellAriaLabel","type":"(date: Date) => string","description":"Accessible label for the date cells."},{"name":"dayFormat","type":"(date: Date) => React.ReactNode","description":"How to format days in buttons in table cells."},{"name":"inlineProps","type":"CalendarMonthInlineProps","description":"Props used to ensure accessibility when displaying the calendar month inline."},{"name":"locale","type":"string","description":"If using the default formatters which locale to use. Undefined defaults to current locale.\nSee https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_identification_and_negotiation"},{"name":"longWeekdayFormat","type":"(date: Date) => React.ReactNode","description":"How to format days in header for screen readers."},{"name":"monthFormat","type":"(date: Date) => React.ReactNode","description":"How to format months in month select."},{"name":"nextMonthAriaLabel","type":"string","description":"Accessible label for the next month button."},{"name":"prevMonthAriaLabel","type":"string","description":"Accessible label for the previous month button."},{"name":"rangeStart","type":"Date","description":"Which date to start range styles from."},{"name":"weekdayFormat","type":"(date: Date) => React.ReactNode","description":"How to format week days in header."},{"name":"weekStart","type":"0 | 1 | 2 | 3 | 4 | 5 | 6 | Weekday","description":"Day of week that starts the week. 0 is Sunday, 6 is Saturday."},{"name":"yearInputAriaLabel","type":"string","description":"Accessible label for the year input."}]},"CalendarProps":{"name":"CalendarProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes to add to the outer div of the calendar month."},{"name":"date","type":"Date","description":"Month/year to base other dates around."},{"name":"isDateFocused","type":"boolean","description":"Flag to set browser focus on the passed date. *"},{"name":"onChange","type":"(event: React.MouseEvent<HTMLButtonElement, MouseEvent>, date: Date) => void","description":"Callback when date is selected."},{"name":"onMonthChange","type":"(\n event?: React.MouseEvent | React.ChangeEvent | React.FormEvent<HTMLInputElement>,\n newDate?: Date\n ) => void","description":"Callback when month or year is changed."},{"name":"onSelectToggle","type":"(open: boolean) => void","description":""},{"name":"validators","type":"((date: Date) => boolean)[]","description":"Functions that returns if a date is valid and selectable."}]},"Button":{"name":"Button","description":"","props":[{"name":"aria-label","type":"string","description":"Adds accessible text to the button."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the button"},{"name":"className","type":"string","description":"Additional classes added to the button"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to button"},{"name":"countOptions","type":"BadgeCountObject","description":"Adds count number to button"},{"name":"hasNoPadding","type":"boolean","description":"Applies no padding on a plain button variant. Use when plain button is placed inline with text"},{"name":"icon","type":"React.ReactNode | null","description":"Icon for the button."},{"name":"iconPosition","type":"'start' | 'end' | 'left' | 'right'","description":"Sets position of the icon. Note: \"left\" and \"right\" are deprecated. Use \"start\" and \"end\" instead"},{"name":"inoperableEvents","type":"string[]","description":"Events to prevent when the button is in an aria-disabled state"},{"name":"isAriaDisabled","type":"boolean","description":"Adds disabled styling and communicates that the button is disabled using the aria-disabled html attribute"},{"name":"isBlock","type":"boolean","description":"Adds block styling to button"},{"name":"isClicked","type":"boolean","description":"Adds clicked styling to button."},{"name":"isDanger","type":"boolean","description":"Adds danger styling to secondary or link button variants"},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling and disables the button using the disabled html attribute"},{"name":"isInline","type":"boolean","description":"Adds inline styling to a link button"},{"name":"isLoading","type":"boolean","description":"Adds progress styling to button"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"size","type":"'default' | 'sm' | 'lg'","description":"Adds styling which affects the size of the button"},{"name":"spinnerAriaLabel","type":"string","description":"Accessible label for the spinner to describe what is loading"},{"name":"spinnerAriaLabelledBy","type":"string","description":"Id of element which describes what is being loaded"},{"name":"spinnerAriaValueText","type":"string","description":"Text describing that current loading status or progress"},{"name":"state","type":"'read' | 'unread' | 'attention'","description":"Sets state of the stateful button variant. Default is \"unread\""},{"name":"tabIndex","type":"number","description":"Sets the button tabindex."},{"name":"type","type":"'button' | 'submit' | 'reset'","description":"Sets button type"},{"name":"variant","type":"'primary' | 'secondary' | 'tertiary' | 'danger' | 'warning' | 'link' | 'plain' | 'control' | 'stateful'","description":"Adds button variant styles"}]},"BadgeCountObject":{"name":"BadgeCountObject","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the badge count"},{"name":"count","type":"number","description":"Adds count number right of button"},{"name":"isRead","type":"boolean","description":"Adds styling to the badge to indicate it has been read"}]},"ButtonProps":{"name":"ButtonProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the button"},{"name":"className","type":"string","description":"Additional classes added to the button"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to button"},{"name":"countOptions","type":"BadgeCountObject","description":"Adds count number to button"},{"name":"hasNoPadding","type":"boolean","description":"Applies no padding on a plain button variant. Use when plain button is placed inline with text"},{"name":"icon","type":"React.ReactNode | null","description":"Icon for the button."},{"name":"iconPosition","type":"'start' | 'end' | 'left' | 'right'","description":"Sets position of the icon. Note: \"left\" and \"right\" are deprecated. Use \"start\" and \"end\" instead"},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"inoperableEvents","type":"string[]","description":"Events to prevent when the button is in an aria-disabled state"},{"name":"isAriaDisabled","type":"boolean","description":"Adds disabled styling and communicates that the button is disabled using the aria-disabled html attribute"},{"name":"isBlock","type":"boolean","description":"Adds block styling to button"},{"name":"isClicked","type":"boolean","description":"Adds clicked styling to button."},{"name":"isDanger","type":"boolean","description":"Adds danger styling to secondary or link button variants"},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling and disables the button using the disabled html attribute"},{"name":"isInline","type":"boolean","description":"Adds inline styling to a link button"},{"name":"isLoading","type":"boolean","description":"Adds progress styling to button"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"size","type":"'default' | 'sm' | 'lg'","description":"Adds styling which affects the size of the button"},{"name":"spinnerAriaLabel","type":"string","description":"Accessible label for the spinner to describe what is loading"},{"name":"spinnerAriaLabelledBy","type":"string","description":"Id of element which describes what is being loaded"},{"name":"spinnerAriaValueText","type":"string","description":"Text describing that current loading status or progress"},{"name":"state","type":"'read' | 'unread' | 'attention'","description":"Sets state of the stateful button variant. Default is \"unread\""},{"name":"tabIndex","type":"number","description":"Sets the button tabindex."},{"name":"type","type":"'button' | 'submit' | 'reset'","description":"Sets button type"},{"name":"Unknown","type":"string","description":"Adds accessible text to the button."},{"name":"variant","type":"'primary' | 'secondary' | 'tertiary' | 'danger' | 'warning' | 'link' | 'plain' | 'control' | 'stateful'","description":"Adds button variant styles"}]},"BreadcrumbItem":{"name":"BreadcrumbItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the breadcrumb item.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the breadcrumb item.","defaultValue":"''"},{"name":"component","type":"React.ElementType","description":"Sets the base component to render. Defaults to <a>","defaultValue":"'a'"},{"name":"isActive","type":"boolean","description":"Flag indicating whether the item is active.","defaultValue":"false"},{"name":"isDropdown","type":"boolean","description":"Flag indicating whether the item contains a dropdown.","defaultValue":"false"},{"name":"render","type":"(props: BreadcrumbItemRenderArgs) => React.ReactNode","description":"A render function to render the component inside the breadcrumb item.","defaultValue":"undefined"},{"name":"showDivider","type":"boolean","description":"Internal prop set by Breadcrumb on all but the first crumb"},{"name":"target","type":"string","description":"Target for breadcrumb link.","defaultValue":"undefined"},{"name":"to","type":"string","description":"HREF for breadcrumb link.","defaultValue":"undefined"}]},"BreadcrumbItemRenderArgs":{"name":"BreadcrumbItemRenderArgs","description":"","props":[{"name":"ariaCurrent","type":"'page' | undefined","description":null,"required":true},{"name":"className","type":"string","description":null,"required":true}]},"BreadcrumbItemProps":{"name":"BreadcrumbItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the breadcrumb item."},{"name":"className","type":"string","description":"Additional classes added to the breadcrumb item."},{"name":"component","type":"React.ElementType","description":"Sets the base component to render. Defaults to <a>"},{"name":"isActive","type":"boolean","description":"Flag indicating whether the item is active."},{"name":"isDropdown","type":"boolean","description":"Flag indicating whether the item contains a dropdown."},{"name":"render","type":"(props: BreadcrumbItemRenderArgs) => React.ReactNode","description":"A render function to render the component inside the breadcrumb item."},{"name":"showDivider","type":"boolean","description":"Internal prop set by Breadcrumb on all but the first crumb"},{"name":"target","type":"string","description":"Target for breadcrumb link."},{"name":"to","type":"string","description":"HREF for breadcrumb link."}]},"BreadcrumbHeading":{"name":"BreadcrumbHeading","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the breadcrumb title.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the breadcrumb item.","defaultValue":"''"},{"name":"component","type":"React.ReactNode","description":"Sets the base component to render. Defaults to <a>","defaultValue":"'a'"},{"name":"showDivider","type":"boolean","description":"Internal prop set by Breadcrumb on all but the first crumb"},{"name":"target","type":"string","description":"Target for breadcrumb link.","defaultValue":"undefined"},{"name":"to","type":"string","description":"HREF for breadcrumb link.","defaultValue":"undefined"}]},"BreadcrumbHeadingProps":{"name":"BreadcrumbHeadingProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the breadcrumb title."},{"name":"className","type":"string","description":"Additional classes added to the breadcrumb item."},{"name":"component","type":"React.ReactNode","description":"Sets the base component to render. Defaults to <a>"},{"name":"showDivider","type":"boolean","description":"Internal prop set by Breadcrumb on all but the first crumb"},{"name":"target","type":"string","description":"Target for breadcrumb link."},{"name":"to","type":"string","description":"HREF for breadcrumb link."}]},"Breadcrumb":{"name":"Breadcrumb","description":"","props":[{"name":"aria-label","type":"string","description":"Aria label added to the breadcrumb nav.","defaultValue":"'Breadcrumb'"},{"name":"children","type":"React.ReactNode","description":"Children nodes be rendered to the BreadCrumb. Should be of type BreadCrumbItem.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the breadcrumb nav.","defaultValue":"''"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"}]},"BreadcrumbProps":{"name":"BreadcrumbProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Children nodes be rendered to the BreadCrumb. Should be of type BreadCrumbItem."},{"name":"className","type":"string","description":"Additional classes added to the breadcrumb nav."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"Unknown","type":"string","description":"Aria label added to the breadcrumb nav."}]},"Brand":{"name":"Brand","description":"","props":[{"name":"alt","type":"string","description":"Attribute that specifies the alt text of a <img> Brand. For a <picture> Brand this specifies the fallback <img> alt text.","required":true},{"name":"children","type":"React.ReactNode","description":"Transforms the Brand into a <picture> element from an <img> element. Container for <source> child elements."},{"name":"className","type":"string","description":"Additional classes added to the either type of Brand.","defaultValue":"''"},{"name":"heights","type":"{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}","description":"Heights at various breakpoints for a <picture> Brand."},{"name":"src","type":"string","description":"Attribute that specifies the URL of a <img> Brand. For a <picture> Brand this specifies the fallback <img> URL.","defaultValue":"''"},{"name":"widths","type":"{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}","description":"Widths at various breakpoints for a <picture> Brand."}]},"BrandProps":{"name":"BrandProps","description":"","props":[{"name":"alt","type":"string","description":"Attribute that specifies the alt text of a <img> Brand. For a <picture> Brand this specifies the fallback <img> alt text.","required":true},{"name":"children","type":"React.ReactNode","description":"Transforms the Brand into a <picture> element from an <img> element. Container for <source> child elements."},{"name":"className","type":"string","description":"Additional classes added to the either type of Brand."},{"name":"heights","type":"{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n }","description":"Heights at various breakpoints for a <picture> Brand."},{"name":"src","type":"string","description":"Attribute that specifies the URL of a <img> Brand. For a <picture> Brand this specifies the fallback <img> URL."},{"name":"widths","type":"{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n }","description":"Widths at various breakpoints for a <picture> Brand."}]},"Banner":{"name":"Banner","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the banner."},{"name":"className","type":"string","description":"Additional classes added to the banner."},{"name":"color","type":"'red' | 'orangered' | 'orange' | 'yellow' | 'green' | 'teal' | 'blue' | 'purple'","description":"Color options for the banner, will be overwritten by any applied using the status prop."},{"name":"isSticky","type":"boolean","description":"If set to true, the banner sticks to the top of its container","defaultValue":"false"},{"name":"screenReaderText","type":"string","description":"Text announced by screen readers to indicate the type of banner. This prop should only\nbe passed in when the banner conveys status/severity."},{"name":"status","type":"'success' | 'warning' | 'danger' | 'info' | 'custom'","description":"Status style options for the banner, will overwrite any color applied using the color prop."}]},"BannerProps":{"name":"BannerProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the banner."},{"name":"className","type":"string","description":"Additional classes added to the banner."},{"name":"color","type":"BannerColor","description":"Color options for the banner, will be overwritten by any applied using the status prop."},{"name":"isSticky","type":"boolean","description":"If set to true, the banner sticks to the top of its container"},{"name":"screenReaderText","type":"string","description":"Text announced by screen readers to indicate the type of banner. This prop should only\nbe passed in when the banner conveys status/severity."},{"name":"status","type":"BannerStatus","description":"Status style options for the banner, will overwrite any color applied using the color prop."}]},"StatusBanner":{"name":"StatusBanner","description":"","props":[{"name":"color","type":"never","description":null},{"name":"status","type":"BannerStatus","description":null}]},"NonStatusBanner":{"name":"NonStatusBanner","description":"","props":[{"name":"color","type":"BannerColor","description":null},{"name":"status","type":"never","description":null}]},"BannerColor":{"name":"BannerColor","description":"","props":[]},"BannerStatus":{"name":"BannerStatus","description":"","props":[]},"Badge":{"name":"Badge","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Badge","defaultValue":"''"},{"name":"className","type":"string","description":"additional classes added to the Badge","defaultValue":"''"},{"name":"isDisabled","type":"boolean","description":"Adds styling to the badge to indicate it is disabled","defaultValue":"false"},{"name":"isRead","type":"boolean","description":"Adds styling to the badge to indicate it has been read","defaultValue":"false"},{"name":"screenReaderText","type":"string","description":"Text announced by screen readers to indicate the current content/status of the badge."}]},"BadgeProps":{"name":"BadgeProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"content rendered inside the Badge"},{"name":"className","type":"string","description":"additional classes added to the Badge"},{"name":"isDisabled","type":"boolean","description":"Adds styling to the badge to indicate it is disabled"},{"name":"isRead","type":"boolean","description":"Adds styling to the badge to indicate it has been read"},{"name":"screenReaderText","type":"string","description":"Text announced by screen readers to indicate the current content/status of the badge."}]},"BackgroundImage":{"name":"BackgroundImage","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the background image."},{"name":"src","type":"string","description":"The URL or file path of the image for the background","required":true}]},"BackgroundImageProps":{"name":"BackgroundImageProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the background image."},{"name":"src","type":"string","description":"The URL or file path of the image for the background","required":true}]},"Backdrop":{"name":"Backdrop","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the backdrop","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the backdrop","defaultValue":"''"}]},"BackdropProps":{"name":"BackdropProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the backdrop"},{"name":"className","type":"string","description":"Additional classes added to the backdrop"}]},"BackToTop":{"name":"BackToTop","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the back to top."},{"name":"isAlwaysVisible","type":"boolean","description":"Flag to always show back to top button, defaults to false."},{"name":"scrollableSelector","type":"string","description":"Selector for the scrollable element to spy on. Not passing a selector defaults to spying on window scroll events."},{"name":"title","type":"string","description":"Title to appear in back to top button."}]},"BackToTopProps":{"name":"BackToTopProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the back to top."},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"isAlwaysVisible","type":"boolean","description":"Flag to always show back to top button, defaults to false."},{"name":"scrollableSelector","type":"string","description":"Selector for the scrollable element to spy on. Not passing a selector defaults to spying on window scroll events."},{"name":"title","type":"string","description":"Title to appear in back to top button."}]},"Avatar":{"name":"Avatar","description":"","props":[{"name":"alt","type":"string","description":"Attribute that specifies the alternate text of the image for the avatar.","required":true},{"name":"className","type":"string","description":"Additional classes added to the avatar."},{"name":"isBordered","type":"boolean","description":"Flag to indicate the avatar should have a border."},{"name":"size","type":"'sm' | 'md' | 'lg' | 'xl'","description":"Size variant of avatar."},{"name":"src","type":"string","description":"Attribute that specifies the URL of the image for the avatar.","defaultValue":"''"}]},"AvatarProps":{"name":"AvatarProps","description":"","props":[{"name":"alt","type":"string","description":"Attribute that specifies the alternate text of the image for the avatar.","required":true},{"name":"className","type":"string","description":"Additional classes added to the avatar."},{"name":"isBordered","type":"boolean","description":"Flag to indicate the avatar should have a border."},{"name":"size","type":"'sm' | 'md' | 'lg' | 'xl'","description":"Size variant of avatar."},{"name":"src","type":"string","description":"Attribute that specifies the URL of the image for the avatar."}]},"AlertToggleExpandButton":{"name":"AlertToggleExpandButton","description":"","props":[{"name":"aria-label","type":"string","description":"Adds accessible text to the button.","defaultValue":"''"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the button"},{"name":"className","type":"string","description":"Additional classes added to the button"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to button"},{"name":"countOptions","type":"BadgeCountObject","description":"Adds count number to button"},{"name":"hasNoPadding","type":"boolean","description":"Applies no padding on a plain button variant. Use when plain button is placed inline with text"},{"name":"icon","type":"React.ReactNode | null","description":"Icon for the button."},{"name":"iconPosition","type":"'start' | 'end' | 'left' | 'right'","description":"Sets position of the icon. Note: \"left\" and \"right\" are deprecated. Use \"start\" and \"end\" instead"},{"name":"inoperableEvents","type":"string[]","description":"Events to prevent when the button is in an aria-disabled state"},{"name":"isAriaDisabled","type":"boolean","description":"Adds disabled styling and communicates that the button is disabled using the aria-disabled html attribute"},{"name":"isBlock","type":"boolean","description":"Adds block styling to button"},{"name":"isClicked","type":"boolean","description":"Adds clicked styling to button."},{"name":"isDanger","type":"boolean","description":"Adds danger styling to secondary or link button variants"},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling and disables the button using the disabled html attribute"},{"name":"isExpanded","type":"boolean","description":"Flag to indicate if the content is expanded.","defaultValue":"false"},{"name":"isInline","type":"boolean","description":"Adds inline styling to a link button"},{"name":"isLoading","type":"boolean","description":"Adds progress styling to button"},{"name":"onToggleExpand","type":"() => void","description":"A callback for when the toggle button is clicked."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"size","type":"'default' | 'sm' | 'lg'","description":"Adds styling which affects the size of the button"},{"name":"spinnerAriaLabel","type":"string","description":"Accessible label for the spinner to describe what is loading"},{"name":"spinnerAriaLabelledBy","type":"string","description":"Id of element which describes what is being loaded"},{"name":"spinnerAriaValueText","type":"string","description":"Text describing that current loading status or progress"},{"name":"state","type":"'read' | 'unread' | 'attention'","description":"Sets state of the stateful button variant. Default is \"unread\""},{"name":"tabIndex","type":"number","description":"Sets the button tabindex."},{"name":"type","type":"'button' | 'submit' | 'reset'","description":"Sets button type"},{"name":"variant","type":"'primary' | 'secondary' | 'tertiary' | 'danger' | 'warning' | 'link' | 'plain' | 'control' | 'stateful'","description":"Adds button variant styles"},{"name":"variantLabel","type":"string","description":"Variant label for the toggle button."}]},"AlertToggleExpandButtonProps":{"name":"AlertToggleExpandButtonProps","description":"","props":[{"name":"isExpanded","type":"boolean","description":"Flag to indicate if the content is expanded."},{"name":"onToggleExpand","type":"() => void","description":"A callback for when the toggle button is clicked."},{"name":"Unknown","type":"string","description":"Accessible label for the toggle button."},{"name":"variantLabel","type":"string","description":"Variant label for the toggle button."}]},"AlertIcon":{"name":"AlertIcon","description":"","props":[{"name":"className","type":"string","description":"Additional class names added to the alert icon.","defaultValue":"''"},{"name":"customIcon","type":"React.ReactNode","description":"A custom icon. If not set the icon is set according to the variant."},{"name":"variant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom'","description":"Variant of the alert icon.","required":true}]},"AlertIconProps":{"name":"AlertIconProps","description":"","props":[{"name":"className","type":"string","description":"Additional class names added to the alert icon."},{"name":"customIcon","type":"React.ReactNode","description":"A custom icon. If not set the icon is set according to the variant."},{"name":"variant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom'","description":"Variant of the alert icon.","required":true}]},"AlertGroupInline":{"name":"AlertGroupInline","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement)","description":"Determine where the alert is appended to"},{"name":"aria-label","type":"string","description":"Adds an accessible label to the alert group."},{"name":"children","type":"React.ReactNode","description":"Alerts to be rendered in the AlertGroup"},{"name":"className","type":"string","description":"Additional classes added to the AlertGroup"},{"name":"hasAnimations","type":"boolean","description":"Flag to indicate whether Alerts are animated upon rendering and being dismissed. This is intended\nto remain false for testing purposes only.","beta":true},{"name":"isLiveRegion","type":"boolean","description":"Turns the container into a live region so that changes to content within the AlertGroup, such as appending an Alert, are reliably announced to assistive technology."},{"name":"isToast","type":"boolean","description":"Toast notifications are positioned at the top right corner of the viewport"},{"name":"onOverflowClick","type":"() => void","description":"Function to call if user clicks on overflow message"},{"name":"overflowMessage","type":"string","description":"Custom text to show for the overflow message"}]},"AlertGroupContext":{"name":"AlertGroupContext","description":"","props":[{"name":"hasAnimations","type":"boolean","description":null},{"name":"updateTransitionEnd","type":"(onTransitionEnd: () => void) => void","description":null}]},"AlertGroup":{"name":"AlertGroup","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement)","description":"Determine where the alert is appended to"},{"name":"aria-label","type":"string","description":"Adds an accessible label to the alert group."},{"name":"children","type":"React.ReactNode","description":"Alerts to be rendered in the AlertGroup"},{"name":"className","type":"string","description":"Additional classes added to the AlertGroup"},{"name":"hasAnimations","type":"boolean","description":"Flag to indicate whether Alerts are animated upon rendering and being dismissed. This is intended\nto remain false for testing purposes only.","beta":true},{"name":"isLiveRegion","type":"boolean","description":"Turns the container into a live region so that changes to content within the AlertGroup, such as appending an Alert, are reliably announced to assistive technology."},{"name":"isToast","type":"boolean","description":"Toast notifications are positioned at the top right corner of the viewport"},{"name":"onOverflowClick","type":"() => void","description":"Function to call if user clicks on overflow message"},{"name":"overflowMessage","type":"string","description":"Custom text to show for the overflow message"}]},"AlertGroupProps":{"name":"AlertGroupProps","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement)","description":"Determine where the alert is appended to"},{"name":"children","type":"React.ReactNode","description":"Alerts to be rendered in the AlertGroup"},{"name":"className","type":"string","description":"Additional classes added to the AlertGroup"},{"name":"hasAnimations","type":"boolean","description":""},{"name":"isLiveRegion","type":"boolean","description":"Turns the container into a live region so that changes to content within the AlertGroup, such as appending an Alert, are reliably announced to assistive technology."},{"name":"isToast","type":"boolean","description":"Toast notifications are positioned at the top right corner of the viewport"},{"name":"onOverflowClick","type":"() => void","description":"Function to call if user clicks on overflow message"},{"name":"overflowMessage","type":"string","description":"Custom text to show for the overflow message"},{"name":"Unknown","type":"string","description":"Adds an accessible label to the alert group."}]},"AlertGroupState":{"name":"AlertGroupState","description":"","props":[{"name":"container","type":"HTMLElement","description":null,"required":true}]},"AlertActionLink":{"name":"AlertActionLink","description":"Renders buttons styled as links beneath the alert title and description when this sub-component\nis passed into the alert's actionLinks property.","props":[{"name":"aria-label","type":"string","description":"Adds accessible text to the button."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the button"},{"name":"className","type":"string","description":"Additional classes added to the button","defaultValue":"''"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to button"},{"name":"countOptions","type":"BadgeCountObject","description":"Adds count number to button"},{"name":"hasNoPadding","type":"boolean","description":"Applies no padding on a plain button variant. Use when plain button is placed inline with text"},{"name":"icon","type":"React.ReactNode | null","description":"Icon for the button."},{"name":"iconPosition","type":"'start' | 'end' | 'left' | 'right'","description":"Sets position of the icon. Note: \"left\" and \"right\" are deprecated. Use \"start\" and \"end\" instead"},{"name":"inoperableEvents","type":"string[]","description":"Events to prevent when the button is in an aria-disabled state"},{"name":"isAriaDisabled","type":"boolean","description":"Adds disabled styling and communicates that the button is disabled using the aria-disabled html attribute"},{"name":"isBlock","type":"boolean","description":"Adds block styling to button"},{"name":"isClicked","type":"boolean","description":"Adds clicked styling to button."},{"name":"isDanger","type":"boolean","description":"Adds danger styling to secondary or link button variants"},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling and disables the button using the disabled html attribute"},{"name":"isInline","type":"boolean","description":"Adds inline styling to a link button"},{"name":"isLoading","type":"boolean","description":"Adds progress styling to button"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"size","type":"'default' | 'sm' | 'lg'","description":"Adds styling which affects the size of the button"},{"name":"spinnerAriaLabel","type":"string","description":"Accessible label for the spinner to describe what is loading"},{"name":"spinnerAriaLabelledBy","type":"string","description":"Id of element which describes what is being loaded"},{"name":"spinnerAriaValueText","type":"string","description":"Text describing that current loading status or progress"},{"name":"state","type":"'read' | 'unread' | 'attention'","description":"Sets state of the stateful button variant. Default is \"unread\""},{"name":"tabIndex","type":"number","description":"Sets the button tabindex."},{"name":"type","type":"'button' | 'submit' | 'reset'","description":"Sets button type"},{"name":"variant","type":"'primary' | 'secondary' | 'tertiary' | 'danger' | 'warning' | 'link' | 'plain' | 'control' | 'stateful'","description":"Adds button variant styles"}]},"AlertActionLinkProps":{"name":"AlertActionLinkProps","description":"Renders buttons styled as links beneath the alert title and description when this sub-component\nis passed into the alert's actionLinks property.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the alert action link. Interactive content such as anchor elements should not be passed in."},{"name":"className","type":"string","description":"Additional classes added to the alert action link."}]},"AlertActionCloseButton":{"name":"AlertActionCloseButton","description":"Renders a close button for a dismissable alert when this sub-component is passed into\nthe alert's actionClose property.","props":[{"name":"aria-label","type":"string","description":"Adds accessible text to the button.","defaultValue":"''"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the button"},{"name":"className","type":"string","description":"Additional classes added to the button"},{"name":"component","type":"React.ElementType<any> | React.ComponentType<any>","description":"Sets the base component to render. defaults to button"},{"name":"countOptions","type":"BadgeCountObject","description":"Adds count number to button"},{"name":"hasNoPadding","type":"boolean","description":"Applies no padding on a plain button variant. Use when plain button is placed inline with text"},{"name":"icon","type":"React.ReactNode | null","description":"Icon for the button."},{"name":"iconPosition","type":"'start' | 'end' | 'left' | 'right'","description":"Sets position of the icon. Note: \"left\" and \"right\" are deprecated. Use \"start\" and \"end\" instead"},{"name":"inoperableEvents","type":"string[]","description":"Events to prevent when the button is in an aria-disabled state"},{"name":"isAriaDisabled","type":"boolean","description":"Adds disabled styling and communicates that the button is disabled using the aria-disabled html attribute"},{"name":"isBlock","type":"boolean","description":"Adds block styling to button"},{"name":"isClicked","type":"boolean","description":"Adds clicked styling to button."},{"name":"isDanger","type":"boolean","description":"Adds danger styling to secondary or link button variants"},{"name":"isDisabled","type":"boolean","description":"Adds disabled styling and disables the button using the disabled html attribute"},{"name":"isInline","type":"boolean","description":"Adds inline styling to a link button"},{"name":"isLoading","type":"boolean","description":"Adds progress styling to button"},{"name":"onClose","type":"() => void","description":"A callback for when the close button is clicked.","defaultValue":"() => undefined as any"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"size","type":"'default' | 'sm' | 'lg'","description":"Adds styling which affects the size of the button"},{"name":"spinnerAriaLabel","type":"string","description":"Accessible label for the spinner to describe what is loading"},{"name":"spinnerAriaLabelledBy","type":"string","description":"Id of element which describes what is being loaded"},{"name":"spinnerAriaValueText","type":"string","description":"Text describing that current loading status or progress"},{"name":"state","type":"'read' | 'unread' | 'attention'","description":"Sets state of the stateful button variant. Default is \"unread\""},{"name":"tabIndex","type":"number","description":"Sets the button tabindex."},{"name":"type","type":"'button' | 'submit' | 'reset'","description":"Sets button type"},{"name":"variant","type":"'primary' | 'secondary' | 'tertiary' | 'danger' | 'warning' | 'link' | 'plain' | 'control' | 'stateful'","description":"Adds button variant styles"},{"name":"variantLabel","type":"string","description":"Variant Label for the close button."}]},"AlertActionCloseButtonProps":{"name":"AlertActionCloseButtonProps","description":"Renders a close button for a dismissable alert when this sub-component is passed into\nthe alert's actionClose property.","props":[{"name":"className","type":"string","description":"Additional classes added to the alert action close button."},{"name":"onClose","type":"() => void","description":"A callback for when the close button is clicked."},{"name":"Unknown","type":"string","description":"Accessible label for the close button"},{"name":"variantLabel","type":"string","description":"Variant Label for the close button."}]},"Alert":{"name":"Alert","description":"The main alert component.","props":[{"name":"actionClose","type":"React.ReactNode","description":"Close button; use the alert action close button component."},{"name":"actionLinks","type":"React.ReactNode","description":"Action links; use a single alert action link component or multiple wrapped in an array\nor React fragment."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the alert.","defaultValue":"''"},{"name":"className","type":"string","description":"Additional classes to add to the alert.","defaultValue":"''"},{"name":"component","type":"React.JSX.IntrinsicElements","description":"Sets the element to use as the alert title. Default is h4.","defaultValue":"'h4'"},{"name":"customIcon","type":"React.ReactNode","description":"Set a custom icon to the alert. If not set the icon is set according to the variant."},{"name":"id","type":"string","description":"Uniquely identifies the alert."},{"name":"isExpandable","type":"boolean","description":"Flag indicating that the alert is expandable.","defaultValue":"false"},{"name":"isInline","type":"boolean","description":"Flag to indicate if the alert is inline.","defaultValue":"false"},{"name":"isLiveRegion","type":"boolean","description":"Flag to indicate if the alert is in a live region.","defaultValue":"false"},{"name":"isPlain","type":"boolean","description":"Flag to indicate if the alert is plain.","defaultValue":"false"},{"name":"onMouseEnter","type":"No type info","defaultValue":"() => {}"},{"name":"onMouseLeave","type":"No type info","defaultValue":"() => {}"},{"name":"onTimeout","type":"() => void","description":"Function to be executed on alert timeout. Relevant when the timeout prop is set.","defaultValue":"() => {}"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"},{"name":"timeout","type":"number | boolean","description":"If set to true, the timeout is 8000 milliseconds. If a number is provided, alert will\nbe dismissed after that amount of time in milliseconds.","defaultValue":"false"},{"name":"timeoutAnimation","type":"number","description":"If the user hovers over the alert and `timeout` expires, this is how long to wait\nbefore finally dismissing the alert.","defaultValue":"3000"},{"name":"title","type":"React.ReactNode","description":"Title of the alert.","required":true},{"name":"toggleAriaLabel","type":"string","description":"Adds accessible text to the alert toggle."},{"name":"tooltipPosition","type":"| TooltipPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Position of the tooltip which is displayed if text is truncated."},{"name":"truncateTitle","type":"number","description":"Truncate title to number of lines.","defaultValue":"0"},{"name":"variant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom'","description":"Adds alert variant styles.","defaultValue":"AlertVariant.custom"},{"name":"variantLabel","type":"string","description":"Variant label text for screen readers."}]},"AlertProps":{"name":"AlertProps","description":"The main alert component.","props":[{"name":"actionClose","type":"React.ReactNode","description":"Close button; use the alert action close button component."},{"name":"actionLinks","type":"React.ReactNode","description":"Action links; use a single alert action link component or multiple wrapped in an array\nor React fragment."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the alert."},{"name":"className","type":"string","description":"Additional classes to add to the alert."},{"name":"component","type":"keyof React.JSX.IntrinsicElements","description":"Sets the element to use as the alert title. Default is h4."},{"name":"customIcon","type":"React.ReactNode","description":"Set a custom icon to the alert. If not set the icon is set according to the variant."},{"name":"id","type":"string","description":"Uniquely identifies the alert."},{"name":"isExpandable","type":"boolean","description":"Flag indicating that the alert is expandable."},{"name":"isInline","type":"boolean","description":"Flag to indicate if the alert is inline."},{"name":"isLiveRegion","type":"boolean","description":"Flag to indicate if the alert is in a live region."},{"name":"isPlain","type":"boolean","description":"Flag to indicate if the alert is plain."},{"name":"onTimeout","type":"() => void","description":"Function to be executed on alert timeout. Relevant when the timeout prop is set."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"timeout","type":"number | boolean","description":"If set to true, the timeout is 8000 milliseconds. If a number is provided, alert will\nbe dismissed after that amount of time in milliseconds."},{"name":"timeoutAnimation","type":"number","description":"If the user hovers over the alert and `timeout` expires, this is how long to wait\nbefore finally dismissing the alert."},{"name":"title","type":"React.ReactNode","description":"Title of the alert.","required":true},{"name":"toggleAriaLabel","type":"string","description":"Adds accessible text to the alert toggle."},{"name":"tooltipPosition","type":"| TooltipPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Position of the tooltip which is displayed if text is truncated."},{"name":"truncateTitle","type":"number","description":"Truncate title to number of lines."},{"name":"variant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom'","description":"Adds alert variant styles."},{"name":"variantLabel","type":"string","description":"Variant label text for screen readers."}]},"ActionListItem":{"name":"ActionListItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Children of the action list item"},{"name":"className","type":"string","description":"Additional classes added to the action list item"}]},"ActionListItemProps":{"name":"ActionListItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Children of the action list item"},{"name":"className","type":"string","description":"Additional classes added to the action list item"}]},"ActionListGroup":{"name":"ActionListGroup","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Children of the action list group"},{"name":"className","type":"string","description":"Additional classes added to the action list group"},{"name":"isIconGroup","type":"boolean","description":"Flag indicating the action list group contains multiple icons and item padding should be removed"}]},"ActionListGroupProps":{"name":"ActionListGroupProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Children of the action list group"},{"name":"className","type":"string","description":"Additional classes added to the action list group"},{"name":"isIconGroup","type":"boolean","description":"Flag indicating the action list group contains multiple icons and item padding should be removed"}]},"ActionList":{"name":"ActionList","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Children of the action list"},{"name":"className","type":"string","description":"Additional classes added to the action list"},{"name":"isIconList","type":"boolean","description":"Flag indicating the action list contains multiple icons and item padding should be removed"}]},"ActionListProps":{"name":"ActionListProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Children of the action list"},{"name":"className","type":"string","description":"Additional classes added to the action list"},{"name":"isIconList","type":"boolean","description":"Flag indicating the action list contains multiple icons and item padding should be removed"}]},"AccordionToggle":{"name":"AccordionToggle","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Accordion toggle","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the Accordion Toggle","defaultValue":"''"},{"name":"component","type":"React.ElementType","description":"Container to override the default for toggle"},{"name":"id","type":"string","description":"Identify the Accordion toggle number","required":true}]},"AccordionToggleProps":{"name":"AccordionToggleProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Accordion toggle"},{"name":"className","type":"string","description":"Additional classes added to the Accordion Toggle"},{"name":"component","type":"React.ElementType","description":"Container to override the default for toggle"},{"name":"id","type":"string","description":"Identify the Accordion toggle number","required":true}]},"AccordionItem":{"name":"AccordionItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the accordion item.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the accordion item."},{"name":"isExpanded","type":"boolean","description":"Flag to indicate whether the accordion item is expanded.","defaultValue":"false"}]},"AccordionItemProps":{"name":"AccordionItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the accordion item."},{"name":"className","type":"string","description":"Additional classes added to the accordion item."},{"name":"isExpanded","type":"boolean","description":"Flag to indicate whether the accordion item is expanded."}]},"AccordionExpandableContentBody":{"name":"AccordionExpandableContentBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the accordion content body","defaultValue":"null"}]},"AccordionExpandableContentBodyProps":{"name":"AccordionExpandableContentBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the accordion content body"}]},"AccordionContent":{"name":"AccordionContent","description":"","props":[{"name":"aria-label","type":"string","description":"Adds accessible text to the Accordion content","defaultValue":"''"},{"name":"aria-labelledby","type":"string","description":"Id of the controlling accordion toggle to label the content."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Accordion","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the Accordion content","defaultValue":"''"},{"name":"component","type":"React.ElementType","description":"Component to use as content container"},{"name":"contentBodyProps","type":"AccordionExpandableContentBodyProps","description":"Props passed to the AccordionExpandableContentBody *"},{"name":"id","type":"string","description":"Identify the AccordionContent item","defaultValue":"''"},{"name":"isCustomContent","type":"React.ReactNode","description":"Flag indicating content is custom. Expanded content Body wrapper will be removed from children. This allows multiple bodies to be rendered as content.","defaultValue":"false"},{"name":"isFixed","type":"boolean","description":"Flag to indicate Accordion content is fixed","defaultValue":"false"}]},"AccordionContentProps":{"name":"AccordionContentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Accordion"},{"name":"className","type":"string","description":"Additional classes added to the Accordion content"},{"name":"component","type":"React.ElementType","description":"Component to use as content container"},{"name":"contentBodyProps","type":"AccordionExpandableContentBodyProps","description":"Props passed to the AccordionExpandableContentBody *"},{"name":"id","type":"string","description":"Identify the AccordionContent item"},{"name":"isCustomContent","type":"React.ReactNode","description":"Flag indicating content is custom. Expanded content Body wrapper will be removed from children. This allows multiple bodies to be rendered as content."},{"name":"isFixed","type":"boolean","description":"Flag to indicate Accordion content is fixed"},{"name":"Unknown","type":"string","description":"Id of the controlling accordion toggle to label the content."}]},"Accordion":{"name":"Accordion","description":"","props":[{"name":"aria-label","type":"string","description":"Adds accessible text to the Accordion"},{"name":"asDefinitionList","type":"boolean","description":"Flag to indicate whether use definition list or div","defaultValue":"true"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Accordion","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the Accordion","defaultValue":"''"},{"name":"displaySize","type":"'default' | 'lg'","description":"Display size variant.","defaultValue":"'default'"},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Heading level to use","defaultValue":"'h3'"},{"name":"isBordered","type":"boolean","description":"Flag to indicate the accordion had a border","defaultValue":"false"},{"name":"togglePosition","type":"'start' | 'end'","description":"Sets the toggle icon position for all accordion toggles.","defaultValue":"'end'"}]},"AccordionProps":{"name":"AccordionProps","description":"","props":[{"name":"asDefinitionList","type":"boolean","description":"Flag to indicate whether use definition list or div"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the Accordion"},{"name":"className","type":"string","description":"Additional classes added to the Accordion"},{"name":"displaySize","type":"'default' | 'lg'","description":"Display size variant."},{"name":"headingLevel","type":"'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'","description":"Heading level to use"},{"name":"isBordered","type":"boolean","description":"Flag to indicate the accordion had a border"},{"name":"togglePosition","type":"'start' | 'end'","description":"Sets the toggle icon position for all accordion toggles."},{"name":"Unknown","type":"string","description":"Adds accessible text to the Accordion"}]},"AboutModalBoxHeader":{"name":"AboutModalBoxHeader","description":"","props":[{"name":"id","type":"string","description":"Id to use for about modal box header","required":true},{"name":"productName","type":"string","description":"Name of the product"}]},"AboutModalBoxHeaderProps":{"name":"AboutModalBoxHeaderProps","description":"","props":[{"name":"id","type":"string","description":"Id to use for about modal box header","required":true},{"name":"productName","type":"string","description":"Name of the product"}]},"AboutModalBoxContent":{"name":"AboutModalBoxContent","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the about modal box content","required":true},{"name":"hasNoContentContainer","type":"boolean","description":"Prevents the about modal from rendering content inside a container; allows for more flexible layouts","defaultValue":"false"},{"name":"trademark","type":"string","description":"The trademark info for the product","required":true}]},"AboutModalBoxContentProps":{"name":"AboutModalBoxContentProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the about modal box content","required":true},{"name":"hasNoContentContainer","type":"boolean","description":"Prevents the about modal from rendering content inside a container; allows for more flexible layouts"},{"name":"trademark","type":"string","description":"The trademark info for the product","required":true}]},"AboutModalBoxCloseButton":{"name":"AboutModalBoxCloseButton","description":"","props":[{"name":"aria-label","type":"string","description":"Set close button aria label","defaultValue":"'Close Dialog'"},{"name":"onClose","type":"(event: React.MouseEvent | MouseEvent | KeyboardEvent) => void","description":"A callback for when the close button is clicked","defaultValue":"(_e) => undefined as any"}]},"AboutModalBoxCloseButtonProps":{"name":"AboutModalBoxCloseButtonProps","description":"","props":[{"name":"onClose","type":"(event: React.MouseEvent | MouseEvent | KeyboardEvent) => void","description":"A callback for when the close button is clicked"},{"name":"Unknown","type":"string","description":"Set close button aria label"}]},"AboutModalBoxBrand":{"name":"AboutModalBoxBrand","description":"","props":[{"name":"alt","type":"string","description":"The alternate text of the brand image.","required":true},{"name":"src","type":"string","description":"The URL of the image for the brand.","required":true}]},"AboutModalBoxBrandProps":{"name":"AboutModalBoxBrandProps","description":"","props":[{"name":"alt","type":"string","description":"The alternate text of the brand image.","required":true},{"name":"src","type":"string","description":"The URL of the image for the brand.","required":true}]},"AboutModalBox":{"name":"AboutModalBox","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the about modal box","required":true},{"name":"className","type":"string","description":"Additional classes added to the about modal box"}]},"AboutModalBoxProps":{"name":"AboutModalBoxProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the about modal box","required":true},{"name":"className","type":"string","description":"Additional classes added to the about modal box"}]},"AboutModal":{"name":"AboutModal","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement)","description":"The parent container to append the modal to. Defaults to document.body"},{"name":"aria-label","type":"string","description":"Aria label for the about modal. This should be used when no productName prop is provided"},{"name":"backgroundImageSrc","type":"string","description":"The URL or file path of the image for the background"},{"name":"brandImageAlt","type":"string","description":"The alternate text of the brand image","required":true},{"name":"brandImageSrc","type":"string","description":"The URL of the image for the brand","required":true},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the about modal","required":true},{"name":"className","type":"string","description":"Additional classes added to the about modal"},{"name":"closeButtonAriaLabel","type":"string","description":"Set aria label to the close button"},{"name":"disableFocusTrap","type":"boolean","description":"Flag to disable focus trap"},{"name":"hasNoContentContainer","type":"boolean","description":"Prevents the about modal from rendering content inside a container; allows for more flexible layouts","defaultValue":"false"},{"name":"isOpen","type":"boolean","description":"Flag to show the about modal","defaultValue":"false"},{"name":"onClose","type":"(event: React.MouseEvent | MouseEvent | KeyboardEvent) => void","description":"A callback for when the close button is clicked","defaultValue":"(_e): any => undefined"},{"name":"productName","type":"string","description":"Product name"},{"name":"trademark","type":"string","description":"Trademark information"}]},"AboutModalProps":{"name":"AboutModalProps","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement)","description":"The parent container to append the modal to. Defaults to document.body"},{"name":"backgroundImageSrc","type":"string","description":"The URL or file path of the image for the background"},{"name":"brandImageAlt","type":"string","description":"The alternate text of the brand image","required":true},{"name":"brandImageSrc","type":"string","description":"The URL of the image for the brand","required":true},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the about modal","required":true},{"name":"className","type":"string","description":"Additional classes added to the about modal"},{"name":"closeButtonAriaLabel","type":"string","description":"Set aria label to the close button"},{"name":"disableFocusTrap","type":"boolean","description":"Flag to disable focus trap"},{"name":"hasNoContentContainer","type":"boolean","description":"Prevents the about modal from rendering content inside a container; allows for more flexible layouts"},{"name":"isOpen","type":"boolean","description":"Flag to show the about modal"},{"name":"onClose","type":"(event: React.MouseEvent | MouseEvent | KeyboardEvent) => void","description":"A callback for when the close button is clicked"},{"name":"productName","type":"string","description":"Product name"},{"name":"trademark","type":"string","description":"Trademark information"},{"name":"Unknown","type":"string","description":"Aria label for the about modal. This should be used when no productName prop is provided"}]},"WizardToggle-deprecated":{"name":"WizardToggle","description":"","props":[{"name":"activeStep","type":"WizardStep","description":"The currently active WizardStep","required":true},{"name":"aria-label","type":"string","description":"The button's aria-label","defaultValue":"'Wizard Toggle'"},{"name":"children","type":"React.ReactNode","description":"The WizardFooter"},{"name":"hasDrawer","type":"boolean","description":"Flag indicating the wizard has a drawer for at least one of the wizard steps"},{"name":"hasNoBodyPadding","type":"boolean","description":"Set to true to remove body padding","defaultValue":"false"},{"name":"isDrawerExpanded","type":"boolean","description":"Flag indicating the wizard drawer is expanded"},{"name":"isInPage","type":"boolean","description":"If the wizard is in-page","defaultValue":"true"},{"name":"isNavOpen","type":"boolean","description":"If the nav is open","required":true},{"name":"mainAriaLabel","type":"string","description":"Adds an accessible name to the wizard body when the body content overflows and renders\na scrollbar.","defaultValue":"null"},{"name":"mainAriaLabelledBy","type":"string","description":"Adds an accessible name to the wizard body by passing the the id of one or more elements.\nThe aria-labelledby will only be applied when the body content overflows and renders a scrollbar.","defaultValue":"null"},{"name":"nav","type":"(isWizardNavOpen: boolean) => React.ReactElement<any>","description":"Function that returns the WizardNav component","required":true},{"name":"onExpandDrawer","type":"() => void","description":"Callback function for when the drawer is toggled"},{"name":"onNavToggle","type":"(isOpen: boolean) => void","description":"Callback function for when the nav is toggled","required":true},{"name":"steps","type":"WizardStep[]","description":"The wizard steps","required":true}]},"WizardToggleProps-deprecated":{"name":"WizardToggleProps","description":"","props":[{"name":"activeStep","type":"WizardStep","description":"The currently active WizardStep","required":true},{"name":"children","type":"React.ReactNode","description":"The WizardFooter"},{"name":"hasDrawer","type":"boolean","description":"Flag indicating the wizard has a drawer for at least one of the wizard steps"},{"name":"hasNoBodyPadding","type":"boolean","description":"Set to true to remove body padding","required":true},{"name":"isDrawerExpanded","type":"boolean","description":"Flag indicating the wizard drawer is expanded"},{"name":"isInPage","type":"boolean","description":"If the wizard is in-page"},{"name":"isNavOpen","type":"boolean","description":"If the nav is open","required":true},{"name":"mainAriaLabel","type":"string","description":"Adds an accessible name to the wizard body when the body content overflows and renders\na scrollbar."},{"name":"mainAriaLabelledBy","type":"string","description":"Adds an accessible name to the wizard body by passing the the id of one or more elements.\nThe aria-labelledby will only be applied when the body content overflows and renders a scrollbar."},{"name":"nav","type":"(isWizardNavOpen: boolean) => React.ReactElement<any>","description":"Function that returns the WizardNav component","required":true},{"name":"onExpandDrawer","type":"() => void","description":"Callback function for when the drawer is toggled"},{"name":"onNavToggle","type":"(isOpen: boolean) => void","description":"Callback function for when the nav is toggled","required":true},{"name":"steps","type":"WizardStep[]","description":"The wizard steps","required":true},{"name":"Unknown","type":"string","description":"The button's aria-label"}]},"WizardNavItem-deprecated":{"name":"WizardNavItem","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Can nest a WizardNav component for substeps","defaultValue":"null"},{"name":"content","type":"React.ReactNode","description":"The content to display in the nav item","defaultValue":"''"},{"name":"href","type":"string","description":"An optional url to use for when using an anchor component","defaultValue":"null"},{"name":"id","type":"string | number","description":"The id for the nav item"},{"name":"isCurrent","type":"boolean","description":"Whether the nav item is the currently active item","defaultValue":"false"},{"name":"isDisabled","type":"boolean","description":"Whether the nav item is disabled","defaultValue":"false"},{"name":"isExpandable","type":"boolean","description":"Flag indicating that this NavItem has child steps and is expandable","defaultValue":"false"},{"name":"navItemComponent","type":"'button' | 'a'","description":"Component used to render WizardNavItem","defaultValue":"'button'"},{"name":"onNavItemClick","type":"(step: number) => any","description":"Callback for when the nav item is clicked","defaultValue":"() => undefined"},{"name":"ouiaId","type":"number | string","description":""},{"name":"ouiaSafe","type":"boolean","description":"","defaultValue":"true"},{"name":"step","type":"number","description":"The step passed into the onNavItemClick callback","required":true}]},"WizardNavItemProps-deprecated":{"name":"WizardNavItemProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Can nest a WizardNav component for substeps"},{"name":"content","type":"React.ReactNode","description":"The content to display in the nav item"},{"name":"href","type":"string","description":"An optional url to use for when using an anchor component"},{"name":"id","type":"string | number","description":"The id for the nav item"},{"name":"isCurrent","type":"boolean","description":"Whether the nav item is the currently active item"},{"name":"isDisabled","type":"boolean","description":"Whether the nav item is disabled"},{"name":"isExpandable","type":"boolean","description":"Flag indicating that this NavItem has child steps and is expandable"},{"name":"navItemComponent","type":"'button' | 'a'","description":"Component used to render WizardNavItem"},{"name":"onNavItemClick","type":"(step: number) => any","description":"Callback for when the nav item is clicked"},{"name":"step","type":"number","description":"The step passed into the onNavItemClick callback","required":true}]},"WizardNav-deprecated":{"name":"WizardNav","description":"","props":[{"name":"aria-label","type":"string","description":"Aria-label applied to the nav element"},{"name":"aria-labelledby","type":"string","description":"Sets the aria-labelledby attribute on the nav element"},{"name":"children","type":"any","description":"children should be WizardNavItem components"},{"name":"isOpen","type":"boolean","description":"Whether the nav is expanded","defaultValue":"false"},{"name":"ouiaId","type":"number | string","description":""},{"name":"ouiaSafe","type":"boolean","description":"","defaultValue":"true"},{"name":"returnList","type":"boolean","description":"True to return the inner list without the wrapping nav element","defaultValue":"false"}]},"WizardNavProps-deprecated":{"name":"WizardNavProps","description":"","props":[{"name":"children","type":"any","description":"children should be WizardNavItem components"},{"name":"isOpen","type":"boolean","description":"Whether the nav is expanded"},{"name":"returnList","type":"boolean","description":"True to return the inner list without the wrapping nav element"},{"name":"Unknown","type":"string","description":"Sets the aria-labelledby attribute on the nav element"}]},"WizardHeader-deprecated":{"name":"WizardHeader","description":"","props":[{"name":"closeButtonAriaLabel","type":"string","description":"Aria-label applied to the X (Close) button"},{"name":"description","type":"React.ReactNode","description":"Description of the wizard"},{"name":"descriptionComponent","type":"'div' | 'p'","description":"Component type of the description","defaultValue":"'div'"},{"name":"descriptionId","type":"string","description":"id for the description"},{"name":"hideClose","type":"boolean","description":"Flag indicating whether the close button should be in the header"},{"name":"onClose","type":"() => void","description":"Callback function called when the X (Close) button is clicked","defaultValue":"() => undefined"},{"name":"title","type":"string","description":"Title of the wizard","required":true},{"name":"titleId","type":"string","description":"id for the title"}]},"WizardHeaderProps-deprecated":{"name":"WizardHeaderProps","description":"","props":[{"name":"closeButtonAriaLabel","type":"string","description":"Aria-label applied to the X (Close) button"},{"name":"description","type":"React.ReactNode","description":"Description of the wizard"},{"name":"descriptionComponent","type":"'div' | 'p'","description":"Component type of the description"},{"name":"descriptionId","type":"string","description":"id for the description"},{"name":"hideClose","type":"boolean","description":"Flag indicating whether the close button should be in the header"},{"name":"onClose","type":"() => void","description":"Callback function called when the X (Close) button is clicked"},{"name":"title","type":"string","description":"Title of the wizard","required":true},{"name":"titleId","type":"string","description":"id for the title"}]},"WizardFooterInternal-deprecated":{"name":"WizardFooterInternal","description":"","props":[{"name":"activeStep","type":"WizardStep","description":"","required":true},{"name":"backButtonText","type":"React.ReactNode","description":"","required":true},{"name":"cancelButtonText","type":"React.ReactNode","description":"","required":true},{"name":"firstStep","type":"boolean","description":"","required":true},{"name":"isValid","type":"boolean","description":"","required":true},{"name":"nextButtonText","type":"React.ReactNode","description":"","required":true},{"name":"onBack","type":"any","description":"","required":true},{"name":"onClose","type":"any","description":"","required":true},{"name":"onNext","type":"any","description":"","required":true}]},"WizardFooterInternalProps-deprecated":{"name":"WizardFooterInternalProps","description":"","props":[{"name":"activeStep","type":"WizardStep","description":null,"required":true},{"name":"backButtonText","type":"React.ReactNode","description":null,"required":true},{"name":"cancelButtonText","type":"React.ReactNode","description":null,"required":true},{"name":"firstStep","type":"boolean","description":null,"required":true},{"name":"isValid","type":"boolean","description":null,"required":true},{"name":"nextButtonText","type":"React.ReactNode","description":null,"required":true},{"name":"onBack","type":"any","description":null,"required":true},{"name":"onClose","type":"any","description":null,"required":true},{"name":"onNext","type":"any","description":null,"required":true}]},"WizardFooter-deprecated":{"name":"WizardFooter","description":"","props":[{"name":"children","type":"any","description":"Buttons in the footer","required":true}]},"WizardFooterProps-deprecated":{"name":"WizardFooterProps","description":"","props":[{"name":"children","type":"any","description":"Buttons in the footer","required":true}]},"WizardDrawerWrapperProps-deprecated":{"name":"WizardDrawerWrapperProps","description":"","props":[{"name":"children","type":"React.ReactElement<any>","description":"The wizard content","required":true},{"name":"hasDrawer","type":"boolean","description":"Flag indicating the wizard has a drawer for at least one of the wizard steps","required":true},{"name":"wrapper","type":"(children: React.ReactElement<any>) => JSX.Element","description":"The drawer component which wraps the wizard content","required":true}]},"WizardBody-deprecated":{"name":"WizardBody","description":"","props":[{"name":"activeStep","type":"WizardStep","description":"The currently active WizardStep","required":true},{"name":"aria-label","type":"string","description":"Adds an accessible name to the wizard body when the body content overflows and renders\na scrollbar."},{"name":"aria-labelledby","type":"string","description":"Adds an accessible name to the wizard body by passing the the id of one or more elements.\nThe aria-labelledby will only be applied when the body content overflows and renders a scrollbar.","required":true},{"name":"children","type":"any","description":"Anything that can be rendered in the Wizard body","required":true},{"name":"hasDrawer","type":"boolean","description":""},{"name":"hasNoBodyPadding","type":"boolean","description":"Set to true to remove the default body padding","defaultValue":"false"},{"name":"isDrawerExpanded","type":"boolean","description":"Flag indicating the wizard drawer is expanded"},{"name":"mainComponent","type":"React.ElementType","description":"Component used as the primary content container","defaultValue":"'div'"},{"name":"onExpandDrawer","type":"() => void","description":"Callback function for when the drawer is toggled"}]},"WizardBodyProps-deprecated":{"name":"WizardBodyProps","description":"","props":[{"name":"activeStep","type":"WizardStep","description":"The currently active WizardStep","required":true},{"name":"children","type":"any","description":"Anything that can be rendered in the Wizard body","required":true},{"name":"hasDrawer","type":"boolean","description":null},{"name":"hasNoBodyPadding","type":"boolean","description":"Set to true to remove the default body padding","required":true},{"name":"isDrawerExpanded","type":"boolean","description":"Flag indicating the wizard drawer is expanded"},{"name":"mainComponent","type":"React.ElementType","description":"Component used as the primary content container"},{"name":"onExpandDrawer","type":"() => void","description":"Callback function for when the drawer is toggled"},{"name":"Unknown","type":"string","description":"Adds an accessible name to the wizard body by passing the the id of one or more elements.\nThe aria-labelledby will only be applied when the body content overflows and renders a scrollbar.","required":true}]},"Wizard-deprecated":{"name":"Wizard","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement)","description":"The parent container to append the modal to. Defaults to document.body","defaultValue":"null"},{"name":"backButtonText","type":"React.ReactNode","description":"(Unused if footer is controlled) The Back button text","defaultValue":"'Back'"},{"name":"cancelButtonText","type":"React.ReactNode","description":"(Unused if footer is controlled) The Cancel button text","defaultValue":"'Cancel'"},{"name":"className","type":"string","description":"Additional classes spread to the Wizard","defaultValue":"''"},{"name":"closeButtonAriaLabel","type":"string","description":"(Unused if footer is controlled) aria-label for the close button","defaultValue":"'Close'"},{"name":"description","type":"React.ReactNode","description":"The wizard description","defaultValue":"''"},{"name":"descriptionComponent","type":"'div' | 'p'","description":"Component type of the description","defaultValue":"'p'"},{"name":"descriptionId","type":"string","description":"An optional id for the description"},{"name":"footer","type":"React.ReactNode","description":"(Use to control the footer) Passing in a footer component lets you control the buttons yourself","defaultValue":"null"},{"name":"hasDrawer","type":"boolean","description":"Flag indicating the wizard has a drawer for at least one of the wizard steps","defaultValue":"false"},{"name":"hasNoBodyPadding","type":"boolean","description":"Can remove the default padding around the main body content by setting this to true","defaultValue":"false"},{"name":"height","type":"number | string","description":"Custom height of the wizard","defaultValue":"null"},{"name":"hideClose","type":"boolean","description":"Flag indicating whether the close button should be in the header","defaultValue":"false"},{"name":"isDrawerExpanded","type":"boolean","description":"Flag indicating the wizard drawer is expanded","defaultValue":"false"},{"name":"isNavExpandable","type":"boolean","description":"Flag indicating nav items with sub steps are expandable","defaultValue":"false"},{"name":"isOpen","type":"boolean","description":"Flag indicating Wizard modal is open. Wizard will be placed into a modal if this prop is provided","defaultValue":"undefined"},{"name":"mainAriaLabel","type":"string","description":"Adds an accessible name to the wizard body when the body content overflows and renders\na scrollbar.","defaultValue":"null"},{"name":"mainAriaLabelledBy","type":"string","description":"Adds an accessible name to the wizard body by passing the the id of one or more elements.\nThe aria-labelledby will only be applied when the body content overflows and renders a scrollbar.","defaultValue":"null"},{"name":"navAriaLabel","type":"string","description":"Aria-label for the Nav","defaultValue":"null"},{"name":"navAriaLabelledBy","type":"string","description":"Sets aria-labelledby on nav element","defaultValue":"null"},{"name":"nextButtonText","type":"React.ReactNode","description":"(Unused if footer is controlled) The Next button text","defaultValue":"'Next'"},{"name":"onBack","type":"(\n newStep: { id?: string | number; name: React.ReactNode },\n prevStep: { prevId?: string | number; prevName: React.ReactNode }\n) => void","description":"(Unused if footer is controlled) Callback function after Back button is clicked","defaultValue":"null"},{"name":"onClose","type":"() => void","description":"Callback function to close the wizard","defaultValue":"() => undefined as any"},{"name":"onCurrentStepChanged","type":"(step: WizardStep) => void","description":"Callback function to signal the current step in the wizard"},{"name":"onExpandDrawer","type":"() => void","description":"Callback function for when the drawer is toggled. Can be used to set browser focus in the drawer.","defaultValue":"() => undefined as any"},{"name":"onGoToStep","type":"(\n newStep: { id?: string | number; name: React.ReactNode },\n prevStep: { prevId?: string | number; prevName: React.ReactNode }\n) => void","description":"Callback function when a step in the nav is clicked","defaultValue":"null"},{"name":"onNext","type":"(\n newStep: { id?: string | number; name: React.ReactNode },\n prevStep: { prevId?: string | number; prevName: React.ReactNode }\n) => void","description":"(Unused if footer is controlled) Callback function after Next button is clicked","defaultValue":"null"},{"name":"onSave","type":"() => void","description":"(Unused if footer is controlled) Callback function to save at the end of the wizard, if not specified uses onClose"},{"name":"startAtStep","type":"number","description":"The current step the wizard is on (1 or higher)","defaultValue":"1"},{"name":"steps","type":"WizardStep[]","description":"The wizard steps configuration object","required":true},{"name":"title","type":"string","description":"The wizard title to display if header is desired","defaultValue":"null"},{"name":"titleId","type":"string","description":"An optional id for the title"},{"name":"width","type":"number | string","description":"Custom width of the wizard","defaultValue":"null"}]},"WizardStep-deprecated":{"name":"WizardStep","description":"","props":[{"name":"canJumpTo","type":"boolean","description":"Enables or disables the step in the navigation. Enabled by default."},{"name":"component","type":"any","description":"The component to render in the main body"},{"name":"drawerPanelContent","type":"any","description":"The content to render in the drawer panel (use when hasDrawer prop is set on the wizard)."},{"name":"drawerToggleButton","type":"React.ReactNode","description":"Custom drawer toggle button that opens the drawer."},{"name":"enableNext","type":"boolean","description":"(Unused if footer is controlled) The condition needed to enable the Next button"},{"name":"hideBackButton","type":"boolean","description":"(Unused if footer is controlled) True to hide the Back button"},{"name":"hideCancelButton","type":"boolean","description":"(Unused if footer is controlled) True to hide the Cancel button"},{"name":"id","type":"string | number","description":"Optional identifier"},{"name":"isDisabled","type":"boolean","description":"Flag to disable the step in the navigation"},{"name":"isFinishedStep","type":"boolean","description":"Setting to true hides the side nav and footer"},{"name":"name","type":"React.ReactNode","description":"The name of the step","required":true},{"name":"nextButtonText","type":"React.ReactNode","description":"(Unused if footer is controlled) Can change the Next button text. If nextButtonText is also set for the Wizard, this step specific one overrides it."},{"name":"stepNavItemProps","type":"React.HTMLProps<HTMLButtonElement | HTMLAnchorElement> | WizardNavItemProps","description":"Props to pass to the WizardNavItem"},{"name":"steps","type":"WizardStep[]","description":"Sub steps"}]},"WizardProps-deprecated":{"name":"WizardProps","description":"","props":[{"name":"appendTo","type":"HTMLElement | (() => HTMLElement)","description":"The parent container to append the modal to. Defaults to document.body"},{"name":"backButtonText","type":"React.ReactNode","description":"(Unused if footer is controlled) The Back button text"},{"name":"cancelButtonText","type":"React.ReactNode","description":"(Unused if footer is controlled) The Cancel button text"},{"name":"className","type":"string","description":"Additional classes spread to the Wizard"},{"name":"closeButtonAriaLabel","type":"string","description":"(Unused if footer is controlled) aria-label for the close button"},{"name":"description","type":"React.ReactNode","description":"The wizard description"},{"name":"descriptionComponent","type":"'div' | 'p'","description":"Component type of the description"},{"name":"descriptionId","type":"string","description":"An optional id for the description"},{"name":"footer","type":"React.ReactNode","description":"(Use to control the footer) Passing in a footer component lets you control the buttons yourself"},{"name":"hasDrawer","type":"boolean","description":"Flag indicating the wizard has a drawer for at least one of the wizard steps"},{"name":"hasNoBodyPadding","type":"boolean","description":"Can remove the default padding around the main body content by setting this to true"},{"name":"height","type":"number | string","description":"Custom height of the wizard"},{"name":"hideClose","type":"boolean","description":"Flag indicating whether the close button should be in the header"},{"name":"isDrawerExpanded","type":"boolean","description":"Flag indicating the wizard drawer is expanded"},{"name":"isNavExpandable","type":"boolean","description":"Flag indicating nav items with sub steps are expandable"},{"name":"isOpen","type":"boolean","description":"Flag indicating Wizard modal is open. Wizard will be placed into a modal if this prop is provided"},{"name":"mainAriaLabel","type":"string","description":"Adds an accessible name to the wizard body when the body content overflows and renders\na scrollbar."},{"name":"mainAriaLabelledBy","type":"string","description":"Adds an accessible name to the wizard body by passing the the id of one or more elements.\nThe aria-labelledby will only be applied when the body content overflows and renders a scrollbar."},{"name":"navAriaLabel","type":"string","description":"Aria-label for the Nav"},{"name":"navAriaLabelledBy","type":"string","description":"Sets aria-labelledby on nav element"},{"name":"nextButtonText","type":"React.ReactNode","description":"(Unused if footer is controlled) The Next button text"},{"name":"onBack","type":"WizardStepFunctionType","description":"(Unused if footer is controlled) Callback function after Back button is clicked"},{"name":"onClose","type":"() => void","description":"Callback function to close the wizard"},{"name":"onCurrentStepChanged","type":"(step: WizardStep) => void","description":"Callback function to signal the current step in the wizard"},{"name":"onExpandDrawer","type":"() => void","description":"Callback function for when the drawer is toggled. Can be used to set browser focus in the drawer."},{"name":"onGoToStep","type":"WizardStepFunctionType","description":"Callback function when a step in the nav is clicked"},{"name":"onNext","type":"WizardStepFunctionType","description":"(Unused if footer is controlled) Callback function after Next button is clicked"},{"name":"onSave","type":"() => void","description":"(Unused if footer is controlled) Callback function to save at the end of the wizard, if not specified uses onClose"},{"name":"startAtStep","type":"number","description":"The current step the wizard is on (1 or higher)"},{"name":"steps","type":"WizardStep[]","description":"The wizard steps configuration object","required":true},{"name":"title","type":"string","description":"The wizard title to display if header is desired"},{"name":"titleId","type":"string","description":"An optional id for the title"},{"name":"width","type":"number | string","description":"Custom width of the wizard"}]},"WizardState-deprecated":{"name":"WizardState","description":"","props":[{"name":"currentStep","type":"number","description":null,"required":true},{"name":"isNavOpen","type":"boolean","description":null,"required":true}]},"WizardStepFunctionType-deprecated":{"name":"WizardStepFunctionType","description":"","props":[]},"Tile-deprecated":{"name":"Tile","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the banner"},{"name":"className","type":"string","description":"Additional classes added to the banner"},{"name":"icon","type":"React.ReactNode","description":"Icon in the tile title"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the tile is disabled"},{"name":"isDisplayLarge","type":"boolean","description":"Flag indicating if the stacked tile icon is large"},{"name":"isSelected","type":"boolean","description":"Flag indicating if the tile is selected"},{"name":"isStacked","type":"boolean","description":"Flag indicating if the tile header is stacked"},{"name":"title","type":"string","description":"Title of the tile","required":true}]},"TileProps-deprecated":{"name":"TileProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the banner"},{"name":"className","type":"string","description":"Additional classes added to the banner"},{"name":"icon","type":"React.ReactNode","description":"Icon in the tile title"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the tile is disabled"},{"name":"isDisplayLarge","type":"boolean","description":"Flag indicating if the stacked tile icon is large"},{"name":"isSelected","type":"boolean","description":"Flag indicating if the tile is selected"},{"name":"isStacked","type":"boolean","description":"Flag indicating if the tile header is stacked"},{"name":"title","type":"string","description":"Title of the tile","required":true}]},"ModalContent-deprecated":{"name":"ModalContent","description":"","props":[{"name":"actions","type":"any","description":"Action buttons to add to the standard modal footer. Ignored if the footer property\nis passed in.","defaultValue":"[]"},{"name":"aria-describedby","type":"string","description":"Id to use for the modal box descriptor."},{"name":"aria-label","type":"string","description":"Accessible descriptor of the modal.","defaultValue":"''"},{"name":"aria-labelledby","type":"string | null","description":"Id to use for the modal box label."},{"name":"backdropId","type":"string","description":"Id of the backdrop."},{"name":"bodyAriaLabel","type":"string","description":"Accessible label applied to the modal box body. This should be used to communicate\nimportant information about the modal box body div element if needed, such as that it\nis scrollable."},{"name":"bodyAriaRole","type":"string","description":"Accessible role applied to the modal box body. This will default to \"region\" if the\nbodyAriaLabel property is passed in. Set to a more appropriate role as applicable\nbased on the modal content and context."},{"name":"boxId","type":"string","description":"Id of the modal box container.","required":true},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal.","required":true},{"name":"className","type":"string","description":"Additional classes added to the modal box.","defaultValue":"''"},{"name":"description","type":"React.ReactNode","description":"Description of the modal.","defaultValue":"null"},{"name":"descriptorId","type":"string","description":"Id of the modal box description.","required":true},{"name":"disableFocusTrap","type":"boolean","description":"Flag to disable focus trap.","defaultValue":"false"},{"name":"elementToFocus","type":"HTMLElement | SVGElement | string","description":"The element to focus when the modal opens. By default the first\nfocusable element will receive focus."},{"name":"footer","type":"React.ReactNode","description":"Custom footer.","defaultValue":"null"},{"name":"hasNoBodyWrapper","type":"boolean","description":"Flag indicating if modal content should be placed in a modal box body wrapper.","defaultValue":"false"},{"name":"header","type":"React.ReactNode","description":"Complex header (more than just text), supersedes the title property for header content.","defaultValue":"null"},{"name":"help","type":"React.ReactNode","description":"Optional help section for the modal header.","defaultValue":"null"},{"name":"isOpen","type":"boolean","description":"Flag to show the modal.","defaultValue":"false"},{"name":"labelId","type":"string","description":"Id of the modal box title.","required":true},{"name":"maxWidth","type":"number | string","description":"Maximum width of the modal."},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"A callback for when the close button is clicked.","defaultValue":"() => undefined as any"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"},{"name":"position","type":"'default' | 'top'","description":"Position of the modal. By default a modal will be positioned vertically and horizontally centered."},{"name":"positionOffset","type":"string","description":"Offset from alternate position. Can be any valid CSS length/percentage."},{"name":"showClose","type":"boolean","description":"Flag to show the close button in the header area of the modal.","defaultValue":"true"},{"name":"title","type":"React.ReactNode","description":"Text content of the modal header.","defaultValue":"''"},{"name":"titleIconVariant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom' | React.ComponentType<any>","description":"Optional alert icon (or other) to show before the title of the modal header. When the\npredefined alert types are used the default styling will be automatically applied.","defaultValue":"null"},{"name":"titleLabel","type":"string","description":"Optional title label text for screen readers.","defaultValue":"''"},{"name":"variant","type":"'small' | 'medium' | 'large' | 'default'","description":"Variant of the modal.","defaultValue":"'default'"},{"name":"width","type":"number | string","description":"Default width of the modal."}]},"ModalContentProps-deprecated":{"name":"ModalContentProps","description":"","props":[{"name":"actions","type":"any","description":"Action buttons to add to the standard modal footer. Ignored if the footer property\nis passed in."},{"name":"backdropId","type":"string","description":"Id of the backdrop."},{"name":"bodyAriaLabel","type":"string","description":"Accessible label applied to the modal box body. This should be used to communicate\nimportant information about the modal box body div element if needed, such as that it\nis scrollable."},{"name":"bodyAriaRole","type":"string","description":"Accessible role applied to the modal box body. This will default to \"region\" if the\nbodyAriaLabel property is passed in. Set to a more appropriate role as applicable\nbased on the modal content and context."},{"name":"boxId","type":"string","description":"Id of the modal box container.","required":true},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal.","required":true},{"name":"className","type":"string","description":"Additional classes added to the modal box."},{"name":"description","type":"React.ReactNode","description":"Description of the modal."},{"name":"descriptorId","type":"string","description":"Id of the modal box description.","required":true},{"name":"disableFocusTrap","type":"boolean","description":"Flag to disable focus trap."},{"name":"elementToFocus","type":"HTMLElement | SVGElement | string","description":"The element to focus when the modal opens. By default the first\nfocusable element will receive focus."},{"name":"footer","type":"React.ReactNode","description":"Custom footer."},{"name":"hasNoBodyWrapper","type":"boolean","description":"Flag indicating if modal content should be placed in a modal box body wrapper."},{"name":"header","type":"React.ReactNode","description":"Complex header (more than just text), supersedes the title property for header content."},{"name":"help","type":"React.ReactNode","description":"Optional help section for the modal header."},{"name":"isOpen","type":"boolean","description":"Flag to show the modal."},{"name":"labelId","type":"string","description":"Id of the modal box title.","required":true},{"name":"maxWidth","type":"number | string","description":"Maximum width of the modal."},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"A callback for when the close button is clicked."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"position","type":"'default' | 'top'","description":"Position of the modal. By default a modal will be positioned vertically and horizontally centered."},{"name":"positionOffset","type":"string","description":"Offset from alternate position. Can be any valid CSS length/percentage."},{"name":"showClose","type":"boolean","description":"Flag to show the close button in the header area of the modal."},{"name":"title","type":"React.ReactNode","description":"Text content of the modal header."},{"name":"titleIconVariant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom' | React.ComponentType<any>","description":"Optional alert icon (or other) to show before the title of the modal header. When the\npredefined alert types are used the default styling will be automatically applied."},{"name":"titleLabel","type":"string","description":"Optional title label text for screen readers."},{"name":"Unknown","type":"string | null","description":"Id to use for the modal box label."},{"name":"variant","type":"'small' | 'medium' | 'large' | 'default'","description":"Variant of the modal."},{"name":"width","type":"number | string","description":"Default width of the modal."}]},"ModalBoxTitle-deprecated":{"name":"ModalBoxTitle","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the modal box title.","defaultValue":"''"},{"name":"id","type":"string","description":"Id of the modal box title.","required":true},{"name":"title","type":"React.ReactNode","description":"Content rendered inside the modal box title.","required":true},{"name":"titleIconVariant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom' | React.ComponentType<any>","description":"Optional alert icon (or other) to show before the title. When the predefined alert types\nare used the default styling will be automatically applied."},{"name":"titleLabel","type":"string","description":"Optional title label text for screen readers.","defaultValue":"''"}]},"ModalBoxTitleProps-deprecated":{"name":"ModalBoxTitleProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the modal box title."},{"name":"id","type":"string","description":"Id of the modal box title.","required":true},{"name":"title","type":"React.ReactNode","description":"Content rendered inside the modal box title.","required":true},{"name":"titleIconVariant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom' | React.ComponentType<any>","description":"Optional alert icon (or other) to show before the title. When the predefined alert types\nare used the default styling will be automatically applied."},{"name":"titleLabel","type":"string","description":"Optional title label text for screen readers."}]},"ModalBoxHeader-deprecated":{"name":"ModalBoxHeader","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal box header.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the modal box header.","defaultValue":"''"},{"name":"help","type":"React.ReactNode","description":"Optional help section for the modal box header.","defaultValue":"null"}]},"ModalBoxHeaderProps-deprecated":{"name":"ModalBoxHeaderProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal box header."},{"name":"className","type":"string","description":"Additional classes added to the modal box header."},{"name":"help","type":"React.ReactNode","description":"Optional help section for the modal box header."}]},"ModalBoxFooter-deprecated":{"name":"ModalBoxFooter","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal box footer.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the modal box footer.","defaultValue":"''"}]},"ModalBoxFooterProps-deprecated":{"name":"ModalBoxFooterProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal box footer."},{"name":"className","type":"string","description":"Additional classes added to the modal box footer."}]},"ModalBoxDescription-deprecated":{"name":"ModalBoxDescription","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the description.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the description.","defaultValue":"''"},{"name":"id","type":"string","description":"Id of the description.","defaultValue":"''"}]},"ModalBoxDescriptionProps-deprecated":{"name":"ModalBoxDescriptionProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the description."},{"name":"className","type":"string","description":"Additional classes added to the description."},{"name":"id","type":"string","description":"Id of the description."}]},"ModalBoxCloseButton-deprecated":{"name":"ModalBoxCloseButton","description":"","props":[{"name":"aria-label","type":"string","description":"Accessible descriptor of the close button.","defaultValue":"'Close'"},{"name":"className","type":"string","description":"Additional classes added to the close button."},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"A callback for when the close button is clicked.","defaultValue":"() => undefined as any"},{"name":"ouiaId","type":"number | string","description":"Value to set the data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":""}]},"ModalBoxCloseButtonProps-deprecated":{"name":"ModalBoxCloseButtonProps","description":"","props":[{"name":"className","type":"string","description":"Additional classes added to the close button."},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"A callback for when the close button is clicked."},{"name":"ouiaId","type":"number | string","description":"Value to set the data-ouia-component-id."},{"name":"Unknown","type":"string","description":"Accessible descriptor of the close button."}]},"ModalBoxBody-deprecated":{"name":"ModalBoxBody","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal box body.","defaultValue":"null"},{"name":"className","type":"string","description":"Additional classes added to the modal box body.","defaultValue":"''"}]},"ModalBoxBodyProps-deprecated":{"name":"ModalBoxBodyProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal box body."},{"name":"className","type":"string","description":"Additional classes added to the modal box body."}]},"ModalBox-deprecated":{"name":"ModalBox","description":"","props":[{"name":"aria-describedby","type":"string","description":"Id to use for the modal box description.","required":true},{"name":"aria-label","type":"string","description":"Accessible descriptor of the modal.","defaultValue":"''"},{"name":"aria-labelledby","type":"string","description":"Id to use for the modal box label."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal box.","required":true},{"name":"className","type":"string","description":"Additional classes added to the modal box.","defaultValue":"''"},{"name":"position","type":"'default' | 'top'","description":"Position of the modal. By default a modal will be positioned vertically and horizontally centered."},{"name":"positionOffset","type":"string","description":"Offset from alternate position. Can be any valid CSS length/percentage."},{"name":"variant","type":"'small' | 'medium' | 'large' | 'default'","description":"Variant of the modal.","defaultValue":"'default'"}]},"ModalBoxProps-deprecated":{"name":"ModalBoxProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal box.","required":true},{"name":"className","type":"string","description":"Additional classes added to the modal box."},{"name":"position","type":"'default' | 'top'","description":"Position of the modal. By default a modal will be positioned vertically and horizontally centered."},{"name":"positionOffset","type":"string","description":"Offset from alternate position. Can be any valid CSS length/percentage."},{"name":"Unknown","type":"string","description":"Id to use for the modal box label."},{"name":"variant","type":"'small' | 'medium' | 'large' | 'default'","description":"Variant of the modal."}]},"Modal-deprecated":{"name":"Modal","description":"","props":[{"name":"actions","type":"any","description":"Action buttons to add to the standard modal footer. Ignored if the footer property\nis passed in.","defaultValue":"[]"},{"name":"appendTo","type":"HTMLElement | (() => HTMLElement)","description":"The parent container to append the modal to. Defaults to \"document.body\".","defaultValue":"() => document.body"},{"name":"aria-describedby","type":"string","description":"Id to use for the modal box descriptor.","defaultValue":"''"},{"name":"aria-label","type":"string","description":"Accessible descriptor of the modal.","defaultValue":"''"},{"name":"aria-labelledby","type":"string","description":"Id to use for the modal box label.","defaultValue":"''"},{"name":"bodyAriaLabel","type":"string","description":"Accessible label applied to the modal box body. This should be used to communicate\nimportant information about the modal box body div element if needed, such as that it\nis scrollable."},{"name":"bodyAriaRole","type":"string","description":"Accessible role applied to the modal box body. This will default to \"region\" if the\nbodyAriaLabel property is passed in. Set to a more appropriate role as applicable\nbased on the modal content and context."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal.","required":true},{"name":"className","type":"string","description":"Additional classes added to the modal.","defaultValue":"''"},{"name":"description","type":"React.ReactNode","description":"Description of the modal."},{"name":"disableFocusTrap","type":"boolean","description":"Flag to disable focus trap."},{"name":"elementToFocus","type":"HTMLElement | SVGElement | string","description":"The element to focus when the modal opens. By default the first\nfocusable element will receive focus."},{"name":"footer","type":"React.ReactNode","description":"Custom footer."},{"name":"hasNoBodyWrapper","type":"boolean","description":"Flag indicating if modal content should be placed in a modal box body wrapper.","defaultValue":"false"},{"name":"header","type":"React.ReactNode","description":"Complex header (more than just text), supersedes the title property for header content."},{"name":"help","type":"React.ReactNode","description":"Optional help section for the modal header."},{"name":"id","type":"string","description":"An id to use for the modal box container.","defaultValue":"undefined"},{"name":"isOpen","type":"boolean","description":"Flag to show the modal.","defaultValue":"false"},{"name":"maxWidth","type":"number | string","description":"Maximum width of the modal."},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"A callback for when the close button is clicked.","defaultValue":"() => undefined as any"},{"name":"onEscapePress","type":"(event: KeyboardEvent) => void","description":"Modal handles pressing of the escape key and closes the modal. If you want to handle\nthis yourself you can use this callback function."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.","defaultValue":"true"},{"name":"position","type":"'default' | 'top'","description":"Position of the modal. By default a modal will be positioned vertically and horizontally centered.","defaultValue":"'default'"},{"name":"positionOffset","type":"string","description":"Offset from alternate position. Can be any valid CSS length/percentage."},{"name":"showClose","type":"boolean","description":"Flag to show the close button in the header area of the modal.","defaultValue":"true"},{"name":"title","type":"React.ReactNode","description":"Text content of the modal header.","defaultValue":"''"},{"name":"titleIconVariant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom' | React.ComponentType<any>","description":"Optional alert icon (or other) to show before the title of the modal header. When the\npredefined alert types are used the default styling will be automatically applied.","defaultValue":"null"},{"name":"titleLabel","type":"string","description":"Optional title label text for screen readers.","defaultValue":"''"},{"name":"variant","type":"'small' | 'medium' | 'large' | 'default'","description":"Variant of the modal.","defaultValue":"'default'"},{"name":"width","type":"number | string","description":"Default width of the modal."}]},"ModalProps-deprecated":{"name":"ModalProps","description":"","props":[{"name":"actions","type":"any","description":"Action buttons to add to the standard modal footer. Ignored if the footer property\nis passed in."},{"name":"appendTo","type":"HTMLElement | (() => HTMLElement)","description":"The parent container to append the modal to. Defaults to \"document.body\"."},{"name":"bodyAriaLabel","type":"string","description":"Accessible label applied to the modal box body. This should be used to communicate\nimportant information about the modal box body div element if needed, such as that it\nis scrollable."},{"name":"bodyAriaRole","type":"string","description":"Accessible role applied to the modal box body. This will default to \"region\" if the\nbodyAriaLabel property is passed in. Set to a more appropriate role as applicable\nbased on the modal content and context."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the modal.","required":true},{"name":"className","type":"string","description":"Additional classes added to the modal."},{"name":"description","type":"React.ReactNode","description":"Description of the modal."},{"name":"disableFocusTrap","type":"boolean","description":"Flag to disable focus trap."},{"name":"elementToFocus","type":"HTMLElement | SVGElement | string","description":"The element to focus when the modal opens. By default the first\nfocusable element will receive focus."},{"name":"footer","type":"React.ReactNode","description":"Custom footer."},{"name":"hasNoBodyWrapper","type":"boolean","description":"Flag indicating if modal content should be placed in a modal box body wrapper."},{"name":"header","type":"React.ReactNode","description":"Complex header (more than just text), supersedes the title property for header content."},{"name":"help","type":"React.ReactNode","description":"Optional help section for the modal header."},{"name":"id","type":"string","description":"An id to use for the modal box container."},{"name":"isOpen","type":"boolean","description":"Flag to show the modal."},{"name":"maxWidth","type":"number | string","description":"Maximum width of the modal."},{"name":"onClose","type":"(event: KeyboardEvent | React.MouseEvent) => void","description":"A callback for when the close button is clicked."},{"name":"onEscapePress","type":"(event: KeyboardEvent) => void","description":"Modal handles pressing of the escape key and closes the modal. If you want to handle\nthis yourself you can use this callback function."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":"Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."},{"name":"position","type":"'default' | 'top'","description":"Position of the modal. By default a modal will be positioned vertically and horizontally centered."},{"name":"positionOffset","type":"string","description":"Offset from alternate position. Can be any valid CSS length/percentage."},{"name":"showClose","type":"boolean","description":"Flag to show the close button in the header area of the modal."},{"name":"title","type":"React.ReactNode","description":"Text content of the modal header."},{"name":"titleIconVariant","type":"'success' | 'danger' | 'warning' | 'info' | 'custom' | React.ComponentType<any>","description":"Optional alert icon (or other) to show before the title of the modal header. When the\npredefined alert types are used the default styling will be automatically applied."},{"name":"titleLabel","type":"string","description":"Optional title label text for screen readers."},{"name":"Unknown","type":"string","description":"Id to use for the modal box label."},{"name":"variant","type":"'small' | 'medium' | 'large' | 'default'","description":"Variant of the modal."},{"name":"width","type":"number | string","description":"Default width of the modal."}]},"ModalState-deprecated":{"name":"ModalState","description":"","props":[{"name":"ouiaStateId","type":"string","description":null,"required":true}]},"DualListSelectorTreeItemBase-deprecated":{"name":"DualListSelectorTreeItemBase","description":"","props":[{"name":"badgeProps","type":"any","description":"Additional properties to pass to the option badge"},{"name":"checkProps","type":"any","description":"Additional properties to pass to the option checkbox"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the dual list selector."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"defaultExpanded","type":"boolean","description":"Flag indicating this option is expanded by default."},{"name":"hasBadge","type":"boolean","description":"Flag indicating this option has a badge"},{"name":"id","type":"string","description":"ID of the option","required":true},{"name":"isChecked","type":"boolean","description":"Flag indicating if this open is checked."},{"name":"isDisabled","type":"boolean","description":"Flag indicating whether the component is disabled.","defaultValue":"false"},{"name":"itemData","type":"DualListSelectorTreeItemData","description":"Raw data of the option"},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n isChecked: boolean,\n itemData: DualListSelectorTreeItemData\n) => void","description":"Callback fired when an option is checked"},{"name":"text","type":"string","description":"Text of the option","required":true},{"name":"useMemo","type":"boolean","description":"Flag indicating the DualListSelector tree should utilize memoization to help render large data sets."}]},"DualListSelectorTreeItemProps-deprecated":{"name":"DualListSelectorTreeItemProps","description":"","props":[{"name":"badgeProps","type":"any","description":"Additional properties to pass to the option badge"},{"name":"checkProps","type":"any","description":"Additional properties to pass to the option checkbox"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the dual list selector."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"defaultExpanded","type":"boolean","description":"Flag indicating this option is expanded by default."},{"name":"hasBadge","type":"boolean","description":"Flag indicating this option has a badge"},{"name":"id","type":"string","description":"ID of the option","required":true},{"name":"isChecked","type":"boolean","description":"Flag indicating if this open is checked."},{"name":"isDisabled","type":"boolean","description":"Flag indicating whether the component is disabled."},{"name":"itemData","type":"DualListSelectorTreeItemData","description":"Raw data of the option"},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n isChecked: boolean,\n itemData: DualListSelectorTreeItemData\n ) => void","description":"Callback fired when an option is checked"},{"name":"text","type":"string","description":"Text of the option","required":true},{"name":"useMemo","type":"boolean","description":"Flag indicating the DualListSelector tree should utilize memoization to help render large data sets."}]},"DualListSelectorTree-deprecated":{"name":"DualListSelectorTree","description":"Used in place of the DualListSelectorListItem sub-component when building a\ncomposable dual list selector with a tree.","props":[{"name":"data","type":"DualListSelectorTreeItemData[] | (() => DualListSelectorTreeItemData[])","description":"Data of the tree view","required":true},{"name":"defaultAllExpanded","type":"boolean","description":"Sets the default expanded behavior","defaultValue":"false"},{"name":"hasBadges","type":"boolean","description":"Flag indicating if all options should have badges","defaultValue":"false"},{"name":"id","type":"string","description":"ID of the tree view"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the dual list selector tree is in the disabled state","defaultValue":"false"},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n isChecked: boolean,\n itemData: DualListSelectorTreeItemData\n) => void","description":"Callback fired when an option is checked"}]},"DualListSelectorTreeItemData-deprecated":{"name":"DualListSelectorTreeItemData","description":"","props":[{"name":"badgeProps","type":"any","description":"Additional properties to pass to the option badge"},{"name":"checkProps","type":"any","description":"Additional properties to pass to the option checkbox"},{"name":"children","type":"DualListSelectorTreeItemData[]","description":"Content rendered inside the dual list selector."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"defaultExpanded","type":"boolean","description":"Flag indicating this option is expanded by default."},{"name":"hasBadge","type":"boolean","description":"Flag indicating this option has a badge"},{"name":"id","type":"string","description":"ID of the option","required":true},{"name":"isChecked","type":"boolean","description":"Checked state of the option","required":true},{"name":"isDisabled","type":"boolean","description":"Flag indicating whether the component is disabled."},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n isChecked: boolean,\n isChosen: boolean,\n itemData: DualListSelectorTreeItemData\n ) => void","description":"Callback fired when an option is checked"},{"name":"parentId","type":"string","description":"Parent id of an option"},{"name":"text","type":"string","description":"Text of the option","required":true}]},"DualListSelectorTreeProps-deprecated":{"name":"DualListSelectorTreeProps","description":"Used in place of the DualListSelectorListItem sub-component when building a\ncomposable dual list selector with a tree.","props":[{"name":"data","type":"DualListSelectorTreeItemData[] | (() => DualListSelectorTreeItemData[])","description":"Data of the tree view","required":true},{"name":"defaultAllExpanded","type":"boolean","description":"Sets the default expanded behavior"},{"name":"hasBadges","type":"boolean","description":"Flag indicating if all options should have badges"},{"name":"id","type":"string","description":"ID of the tree view"},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the dual list selector tree is in the disabled state"},{"name":"isNested","type":"boolean","description":""},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n isChecked: boolean,\n itemData: DualListSelectorTreeItemData\n ) => void","description":"Callback fired when an option is checked"}]},"DualListSelectorPane-deprecated":{"name":"DualListSelectorPane","description":"Acts as the container for a list of options that are either available or chosen,\ndepending on the pane type (available or chosen). A search input and other actions,\nsuch as sorting, can also be passed into this sub-component.","props":[{"name":"actions","type":"React.ReactNode[]","description":"Actions to place above the pane."},{"name":"children","type":"React.ReactNode","description":"A dual list selector list or dual list selector tree to be rendered in the pane."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector pane.","defaultValue":"''"},{"name":"id","type":"string","description":"Id of the pane.","defaultValue":"getUniqueId('dual-list-selector-pane')"},{"name":"isChosen","type":"boolean","description":"Flag indicating if this pane is the chosen pane.","defaultValue":"false"},{"name":"isDisabled","type":"boolean","description":"Flag indicating whether the component is disabled.","defaultValue":"false"},{"name":"listMinHeight","type":"string","description":"Minimum height of the list of options rendered in the pane. *"},{"name":"onSearch","type":"(event: React.ChangeEvent<HTMLInputElement>) => void","description":"Callback for search input. To be used when isSearchable is true."},{"name":"searchInput","type":"React.ReactNode","description":"A search input placed above the list at the top of the pane, before actions."},{"name":"status","type":"string","description":"Status to display above the pane.","defaultValue":"''"},{"name":"title","type":"React.ReactNode","description":"Title of the pane.","defaultValue":"''"}]},"DualListSelectorPaneProps-deprecated":{"name":"DualListSelectorPaneProps","description":"Acts as the container for a list of options that are either available or chosen,\ndepending on the pane type (available or chosen). A search input and other actions,\nsuch as sorting, can also be passed into this sub-component.","props":[{"name":"actions","type":"React.ReactNode[]","description":"Actions to place above the pane."},{"name":"children","type":"React.ReactNode","description":"A dual list selector list or dual list selector tree to be rendered in the pane."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector pane."},{"name":"filterOption","type":"(option: React.ReactNode, input: string) => boolean","description":""},{"name":"id","type":"string","description":"Id of the pane."},{"name":"isChosen","type":"boolean","description":"Flag indicating if this pane is the chosen pane."},{"name":"isDisabled","type":"boolean","description":"Flag indicating whether the component is disabled."},{"name":"isSearchable","type":"boolean","description":""},{"name":"listMinHeight","type":"string","description":"Minimum height of the list of options rendered in the pane. *"},{"name":"onFilterUpdate","type":"(newFilteredOptions: React.ReactNode[], paneType: string, isSearchReset: boolean) => void","description":""},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n isChecked: boolean,\n itemData: DualListSelectorTreeItemData\n ) => void","description":""},{"name":"onOptionSelect","type":"(\n event: React.MouseEvent | React.ChangeEvent | React.KeyboardEvent,\n index: number,\n isChosen: boolean,\n id?: string,\n itemData?: any,\n parentData?: any\n ) => void","description":""},{"name":"onSearch","type":"(event: React.ChangeEvent<HTMLInputElement>) => void","description":"Callback for search input. To be used when isSearchable is true."},{"name":"onSearchInputChanged","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":""},{"name":"onSearchInputClear","type":"(event: React.SyntheticEvent<HTMLButtonElement>) => void","description":""},{"name":"options","type":"React.ReactNode[]","description":""},{"name":"searchInput","type":"React.ReactNode","description":"A search input placed above the list at the top of the pane, before actions."},{"name":"searchInputAriaLabel","type":"string","description":""},{"name":"selectedOptions","type":"string[] | number[]","description":""},{"name":"status","type":"string","description":"Status to display above the pane."},{"name":"title","type":"React.ReactNode","description":"Title of the pane."}]},"DualListSelectorListWrapperProps-deprecated":{"name":"DualListSelectorListWrapperProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the list"},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"displayOption","type":"(option: React.ReactNode) => boolean","description":""},{"name":"id","type":"string","description":"Id of the dual list selector list"},{"name":"innerRef","type":"React.RefObject<HTMLDivElement | null>","description":""},{"name":"isDisabled","type":"boolean","description":"Flag indicating whether the component is disabled."},{"name":"onOptionSelect","type":"(e: React.MouseEvent | React.ChangeEvent | React.KeyboardEvent, index: number, id: string) => void","description":""},{"name":"options","type":"React.ReactNode[]","description":""},{"name":"selectedOptions","type":"string[] | number[]","description":""},{"name":"Unknown","type":"string","description":"Accessibly label for the list","required":true}]},"DualListSelectorListItemProps-deprecated":{"name":"DualListSelectorListItemProps","description":"Creates an individual option that can be selected and moved between the\ndual list selector panes. This is contained within the DualListSelectorList sub-component.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the dual list selector."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"draggableButtonAriaLabel","type":"string","description":"Accessible label for the draggable button on draggable list items"},{"name":"id","type":"string","description":"ID of the option."},{"name":"innerRef","type":"React.RefObject<HTMLLIElement | null>","description":""},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the dual list selector is in a disabled state"},{"name":"isDraggable","type":"boolean","description":"Flag indicating this item is draggable for reordering"},{"name":"isSelected","type":"boolean","description":"Flag indicating the list item is currently selected."},{"name":"onOptionSelect","type":"(event: React.MouseEvent | React.ChangeEvent | React.KeyboardEvent, id?: string) => void","description":"Callback fired when an option is selected."},{"name":"orderIndex","type":"number","description":""}]},"DualListSelectorList-deprecated":{"name":"DualListSelectorList","description":"Acts as the container for DualListSelectorListItem sub-components.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the dual list selector list"}]},"DualListSelectorListProps-deprecated":{"name":"DualListSelectorListProps","description":"Acts as the container for DualListSelectorListItem sub-components.","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside the dual list selector list"}]},"DualListSelectorControlsWrapperProps-deprecated":{"name":"DualListSelectorControlsWrapperProps","description":"Acts as the container for the DualListSelectorControl sub-components.","props":[{"name":"children","type":"React.ReactNode","description":"Anything that can be rendered inside of the wrapper."},{"name":"className","type":"string","description":"Additional classes added to the wrapper."},{"name":"innerRef","type":"React.RefObject<HTMLDivElement | null>","description":""},{"name":"Unknown","type":"string","description":"Accessible label for the dual list selector controls wrapper."}]},"DualListSelectorControlProps-deprecated":{"name":"DualListSelectorControlProps","description":"Renders an individual control button for moving selected options between each\ndual list selector pane.","props":[{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the dual list selector control."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector control."},{"name":"innerRef","type":"React.Ref<any>","description":""},{"name":"isDisabled","type":"boolean","description":"Flag indicating the control is disabled."},{"name":"onClick","type":"(event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void","description":"Callback fired when dual list selector control is selected."},{"name":"tooltipContent","type":"React.ReactNode","description":"Content to be displayed in a tooltip on hover of control."},{"name":"tooltipProps","type":"any","description":"Additional tooltip properties passed to the tooltip."},{"name":"Unknown","type":"string","description":"Accessible label for the dual list selector control."}]},"DualListSelector-deprecated":{"name":"DualListSelector","description":"Acts as a container for all other DualListSelector sub-components when using a\ncomposable dual list selector.","props":[{"name":"addAll","type":"(newAvailableOptions: React.ReactNode[], newChosenOptions: React.ReactNode[]) => void","description":"Optional callback for the dynamically built add all button"},{"name":"addAllAriaLabel","type":"string","description":"Accessible label for the dynamically built add all button","defaultValue":"'Add all'"},{"name":"addAllTooltip","type":"React.ReactNode","description":"Tooltip content for the dynamically built add all button"},{"name":"addAllTooltipProps","type":"any","description":"Additional tooltip properties for the dynamically built add all tooltip"},{"name":"addSelected","type":"(newAvailableOptions: React.ReactNode[], newChosenOptions: React.ReactNode[]) => void","description":"Optional callback for the dynamically built add selected button"},{"name":"addSelectedAriaLabel","type":"string","description":"Accessible label for the dynamically built add selected button","defaultValue":"'Add selected'"},{"name":"addSelectedTooltip","type":"React.ReactNode","description":"Tooltip content for the dynamically built add selected button"},{"name":"addSelectedTooltipProps","type":"any","description":"Additional tooltip properties for the dynamically built add selected tooltip"},{"name":"availableOptions","type":"React.ReactNode[] | DualListSelectorTreeItemData[]","description":"Options to display in the dynamically built available options pane. When using trees, the options should be in the DualListSelectorTreeItemData[] format.","defaultValue":"[]"},{"name":"availableOptionsActions","type":"React.ReactNode[]","description":"Actions to be displayed above the dynamically built available options pane."},{"name":"availableOptionsSearchAriaLabel","type":"string","description":"Accessible label for the search input on the dynamically built available options pane.","defaultValue":"'Available search input'"},{"name":"availableOptionsStatus","type":"string","description":"Status message to display above the dynamically built available options pane."},{"name":"availableOptionsTitle","type":"string","description":"Title applied to the dynamically built available options pane.","defaultValue":"'Available options'"},{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the dual list selector. Panes & controls will not be built dynamically when children are provided.","defaultValue":"''"},{"name":"chosenOptions","type":"React.ReactNode[] | DualListSelectorTreeItemData[]","description":"Options to display in the dynamically built chosen options pane. When using trees, the options should be in the DualListSelectorTreeItemData[] format.","defaultValue":"[]"},{"name":"chosenOptionsActions","type":"React.ReactNode[]","description":"Actions to be displayed above the dynamically built chosen options pane."},{"name":"chosenOptionsSearchAriaLabel","type":"string","description":"Accessible label for the search input on the dynamically built chosen options pane.","defaultValue":"'Chosen search input'"},{"name":"chosenOptionsStatus","type":"string","description":"Status message to display above the dynamically built chosen options pane."},{"name":"chosenOptionsTitle","type":"string","description":"Title applied to the dynamically built chosen options pane.","defaultValue":"'Chosen options'"},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"controlsAriaLabel","type":"string","description":"Accessible label for the dynamically built controls between the two panes.","defaultValue":"'Selector controls'"},{"name":"filterOption","type":"(option: React.ReactNode, input: string) => boolean","description":"Optional filter function for custom filtering based on search string. Used with a dynamically built search input."},{"name":"id","type":"string","description":"Id of the dual list selector."},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the dual list selector is in a disabled state","defaultValue":"false"},{"name":"isSearchable","type":"boolean","description":"Flag indicating a search bar should be included above both the dynamically built available and chosen panes."},{"name":"isTree","type":"boolean","description":"Flag indicating if the dual list selector uses trees instead of simple lists","defaultValue":"false"},{"name":"onAvailableOptionsSearchInputChanged","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"A callback for when the search input value for the dynamically built available options changes."},{"name":"onChosenOptionsSearchInputChanged","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"A callback for when the search input value for the dynamically built chosen options changes."},{"name":"onListChange","type":"(\n event: React.MouseEvent<HTMLElement>,\n newAvailableOptions: React.ReactNode[],\n newChosenOptions: React.ReactNode[]\n) => void","description":"Callback fired every time dynamically built options are chosen or removed"},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n checked: boolean,\n checkedId: string,\n newCheckedItems: string[]\n) => void","description":"Optional callback fired when a dynamically built option is checked"},{"name":"onOptionSelect","type":"(\n event: React.MouseEvent | React.ChangeEvent | React.KeyboardEvent,\n index: number,\n isChosen: boolean,\n id: string,\n itemData: any,\n parentData: any\n) => void","description":"Optional callback fired when a dynamically built option is selected"},{"name":"removeAll","type":"(newAvailableOptions: React.ReactNode[], newChosenOptions: React.ReactNode[]) => void","description":"Optional callback for the dynamically built remove all button"},{"name":"removeAllAriaLabel","type":"string","description":"Accessible label for the dynamically built remove all button","defaultValue":"'Remove all'"},{"name":"removeAllTooltip","type":"React.ReactNode","description":"Tooltip content for the dynamically built remove all button"},{"name":"removeAllTooltipProps","type":"any","description":"Additional tooltip properties for the dynamically built remove all tooltip"},{"name":"removeSelected","type":"(newAvailableOptions: React.ReactNode[], newChosenOptions: React.ReactNode[]) => void","description":"Optional callback for the dynamically built remove selected button"},{"name":"removeSelectedAriaLabel","type":"string","description":"Accessible label for the dynamically built remove selected button","defaultValue":"'Remove selected'"},{"name":"removeSelectedTooltip","type":"React.ReactNode","description":"Tooltip content for the dynamically built remove selected button"},{"name":"removeSelectedTooltipProps","type":"any","description":"Additional tooltip properties for the dynamically built remove selected tooltip"}]},"DualListSelectorProps-deprecated":{"name":"DualListSelectorProps","description":"Acts as a container for all other DualListSelector sub-components when using a\ncomposable dual list selector.","props":[{"name":"addAll","type":"(newAvailableOptions: React.ReactNode[], newChosenOptions: React.ReactNode[]) => void","description":"Optional callback for the dynamically built add all button"},{"name":"addAllAriaLabel","type":"string","description":"Accessible label for the dynamically built add all button"},{"name":"addAllTooltip","type":"React.ReactNode","description":"Tooltip content for the dynamically built add all button"},{"name":"addAllTooltipProps","type":"any","description":"Additional tooltip properties for the dynamically built add all tooltip"},{"name":"addSelected","type":"(newAvailableOptions: React.ReactNode[], newChosenOptions: React.ReactNode[]) => void","description":"Optional callback for the dynamically built add selected button"},{"name":"addSelectedAriaLabel","type":"string","description":"Accessible label for the dynamically built add selected button"},{"name":"addSelectedTooltip","type":"React.ReactNode","description":"Tooltip content for the dynamically built add selected button"},{"name":"addSelectedTooltipProps","type":"any","description":"Additional tooltip properties for the dynamically built add selected tooltip"},{"name":"availableOptions","type":"React.ReactNode[] | DualListSelectorTreeItemData[]","description":"Options to display in the dynamically built available options pane. When using trees, the options should be in the DualListSelectorTreeItemData[] format."},{"name":"availableOptionsActions","type":"React.ReactNode[]","description":"Actions to be displayed above the dynamically built available options pane."},{"name":"availableOptionsSearchAriaLabel","type":"string","description":"Accessible label for the search input on the dynamically built available options pane."},{"name":"availableOptionsStatus","type":"string","description":"Status message to display above the dynamically built available options pane."},{"name":"availableOptionsTitle","type":"string","description":"Title applied to the dynamically built available options pane."},{"name":"children","type":"React.ReactNode","description":"Content to be rendered in the dual list selector. Panes & controls will not be built dynamically when children are provided."},{"name":"chosenOptions","type":"React.ReactNode[] | DualListSelectorTreeItemData[]","description":"Options to display in the dynamically built chosen options pane. When using trees, the options should be in the DualListSelectorTreeItemData[] format."},{"name":"chosenOptionsActions","type":"React.ReactNode[]","description":"Actions to be displayed above the dynamically built chosen options pane."},{"name":"chosenOptionsSearchAriaLabel","type":"string","description":"Accessible label for the search input on the dynamically built chosen options pane."},{"name":"chosenOptionsStatus","type":"string","description":"Status message to display above the dynamically built chosen options pane."},{"name":"chosenOptionsTitle","type":"string","description":"Title applied to the dynamically built chosen options pane."},{"name":"className","type":"string","description":"Additional classes applied to the dual list selector."},{"name":"controlsAriaLabel","type":"string","description":"Accessible label for the dynamically built controls between the two panes."},{"name":"filterOption","type":"(option: React.ReactNode, input: string) => boolean","description":"Optional filter function for custom filtering based on search string. Used with a dynamically built search input."},{"name":"id","type":"string","description":"Id of the dual list selector."},{"name":"isDisabled","type":"boolean","description":"Flag indicating if the dual list selector is in a disabled state"},{"name":"isSearchable","type":"boolean","description":"Flag indicating a search bar should be included above both the dynamically built available and chosen panes."},{"name":"isTree","type":"boolean","description":"Flag indicating if the dual list selector uses trees instead of simple lists"},{"name":"onAvailableOptionsSearchInputChanged","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"A callback for when the search input value for the dynamically built available options changes."},{"name":"onChosenOptionsSearchInputChanged","type":"(event: React.FormEvent<HTMLInputElement>, value: string) => void","description":"A callback for when the search input value for the dynamically built chosen options changes."},{"name":"onListChange","type":"(\n event: React.MouseEvent<HTMLElement>,\n newAvailableOptions: React.ReactNode[],\n newChosenOptions: React.ReactNode[]\n ) => void","description":"Callback fired every time dynamically built options are chosen or removed"},{"name":"onOptionCheck","type":"(\n event: React.MouseEvent | React.ChangeEvent<HTMLInputElement> | React.KeyboardEvent,\n checked: boolean,\n checkedId: string,\n newCheckedItems: string[]\n ) => void","description":"Optional callback fired when a dynamically built option is checked"},{"name":"onOptionSelect","type":"(\n event: React.MouseEvent | React.ChangeEvent | React.KeyboardEvent,\n index: number,\n isChosen: boolean,\n id: string,\n itemData: any,\n parentData: any\n ) => void","description":"Optional callback fired when a dynamically built option is selected"},{"name":"removeAll","type":"(newAvailableOptions: React.ReactNode[], newChosenOptions: React.ReactNode[]) => void","description":"Optional callback for the dynamically built remove all button"},{"name":"removeAllAriaLabel","type":"string","description":"Accessible label for the dynamically built remove all button"},{"name":"removeAllTooltip","type":"React.ReactNode","description":"Tooltip content for the dynamically built remove all button"},{"name":"removeAllTooltipProps","type":"any","description":"Additional tooltip properties for the dynamically built remove all tooltip"},{"name":"removeSelected","type":"(newAvailableOptions: React.ReactNode[], newChosenOptions: React.ReactNode[]) => void","description":"Optional callback for the dynamically built remove selected button"},{"name":"removeSelectedAriaLabel","type":"string","description":"Accessible label for the dynamically built remove selected button"},{"name":"removeSelectedTooltip","type":"React.ReactNode","description":"Tooltip content for the dynamically built remove selected button"},{"name":"removeSelectedTooltipProps","type":"any","description":"Additional tooltip properties for the dynamically built remove selected tooltip"}]},"DualListSelectorState-deprecated":{"name":"DualListSelectorState","description":"","props":[{"name":"availableFilteredOptions","type":"React.ReactNode[]","description":null,"required":true},{"name":"availableOptions","type":"React.ReactNode[]","description":null,"required":true},{"name":"availableOptionsSelected","type":"number[]","description":null,"required":true},{"name":"availableTreeFilteredOptions","type":"string[]","description":null,"required":true},{"name":"availableTreeOptionsChecked","type":"string[]","description":null,"required":true},{"name":"chosenFilteredOptions","type":"React.ReactNode[]","description":null,"required":true},{"name":"chosenOptions","type":"React.ReactNode[]","description":null,"required":true},{"name":"chosenOptionsSelected","type":"number[]","description":null,"required":true},{"name":"chosenTreeFilteredOptions","type":"string[]","description":null,"required":true},{"name":"chosenTreeOptionsChecked","type":"string[]","description":null,"required":true}]},"Droppable-deprecated":{"name":"Droppable","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside DragDrop"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"droppableId","type":"string","description":"Id to be passed back on drop events","defaultValue":"'defaultId'"},{"name":"hasNoWrapper","type":"boolean","description":"Don't wrap the component in a div. Requires passing a single child.","defaultValue":"false"},{"name":"zone","type":"string","description":"Name of zone that items can be dragged between. Should specify if there is more than one Droppable on the page.","defaultValue":"'defaultZone'"}]},"DroppableProps-deprecated":{"name":"DroppableProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside DragDrop"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"droppableId","type":"string","description":"Id to be passed back on drop events"},{"name":"hasNoWrapper","type":"boolean","description":"Don't wrap the component in a div. Requires passing a single child."},{"name":"zone","type":"string","description":"Name of zone that items can be dragged between. Should specify if there is more than one Droppable on the page."}]},"Draggable-deprecated":{"name":"Draggable","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside DragDrop"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"hasNoWrapper","type":"boolean","description":"Don't wrap the component in a div. Requires passing a single child.","defaultValue":"false"},{"name":"style","type":"No type info","defaultValue":"{}"}]},"DraggableProps-deprecated":{"name":"DraggableProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Content rendered inside DragDrop"},{"name":"className","type":"string","description":"Class to add to outer div"},{"name":"hasNoWrapper","type":"boolean","description":"Don't wrap the component in a div. Requires passing a single child."}]},"DroppableItem-deprecated":{"name":"DroppableItem","description":"","props":[{"name":"draggableNodes","type":"HTMLElement[]","description":null,"required":true},{"name":"draggableNodesRects","type":"DOMRect[]","description":null,"required":true},{"name":"isDraggingHost","type":"boolean","description":null,"required":true},{"name":"node","type":"HTMLElement","description":null,"required":true},{"name":"rect","type":"DOMRect","description":null,"required":true}]},"DragDrop-deprecated":{"name":"DragDrop","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Potentially Droppable and Draggable children"},{"name":"onDrag","type":"(source: DraggableItemPosition) => boolean","description":"Callback for drag event. Return true to allow drag, false to disallow.","defaultValue":"() => true"},{"name":"onDragMove","type":"(source: DraggableItemPosition, dest?: DraggableItemPosition) => void","description":"Callback on mouse move while dragging.","defaultValue":"() => {}"},{"name":"onDrop","type":"(source: DraggableItemPosition, dest?: DraggableItemPosition) => boolean","description":"Callback for drop event. Return true to allow drop, false to disallow.","defaultValue":"() => false"}]},"DraggableItemPosition-deprecated":{"name":"DraggableItemPosition","description":"","props":[{"name":"droppableId","type":"string","description":"Parent droppableId","required":true},{"name":"index","type":"number","description":"Index of item in parent Droppable","required":true}]},"DragDropProps-deprecated":{"name":"DragDropProps","description":"","props":[{"name":"children","type":"React.ReactNode","description":"Potentially Droppable and Draggable children"},{"name":"onDrag","type":"(source: DraggableItemPosition) => boolean","description":"Callback for drag event. Return true to allow drag, false to disallow."},{"name":"onDragMove","type":"(source: DraggableItemPosition, dest?: DraggableItemPosition) => void","description":"Callback on mouse move while dragging."},{"name":"onDrop","type":"(source: DraggableItemPosition, dest?: DraggableItemPosition) => boolean","description":"Callback for drop event. Return true to allow drop, false to disallow."}]},"ChipGroup-deprecated":{"name":"ChipGroup","description":"","props":[{"name":"aria-label","type":"string","description":"Aria label for chip group that does not have a category name","defaultValue":"'Chip group category'"},{"name":"categoryName","type":"string","description":"Category name text for the chip group category. If this prop is supplied the chip group with have a label and category styling applied","defaultValue":"''"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the chip group. Should be <Chip> elements."},{"name":"className","type":"string","description":"Additional classes added to the chip item"},{"name":"closeBtnAriaLabel","type":"string","description":"Aria label for close button","defaultValue":"'Close chip group'"},{"name":"collapsedText","type":"string","description":"Customizable template string. Use variable \"${remaining}\" for the overflow chip count.","defaultValue":"'${remaining} more'"},{"name":"defaultIsOpen","type":"boolean","description":"Flag for having the chip group default to expanded","defaultValue":"false"},{"name":"expandedText","type":"string","description":"Customizable \"Show Less\" text string","defaultValue":"'Show Less'"},{"name":"isClosable","type":"boolean","description":"Flag if chip group can be closed","defaultValue":"false"},{"name":"numChips","type":"number","description":"Set number of chips to show before overflow","defaultValue":"3"},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"Function that is called when clicking on the chip group close button or on an overflow chip"},{"name":"onOverflowChipClick","type":"(event: React.MouseEvent) => void","description":"Function that is called when clicking on the overflow (expand/collapse) chip button","deprecated":true},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":""},{"name":"tooltipPosition","type":"| TooltipPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Position of the tooltip which is displayed if the category name text is longer","defaultValue":"'top'"}]},"ChipGroupProps-deprecated":{"name":"ChipGroupProps","description":"","props":[{"name":"categoryName","type":"string","description":"Category name text for the chip group category. If this prop is supplied the chip group with have a label and category styling applied"},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the chip group. Should be <Chip> elements."},{"name":"className","type":"string","description":"Additional classes added to the chip item"},{"name":"closeBtnAriaLabel","type":"string","description":"Aria label for close button"},{"name":"collapsedText","type":"string","description":"Customizable template string. Use variable \"${remaining}\" for the overflow chip count."},{"name":"defaultIsOpen","type":"boolean","description":"Flag for having the chip group default to expanded"},{"name":"expandedText","type":"string","description":"Customizable \"Show Less\" text string"},{"name":"isClosable","type":"boolean","description":"Flag if chip group can be closed"},{"name":"numChips","type":"number","description":"Set number of chips to show before overflow"},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"Function that is called when clicking on the chip group close button or on an overflow chip"},{"name":"onOverflowChipClick","type":"(event: React.MouseEvent) => void","description":""},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"tooltipPosition","type":"| TooltipPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Position of the tooltip which is displayed if the category name text is longer"},{"name":"Unknown","type":"string","description":"Aria label for chip group that does not have a category name"}]},"Chip-deprecated":{"name":"Chip","description":"","props":[{"name":"badge","type":"React.ReactNode","description":"Badge to add to the chip. The badge will be rendered after the chip text."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the label."},{"name":"className","type":"string","description":"Additional classes added to the label.","defaultValue":"''"},{"name":"closeBtn","type":"React.ReactNode","description":"Node for custom close button."},{"name":"closeBtnAriaLabel","type":"string","description":"Aria label for close button"},{"name":"closeBtnProps","type":"any","description":"Additional properties for the default close button."},{"name":"color","type":"'blue' | 'teal' | 'green' | 'orange' | 'purple' | 'red' | 'orangered' | 'grey' | 'yellow'","description":"Color of the label."},{"name":"component","type":"React.ReactNode","description":"Component that will be used for chip. It is recommended that <button> or <li> are used when the chip is an overflow chip.","deprecated":true},{"name":"editableProps","type":"any","description":"Additional props passed to the editable label text div. Optionally passing onInput and onBlur callbacks will allow finer custom text input control."},{"name":"href","type":"string","description":"Href for a label that is a link. If present, the label will change to an anchor element. This should not be passed in if the onClick prop is also passed in."},{"name":"icon","type":"React.ReactNode","description":"Icon added to the left of the label text. Overrides the icon set by the status property."},{"name":"isClickable","type":"boolean","description":"Flag indicating the label is clickable. This flag will automatically be set if a href is passed, or if an onClick handler is passed and the label is not an overflow or add variant. This should be manually set when using the render prop."},{"name":"isCompact","type":"boolean","description":"Flag indicating the label is compact."},{"name":"isDisabled","type":"boolean","description":"Flag indicating the label is disabled. Works only on clickable labels, so either href or onClick props must be passed in."},{"name":"isEditable","type":"boolean","description":"Flag indicating the label is editable."},{"name":"isOverflowChip","type":"boolean","description":"Flag indicating if the chip is an overflow chip","defaultValue":"false"},{"name":"isReadOnly","type":"boolean","description":"Flag indicating if chip is read only","defaultValue":"false"},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"Callback for when the label is clicked. This should not be passed in if the href or isEditable props are also passed in.","defaultValue":"(_e: React.MouseEvent) => undefined as any"},{"name":"onClose","type":"(event: React.MouseEvent) => void","description":"Close click callback for removable labels. If present, label will have a close button."},{"name":"onEditCancel","type":"(event: KeyboardEvent, previousText: string) => void","description":"Callback when an editable label cancels an edit."},{"name":"onEditComplete","type":"(event: MouseEvent | KeyboardEvent, newText: string) => void","description":"Callback when an editable label completes an edit."},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"ouiaSafe","type":"boolean","description":""},{"name":"render","type":"({\n className,\n content,\n componentRef\n}: {\n className: string;\n content: React.ReactNode;\n componentRef: any;\n}) => React.ReactNode","description":"Forwards the label content and className to rendered function. Use this prop for react router support."},{"name":"status","type":"'success' | 'warning' | 'danger' | 'info' | 'custom'","description":"Status of the label with a respective icon and color. Overrides the color set by the color property."},{"name":"textMaxWidth","type":"string","description":"The max width of the label before it is truncated. Can be any valid CSS unit, such as '100%', '100px', or '16ch'.","defaultValue":"'16ch'"},{"name":"tooltipPosition","type":"| TooltipPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'","description":"Position of the tooltip which is displayed if text is truncated","defaultValue":"'top'"},{"name":"variant","type":"'outline' | 'filled' | 'overflow' | 'add'","description":"Variant of the label."}]},"ChipProps-deprecated":{"name":"ChipProps","description":"","props":[{"name":"badge","type":"React.ReactNode","description":"Badge to add to the chip. The badge will be rendered after the chip text."},{"name":"children","type":"React.ReactNode","description":"Content rendered inside the chip text"},{"name":"className","type":"string","description":"Additional classes added to the chip item"},{"name":"closeBtnAriaLabel","type":"string","description":"Aria Label for close button"},{"name":"component","type":"React.ReactNode","description":""},{"name":"isOverflowChip","type":"boolean","description":"Flag indicating if the chip is an overflow chip"},{"name":"isReadOnly","type":"boolean","description":"Flag indicating if chip is read only"},{"name":"onClick","type":"(event: React.MouseEvent) => void","description":"Function that is called when clicking on the chip close button"},{"name":"ouiaId","type":"number | string","description":"Value to overwrite the randomly generated data-ouia-component-id."},{"name":"textMaxWidth","type":"string","description":"Css property expressed in percentage or any css unit that overrides the default value of the max-width of the chip's text"},{"name":"tooltipPosition","type":"| TooltipPosition\n | 'auto'\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'","description":"Position of the tooltip which is displayed if text is longer"}]}}
|