@cloudoperators/juno-ui-components 6.1.0 → 6.1.1

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.
Files changed (206) hide show
  1. package/build/components/AppBody/AppBody.component.d.ts +18 -8
  2. package/build/components/AppBody/AppBody.component.d.ts.map +1 -1
  3. package/build/components/AppBody/AppBody.stories.d.ts.map +1 -1
  4. package/build/components/AppShell/AppShell.component.d.ts +39 -15
  5. package/build/components/AppShell/AppShell.component.d.ts.map +1 -1
  6. package/build/components/AppShellProvider/AppShellProvider.component.d.ts +30 -9
  7. package/build/components/AppShellProvider/AppShellProvider.component.d.ts.map +1 -1
  8. package/build/components/Badge/Badge.component.d.ts +20 -17
  9. package/build/components/Badge/Badge.component.d.ts.map +1 -1
  10. package/build/components/Box/Box.component.d.ts +16 -10
  11. package/build/components/Box/Box.component.d.ts.map +1 -1
  12. package/build/components/Breadcrumb/Breadcrumb.component.d.ts +14 -12
  13. package/build/components/Breadcrumb/Breadcrumb.component.d.ts.map +1 -1
  14. package/build/components/Breadcrumb/Breadcrumb.stories.d.ts +1 -1
  15. package/build/components/BreadcrumbItem/BreadcrumbItem.component.d.ts +25 -15
  16. package/build/components/BreadcrumbItem/BreadcrumbItem.component.d.ts.map +1 -1
  17. package/build/components/BreadcrumbItem/BreadcrumbItem.stories.d.ts +1 -1
  18. package/build/components/Button/Button.component.d.ts +48 -16
  19. package/build/components/Button/Button.component.d.ts.map +1 -1
  20. package/build/components/ButtonRow/ButtonRow.component.d.ts +21 -7
  21. package/build/components/ButtonRow/ButtonRow.component.d.ts.map +1 -1
  22. package/build/components/Card/Card.component.d.ts +13 -7
  23. package/build/components/Card/Card.component.d.ts.map +1 -1
  24. package/build/components/Checkbox/Checkbox.component.d.ts +69 -21
  25. package/build/components/Checkbox/Checkbox.component.d.ts.map +1 -1
  26. package/build/components/CheckboxGroup/CheckboxGroup.component.d.ts +43 -16
  27. package/build/components/CheckboxGroup/CheckboxGroup.component.d.ts.map +1 -1
  28. package/build/components/Code/Code.component.d.ts +17 -6
  29. package/build/components/Code/Code.component.d.ts.map +1 -1
  30. package/build/components/CodeBlock/CodeBlock.component.d.ts +39 -13
  31. package/build/components/CodeBlock/CodeBlock.component.d.ts.map +1 -1
  32. package/build/components/ComboBox/ComboBox.component.d.ts +70 -33
  33. package/build/components/ComboBox/ComboBox.component.d.ts.map +1 -1
  34. package/build/components/ComboBoxOption/ComboBoxOption.component.d.ts +22 -8
  35. package/build/components/ComboBoxOption/ComboBoxOption.component.d.ts.map +1 -1
  36. package/build/components/Container/Container.component.d.ts +20 -8
  37. package/build/components/Container/Container.component.d.ts.map +1 -1
  38. package/build/components/ContentAreaToolbar/ContentAreaToolbar.component.d.ts +11 -8
  39. package/build/components/ContentAreaToolbar/ContentAreaToolbar.component.d.ts.map +1 -1
  40. package/build/components/ContentContainer/ContentContainer.component.d.ts +10 -11
  41. package/build/components/ContentContainer/ContentContainer.component.d.ts.map +1 -1
  42. package/build/components/ContentHeading/ContentHeading.component.d.ts +13 -11
  43. package/build/components/ContentHeading/ContentHeading.component.d.ts.map +1 -1
  44. package/build/components/DataGrid/DataGrid.component.d.ts +31 -20
  45. package/build/components/DataGrid/DataGrid.component.d.ts.map +1 -1
  46. package/build/components/DataGridCell/DataGridCell.component.d.ts +19 -7
  47. package/build/components/DataGridCell/DataGridCell.component.d.ts.map +1 -1
  48. package/build/components/DataGridCheckboxCell/DataGridCheckboxCell.component.d.ts +23 -8
  49. package/build/components/DataGridCheckboxCell/DataGridCheckboxCell.component.d.ts.map +1 -1
  50. package/build/components/DataGridFoot/DataGridFoot.component.d.ts +17 -6
  51. package/build/components/DataGridFoot/DataGridFoot.component.d.ts.map +1 -1
  52. package/build/components/DataGridHeadCell/DataGridHeadCell.component.d.ts +9 -3
  53. package/build/components/DataGridHeadCell/DataGridHeadCell.component.d.ts.map +1 -1
  54. package/build/components/DataGridRow/DataGridRow.component.d.ts +10 -4
  55. package/build/components/DataGridRow/DataGridRow.component.d.ts.map +1 -1
  56. package/build/components/DataGridToolbar/DataGridToolbar.component.d.ts +21 -9
  57. package/build/components/DataGridToolbar/DataGridToolbar.component.d.ts.map +1 -1
  58. package/build/components/DateTimePicker/DateTimePicker.component.d.ts +11 -6
  59. package/build/components/DateTimePicker/DateTimePicker.component.d.ts.map +1 -1
  60. package/build/components/Form/Form.component.d.ts +9 -4
  61. package/build/components/Form/Form.component.d.ts.map +1 -1
  62. package/build/components/FormHint/FormHint.component.d.ts +13 -4
  63. package/build/components/FormHint/FormHint.component.d.ts.map +1 -1
  64. package/build/components/FormRow/FormRow.component.d.ts +10 -6
  65. package/build/components/FormRow/FormRow.component.d.ts.map +1 -1
  66. package/build/components/FormSection/FormSection.component.d.ts +9 -4
  67. package/build/components/FormSection/FormSection.component.d.ts.map +1 -1
  68. package/build/components/FormattedText/FormattedText.component.d.ts +13 -6
  69. package/build/components/FormattedText/FormattedText.component.d.ts.map +1 -1
  70. package/build/components/Grid/Grid.component.d.ts +11 -6
  71. package/build/components/Grid/Grid.component.d.ts.map +1 -1
  72. package/build/components/GridColumn/GridColumn.component.d.ts +11 -5
  73. package/build/components/GridColumn/GridColumn.component.d.ts.map +1 -1
  74. package/build/components/GridRow/GridRow.component.d.ts +9 -6
  75. package/build/components/GridRow/GridRow.component.d.ts.map +1 -1
  76. package/build/components/HeaderContainer/HeaderContainer.component.d.ts +21 -6
  77. package/build/components/HeaderContainer/HeaderContainer.component.d.ts.map +1 -1
  78. package/build/components/Icon/Icon.component.d.ts +22 -3
  79. package/build/components/Icon/Icon.component.d.ts.map +1 -1
  80. package/build/components/InputGroup/InputGroup.component.d.ts +8 -4
  81. package/build/components/InputGroup/InputGroup.component.d.ts.map +1 -1
  82. package/build/components/IntroBox/IntroBox.component.d.ts +32 -13
  83. package/build/components/IntroBox/IntroBox.component.d.ts.map +1 -1
  84. package/build/components/JsonViewer/JsonViewer.component.d.ts +38 -11
  85. package/build/components/JsonViewer/JsonViewer.component.d.ts.map +1 -1
  86. package/build/components/Label/Label.component.d.ts +32 -10
  87. package/build/components/Label/Label.component.d.ts.map +1 -1
  88. package/build/components/LoadingIndicator/LoadingIndicator.component.d.ts +12 -8
  89. package/build/components/LoadingIndicator/LoadingIndicator.component.d.ts.map +1 -1
  90. package/build/components/MainContainer/MainContainer.component.d.ts +15 -7
  91. package/build/components/MainContainer/MainContainer.component.d.ts.map +1 -1
  92. package/build/components/MainContainerInner/MainContainerInner.component.d.ts +19 -8
  93. package/build/components/MainContainerInner/MainContainerInner.component.d.ts.map +1 -1
  94. package/build/components/MainTabs/MainTabs.component.d.ts +25 -11
  95. package/build/components/MainTabs/MainTabs.component.d.ts.map +1 -1
  96. package/build/components/Message/Message.component.d.ts +15 -8
  97. package/build/components/Message/Message.component.d.ts.map +1 -1
  98. package/build/components/Modal/Modal.component.d.ts +91 -42
  99. package/build/components/Modal/Modal.component.d.ts.map +1 -1
  100. package/build/components/ModalFooter/ModalFooter.component.d.ts +47 -21
  101. package/build/components/ModalFooter/ModalFooter.component.d.ts.map +1 -1
  102. package/build/components/NativeSelect/NativeSelect.component.d.ts +16 -6
  103. package/build/components/NativeSelect/NativeSelect.component.d.ts.map +1 -1
  104. package/build/components/NativeSelectOption/NativeSelectOption.component.d.ts +9 -5
  105. package/build/components/NativeSelectOption/NativeSelectOption.component.d.ts.map +1 -1
  106. package/build/components/NativeSelectOptionGroup/NativeSelectOptionGroup.component.d.ts +10 -6
  107. package/build/components/NativeSelectOptionGroup/NativeSelectOptionGroup.component.d.ts.map +1 -1
  108. package/build/components/Navigation/Navigation.component.d.ts +30 -10
  109. package/build/components/Navigation/Navigation.component.d.ts.map +1 -1
  110. package/build/components/NavigationItem/NavigationItem.component.d.ts +56 -17
  111. package/build/components/NavigationItem/NavigationItem.component.d.ts.map +1 -1
  112. package/build/components/PageFooter/PageFooter.component.d.ts +17 -11
  113. package/build/components/PageFooter/PageFooter.component.d.ts.map +1 -1
  114. package/build/components/PageFooter/PageFooter.stories.d.ts +1 -1
  115. package/build/components/PageHeader/PageHeader.component.d.ts +17 -12
  116. package/build/components/PageHeader/PageHeader.component.d.ts.map +1 -1
  117. package/build/components/Pagination/Pagination.component.d.ts +5 -3
  118. package/build/components/Pagination/Pagination.component.d.ts.map +1 -1
  119. package/build/components/Panel/Panel.component.d.ts +4 -2
  120. package/build/components/Panel/Panel.component.d.ts.map +1 -1
  121. package/build/components/PanelBody/PanelBody.component.d.ts +4 -2
  122. package/build/components/PanelBody/PanelBody.component.d.ts.map +1 -1
  123. package/build/components/PanelFooter/PanelFooter.component.d.ts +4 -2
  124. package/build/components/PanelFooter/PanelFooter.component.d.ts.map +1 -1
  125. package/build/components/Pill/Pill.component.d.ts +7 -5
  126. package/build/components/Pill/Pill.component.d.ts.map +1 -1
  127. package/build/components/PopupMenu/PopupMenu.component.d.ts +21 -17
  128. package/build/components/PopupMenu/PopupMenu.component.d.ts.map +1 -1
  129. package/build/components/PortalProvider/PortalProvider.Portal.component.d.ts +6 -3
  130. package/build/components/PortalProvider/PortalProvider.Portal.component.d.ts.map +1 -1
  131. package/build/components/PortalProvider/PortalProvider.component.d.ts +8 -3
  132. package/build/components/PortalProvider/PortalProvider.component.d.ts.map +1 -1
  133. package/build/components/Radio/Radio.component.d.ts +8 -4
  134. package/build/components/Radio/Radio.component.d.ts.map +1 -1
  135. package/build/components/RadioGroup/RadioGroup.component.d.ts +7 -5
  136. package/build/components/RadioGroup/RadioGroup.component.d.ts.map +1 -1
  137. package/build/components/SearchInput/SearchInput.component.d.ts +9 -7
  138. package/build/components/SearchInput/SearchInput.component.d.ts.map +1 -1
  139. package/build/components/SecretText/SecretText.component.d.ts +11 -7
  140. package/build/components/SecretText/SecretText.component.d.ts.map +1 -1
  141. package/build/components/Select/Select.component.d.ts +8 -6
  142. package/build/components/Select/Select.component.d.ts.map +1 -1
  143. package/build/components/SelectDivider/SelectDivider.component.d.ts +7 -3
  144. package/build/components/SelectDivider/SelectDivider.component.d.ts.map +1 -1
  145. package/build/components/SelectOption/SelectOption.component.d.ts +15 -3
  146. package/build/components/SelectOption/SelectOption.component.d.ts.map +1 -1
  147. package/build/components/ShadowRoot/ShadowRoot.component.d.ts +5 -3
  148. package/build/components/ShadowRoot/ShadowRoot.component.d.ts.map +1 -1
  149. package/build/components/SideNavigation/SideNavigation.component.d.ts +8 -6
  150. package/build/components/SideNavigation/SideNavigation.component.d.ts.map +1 -1
  151. package/build/components/SideNavigationGroup/SideNavigationGroup.component.d.ts +5 -2
  152. package/build/components/SideNavigationGroup/SideNavigationGroup.component.d.ts.map +1 -1
  153. package/build/components/SideNavigationItem/SideNavigationItem.component.d.ts +7 -4
  154. package/build/components/SideNavigationItem/SideNavigationItem.component.d.ts.map +1 -1
  155. package/build/components/SideNavigationList/SideNavigationList.component.d.ts +10 -2
  156. package/build/components/SideNavigationList/SideNavigationList.component.d.ts.map +1 -1
  157. package/build/components/SideNavigationList/SideNavigationList.stories.d.ts.map +1 -1
  158. package/build/components/SignInForm/SignInForm.component.d.ts +2 -2
  159. package/build/components/SignInForm/SignInForm.component.d.ts.map +1 -1
  160. package/build/components/SortButton/SortButton.component.d.ts +14 -3
  161. package/build/components/SortButton/SortButton.component.d.ts.map +1 -1
  162. package/build/components/SortButton/SortButton.stories.d.ts.map +1 -1
  163. package/build/components/Spinner/Spinner.component.d.ts +8 -5
  164. package/build/components/Spinner/Spinner.component.d.ts.map +1 -1
  165. package/build/components/Stack/Stack.component.d.ts +6 -4
  166. package/build/components/Stack/Stack.component.d.ts.map +1 -1
  167. package/build/components/StyleProvider/StyleProvider.component.d.ts +3 -0
  168. package/build/components/StyleProvider/StyleProvider.component.d.ts.map +1 -1
  169. package/build/components/Switch/Switch.component.d.ts +8 -5
  170. package/build/components/Switch/Switch.component.d.ts.map +1 -1
  171. package/build/components/Tab/Tab.component.d.ts +9 -8
  172. package/build/components/Tab/Tab.component.d.ts.map +1 -1
  173. package/build/components/TabList/TabList.component.d.ts +9 -5
  174. package/build/components/TabList/TabList.component.d.ts.map +1 -1
  175. package/build/components/TabNavigation/TabNavigation.component.d.ts +8 -4
  176. package/build/components/TabNavigation/TabNavigation.component.d.ts.map +1 -1
  177. package/build/components/TabNavigationItem/TabNavigationItem.component.d.ts +11 -7
  178. package/build/components/TabNavigationItem/TabNavigationItem.component.d.ts.map +1 -1
  179. package/build/components/TabPanel/TabPanel.component.d.ts +7 -5
  180. package/build/components/TabPanel/TabPanel.component.d.ts.map +1 -1
  181. package/build/components/Tabs/Tabs.component.d.ts +9 -7
  182. package/build/components/Tabs/Tabs.component.d.ts.map +1 -1
  183. package/build/components/TextInput/TextInput.component.d.ts +11 -9
  184. package/build/components/TextInput/TextInput.component.d.ts.map +1 -1
  185. package/build/components/Textarea/Textarea.component.d.ts +11 -9
  186. package/build/components/Textarea/Textarea.component.d.ts.map +1 -1
  187. package/build/components/ThemeToggle/ThemeToggle.component.d.ts +4 -2
  188. package/build/components/ThemeToggle/ThemeToggle.component.d.ts.map +1 -1
  189. package/build/components/Toast/Toast.component.d.ts +8 -6
  190. package/build/components/Toast/Toast.component.d.ts.map +1 -1
  191. package/build/components/ToggleButton/ToggleButton.component.d.ts +21 -0
  192. package/build/components/ToggleButton/ToggleButton.component.d.ts.map +1 -1
  193. package/build/components/ToggleButton/ToggleButton.stories.d.ts.map +1 -1
  194. package/build/components/Tooltip/Tooltip.component.d.ts +8 -5
  195. package/build/components/Tooltip/Tooltip.component.d.ts.map +1 -1
  196. package/build/components/TooltipContent/TooltipContent.component.d.ts +5 -3
  197. package/build/components/TooltipContent/TooltipContent.component.d.ts.map +1 -1
  198. package/build/components/TooltipTrigger/TooltipTrigger.component.d.ts +5 -3
  199. package/build/components/TooltipTrigger/TooltipTrigger.component.d.ts.map +1 -1
  200. package/build/components/TopNavigation/TopNavigation.component.d.ts +8 -6
  201. package/build/components/TopNavigation/TopNavigation.component.d.ts.map +1 -1
  202. package/build/components/TopNavigationItem/TopNavigationItem.component.d.ts +10 -8
  203. package/build/components/TopNavigationItem/TopNavigationItem.component.d.ts.map +1 -1
  204. package/build/components/withDeprecationWarning/withDeprecationWarning.component.d.ts.map +1 -1
  205. package/build/index.js +1802 -1795
  206. package/package.json +1 -1
