@rio-cloud/uikit-mcp 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +91 -0
- package/bin/uikit-mcp.mjs +23 -0
- package/data/pages/Components/components/accentbar.json +207 -0
- package/data/pages/Components/components/activity.json +87 -0
- package/data/pages/Components/components/animatednumber.json +99 -0
- package/data/pages/Components/components/animations.json +87 -0
- package/data/pages/Components/components/appheader.json +291 -0
- package/data/pages/Components/components/applayout.json +1198 -0
- package/data/pages/Components/components/appnavigationbar.json +327 -0
- package/data/pages/Components/components/areacharts.json +563 -0
- package/data/pages/Components/components/aspectratioplaceholder.json +75 -0
- package/data/pages/Components/components/assettree.json +3080 -0
- package/data/pages/Components/components/autosuggests.json +710 -0
- package/data/pages/Components/components/avatar.json +157 -0
- package/data/pages/Components/components/banner.json +599 -0
- package/data/pages/Components/components/barcharts.json +1507 -0
- package/data/pages/Components/components/barlist.json +223 -0
- package/data/pages/Components/components/basicmap.json +68 -0
- package/data/pages/Components/components/bottomsheet.json +601 -0
- package/data/pages/Components/components/button.json +583 -0
- package/data/pages/Components/components/buttontoolbar.json +63 -0
- package/data/pages/Components/components/calendarstripe.json +235 -0
- package/data/pages/Components/components/card.json +69 -0
- package/data/pages/Components/components/carousel.json +39 -0
- package/data/pages/Components/components/chartcolors.json +34 -0
- package/data/pages/Components/components/chartsgettingstarted.json +32 -0
- package/data/pages/Components/components/chat.json +39 -0
- package/data/pages/Components/components/checkbox.json +847 -0
- package/data/pages/Components/components/clearableinput.json +789 -0
- package/data/pages/Components/components/collapse.json +175 -0
- package/data/pages/Components/components/composedcharts.json +159 -0
- package/data/pages/Components/components/contentloader.json +233 -0
- package/data/pages/Components/components/datatabs.json +680 -0
- package/data/pages/Components/components/datepickers.json +287 -0
- package/data/pages/Components/components/dialogs.json +1492 -0
- package/data/pages/Components/components/divider.json +93 -0
- package/data/pages/Components/components/dropdowns.json +936 -0
- package/data/pages/Components/components/editablecontent.json +1117 -0
- package/data/pages/Components/components/expander.json +377 -0
- package/data/pages/Components/components/fade.json +403 -0
- package/data/pages/Components/components/fadeexpander.json +75 -0
- package/data/pages/Components/components/fadeup.json +127 -0
- package/data/pages/Components/components/feedback.json +269 -0
- package/data/pages/Components/components/filepickers.json +269 -0
- package/data/pages/Components/components/formlabel.json +115 -0
- package/data/pages/Components/components/fullscreenmap.json +22 -0
- package/data/pages/Components/components/groupeditemlist.json +323 -0
- package/data/pages/Components/components/iconlist.json +45 -0
- package/data/pages/Components/components/imagepreloader.json +81 -0
- package/data/pages/Components/components/labeledelement.json +75 -0
- package/data/pages/Components/components/licenseplate.json +69 -0
- package/data/pages/Components/components/linecharts.json +987 -0
- package/data/pages/Components/components/listmenu.json +313 -0
- package/data/pages/Components/components/loadmore.json +175 -0
- package/data/pages/Components/components/mainnavigation.json +39 -0
- package/data/pages/Components/components/mapcircle.json +34 -0
- package/data/pages/Components/components/mapcluster.json +51 -0
- package/data/pages/Components/components/mapcontext.json +105 -0
- package/data/pages/Components/components/mapdraggablemarker.json +34 -0
- package/data/pages/Components/components/mapgettingstarted.json +27 -0
- package/data/pages/Components/components/mapgroup.json +1198 -0
- package/data/pages/Components/components/mapinfobubble.json +34 -0
- package/data/pages/Components/components/maplayergroup.json +34 -0
- package/data/pages/Components/components/mapmarker.json +700 -0
- package/data/pages/Components/components/mappolygon.json +45 -0
- package/data/pages/Components/components/maproute.json +623 -0
- package/data/pages/Components/components/maproutegenerator.json +16 -0
- package/data/pages/Components/components/mapsettings.json +51 -0
- package/data/pages/Components/components/maputils.json +34 -0
- package/data/pages/Components/components/multiselects.json +1451 -0
- package/data/pages/Components/components/nodata.json +139 -0
- package/data/pages/Components/components/notifications.json +65 -0
- package/data/pages/Components/components/numbercontrol.json +301 -0
- package/data/pages/Components/components/onboarding.json +302 -0
- package/data/pages/Components/components/page.json +197 -0
- package/data/pages/Components/components/pager.json +93 -0
- package/data/pages/Components/components/piecharts.json +731 -0
- package/data/pages/Components/components/popover.json +251 -0
- package/data/pages/Components/components/position.json +69 -0
- package/data/pages/Components/components/radialbarcharts.json +1304 -0
- package/data/pages/Components/components/radiobutton.json +1105 -0
- package/data/pages/Components/components/releasenotes.json +44 -0
- package/data/pages/Components/components/resizer.json +93 -0
- package/data/pages/Components/components/responsivecolumnstripe.json +123 -0
- package/data/pages/Components/components/responsivevideo.json +75 -0
- package/data/pages/Components/components/rioglyph.json +93 -0
- package/data/pages/Components/components/rules.json +410 -0
- package/data/pages/Components/components/saveableinput.json +703 -0
- package/data/pages/Components/components/selects.json +701 -0
- package/data/pages/Components/components/sidebar.json +243 -0
- package/data/pages/Components/components/sliders.json +235 -0
- package/data/pages/Components/components/smoothscrollbars.json +335 -0
- package/data/pages/Components/components/spinners.json +343 -0
- package/data/pages/Components/components/states.json +1705 -0
- package/data/pages/Components/components/statswidgets.json +314 -0
- package/data/pages/Components/components/statusbar.json +177 -0
- package/data/pages/Components/components/stepbutton.json +57 -0
- package/data/pages/Components/components/steppedprogressbars.json +417 -0
- package/data/pages/Components/components/subnavigation.json +107 -0
- package/data/pages/Components/components/supportmarker.json +45 -0
- package/data/pages/Components/components/svgimage.json +81 -0
- package/data/pages/Components/components/switch.json +111 -0
- package/data/pages/Components/components/tables.json +144 -0
- package/data/pages/Components/components/tagmanager.json +86 -0
- package/data/pages/Components/components/tags.json +146 -0
- package/data/pages/Components/components/teaser.json +188 -0
- package/data/pages/Components/components/timeline.json +45 -0
- package/data/pages/Components/components/timepicker.json +163 -0
- package/data/pages/Components/components/togglebutton.json +247 -0
- package/data/pages/Components/components/tooltip.json +270 -0
- package/data/pages/Components/components/virtuallist.json +175 -0
- package/data/pages/Foundations/foundations.json +2475 -0
- package/data/pages/Getting-started/start/changelog.json +22 -0
- package/data/pages/Getting-started/start/goodtoknow.json +32 -0
- package/data/pages/Getting-started/start/guidelines/color-combinations.json +58 -0
- package/data/pages/Getting-started/start/guidelines/custom-css.json +27 -0
- package/data/pages/Getting-started/start/guidelines/custom-rioglyph.json +22 -0
- package/data/pages/Getting-started/start/guidelines/formatting.json +97 -0
- package/data/pages/Getting-started/start/guidelines/iframe.json +93 -0
- package/data/pages/Getting-started/start/guidelines/obfuscate-data.json +22 -0
- package/data/pages/Getting-started/start/guidelines/print-css.json +37 -0
- package/data/pages/Getting-started/start/guidelines/spinner.json +144 -0
- package/data/pages/Getting-started/start/guidelines/supported-browsers.json +22 -0
- package/data/pages/Getting-started/start/guidelines/writing.json +242 -0
- package/data/pages/Getting-started/start/howto.json +72 -0
- package/data/pages/Getting-started/start/intro.json +37 -0
- package/data/pages/Getting-started/start/responsiveness.json +52 -0
- package/data/pages/Templates/templates/common-table.json +39 -0
- package/data/pages/Templates/templates/detail-views.json +71 -0
- package/data/pages/Templates/templates/expandable-details.json +39 -0
- package/data/pages/Templates/templates/feature-cards.json +103 -0
- package/data/pages/Templates/templates/form-summary.json +39 -0
- package/data/pages/Templates/templates/form-toggle.json +39 -0
- package/data/pages/Templates/templates/list-blocks.json +119 -0
- package/data/pages/Templates/templates/loading-progress.json +39 -0
- package/data/pages/Templates/templates/options-panel.json +39 -0
- package/data/pages/Templates/templates/panel-variants.json +39 -0
- package/data/pages/Templates/templates/progress-cards.json +71 -0
- package/data/pages/Templates/templates/progress-success.json +39 -0
- package/data/pages/Templates/templates/settings-form.json +39 -0
- package/data/pages/Templates/templates/stats-blocks.json +135 -0
- package/data/pages/Templates/templates/table-panel.json +39 -0
- package/data/pages/Templates/templates/table-row-animation.json +39 -0
- package/data/pages/Templates/templates/usage-cards.json +39 -0
- package/data/pages/Utilities/utilities/deviceutils.json +39 -0
- package/data/pages/Utilities/utilities/featuretoggles.json +42 -0
- package/data/pages/Utilities/utilities/fueltypeutils.json +118 -0
- package/data/pages/Utilities/utilities/routeutils.json +34 -0
- package/data/pages/Utilities/utilities/useaftermount.json +63 -0
- package/data/pages/Utilities/utilities/useaverage.json +86 -0
- package/data/pages/Utilities/utilities/useclickoutside.json +69 -0
- package/data/pages/Utilities/utilities/useclipboard.json +57 -0
- package/data/pages/Utilities/utilities/usecount.json +92 -0
- package/data/pages/Utilities/utilities/usedarkmode.json +50 -0
- package/data/pages/Utilities/utilities/usedebuginfo.json +63 -0
- package/data/pages/Utilities/utilities/useeffectonce.json +57 -0
- package/data/pages/Utilities/utilities/useelapsedtime.json +57 -0
- package/data/pages/Utilities/utilities/useelementsize.json +63 -0
- package/data/pages/Utilities/utilities/useesc.json +57 -0
- package/data/pages/Utilities/utilities/useevent.json +75 -0
- package/data/pages/Utilities/utilities/usefocustrap.json +57 -0
- package/data/pages/Utilities/utilities/usefullscreen.json +197 -0
- package/data/pages/Utilities/utilities/usehover.json +57 -0
- package/data/pages/Utilities/utilities/useinterval.json +63 -0
- package/data/pages/Utilities/utilities/useisfocuswithin.json +75 -0
- package/data/pages/Utilities/utilities/usekey.json +75 -0
- package/data/pages/Utilities/utilities/uselocalstorage.json +69 -0
- package/data/pages/Utilities/utilities/uselocationsuggestions.json +110 -0
- package/data/pages/Utilities/utilities/usemax.json +86 -0
- package/data/pages/Utilities/utilities/usemin.json +86 -0
- package/data/pages/Utilities/utilities/usemutationobserver.json +69 -0
- package/data/pages/Utilities/utilities/useonlinestatus.json +39 -0
- package/data/pages/Utilities/utilities/useonscreen.json +63 -0
- package/data/pages/Utilities/utilities/usepostmessage.json +80 -0
- package/data/pages/Utilities/utilities/useprevious.json +63 -0
- package/data/pages/Utilities/utilities/useresizeobserver.json +65 -0
- package/data/pages/Utilities/utilities/usescrollposition.json +103 -0
- package/data/pages/Utilities/utilities/usesearch.json +197 -0
- package/data/pages/Utilities/utilities/usesorting.json +139 -0
- package/data/pages/Utilities/utilities/usestatewithvalidation.json +69 -0
- package/data/pages/Utilities/utilities/usesum.json +86 -0
- package/data/pages/Utilities/utilities/usetableexport.json +87 -0
- package/data/pages/Utilities/utilities/usetableselection.json +311 -0
- package/data/pages/Utilities/utilities/usetimeout.json +63 -0
- package/data/pages/Utilities/utilities/usetoggle.json +75 -0
- package/data/pages/Utilities/utilities/usewindowresize.json +63 -0
- package/data/version.json +4 -0
- package/docs/content-schema.md +147 -0
- package/docs/navigation-inventory.json +1310 -0
- package/docs/search-synonyms.json +43 -0
- package/package.json +38 -0
- package/server/index.mjs +268 -0
- package/server/lib/load-docs.mjs +48 -0
- package/server/lib/normalise-doc.mjs +220 -0
- package/server/lib/render-markdown.mjs +82 -0
- package/server/lib/search-index.mjs +49 -0
- package/server/lib/types.js +99 -0
|
@@ -0,0 +1,291 @@
|
|
|
1
|
+
{
|
|
2
|
+
"metadata": {
|
|
3
|
+
"captured_at": "2025-11-21T12:07:04.142Z",
|
|
4
|
+
"source": "https://uikit.developers.rio.cloud/#components/appHeader",
|
|
5
|
+
"category": "Components",
|
|
6
|
+
"section": "Application",
|
|
7
|
+
"slug": "components/appheader",
|
|
8
|
+
"version": "v1.13.2",
|
|
9
|
+
"hash_algorithm": "sha256",
|
|
10
|
+
"hash": "a1486a960820924f5e995469c4252a5a5a6a229861d96124b8d675fe2fb15870"
|
|
11
|
+
},
|
|
12
|
+
"title": "ApplicationHeader",
|
|
13
|
+
"lead": "This is the header component for all services. All navigation link components that are passed into the header should be based on react-router",
|
|
14
|
+
"content": [
|
|
15
|
+
{
|
|
16
|
+
"heading": "ApplicationHeader",
|
|
17
|
+
"body": "",
|
|
18
|
+
"examples": [
|
|
19
|
+
{
|
|
20
|
+
"caption": "Example 1",
|
|
21
|
+
"rendered_html": "<div class=\"playground-content bg-lighter padding-20 padding-bottom-25\" style=\"width: 100%;\"><div><div class=\"ApplicationLayout\"><div class=\"ApplicationLayoutHeader\" id=\"ApplicationLayoutHeader\"><nav class=\"ApplicationHeader user-select-none\"><div class=\"navbar-header\"><span class=\"navbar-brand home-icon\"><a aria-current=\"page\" class=\"active\" href=\"#\"></a></span></div><ul class=\"ModuleNavigation AppMenu user-select-none hasModules appNavigatorClassName\"><li class=\"dropdown\"><a class=\"ModuleNavigation-dropdown dropdown-toggle justify-content-between\" role=\"button\" id=\"basic-nav-dropdown\"><span>ApplicationHeader</span><span class=\"caret\"></span></a><ul role=\"menu\" class=\"dropdown-menu ModuleNavigation-dropdown-menu\"><li role=\"presentation\"><div class=\"display-flex flex-column padding-10\"><a href=\"/\" target=\"_top\" class=\"rounded link bg-white display-flex align-items-start gap-15 user-select-none text-decoration-none hover-bg-lightest padding-15\"><div class=\"position-relative padding-20 border border-size-2 border-color-primary bg-white\"><div class=\"position-absolute inset-0 display-grid place-items-center\"><span class=\"text-size-20 rioglyph rioglyph-number-1\"></span></div></div><div class=\"flex-1-1\"><div class=\"line-height-125rel margin-top--3\"><div class=\"text-size-18 text-medium margin-bottom-3 text-color-primary\">Headline 1</div><div class=\"text-size-14 text-color-darkest text-capitalize\">Subline 1</div></div></div></a><a href=\"/\" target=\"_top\" class=\"rounded link bg-white display-flex align-items-start gap-15 user-select-none text-decoration-none hover-bg-lightest padding-15\"><div class=\"position-relative padding-20 border border-size-2 border-color-primary bg-white\"><div class=\"position-absolute inset-0 display-grid place-items-center\"><span class=\"text-size-20 rioglyph rioglyph-number-2\"></span></div></div><div class=\"flex-1-1\"><div class=\"line-height-125rel margin-top--3\"><div class=\"text-size-18 text-medium margin-bottom-3 text-color-primary\">Headline 2</div><div class=\"text-size-14 text-color-darkest text-capitalize\">Subline 2</div></div></div></a><a href=\"/\" target=\"_top\" class=\"rounded link bg-white display-flex align-items-start gap-15 user-select-none text-decoration-none hover-bg-lightest padding-15\"><div class=\"position-relative padding-20 border border-size-2 border-color-primary bg-white\"><div class=\"position-absolute inset-0 display-grid place-items-center\"><span class=\"text-size-20 rioglyph rioglyph-number-3\"></span></div></div><div class=\"flex-1-1\"><div class=\"line-height-125rel margin-top--3\"><div class=\"text-size-18 text-medium margin-bottom-3 text-color-primary\">Headline 3</div><div class=\"text-size-14 text-color-darkest text-capitalize\">Subline 3</div></div></div></a></div></li></ul></li></ul><ul class=\"SubmoduleNavigation nav\"><li class=\"submodule \" data-nav-item-key=\"A\"><a aria-current=\"page\" class=\"active\" href=\"#components/appHeader\">Test A</a></li><li class=\"submodule \" data-nav-item-key=\"B\"><a href=\"#2\">Test B</a></li><li class=\"submodule \" data-nav-item-key=\"C\"><a href=\"#3\">Test C</a></li><li class=\"submodule \" data-nav-item-key=\"D\"><a href=\"#4\">Test D</a></li><li class=\"CollapsedDropdown dropdown \"><a id=\"basic-nav-dropdown\" role=\"button\" class=\"dropdown-toggle text-color-gray\" aria-haspopup=\"true\" aria-expanded=\"true\"><span class=\"rioglyph rioglyph-option-horizontal\" aria-hidden=\"true\"></span></a><ul class=\"dropdown-menu\" role=\"menu\" aria-labelledby=\"basic-nav-dropdown\"><li class=\"submodule\" data-nav-item-key=\"E\"><a href=\"#5\">Test E</a></li></ul></li></ul><ul class=\"ApplicationActionBar nav navbar-nav navbar-right \"><li role=\"presentation\" class=\"navigationItem\"><div class=\"ActionBarItem\"><div class=\"ActionBarItemIcon\"><span class=\"icon rioglyph rioglyph-cog\"></span></div></div></li><li role=\"presentation\" class=\"navigationItem\"><div class=\"ActionBarItem\"><div class=\"ActionBarItemIcon\"><span class=\"icon rioglyph rioglyph-user\"></span></div></div></li></ul></nav></div></div><div class=\"margin-top-20 margin-bottom-20\"><button type=\"button\" class=\"btn btn-default\">Load different Nav Items</button></div></div></div>",
|
|
22
|
+
"tabs": [
|
|
23
|
+
{
|
|
24
|
+
"label": "React",
|
|
25
|
+
"language": "tsx",
|
|
26
|
+
"code": "import { useEffect, useRef, useState } from 'react';\nimport { NavLink } from 'react-router-dom';\n\nimport ApplicationLayout from '@rio-cloud/rio-uikit/ApplicationLayout';\nimport ApplicationHeader from '@rio-cloud/rio-uikit/ApplicationHeader';\nimport ActionBarItem from '@rio-cloud/rio-uikit/ActionBarItem';\nimport Notification from '@rio-cloud/rio-uikit/Notification';\nimport Dialog from '@rio-cloud/rio-uikit/Dialog';\nimport Checkbox from '@rio-cloud/rio-uikit/Checkbox';\nimport Button from '@rio-cloud/rio-uikit/Button';\nimport ButtonToolbar from '@rio-cloud/rio-uikit/ButtonToolbar';\n\nconst manyNavItems = [\n { key: 'A', route: <NavLink to='/components/appHeader'>Test A</NavLink> },\n { key: 'B', route: <NavLink to='/2'>Test B</NavLink> },\n { key: 'C', route: <NavLink to='/3'>Test C</NavLink> },\n { key: 'D', route: <NavLink to='/4'>Test D</NavLink> },\n { key: 'E', route: <NavLink to='/5'>Test E</NavLink> },\n];\n\nconst fewNavItems = [\n { key: '1', route: <NavLink to='/6'>Lorem</NavLink> },\n { key: '2', route: <NavLink to='/7'>Ipsum</NavLink> },\n { key: '3', route: <NavLink to='/8'>Dolor</NavLink> },\n];\n\nconst fakeAppNavigator = (\n <div className='display-flex flex-column padding-10'>\n {[1, 2, 3].map(index => (\n <a\n key={index}\n href='/'\n target='_top'\n className='rounded link bg-white display-flex align-items-start gap-15 user-select-none text-decoration-none hover-bg-lightest padding-15'\n >\n <div className='position-relative padding-20 border border-size-2 border-color-primary bg-white'>\n <div className='position-absolute inset-0 display-grid place-items-center'>\n <span className={`text-size-20 rioglyph rioglyph-number-${index}`} />\n </div>\n </div>\n <div className='flex-1-1'>\n <div className='line-height-125rel margin-top--3'>\n <div className='text-size-18 text-medium margin-bottom-3 text-color-primary'>\n Headline {index}\n </div>\n <div className='text-size-14 text-color-darkest text-capitalize'>Subline {index}</div>\n </div>\n </div>\n </a>\n ))}\n </div>\n);\n\n// We use this component to simulate a pre rendered component\nconst PreRendered = () => {\n const [index, setIndex] = useState(0);\n\n useEffect(() => {\n let counter = 0;\n const id = setInterval(() => {\n setIndex(counter++);\n }, 1000);\n return () => clearInterval(id);\n }, []);\n\n return (\n <div className='display-flex flex-row justify-content-between align-items-center'>\n <div>\n <span className='margin-right-5 text-color-gray'>Counter:</span>\n <span>{index}</span>\n </div>\n <div>\n <button\n className='btn btn-default'\n type='button'\n onClick={() => Notification.info(`Button clicked with ${index}`)}\n >\n Click Me\n </button>\n </div>\n </div>\n );\n};\n\nconst AccountMenuComponent = (\n <ActionBarItem id='accountMenu'>\n <ActionBarItem.Icon>\n <span className='icon rioglyph rioglyph-user' />\n </ActionBarItem.Icon>\n <ActionBarItem.Popover title='Prerending the Popover' useOffscreen>\n <PreRendered />\n </ActionBarItem.Popover>\n </ActionBarItem>\n);\n\nconst AppHeaderExample = () => {\n const [navItems, setNavItems] = useState(manyNavItems);\n\n const [showSettingsDialog, setShowSettingsDialog] = useState(false);\n\n const headerRef = useRef<HTMLDivElement>(null);\n\n useEffect(() => {\n if (headerRef.current) {\n console.log('Header mounted');\n }\n }, [headerRef.current]);\n\n const handleOnClick = () => {\n setNavItems(prevNavItems => (prevNavItems === fewNavItems ? manyNavItems : fewNavItems));\n };\n\n const sampleActionBarComponent = (\n <ActionBarItem id='cog'>\n <ActionBarItem.Icon onClick={() => setShowSettingsDialog(true)}>\n <span className='icon rioglyph rioglyph-cog' />\n </ActionBarItem.Icon>\n <Dialog\n show={showSettingsDialog}\n body={\n <div>\n <div className='margin-bottom-15'>\n <i>\n This is the place for some service specific settings, that are not global for all\n services.\n </i>\n </div>\n <div className='margin-bottom-25'>\n <legend>Category one settings</legend>\n <div className='form-group'>\n <label className='width-100pct'>\n <div>Lorem ipsum</div>\n <input\n className='form-control margin-y-5'\n type='text'\n placeholder='Lorem Ipsum Dolor'\n />\n </label>\n <label className='width-100pct'>\n <div className='margin-bottom-5'>Lorem ipsum</div>\n <div className='input-group'>\n <span className='input-group-addon'>\n <span className='rioglyph rioglyph-user' />\n </span>\n <input className='form-control' type='text' placeholder='Lorem Ipsum Dolor' />\n </div>\n </label>\n </div>\n </div>\n <div>\n <legend>Category two settings</legend>\n <div className='form-group space-y-10'>\n <Checkbox>Lorem ipsum solor</Checkbox>\n <Checkbox defaultChecked>Ipsum dolor sit</Checkbox>\n <Checkbox>Dolor sit amet</Checkbox>\n </div>\n </div>\n </div>\n }\n title='Service settings'\n footer={\n <ButtonToolbar>\n <Button onClick={() => setShowSettingsDialog(false)}>Discard</Button>\n <Button bsStyle='primary' onClick={() => setShowSettingsDialog(false)}>\n Apply changes\n </Button>\n </ButtonToolbar>\n }\n onClose={() => setShowSettingsDialog(false)}\n bsSize={Dialog.SIZE_SM}\n showCloseButton\n />\n </ActionBarItem>\n );\n\n return (\n <div>\n <ApplicationLayout>\n <ApplicationLayout.Header>\n <ApplicationHeader\n ref={headerRef}\n label='ApplicationHeader'\n homeRoute={<NavLink to='/' />}\n appNavigator={fakeAppNavigator}\n appNavigatorClassName='appNavigatorClassName'\n navItems={navItems}\n onToggleAppMenu={isMenuOpen => console.log({ isMenuOpen })}\n actionBarItems={[sampleActionBarComponent, AccountMenuComponent]}\n />\n </ApplicationLayout.Header>\n </ApplicationLayout>\n <div className='margin-top-20 margin-bottom-20'>\n <button type='button' className='btn btn-default' onClick={handleOnClick}>\n Load different Nav Items\n </button>\n </div>\n </div>\n );\n};\n\nexport default AppHeaderExample;"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"label": "HTML",
|
|
30
|
+
"language": "html",
|
|
31
|
+
"code": "<div>\n <div class=\"ApplicationLayout\">\n <div class=\"ApplicationLayoutHeader\" id=\"ApplicationLayoutHeader\">\n <nav class=\"ApplicationHeader user-select-none\">\n <div class=\"navbar-header\">\n <span class=\"navbar-brand home-icon\">\n <a aria-current=\"page\" class=\"active\" href=\"#\">\n </a>\n </span>\n </div>\n <ul class=\"ModuleNavigation AppMenu user-select-none hasModules appNavigatorClassName\">\n <li class=\"dropdown\">\n <a class=\"ModuleNavigation-dropdown dropdown-toggle justify-content-between\" role=\"button\" id=\"basic-nav-dropdown\">\n <span>ApplicationHeader</span>\n <span class=\"caret\">\n </span>\n </a>\n <ul role=\"menu\" class=\"dropdown-menu ModuleNavigation-dropdown-menu\">\n <li role=\"presentation\">\n <div class=\"display-flex flex-column padding-10\">\n <a href=\"/\" target=\"_top\" class=\"rounded link bg-white display-flex align-items-start gap-15 user-select-none text-decoration-none hover-bg-lightest padding-15\">\n <div class=\"position-relative padding-20 border border-size-2 border-color-primary bg-white\">\n <div class=\"position-absolute inset-0 display-grid place-items-center\">\n <span class=\"text-size-20 rioglyph rioglyph-number-1\">\n </span>\n </div>\n </div>\n <div class=\"flex-1-1\">\n <div class=\"line-height-125rel margin-top--3\">\n <div class=\"text-size-18 text-medium margin-bottom-3 text-color-primary\">Headline 1</div>\n <div class=\"text-size-14 text-color-darkest text-capitalize\">Subline 1</div>\n </div>\n </div>\n </a>\n <a href=\"/\" target=\"_top\" class=\"rounded link bg-white display-flex align-items-start gap-15 user-select-none text-decoration-none hover-bg-lightest padding-15\">\n <div class=\"position-relative padding-20 border border-size-2 border-color-primary bg-white\">\n <div class=\"position-absolute inset-0 display-grid place-items-center\">\n <span class=\"text-size-20 rioglyph rioglyph-number-2\">\n </span>\n </div>\n </div>\n <div class=\"flex-1-1\">\n <div class=\"line-height-125rel margin-top--3\">\n <div class=\"text-size-18 text-medium margin-bottom-3 text-color-primary\">Headline 2</div>\n <div class=\"text-size-14 text-color-darkest text-capitalize\">Subline 2</div>\n </div>\n </div>\n </a>\n <a href=\"/\" target=\"_top\" class=\"rounded link bg-white display-flex align-items-start gap-15 user-select-none text-decoration-none hover-bg-lightest padding-15\">\n <div class=\"position-relative padding-20 border border-size-2 border-color-primary bg-white\">\n <div class=\"position-absolute inset-0 display-grid place-items-center\">\n <span class=\"text-size-20 rioglyph rioglyph-number-3\">\n </span>\n </div>\n </div>\n <div class=\"flex-1-1\">\n <div class=\"line-height-125rel margin-top--3\">\n <div class=\"text-size-18 text-medium margin-bottom-3 text-color-primary\">Headline 3</div>\n <div class=\"text-size-14 text-color-darkest text-capitalize\">Subline 3</div>\n </div>\n </div>\n </a>\n </div>\n </li>\n </ul>\n </li>\n </ul>\n <ul class=\"SubmoduleNavigation nav\">\n <li class=\"submodule \" data-nav-item-key=\"A\">\n <a aria-current=\"page\" class=\"active\" href=\"#components/appHeader\">Test A</a>\n </li>\n <li class=\"submodule \" data-nav-item-key=\"B\">\n <a href=\"#2\">Test B</a>\n </li>\n <li class=\"submodule \" data-nav-item-key=\"C\">\n <a href=\"#3\">Test C</a>\n </li>\n <li class=\"submodule \" data-nav-item-key=\"D\">\n <a href=\"#4\">Test D</a>\n </li>\n <li class=\"CollapsedDropdown dropdown \">\n <a id=\"basic-nav-dropdown\" role=\"button\" class=\"dropdown-toggle text-color-gray\" aria-haspopup=\"true\" aria-expanded=\"true\">\n <span class=\"rioglyph rioglyph-option-horizontal\" aria-hidden=\"true\">\n </span>\n </a>\n <ul class=\"dropdown-menu\" role=\"menu\" aria-labelledby=\"basic-nav-dropdown\">\n <li class=\"submodule\" data-nav-item-key=\"E\">\n <a href=\"#5\">Test E</a>\n </li>\n </ul>\n </li>\n </ul>\n <ul class=\"ApplicationActionBar nav navbar-nav navbar-right \">\n <li role=\"presentation\" class=\"navigationItem\">\n <div class=\"ActionBarItem\">\n <div class=\"ActionBarItemIcon\">\n <span class=\"icon rioglyph rioglyph-cog\">\n </span>\n </div>\n </div>\n </li>\n <li role=\"presentation\" class=\"navigationItem\">\n <div class=\"ActionBarItem\">\n <div class=\"ActionBarItemIcon\">\n <span class=\"icon rioglyph rioglyph-user\">\n </span>\n </div>\n </div>\n </li>\n </ul>\n </nav>\n </div>\n </div>\n <div class=\"margin-top-20 margin-bottom-20\">\n <button type=\"button\" class=\"btn btn-default\">Load different Nav Items</button>\n </div>\n</div>"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"label": "Props",
|
|
35
|
+
"language": "json",
|
|
36
|
+
"code": null,
|
|
37
|
+
"props": [
|
|
38
|
+
{
|
|
39
|
+
"heading": null,
|
|
40
|
+
"rows": [
|
|
41
|
+
{
|
|
42
|
+
"name": "label",
|
|
43
|
+
"type": "Node",
|
|
44
|
+
"default": "",
|
|
45
|
+
"description": "The service name shown as the navigator dropdown label."
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "homeRoute",
|
|
49
|
+
"type": "Node",
|
|
50
|
+
"default": "",
|
|
51
|
+
"description": "The home URL that shall be used for the home button. Pass a react-router-dom NavLink as homeRoute into the header. For example: <NavLink to='https://home.rio.cloud' />"
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"name": "showHomeIcon",
|
|
55
|
+
"type": "Boolean",
|
|
56
|
+
"default": "true",
|
|
57
|
+
"description": "Defines to either show the home icon or the RIO logo as brand logo."
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"name": "appNavigator",
|
|
61
|
+
"type": "Node",
|
|
62
|
+
"default": "",
|
|
63
|
+
"description": "The component for the navigation between apps which will be shown inside the main dropdown. Platform apps may use the default AppNavigator but there are also other cases like support apps where it's just a simple list In this case, use the prop appMenuItems. If no appNavigator is defined, the dropdown menu will not be rendered."
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"name": "appNavigatorClassName",
|
|
67
|
+
"type": "String",
|
|
68
|
+
"default": "",
|
|
69
|
+
"description": "Additional class names that are added to the appNavigator."
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"name": "appMenuItems",
|
|
73
|
+
"type": "Array",
|
|
74
|
+
"default": "",
|
|
75
|
+
"description": "List of application navigation link components."
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"name": "└key",
|
|
79
|
+
"type": "String",
|
|
80
|
+
"default": "",
|
|
81
|
+
"description": "Unique key for the navigation component."
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"name": "└route",
|
|
85
|
+
"type": "Node",
|
|
86
|
+
"default": "",
|
|
87
|
+
"description": "The navigation link component used for rendering the name and for routing. For example: <NavLink to='/app1'>{'App 1'}</NavLink>"
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
"name": "navItems",
|
|
91
|
+
"type": "Array",
|
|
92
|
+
"default": "",
|
|
93
|
+
"description": "List of sub-module navigation component of an app. Items collapse into a dropdown if remaining space in the header is not sufficient."
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
"name": "└key",
|
|
97
|
+
"type": "String",
|
|
98
|
+
"default": "",
|
|
99
|
+
"description": "Unique key for the sub-module navigation component of an app."
|
|
100
|
+
},
|
|
101
|
+
{
|
|
102
|
+
"name": "└route",
|
|
103
|
+
"type": "Node",
|
|
104
|
+
"default": "",
|
|
105
|
+
"description": "The navigation link component used for rendering the name and for routing. For example: <NavLink to='/app/ipsum'>{'Lorem ipsum'}</NavLink>"
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"name": "actionBarItems",
|
|
109
|
+
"type": "Array of Nodes",
|
|
110
|
+
"default": "[]",
|
|
111
|
+
"description": "List of external smart components like the rio-accountmenu or application owned components such as a ServiceInfo icon. These components are based on the ActionBarItem"
|
|
112
|
+
},
|
|
113
|
+
{
|
|
114
|
+
"name": "onToggleAppMenu",
|
|
115
|
+
"type": "(isOpen: boolean) => void",
|
|
116
|
+
"default": "",
|
|
117
|
+
"description": "Callback function triggered when the application menu is open or closed."
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"name": "className",
|
|
121
|
+
"type": "String",
|
|
122
|
+
"default": "",
|
|
123
|
+
"description": "Additional class names that are added to the wrapper component."
|
|
124
|
+
}
|
|
125
|
+
]
|
|
126
|
+
}
|
|
127
|
+
]
|
|
128
|
+
}
|
|
129
|
+
]
|
|
130
|
+
}
|
|
131
|
+
]
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"heading": "ActionBarItem",
|
|
135
|
+
"body": "The ActionBarItem components consists mainly of two sub-components: Icon and Popover. The Icon component is mandatory and is shown in the header. The Popover component is optional and it's content will be shown inside a Popover.",
|
|
136
|
+
"examples": [
|
|
137
|
+
{
|
|
138
|
+
"caption": "Example 2",
|
|
139
|
+
"rendered_html": "<div class=\"playground-content bg-lighter padding-20 padding-bottom-25\" style=\"width: 100%;\"><div class=\"ApplicationLayout\"><div class=\"ApplicationLayoutHeader\" id=\"ApplicationLayoutHeader\"><nav class=\"ApplicationHeader user-select-none\"><div class=\"navbar-header\"><span class=\"navbar-brand home-icon\"></span></div><ul class=\"ModuleNavigation AppMenu user-select-none pointer-events-none\"><li class=\"dropdown\"><a class=\"ModuleNavigation-dropdown dropdown-toggle justify-content-between inactive\" role=\"button\" id=\"basic-nav-dropdown\"><span>ApplicationHeader</span></a></li></ul><ul class=\"SubmoduleNavigation nav\"></ul><ul class=\"ApplicationActionBar nav navbar-nav navbar-right \"><li role=\"presentation\" class=\"navigationItem\"><div class=\"ActionBarItem\"><div class=\"ActionBarItemIcon\"><span class=\"icon rioglyph rioglyph-support\"></span></div></div></li><li role=\"presentation\" class=\"navigationItem\"><div class=\"ActionBarItem myItem\"><div class=\"ActionBarItemIcon\"><span class=\"icon rioglyph rioglyph-info-sign\"></span></div></div></li><li role=\"presentation\" class=\"navigationItem\"><div class=\"ActionBarItem\"><div class=\"ActionBarItemIcon\"><span class=\"icon rioglyph rioglyph-notification\"></span><span class=\"badge badge-primary badge-indicator badge-indicator-pinging\">4</span></div></div></li><li role=\"presentation\" class=\"navigationItem\"><div class=\"ActionBarItem\"><div class=\"ActionBarItemIcon\"><span class=\"icon rioglyph rioglyph-user\"></span></div></div></li></ul></nav></div></div></div>",
|
|
140
|
+
"tabs": [
|
|
141
|
+
{
|
|
142
|
+
"label": "React",
|
|
143
|
+
"language": "tsx",
|
|
144
|
+
"code": "import React, { useState, type ChangeEvent } from 'react';\nimport { Link } from 'react-router-dom';\n\nimport ApplicationLayout from '@rio-cloud/rio-uikit/ApplicationLayout';\nimport ApplicationHeader from '@rio-cloud/rio-uikit/ApplicationHeader';\nimport ActionBarItem from '@rio-cloud/rio-uikit/ActionBarItem';\nimport Select from '@rio-cloud/rio-uikit/Select';\nimport Fade from '@rio-cloud/rio-uikit/Fade';\nimport ToggleButton from '@rio-cloud/rio-uikit/ToggleButton';\nimport Notification from '@rio-cloud/rio-uikit/Notification';\nimport Button from '@rio-cloud/rio-uikit/Button';\n\nconst ActionBarItemsExample = () => {\n const [showFeedbackNotification, setShowFeedbackNotification] = useState(false);\n const [feedbackButtonText, setFeedbackButtonText] = useState('Send feedback');\n const [value, setValue] = useState('');\n const [rows, setRows] = useState(5);\n const [minRows, setMinRows] = useState(5);\n const [maxRows, setMaxRows] = useState(30);\n\n const handleFeedbackCategory = (id: string) => {\n switch (id) {\n case '1':\n setFeedbackButtonText('Send usability feedback');\n break;\n case '2':\n setFeedbackButtonText('Send bug report');\n break;\n case '3':\n setFeedbackButtonText('Send feature request');\n break;\n default:\n setFeedbackButtonText('Send feedback');\n break;\n }\n };\n\n const handleAutosize = (event: ChangeEvent<HTMLTextAreaElement>) => {\n const textareaLineHeight = 20.1; // 1.42857143 + 14px\n\n const previousRows = event.target.rows;\n event.target.rows = minRows; // reset number of rows in textarea\n\n const currentRows = Math.floor(event.target.scrollHeight / textareaLineHeight);\n\n if (currentRows === previousRows) {\n event.target.rows = currentRows;\n }\n\n if (currentRows >= maxRows) {\n event.target.rows = maxRows;\n event.target.scrollTop = event.target.scrollHeight;\n }\n\n setValue(event.target.value);\n setRows(currentRows < maxRows ? currentRows : maxRows);\n };\n\n const title = (\n <div>\n <span>Service XYZ</span>\n <span className='text-color-gray margin-left-10'>v1.1.0</span>\n </div>\n );\n\n const FeedbackComponent = (\n <ActionBarItem id='feedback' hidePopoverOnClick={false} popoverWidth={400}>\n <ActionBarItem.Icon>\n <span className='icon rioglyph rioglyph-support' />\n </ActionBarItem.Icon>\n <ActionBarItem.Popover title='Customer care center' className='padding-20'>\n <div className='padding-top-5 padding-bottom-5'>\n <div className='text-center padding-top-10 padding-bottom-25'>\n <a className='text-size-h4' hre='tel:0049-0800-22550746'>\n Hotline +(49) 08 00 / 22 55 07 46\n </a>\n <div className='text-size-16'>Monday - Friday: 8:00 am - 04:30 pm (MEZ)</div>\n </div>\n <form>\n <div className='form-group'>\n <input className='form-control' type='email' placeholder='logged.in@user.email' disabled />\n </div>\n <div className='form-group'>\n <Select\n placeholder='Type of feedback'\n options={[\n {\n id: '1',\n label: 'Usability',\n },\n {\n id: '2',\n label: 'Bug report',\n },\n {\n id: '3',\n label: 'Missing feature',\n },\n {\n id: '4',\n label: 'Other',\n },\n ]}\n onChange={item => handleFeedbackCategory(item.id)}\n />\n </div>\n <div className='form-group'>\n <textarea\n rows={rows}\n value={value}\n className='form-control'\n onChange={event => handleAutosize(event)}\n />\n </div>\n <div className='display-flex justify-content-end'>\n <ToggleButton\n className='margin-bottom-10'\n active={showFeedbackNotification}\n onClick={() => setShowFeedbackNotification(!showFeedbackNotification)}\n >\n {feedbackButtonText}\n </ToggleButton>\n </div>\n <Fade show={showFeedbackNotification}>\n <div className='alert alert-success margin-bottom-0'>\n <strong>Thank you for your feedback!</strong> We will use your feedback for future\n improvement. In case it`s necessary, we will contact you for further clarification.\n </div>\n </Fade>\n </form>\n </div>\n </ActionBarItem.Popover>\n </ActionBarItem>\n );\n\n const ServiceInfo = () => (\n <ActionBarItem.List>\n <ActionBarItem.ListItem icon='rioglyph-hand-right' onClick={() => Notification.info('Show welcome dialog')}>\n <div className='display-flex align-items-center gap-5'>\n <span>Welcome</span>\n <span className='badge badge-primary'>1</span>\n </div>\n </ActionBarItem.ListItem>\n <ActionBarItem.ListItem\n icon='rioglyph-exclamation-sign'\n onClick={() => Notification.info(\"Show what's new dialog\")}\n >\n What's new?\n </ActionBarItem.ListItem>\n <ActionBarItem.ListItem\n icon='rioglyph-question-sign'\n onClick={() => Notification.info('Show features dialog')}\n >\n Features\n </ActionBarItem.ListItem>\n <ActionBarItem.ListSeparator />\n <ActionBarItem.ListItem icon='rioglyph-envelope' hasLink>\n <Link to='/components/appHeader'>Feedback</Link>\n </ActionBarItem.ListItem>\n </ActionBarItem.List>\n );\n\n const ServiceInfoComponent = (\n <ActionBarItem id='serviceInfo' className='myItem'>\n <ActionBarItem.Icon>\n <span className='icon rioglyph rioglyph-info-sign' />\n </ActionBarItem.Icon>\n <ActionBarItem.Popover className='myItemPopover' title={title}>\n <ServiceInfo />\n </ActionBarItem.Popover>\n </ActionBarItem>\n );\n\n const AccountMenuComponent = (\n <ActionBarItem>\n <ActionBarItem.Icon>\n <span className='icon rioglyph rioglyph-user' />\n </ActionBarItem.Icon>\n <ActionBarItem.Popover>\n <ActionBarItem.List>\n <div className='padding-10'>\n <div className='text-medium'>This is just an example</div>\n <div>The real content goes here...</div>\n </div>\n <ActionBarItem.ListSeparator />\n <ActionBarItem.ListItem>\n <Button\n bsStyle='default'\n variant='link'\n iconName='rioglyph-logout'\n onClick={() => Notification.info('Logout')}\n >\n <span className='hover-text-decoration-none'>Logout</span>\n </Button>\n </ActionBarItem.ListItem>\n </ActionBarItem.List>\n </ActionBarItem.Popover>\n </ActionBarItem>\n );\n\n const Notifications = (\n <ActionBarItem>\n <ActionBarItem.Icon>\n <span className='icon rioglyph rioglyph-notification' />\n <span className='badge badge-primary badge-indicator badge-indicator-pinging'>4</span>\n </ActionBarItem.Icon>\n </ActionBarItem>\n );\n\n return (\n <ApplicationLayout>\n <ApplicationLayout.Header>\n <ApplicationHeader\n label='ApplicationHeader'\n actionBarItems={[FeedbackComponent, ServiceInfoComponent, Notifications, AccountMenuComponent]}\n />\n </ApplicationLayout.Header>\n </ApplicationLayout>\n );\n};\n\nexport default ActionBarItemsExample;"
|
|
145
|
+
},
|
|
146
|
+
{
|
|
147
|
+
"label": "HTML",
|
|
148
|
+
"language": "html",
|
|
149
|
+
"code": "<div class=\"ApplicationLayout\">\n <div class=\"ApplicationLayoutHeader\" id=\"ApplicationLayoutHeader\">\n <nav class=\"ApplicationHeader user-select-none\">\n <div class=\"navbar-header\">\n <span class=\"navbar-brand home-icon\">\n </span>\n </div>\n <ul class=\"ModuleNavigation AppMenu user-select-none pointer-events-none\">\n <li class=\"dropdown\">\n <a class=\"ModuleNavigation-dropdown dropdown-toggle justify-content-between inactive\" role=\"button\" id=\"basic-nav-dropdown\">\n <span>ApplicationHeader</span>\n </a>\n </li>\n </ul>\n <ul class=\"SubmoduleNavigation nav\">\n </ul>\n <ul class=\"ApplicationActionBar nav navbar-nav navbar-right \">\n <li role=\"presentation\" class=\"navigationItem\">\n <div class=\"ActionBarItem\">\n <div class=\"ActionBarItemIcon\">\n <span class=\"icon rioglyph rioglyph-support\">\n </span>\n </div>\n </div>\n </li>\n <li role=\"presentation\" class=\"navigationItem\">\n <div class=\"ActionBarItem myItem\">\n <div class=\"ActionBarItemIcon\">\n <span class=\"icon rioglyph rioglyph-info-sign\">\n </span>\n </div>\n </div>\n </li>\n <li role=\"presentation\" class=\"navigationItem\">\n <div class=\"ActionBarItem\">\n <div class=\"ActionBarItemIcon\">\n <span class=\"icon rioglyph rioglyph-notification\">\n </span>\n <span class=\"badge badge-primary badge-indicator badge-indicator-pinging\">4</span>\n </div>\n </div>\n </li>\n <li role=\"presentation\" class=\"navigationItem\">\n <div class=\"ActionBarItem\">\n <div class=\"ActionBarItemIcon\">\n <span class=\"icon rioglyph rioglyph-user\">\n </span>\n </div>\n </div>\n </li>\n </ul>\n </nav>\n </div>\n</div>"
|
|
150
|
+
},
|
|
151
|
+
{
|
|
152
|
+
"label": "Props",
|
|
153
|
+
"language": "json",
|
|
154
|
+
"code": null,
|
|
155
|
+
"props": [
|
|
156
|
+
{
|
|
157
|
+
"heading": "ActionBarItem",
|
|
158
|
+
"rows": [
|
|
159
|
+
{
|
|
160
|
+
"name": "id",
|
|
161
|
+
"type": "String",
|
|
162
|
+
"default": "",
|
|
163
|
+
"description": "The id is used to identify the item in the DOM. If not provided, a random id is used instead."
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"name": "title",
|
|
167
|
+
"type": "String",
|
|
168
|
+
"default": "",
|
|
169
|
+
"description": "The title property for the sub component ActionBarItem.Popover. This can be a String or another component as well as a React-Intl component."
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
"name": "className",
|
|
173
|
+
"type": "String",
|
|
174
|
+
"default": "",
|
|
175
|
+
"description": "Additional class names that are added to the respective component. It can be defined for the parent and all sub components."
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
"name": "mobileDialogBodyClassName",
|
|
179
|
+
"type": "String",
|
|
180
|
+
"default": "",
|
|
181
|
+
"description": "Additional class names that are added to dialog fallback modal-body element."
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"name": "hidePopoverOnClick",
|
|
185
|
+
"type": "Boolean",
|
|
186
|
+
"default": "true",
|
|
187
|
+
"description": "Defined if the popover should close when any child element is being clicked."
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
"name": "popoverWidth",
|
|
191
|
+
"type": "Number",
|
|
192
|
+
"default": "250",
|
|
193
|
+
"description": "Possible values are: 100, 150, 200, 250, 300, 350, 400, 450 or 500"
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
"name": "useOffscreen",
|
|
197
|
+
"type": "Boolean",
|
|
198
|
+
"default": "",
|
|
199
|
+
"description": "Set on ActionBarItem.Popover in order to render the Popover content in the offscreen to have it in place and loaded when the Popover is shown. This flag ignored for mobile, in order to save energy."
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
"name": "children",
|
|
203
|
+
"type": "any",
|
|
204
|
+
"default": "",
|
|
205
|
+
"description": "Any component given to the sub components will be within the respective area. NoteChild elements for ActionItemBar.Icon such as rioglyph or svg icons that shall be shown as icon in the header must have set the class icon"
|
|
206
|
+
}
|
|
207
|
+
]
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
"heading": "ActionBarItem.List",
|
|
211
|
+
"rows": [
|
|
212
|
+
{
|
|
213
|
+
"name": "className",
|
|
214
|
+
"type": "String",
|
|
215
|
+
"default": "",
|
|
216
|
+
"description": "Additional class names that are added to the wrapping list item component."
|
|
217
|
+
}
|
|
218
|
+
]
|
|
219
|
+
},
|
|
220
|
+
{
|
|
221
|
+
"heading": "ActionBarItem.ListItem",
|
|
222
|
+
"rows": [
|
|
223
|
+
{
|
|
224
|
+
"name": "hasLink",
|
|
225
|
+
"type": "Boolean",
|
|
226
|
+
"default": "",
|
|
227
|
+
"description": "Set it to true when you want to use the item as link item. In case, please use the Link component from react-router-dom instead of an anchor tag to prevent side effects when automatically closing the popover."
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
"name": "icon",
|
|
231
|
+
"type": "String",
|
|
232
|
+
"default": "",
|
|
233
|
+
"description": "The name of the icon to be used for the item."
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
"name": "onClick",
|
|
237
|
+
"type": "Function",
|
|
238
|
+
"default": "",
|
|
239
|
+
"description": "Callback function to be triggered when the internal button of a list item is clicked. Note: When no callback function is provided, the children are rendered as is without wrapping them in a button."
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"name": "className",
|
|
243
|
+
"type": "String",
|
|
244
|
+
"default": "",
|
|
245
|
+
"description": "Additional class names that are added to the wrapping list item component."
|
|
246
|
+
}
|
|
247
|
+
]
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"heading": "ActionBarItem.ListSeparator",
|
|
251
|
+
"rows": [
|
|
252
|
+
{
|
|
253
|
+
"name": "className",
|
|
254
|
+
"type": "String",
|
|
255
|
+
"default": "",
|
|
256
|
+
"description": "Additional class names that are added to the wrapping list item component."
|
|
257
|
+
}
|
|
258
|
+
]
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
"heading": "ActionBarItem.Popover",
|
|
262
|
+
"rows": [
|
|
263
|
+
{
|
|
264
|
+
"name": "title",
|
|
265
|
+
"type": "String / Node",
|
|
266
|
+
"default": "",
|
|
267
|
+
"description": "The popover title."
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
"name": "useOffscreen",
|
|
271
|
+
"type": "Boolean",
|
|
272
|
+
"default": "false",
|
|
273
|
+
"description": "Define whether the popover content shall be rendered behind the scene to pre-load content or to avoid unmounting the content component"
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"name": "className",
|
|
277
|
+
"type": "String",
|
|
278
|
+
"default": "",
|
|
279
|
+
"description": "Additional class names that are added to the popover content."
|
|
280
|
+
}
|
|
281
|
+
]
|
|
282
|
+
}
|
|
283
|
+
]
|
|
284
|
+
}
|
|
285
|
+
]
|
|
286
|
+
}
|
|
287
|
+
]
|
|
288
|
+
}
|
|
289
|
+
],
|
|
290
|
+
"see_also": []
|
|
291
|
+
}
|