@@ -1,13 +1,23 @@
1
- import { default as React } from 'react';
1
+ import { ReactNode, HTMLAttributes } from 'react';
2
2
  /**
3
- * Only needed if you want to build your app's scaffold manually. In most cases it is better to use the AppShell component instead.
4
- * Body of the app. Treat this like the body tag of an html page.
3
+ * The `AppBody` component serves as the main container for the body of your application.
4
+ * It is specifically useful when you require manual setup of the app's layout, providing
5
+ * flexibility and control over the structure of the application body. For most cases,
6
+ * consider using the `AppShell` component which encompasses more features suitable for
7
+ * typical application scaffolding.
8
+ * @see https://cloudoperators.github.io/juno/?path=/docs/internal-appbody--docs
9
+ * @see {@link AppBodyProps}
5
10
  */
6
- export declare const AppBody: React.FC<AppBodyProps>;
7
- export interface AppBodyProps extends React.HTMLAttributes<HTMLDivElement> {
8
- /** Add custom class name */
11
+ export declare const AppBody: ({ className, children, ...props }: AppBodyProps) => ReactNode;
12
+ export interface AppBodyProps extends HTMLAttributes<HTMLDivElement> {
13
+ /**
14
+ * Add custom class name to style the component.
15
+ * @default ""
16
+ */
9
17
  className?: string;
10
- /** Pass children nodes */
11
- children?: React.ReactNode;
18
+ /**
19
+ * The content to be rendered inside the AppBody component.
20
+ */
21
+ children?: ReactNode;
12
22
  }
13
23
  //# sourceMappingURL=AppBody.component.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"AppBody.component.d.ts","sourceRoot":"","sources":["../../../src/components/AppBody/AppBody.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,OAAO,CAAA;AAQzB;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,YAAY,CAM1C,CAAA;AAED,MAAM,WAAW,YAAa,SAAQ,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC;IACxE,4BAA4B;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B"}
1
+ {"version":3,"file":"AppBody.component.d.ts","sourceRoot":"","sources":["../../../src/components/AppBody/AppBody.component.tsx"],"names":[],"mappings":"AAKA,OAAc,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AAQxD;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,GAAI,mCAAwC,YAAY,KAAG,SAM9E,CAAA;AAED,MAAM,WAAW,YAAa,SAAQ,cAAc,CAAC,cAAc,CAAC;IAClE;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAA;CACrB"}
@@ -1 +1 @@
1
- {"version":3,"file":"AppBody.stories.d.ts","sourceRoot":"","sources":["../../../src/components/AppBody/AppBody.stories.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAE3D,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEpC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,OAAO,OAAO,CAQ9B,CAAA;AAED,eAAe,IAAI,CAAA;AACnB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAA;AAElC,eAAO,MAAM,IAAI,EAAE,KAUlB,CAAA"}
1
+ {"version":3,"file":"AppBody.stories.d.ts","sourceRoot":"","sources":["../../../src/components/AppBody/AppBody.stories.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAE3D,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEpC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,OAAO,OAAO,CAQ9B,CAAA;AAED,eAAe,IAAI,CAAA;AACnB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAA;AAElC,eAAO,MAAM,IAAI,EAAE,KAGlB,CAAA"}
@@ -1,25 +1,49 @@
1
- import { default as React, ReactNode } from 'react';
1
+ import { HTMLAttributes, ReactNode } from 'react';
2
2
  /**
3
- * Body of the app. Treat this like the body tag of an html page.
3
+ * The `AppShell` component provides the foundational layout structure for the application.
4
+ * It acts similarly to an HTML `body` element, organizing pages with headers, footers,
5
+ * navigation, and content areas. For simpler manual layout setup, consider using `AppBody`.
6
+ * @see https://cloudoperators.github.io/juno/?path=/docs/layout-appshell--docs
7
+ * @see {@link AppShellProps}
4
8
  */
5
- export declare const AppShell: React.FC<AppShellProps>;
6
- export interface AppShellProps extends React.HTMLAttributes<HTMLElement> {
7
- /** The main content of the app. */
9
+ export declare const AppShell: ({ children, className, embedded, pageHeader, pageFooter, fullWidthContent, sideNavigation, topNavigation, ...props }: AppShellProps) => ReactNode;
10
+ export interface AppShellProps extends HTMLAttributes<HTMLElement> {
11
+ /**
12
+ * The main content of the app.
13
+ */
8
14
  children?: ReactNode;
9
- /** Pass either the `<PageHeader>` component or if you don't need to add any content to the page header pass a string to be used as the app name in the standard page header. */
15
+ /**
16
+ * Add a custom class name to style the component.
17
+ * @default ""
18
+ */
19
+ className?: string;
20
+ /**
21
+ * Determines if the app should be rendered in embedded mode, reducing layout components to core content.
22
+ * @default false
23
+ */
24
+ embedded?: boolean;
25
+ /**
26
+ * Pass either a `<PageHeader>` component or a string to be used as the application name in the standard page header.
27
+ * @default `<PageHeader />`
28
+ */
10
29
  pageHeader?: ReactNode;
11
- /** Optional. If specified pass a `<PageFooter>` component. If undefined will use default PageFooter */
30
+ /**
31
+ * An optional `<PageFooter>` component if specified. Uses the default `<PageFooter />` if undefined.
32
+ * @default `<PageFooter />`
33
+ */
12
34
  pageFooter?: ReactNode;
13
- /** Optional. If specified expects a `<TopNavigation>` component. If undefined no top navigation is rendered. */
35
+ /**
36
+ * Optional `<TopNavigation>` component. Only rendered if provided.
37
+ */
14
38
  topNavigation?: ReactNode;
15
- /** Optional. If specified expects a `<SideNavigation>` component. If undefined no side navigation is rendered. */
39
+ /**
40
+ * Optional `<SideNavigation>` component. Only rendered if provided.
41
+ */
16
42
  sideNavigation?: ReactNode;
17
- /** Optional: Defaults to false. Set embedded to true if app is to be rendered embedded in another app/page.
18
- * In this case only the content area and children are rendered, a TopNavigation if passed, but no header/footer or remaining layout components */
19
- embedded?: boolean;
20
- /** Whether the main page / view content can spread over the full available width of the viewport or not. Default is `false` (resulting in a width-constrained, centred content column on very wide screens) UNLESS the AppShell is rendered with embedded as true, then the main content will be full-width by default. In embedded mode, `fullWidthContent` can still be passed as `false` explicitly. */
43
+ /**
44
+ * Indicates whether the main content should span the full viewport width.
45
+ * Defaults to `false` unless embedded, allowing content to occupy full width.
46
+ */
21
47
  fullWidthContent?: boolean;
22
- /** Add a custom class name */
23
- className?: string;
24
48
  }
25
49
  //# sourceMappingURL=AppShell.component.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"AppShell.component.d.ts","sourceRoot":"","sources":["../../../src/components/AppShell/AppShell.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AASxC;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC,aAAa,CA+C5C,CAAA;AAED,MAAM,WAAW,aAAc,SAAQ,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC;IACtE,mCAAmC;IACnC,QAAQ,CAAC,EAAE,SAAS,CAAA;IACpB,gLAAgL;IAChL,UAAU,CAAC,EAAE,SAAS,CAAA;IACtB,uGAAuG;IACvG,UAAU,CAAC,EAAE,SAAS,CAAA;IACtB,gHAAgH;IAChH,aAAa,CAAC,EAAE,SAAS,CAAA;IACzB,kHAAkH;IAClH,cAAc,CAAC,EAAE,SAAS,CAAA;IAC1B;sJACkJ;IAClJ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,2YAA2Y;IAC3Y,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}
1
+ {"version":3,"file":"AppShell.component.d.ts","sourceRoot":"","sources":["../../../src/components/AppShell/AppShell.component.tsx"],"names":[],"mappings":"AAKA,OAAc,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AASxD;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,GAAI,sHAUtB,aAAa,KAAG,SAqClB,CAAA;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc,CAAC,WAAW,CAAC;IAChE;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAA;IAEpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,SAAS,CAAA;IAEtB;;;OAGG;IACH,UAAU,CAAC,EAAE,SAAS,CAAA;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,CAAA;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,CAAA;IAE1B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B"}
@@ -1,21 +1,42 @@
1
- import { default as React } from 'react';
1
+ import { ReactNode } from 'react';
2
2
  /**
3
- * This provider acts as a wrapper for Juno apps. It renders a StyleProvider and PortalProvider
3
+ * The `AppShellProvider` component serves as a wrapper for Juno apps. It integrates both
4
+ * `StyleProvider` and `PortalProvider`, offering consistent theming and managing portals across the app.
5
+ * This provider can optionally render within a `ShadowRoot` to encapsulate styles independently.
6
+ * @see https://cloudoperators.github.io/juno/?path=/docs/layout-appshellprovider--docs
7
+ * @see {@link AppShellProviderProps}
4
8
  */
5
- export declare const AppShellProvider: React.FC<AppShellProviderProps>;
9
+ export declare const AppShellProvider: ({ shadowRoot, shadowRootMode, stylesWrapper, theme, children, }: AppShellProviderProps) => ReactNode;
6
10
  export type AppShellStyleWrapper = "head" | "inline";
7
11
  interface WrapperProps {
8
- /** React nodes or a collection of React nodes to be rendered as content. */
9
- children?: React.ReactNode;
10
- /** Whether the app is rendered inside a ShadowRoot. Only choose false if the app is meant to run as a stand-alone application. */
12
+ /**
13
+ * React nodes or a collection of React nodes to be rendered as content.
14
+ */
15
+ children?: ReactNode;
16
+ /**
17
+ * Determines whether the app is rendered inside a `ShadowRoot`.
18
+ * Only set to `false` if the app runs as a standalone application.
19
+ * @default true
20
+ */
11
21
  shadowRoot?: boolean;
12
- /** Shadow root mode */
22
+ /**
23
+ * Specifies the mode of the `ShadowRoot`.
24
+ * @default "open"
25
+ */
13
26
  shadowRootMode?: ShadowRootMode;
14
27
  }
15
28
  export interface AppShellProviderProps extends WrapperProps {
16
- /** Where app stylesheets are imported. This is only relevant if shadowRoot === false. If you use a ShadowRoot the styles must be inline. */
29
+ /**
30
+ * Specifies where app stylesheets are imported.
31
+ * This is relevant only if `shadowRoot` is `false`. Must be `"inline"` if using a `ShadowRoot`.
32
+ * @default "inline"
33
+ */
17
34
  stylesWrapper?: AppShellStyleWrapper;
18
- /** theme: theme-dark or theme-light */
35
+ /**
36
+ * Determines the theme of the application, choosing between `"theme-dark"` or `"theme-light"`.
37
+ * Defaults to the global default theme name.
38
+ * @default DEFAULT_THEME_NAME
39
+ */
19
40
  theme?: "theme-dark" | "theme-light";
20
41
  }
21
42
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"AppShellProvider.component.d.ts","sourceRoot":"","sources":["../../../src/components/AppShellProvider/AppShellProvider.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,OAAO,CAAA;AAiBzB;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,KAAK,CAAC,EAAE,CAAC,qBAAqB,CAc5D,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,QAAQ,CAAA;AAEpD,UAAU,YAAY;IACpB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B,kIAAkI;IAClI,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,uBAAuB;IACvB,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,4IAA4I;IAC5I,aAAa,CAAC,EAAE,oBAAoB,CAAA;IACpC,uCAAuC;IACvC,KAAK,CAAC,EAAE,YAAY,GAAG,aAAa,CAAA;CACrC"}
1
+ {"version":3,"file":"AppShellProvider.component.d.ts","sourceRoot":"","sources":["../../../src/components/AppShellProvider/AppShellProvider.component.tsx"],"names":[],"mappings":"AAKA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAiBxC;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAAI,iEAM9B,qBAAqB,KAAG,SAQ1B,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,QAAQ,CAAA;AAEpD,UAAU,YAAY;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAA;IAEpB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD;;;;OAIG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAA;IAEpC;;;;OAIG;IACH,KAAK,CAAC,EAAE,YAAY,GAAG,aAAa,CAAA;CACrC"}
@@ -1,37 +1,40 @@
1
- import { default as React } from 'react';
1
+ import { HTMLAttributes, ReactNode } from 'react';
2
2
  import { KnownIcons } from '../Icon/Icon.component';
3
3
  export type BadgeVariantType = "default" | "info" | "success" | "warning" | "danger" | "error";
4
- export interface BadgeProps extends React.HTMLAttributes<HTMLSpanElement> {
4
+ export interface BadgeProps extends HTMLAttributes<HTMLSpanElement> {
5
5
  /**
6
- * Specify an optional semantic variant that determines the appearance of a badge.
6
+ * Specify a semantic variant that determines the appearance of the badge.
7
+ * @default "default"
7
8
  */
8
9
  variant?: BadgeVariantType;
9
10
  /**
10
- * Optional.
11
- * If true, an icon corresponding to the variant will be displayed.
12
- * If a string is provided and it's a valid icon name, that icon will be displayed.
11
+ * Determines whether to display an icon. If set to `true`, an icon related
12
+ * to the variant will be used. If a valid string representing a known icon
13
+ * is provided, that icon will be displayed.
14
+ * @default false
13
15
  */
14
16
  icon?: boolean | KnownIcons;
15
17
  /**
16
- * Pass an optional string of text to be rendered as content.
17
- * Alternatively, content can be passed as children (see below).
18
- * If children are provided, they will take precedence.
18
+ * The optional text content of the badge. If children are provided, they take precedence.
19
19
  */
20
20
  text?: string;
21
21
  /**
22
- * Pass an optional CSS class to apply to the message.
22
+ * Additional CSS class to apply to the badge.
23
+ * @default ""
23
24
  */
24
25
  className?: string;
25
26
  /**
26
- * Pass optional React nodes or a collection of React nodes to be rendered as content.
27
- * Takes precedence over the text property.
27
+ * React nodes or a collection of React nodes to be rendered as content, taking
28
+ * precedence over the `text` property.
28
29
  */
29
- children?: React.ReactNode;
30
+ children?: ReactNode;
30
31
  }
31
32
  /**
32
- * A Badge is used to visually represent properties or states of an entity.
33
- * It supports multiple semantic versions, each with distinct styling.
34
- * Optionally, an icon can be included to further emphasize the meaning.
33
+ * The `Badge` component visually represents properties or states of an entity.
34
+ * It supports multiple semantic variants, each with distinct styling. An optional
35
+ * icon can be included to further emphasize meaning.
36
+ * @see https://cloudoperators.github.io/juno/?path=/docs/components-badge--docs
37
+ * @see {@link BadgeProps}
35
38
  */
36
- export declare const Badge: React.FC<BadgeProps>;
39
+ export declare const Badge: ({ variant, icon, text, className, children, ...props }: BadgeProps) => ReactNode;
37
40
  //# sourceMappingURL=Badge.component.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Badge.component.d.ts","sourceRoot":"","sources":["../../../src/components/Badge/Badge.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAQ,UAAU,EAAkB,MAAM,wBAAwB,CAAA;AAuBzE,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAA;AAE9F,MAAM,WAAW,UAAW,SAAQ,KAAK,CAAC,cAAc,CAAC,eAAe,CAAC;IACvE;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAE1B;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,CAAA;IAE3B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B;AAuBD;;;;GAIG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,UAAU,CA0BtC,CAAA"}
1
+ {"version":3,"file":"Badge.component.d.ts","sourceRoot":"","sources":["../../../src/components/Badge/Badge.component.tsx"],"names":[],"mappings":"AAKA,OAAc,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACxD,OAAO,EAAQ,UAAU,EAAkB,MAAM,wBAAwB,CAAA;AAwBzE,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAA;AAE9F,MAAM,WAAW,UAAW,SAAQ,cAAc,CAAC,eAAe,CAAC;IACjE;;;OAGG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAE1B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,CAAA;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAA;CACrB;AAuBD;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,GAAI,wDAOnB,UAAU,KAAG,SAkBf,CAAA"}
@@ -1,22 +1,28 @@
1
- import { default as React } from 'react';
2
- export interface BoxProps extends React.HTMLAttributes<HTMLDivElement> {
1
+ import { HTMLAttributes, ReactNode } from 'react';
2
+ export interface BoxProps extends HTMLAttributes<HTMLDivElement> {
3
3
  /**
4
- * Child elements to be rendered inside the Box.
4
+ * The child elements to be rendered inside the Box.
5
5
  */
6
- children?: React.ReactNode;
6
+ children?: ReactNode;
7
7
  /**
8
- * If true, padding is removed.
8
+ * Determines whether the Box should render without padding.
9
+ * When true, padding is removed.
10
+ * @default false
9
11
  */
10
12
  unpad?: boolean;
11
13
  /**
12
- * Additional CSS styles to apply to the Box.
14
+ * Additional CSS classes to apply to the Box component.
15
+ * @default ""
13
16
  */
14
17
  className?: string;
15
18
  }
16
19
  /**
17
- * A generic Box component with optional padding and a light border.
18
- * Ideal for annotations, additional explanations, and remarks where a Message or InfoBox would be too visually emphasized.
19
- * Typically used for small text but can contain any child elements, as required.
20
+ * The `Box` component is a versatile container with optional padding and a subtle border.
21
+ * It is perfect for annotations, supplementary explanations, and remarks where more visually
22
+ * pronounced components like a MessageBox or InfoBox would be excessive.
23
+ * This component typically displays small text but can contain any child elements as required.
24
+ * @see https://cloudoperators.github.io/juno/?path=/docs/components-box--docs
25
+ * @see {@link BoxProps}
20
26
  */
21
- export declare const Box: React.FC<BoxProps>;
27
+ export declare const Box: ({ children, unpad, className, ...props }: BoxProps) => ReactNode;
22
28
  //# sourceMappingURL=Box.component.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Box.component.d.ts","sourceRoot":"","sources":["../../../src/components/Box/Box.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,OAAO,CAAA;AAgBzB,MAAM,WAAW,QAAS,SAAQ,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC;IACpE;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;;GAIG;AACH,eAAO,MAAM,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,QAAQ,CAOlC,CAAA"}
1
+ {"version":3,"file":"Box.component.d.ts","sourceRoot":"","sources":["../../../src/components/Box/Box.component.tsx"],"names":[],"mappings":"AAKA,OAAc,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAgBxD,MAAM,WAAW,QAAS,SAAQ,cAAc,CAAC,cAAc,CAAC;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAA;IAEpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,GAAI,0CAAuD,QAAQ,KAAG,SAOrF,CAAA"}
@@ -1,22 +1,24 @@
1
- import { default as React } from 'react';
2
- export interface BreadcrumbProps extends React.HTMLAttributes<HTMLElement> {
1
+ import { HTMLAttributes, ReactNode } from 'react';
2
+ export interface BreadcrumbProps extends HTMLAttributes<HTMLElement> {
3
3
  /**
4
- * Additional CSS styles to apply to the breadcrumb for custom styling.
4
+ * Additional CSS classes for styling the breadcrumb component.
5
+ * @default ""
5
6
  */
6
7
  className?: string;
7
8
  /**
8
9
  * Optional React nodes or a collection of React nodes to be rendered as custom content.
9
- * The BreadcrumbItem component is typically used.
10
+ * The `BreadcrumbItem` component is typically used.
10
11
  */
11
- children?: React.ReactNode;
12
+ children?: ReactNode;
12
13
  }
13
14
  /**
14
- * Breadcrumb is a component that structures navigational links in a breadcrumb trail.
15
- *
16
- * This component:
17
- * - Wraps around BreadcrumbItem or other custom components to create breadcrumb navigation.
18
- * - Automatically inserts separator icons between items.
19
- * - Filters out invalid React elements to prevent rendering errors.
15
+ * The `Breadcrumb` component structures navigational links in a breadcrumb trail, providing a way to display
16
+ * hierarchical navigation paths. It efficiently manages:
17
+ * - Wrapping `BreadcrumbItem` or other custom components to form breadcrumb navigation.
18
+ * - Automatic insertion of separator icons between items, enhancing visibility.
19
+ * - Filtering out invalid React elements to prevent rendering errors.
20
+ * @see https://cloudoperators.github.io/juno/?path=/docs/components-breadcrumb-breadcrumb--docs
21
+ * @see {@link BreadcrumbProps}
20
22
  */
21
- export declare const Breadcrumb: React.FC<BreadcrumbProps>;
23
+ export declare const Breadcrumb: ({ children, className, ...props }: BreadcrumbProps) => ReactNode;
22
24
  //# sourceMappingURL=Breadcrumb.component.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Breadcrumb.component.d.ts","sourceRoot":"","sources":["../../../src/components/Breadcrumb/Breadcrumb.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAiC,MAAM,OAAO,CAAA;AAMrD,MAAM,WAAW,eAAgB,SAAQ,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC;IACxE;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CAgBhD,CAAA"}
1
+ {"version":3,"file":"Breadcrumb.component.d.ts","sourceRoot":"","sources":["../../../src/components/Breadcrumb/Breadcrumb.component.tsx"],"names":[],"mappings":"AAKA,OAAc,EAAsB,cAAc,EAAgC,SAAS,EAAE,MAAM,OAAO,CAAA;AAM1G,MAAM,WAAW,eAAgB,SAAQ,cAAc,CAAC,WAAW,CAAC;IAClE;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAA;CACrB;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,GAAI,mCAAwC,eAAe,KAAG,SAgBpF,CAAA"}
@@ -2,7 +2,7 @@ import { default as React } from 'react';
2
2
  import { BreadcrumbProps } from './Breadcrumb.component';
3
3
  declare const _default: {
4
4
  title: string;
5
- component: React.FC<BreadcrumbProps>;
5
+ component: ({ children, className, ...props }: BreadcrumbProps) => React.ReactNode;
6
6
  argTypes: {
7
7
  children: {
8
8
  control: boolean;
@@ -1,45 +1,55 @@
1
- import { default as React } from 'react';
1
+ import { ReactNode, HTMLAttributes, MouseEventHandler } from 'react';
2
2
  import { KnownIcons } from '../Icon/Icon.component';
3
- export interface BreadcrumbItemProps extends React.HTMLAttributes<HTMLSpanElement> {
3
+ export interface BreadcrumbItemProps extends HTMLAttributes<HTMLSpanElement> {
4
4
  /**
5
- * The icon type to display in the breadcrumb item.
5
+ * The type of icon to display within the breadcrumb item.
6
6
  */
7
7
  icon?: KnownIcons;
8
8
  /**
9
- * A URL the breadcrumb item points to for navigation.
9
+ * The URL that the breadcrumb item points to for navigation.
10
+ * @default "#"
10
11
  */
11
12
  href?: string;
12
13
  /**
13
- * The text to display inside the breadcrumb item.
14
+ * The text to display within the breadcrumb item.
15
+ * @default "Item"
14
16
  */
15
17
  label?: string;
16
18
  /**
17
- * The value for the aria-label attribute, used to improve accessibility.
19
+ * The value for the `aria-label` attribute, enhancing accessibility by providing a textual description.
18
20
  */
19
21
  ariaLabel?: string;
20
22
  /**
21
- * Determines if this item is the last or currently active breadcrumb.
23
+ * Specifies whether this item is the last or currently active breadcrumb.
24
+ * @default false
22
25
  */
23
26
  active?: boolean;
24
27
  /**
25
- * The click event handler for the breadcrumb item.
28
+ * The click event handler for the breadcrumb item, called when the item is clicked.
26
29
  */
27
- onClick?: React.MouseEventHandler<HTMLAnchorElement>;
30
+ onClick?: MouseEventHandler<HTMLAnchorElement>;
28
31
  /**
29
- * If true, disables the breadcrumb item.
32
+ * If `true`, disables the breadcrumb item, preventing interaction.
33
+ * @default false
30
34
  */
31
35
  disabled?: boolean;
32
36
  /**
33
- * Additional CSS class names to apply to the breadcrumb item for custom styling.
37
+ * Additional CSS class names to apply for custom styling of the breadcrumb item.
38
+ * @default ""
34
39
  */
35
40
  className?: string;
36
41
  /**
37
- * Custom content to render within the breadcrumb item, replacing the default content.
42
+ * Custom content to be rendered inside the breadcrumb item, replacing default content.
43
+ * This takes precedence over other content.
38
44
  */
39
- children?: React.ReactNode;
45
+ children?: ReactNode;
40
46
  }
41
47
  /**
42
- * BreadcrumbItem represents an individual item within a Breadcrumb component.
48
+ * The `BreadcrumbItem` component represents an individual item within a Breadcrumb component.
49
+ * It can render as either a static label or a navigable link, depending on the `active`
50
+ * and `disabled` states. It supports custom icons, labels, and click functionality.
51
+ * @see https://cloudoperators.github.io/juno/?path=/docs/components-breadcrumb-breadcrumbitem--docs
52
+ * @see {@link BreadcrumbItemProps}
43
53
  */
44
- export declare const BreadcrumbItem: React.FC<BreadcrumbItemProps>;
54
+ export declare const BreadcrumbItem: ({ href, label, ariaLabel, active, children, disabled, onClick, className, icon, ...props }: BreadcrumbItemProps) => ReactNode;
45
55
  //# sourceMappingURL=BreadcrumbItem.component.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"BreadcrumbItem.component.d.ts","sourceRoot":"","sources":["../../../src/components/BreadcrumbItem/BreadcrumbItem.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAQ,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAezD,MAAM,WAAW,mBAAoB,SAAQ,KAAK,CAAC,cAAc,CAAC,eAAe,CAAC;IAChF;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAA;IACpD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,mBAAmB,CA6CxD,CAAA"}
1
+ {"version":3,"file":"BreadcrumbItem.component.d.ts","sourceRoot":"","sources":["../../../src/components/BreadcrumbItem/BreadcrumbItem.component.tsx"],"names":[],"mappings":"AAKA,OAAc,EAAE,SAAS,EAAc,cAAc,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAA;AACvF,OAAO,EAAQ,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAezD,MAAM,WAAW,mBAAoB,SAAQ,cAAc,CAAC,eAAe,CAAC;IAC1E;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,CAAA;IAE9C;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAA;CACrB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,4FAW5B,mBAAmB,KAAG,SAmCxB,CAAA"}
@@ -2,7 +2,7 @@ import { default as React } from 'react';
2
2
  import { BreadcrumbItemProps } from './BreadcrumbItem.component';
3
3
  declare const _default: {
4
4
  title: string;
5
- component: React.FC<BreadcrumbItemProps>;
5
+ component: ({ href, label, ariaLabel, active, children, disabled, onClick, className, icon, ...props }: BreadcrumbItemProps) => React.ReactNode;
6
6
  argTypes: {
7
7
  icon: {
8
8
  options: string[];
@@ -1,34 +1,66 @@
1
- import { default as React } from 'react';
1
+ import { default as React, HTMLProps, MouseEventHandler, ReactNode } from 'react';
2
2
  import { KnownIcons } from '../Icon/Icon.component';
3
3
  /**
4
- * The basic button component. Use this for `onClick` interactions.
4
+ * The `Button` component provides an interactive element for user actions, supporting various sizes,
5
+ * styles, and states such as disabled or in-progress.
6
+ * @see https://cloudoperators.github.io/juno/?path=/docs/components-button--docs
7
+ * @see {@link ButtonProps}
5
8
  */
6
9
  export declare const Button: React.ForwardRefExoticComponent<Omit<ButtonProps, "ref"> & React.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
7
10
  type ButtonVariant = "primary" | "primary-danger" | "default" | "subdued";
8
11
  type ButtonSize = "small" | "default";
9
- export interface ButtonProps extends Omit<React.HTMLProps<HTMLAnchorElement> | React.HTMLProps<HTMLButtonElement>, "size"> {
10
- children?: React.ReactNode;
11
- /** Choose a variant for your purpose. May leave empty to get default button. */
12
+ export interface ButtonProps extends Omit<HTMLProps<HTMLAnchorElement> | HTMLProps<HTMLButtonElement>, "size"> {
13
+ /**
14
+ * Child elements or text to be rendered inside the button.
15
+ */
16
+ children?: ReactNode;
17
+ /**
18
+ * Choose a variant for your button style. Defaults to "default" if unspecified.
19
+ * @default "default"
20
+ */
12
21
  variant?: ButtonVariant;
13
- /** Leave empty for default size */
22
+ /**
23
+ * Chooses the button size. Defaults to "default" if unspecified.
24
+ * @default "default"
25
+ */
14
26
  size?: ButtonSize;
15
- /** Whether the button is disabled */
27
+ /**
28
+ * Indicates if the button is disabled.
29
+ */
16
30
  disabled?: boolean;
17
- /** Optionally specify an href. This will turn the Button into an <a> element */
31
+ /**
32
+ * Optionally specify an href. This renders the Button as an `<a>` element.
33
+ */
18
34
  href?: string;
19
- /** Button label can be passed like this or as children */
35
+ /**
36
+ * Button label can be passed directly or as children.
37
+ */
20
38
  label?: string;
21
- /** Specify title for accessibility. Gets value of label if no title specified */
39
+ /**
40
+ * Specify a title for accessibility purposes. Defaults to the label if not specified.
41
+ */
22
42
  title?: string;
23
- /** Pass the name of an icon the button should show. Can be any icon included with Juno. */
43
+ /**
44
+ * Pass the name of an icon that the button should display. Can be any icon included with Juno.
45
+ */
24
46
  icon?: KnownIcons;
25
- /** Pass a className */
47
+ /**
48
+ * Additional class names for styling.
49
+ * @default ""
50
+ */
26
51
  className?: string;
27
- /** Click handler */
28
- onClick?: React.MouseEventHandler<HTMLButtonElement | HTMLAnchorElement>;
29
- /** Whether the button action is in progress */
52
+ /**
53
+ * Click event handler for the button.
54
+ */
55
+ onClick?: MouseEventHandler<HTMLButtonElement | HTMLAnchorElement>;
56
+ /**
57
+ * Indicates whether the button's action is in progress.
58
+ * @default false
59
+ */
30
60
  progress?: boolean;
31
- /** Display an alternative label while the button action is in progress */
61
+ /**
62
+ * Display an alternative label while the button's action is in progress.
63
+ */
32
64
  progressLabel?: string;
33
65
  }
34
66
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"Button.component.d.ts","sourceRoot":"","sources":["../../../src/components/Button/Button.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAoB,MAAM,OAAO,CAAA;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAsJnD;;GAEG;AACH,eAAO,MAAM,MAAM,wHA0FlB,CAAA;AAID,KAAK,aAAa,GAAG,SAAS,GAAG,gBAAgB,GAAG,SAAS,GAAG,SAAS,CAAA;AACzE,KAAK,UAAU,GAAG,OAAO,GAAG,SAAS,CAAA;AAErC,MAAM,WAAW,WACf,SAAQ,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC7F,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B,gFAAgF;IAChF,OAAO,CAAC,EAAE,aAAa,CAAA;IACvB,mCAAmC;IACnC,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,gFAAgF;IAChF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iFAAiF;IACjF,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,2FAA2F;IAC3F,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,uBAAuB;IACvB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,qBAAqB;IACrB,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,iBAAiB,GAAG,iBAAiB,CAAC,CAAA;IACxE,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,0EAA0E;IAC1E,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB"}
1
+ {"version":3,"file":"Button.component.d.ts","sourceRoot":"","sources":["../../../src/components/Button/Button.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,EAAc,SAAS,EAAa,iBAAiB,EAAE,SAAS,EAAc,MAAM,OAAO,CAAA;AAEzG,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAsJnD;;;;;GAKG;AACH,eAAO,MAAM,MAAM,wHA0FlB,CAAA;AAID,KAAK,aAAa,GAAG,SAAS,GAAG,gBAAgB,GAAG,SAAS,GAAG,SAAS,CAAA;AACzE,KAAK,UAAU,GAAG,OAAO,GAAG,SAAS,CAAA;AAErC,MAAM,WAAW,WAAY,SAAQ,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC5G;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAA;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,aAAa,CAAA;IAEvB;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC,iBAAiB,GAAG,iBAAiB,CAAC,CAAA;IAElE;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB"}
@@ -1,10 +1,24 @@
1
- import { default as React } from 'react';
2
- /** A container to hold one or multiple buttons and space and align them. */
3
- export declare const ButtonRow: React.FC<ButtonRowProps>;
4
- export interface ButtonRowProps extends React.HTMLAttributes<HTMLElement> {
5
- /** Add a class to the ButtonRow */
1
+ import { HTMLAttributes, ReactNode } from 'react';
2
+ /**
3
+ * The `ButtonRow` component is designed to contain one or several buttons,
4
+ * providing them with structured spacing and alignment. It uses the `Stack`
5
+ * component for consistent gap management and alignment, ensuring that
6
+ * button elements are neatly organized within a row. This is particularly
7
+ * useful in dialogs, forms, or any interface requiring a uniform presentation
8
+ * for multiple actions.
9
+ * @see https://cloudoperators.github.io/juno/?path=/docs/forms-buttonrow--docs
10
+ * @see {@link ButtonRowProps}
11
+ */
12
+ export declare const ButtonRow: ({ children, className, ...props }: ButtonRowProps) => ReactNode;
13
+ export interface ButtonRowProps extends HTMLAttributes<HTMLElement> {
14
+ /**
15
+ * Add a class to the ButtonRow for additional styling.
16
+ * @default ""
17
+ */
6
18
  className?: string;
7
- /** Children to render in the ButtonRow */
8
- children?: React.ReactNode;
19
+ /**
20
+ * Children to render within the ButtonRow.
21
+ */
22
+ children?: ReactNode;
9
23
  }
10
24
  //# sourceMappingURL=ButtonRow.component.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ButtonRow.component.d.ts","sourceRoot":"","sources":["../../../src/components/ButtonRow/ButtonRow.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,4EAA4E;AAC5E,eAAO,MAAM,SAAS,EAAE,KAAK,CAAC,EAAE,CAAC,cAAc,CAM9C,CAAA;AAED,MAAM,WAAW,cAAe,SAAQ,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC;IACvE,mCAAmC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B"}
1
+ {"version":3,"file":"ButtonRow.component.d.ts","sourceRoot":"","sources":["../../../src/components/ButtonRow/ButtonRow.component.tsx"],"names":[],"mappings":"AAKA,OAAc,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAGxD;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,GAAI,mCAAwC,cAAc,KAAG,SAMlF,CAAA;AACD,MAAM,WAAW,cAAe,SAAQ,cAAc,CAAC,WAAW,CAAC;IACjE;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAA;CACrB"}
@@ -1,20 +1,26 @@
1
- import { default as React } from 'react';
2
- export interface CardProps extends React.HTMLAttributes<HTMLDivElement> {
1
+ import { HTMLAttributes, ReactNode } from 'react';
2
+ export interface CardProps extends HTMLAttributes<HTMLDivElement> {
3
3
  /**
4
4
  * Components or elements to be rendered as content.
5
5
  */
6
- children?: React.ReactNode;
6
+ children?: ReactNode;
7
7
  /**
8
- * Optional padding.
8
+ * Optional padding for the Card component.
9
+ * @default false
9
10
  */
10
11
  padding?: boolean;
11
12
  /**
12
- * Additional CSS styles.
13
+ * Additional CSS styles to apply.
14
+ * @default ""
13
15
  */
14
16
  className?: string;
15
17
  }
16
18
  /**
17
- * A generic Card component with optional padding.
19
+ * The `Card` component acts as a versatile container for various types of content, providing
20
+ * an optional padding feature for additional layout flexibility. It is commonly used for
21
+ * displaying information or grouping elements, allowing for consistent styling and shadow effects.
22
+ * @see https://cloudoperators.github.io/juno/?path=/docs/components-card--docs
23
+ * @see {@link CardProps}
18
24
  */
19
- export declare const Card: React.FC<CardProps>;
25
+ export declare const Card: ({ children, padding, className, ...props }: CardProps) => ReactNode;
20
26
  //# sourceMappingURL=Card.component.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Card.component.d.ts","sourceRoot":"","sources":["../../../src/components/Card/Card.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,OAAO,CAAA;AAazB,MAAM,WAAW,SAAU,SAAQ,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC;IACrE;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,SAAS,CAOpC,CAAA"}
1
+ {"version":3,"file":"Card.component.d.ts","sourceRoot":"","sources":["../../../src/components/Card/Card.component.tsx"],"names":[],"mappings":"AAKA,OAAc,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAaxD,MAAM,WAAW,SAAU,SAAQ,cAAc,CAAC,cAAc,CAAC;IAC/D;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAA;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,IAAI,GAAI,4CAAyD,SAAS,KAAG,SAOzF,CAAA"}