@iress-oss/ids-mcp-server 5.15.0 → 5.20.1

package/generated/docs/{components-panel-docs.md → components_components-panel-docs.md}

@@ -1,30 +1,112 @@
-[](#panel)Panel
-===============
+Panel
+=====
 
 Overview
 --------
 
 A panel is used to group related content.
 
-His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.
+[](./iframe.html?id=components-panel--default)
 
-Hide code
+His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.
 
-\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
+```
 
 <IressPanel\>
   His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.
 </IressPanel\>
 
-Copy
+```
+
+Props
+-----
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| background | 
+Panel background - controls the background style (set via the theme).
+
+union
+
+
+
+ | 
+
+'default'
+
+ | Set object |
+| children | 
+
+Content to be grouped using a panel.
+
+ReactNode
+
+
+
+ | \- | Choose option...nonetextparagraphsstory |
+| noBorderRadius | 
+
+Setting to true will ignore the border radius set in the theme and set it to zero.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| noGutter | 
+
+Removes bottom margin from last child of the panel element if true.
+
+boolean
+
+
 
-[](#examples)Examples
----------------------
+ | \- | Set boolean |
+| padding | 
 
-### [](#background)Background
+Padding of the panel.
+
+union
+
+
+
+ | 
+
+'md'
+
+ | Set object |
+| stretch | 
+
+If `true`, the panel background will fill the height of the container.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| textAlign | 
+
+Text alignment for panel.
+
+union
+
+
+
+ | 
+
+'inherit'
+
+ | Set object |
+
+Examples
+--------
+
+### Background
 
 The `background` prop allows you to vary the styling of the panel component. It has four variants.
 
+[](./iframe.html?id=components-panel--background)
+
 default
 -------
 
@@ -45,9 +127,7 @@ transparent
 
 His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.
 
-Hide code
-
-\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
+```
 
 <IressStack gutter\="md"\>
   <IressPanel background\="default"\>
@@ -68,12 +148,93 @@ Hide code
     His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.  </IressPanel\>
 </IressStack\>
 
-Copy
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| background | 
+Panel background - controls the background style (set via the theme).
 
-### [](#padding)Padding
+union
+
+
+
+ | 
+
+'default'
+
+ | \- |
+| children | 
+
+Content to be grouped using a panel.
+
+ReactNode
+
+
+
+ | \- | Choose option...nonetextparagraphsstory |
+| noBorderRadius | 
+
+Setting to true will ignore the border radius set in the theme and set it to zero.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| noGutter | 
+
+Removes bottom margin from last child of the panel element if true.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| padding | 
+
+Padding of the panel.
+
+union
+
+
+
+ | 
+
+'md'
+
+ | Set object |
+| stretch | 
+
+If `true`, the panel background will fill the height of the container.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| textAlign | 
+
+Text alignment for panel.
+
+union
+
+
+
+ | 
+
+'inherit'
+
+ | Set object |
+
+### Padding
 
 Panel padding can be set using the `padding` prop. It can be set to `none`, `sm`, `md` or `lg`. Its default value is `md`.
 
+[](./iframe.html?id=components-panel--padding)
+
 none
 ----
 
@@ -94,9 +255,7 @@ lg
 
 His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.
 
-Hide code
-
-\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
+```
 
 <IressStack gutter\="md"\>
   <IressPanel padding\="none"\>
@@ -117,12 +276,93 @@ Hide code
     His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.  </IressPanel\>
 </IressStack\>
 
-Copy
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| background | 
+Panel background - controls the background style (set via the theme).
+
+union
+
+
+
+ | 
+
+'default'
 
-### [](#responsive-padding)Responsive padding
+ | Set object |
+| children | 
+
+Content to be grouped using a panel.
+
+ReactNode
+
+
+
+ | \- | Choose option...nonetextparagraphsstory |
+| noBorderRadius | 
+
+Setting to true will ignore the border radius set in the theme and set it to zero.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| noGutter | 
+
+Removes bottom margin from last child of the panel element if true.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| padding | 
+
+Padding of the panel.
+
+union
+
+
+
+ | 
+
+'md'
+
+ | \- |
+| stretch | 
+
+If `true`, the panel background will fill the height of the container.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| textAlign | 
+
+Text alignment for panel.
+
+union
+
+
+
+ | 
+
+'inherit'
+
+ | Set object |
+
+### Responsive padding
 
 The `padding` prop can take an object that takes five key/value pairs that correlate with the IDS breakpoints.
 
+[](./iframe.html?id=components-panel--responsive-padding)
+
 Current breakpoint: **xl** breakpoint (1200px - 1499px).
 
 padding={{
@@ -132,9 +372,7 @@ padding={{
   "lg": "lg"
 }}
 
-Hide code
-
-\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
+```
 
 <IressPanel
   noGutter
@@ -147,7 +385,7 @@ Hide code
 \>
   <p\>
     Current breakpoint:{' '}
-    <CurrentBreakpoint />
+    <kn />
     .  </p\>
   <p\>
     <pre\>
@@ -157,9 +395,109 @@ Hide code
   </p\>
 </IressPanel\>
 
-Copy
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| background | 
+Panel background - controls the background style (set via the theme).
+
+union
+
+
+
+ | 
+
+'default'
+
+ | Set object |
+| children | 
+
+Content to be grouped using a panel.
+
+ReactNode
+
+
+
+ | \- | \- |
+| noBorderRadius | 
 
-### [](#variable-padding)Variable padding
+Setting to true will ignore the border radius set in the theme and set it to zero.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| noGutter | 
+
+Removes bottom margin from last child of the panel element if true.
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| padding | 
+
+Padding of the panel.
+
+union
+
+
+
+ | 
+
+'md'
+
+ | 
+
+RAW
+
+padding :
+
+{
+
+*   xs : "none"
+*   sm : "sm"
+*   md : "md"
+*   lg : "lg"
+
+}
+
+
+
+
+
+
+
+ |
+| stretch | 
+
+If `true`, the panel background will fill the height of the container.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| textAlign | 
+
+Text alignment for panel.
+
+union
+
+
+
+ | 
+
+'inherit'
+
+ | Set object |
+
+### Variable padding
 
 If you need finer control of a panel's padding, for example, you need different padding sizes on different axes, you can pass a `VariablePadding` object to the `padding` prop.
 
@@ -174,6 +512,8 @@ A VariablePadding object can consist of any of the following keys:
 
 Variable padding can also be passed as part of a responsive object.
 
+[](./iframe.html?id=components-panel--variable-padding)
+
 Variable padding
 ----------------
 
@@ -204,11 +544,12 @@ padding={{
   }
 }}
 
-Hide code
-
-\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
+```
 
-<IressStack gutter\="md"\>
+<IressStack
+  ref\={undefined}
+  gutter\="md"
+\>
   <IressPanel
     noGutter
     padding\={{
@@ -248,7 +589,7 @@ Hide code
       Responsive variable padding    </h2\>
     <p\>
       Current breakpoint:{' '}
-      <CurrentBreakpoint />
+      <kn />
       .    </p\>
     <p\>
       <pre\>
@@ -259,14 +600,148 @@ Hide code
   </IressPanel\>
 </IressStack\>
 
-Copy
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| background | 
+Panel background - controls the background style (set via the theme).
+
+union
 
-### [](#text-align)Text align
+
+
+ | 
+
+'default'
+
+ | Set object |
+| children | 
+
+Content to be grouped using a panel.
+
+ReactNode
+
+
+
+ | \- | \- |
+| noBorderRadius | 
+
+Setting to true will ignore the border radius set in the theme and set it to zero.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| noGutter | 
+
+Removes bottom margin from last child of the panel element if true.
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| padding | 
+
+Padding of the panel.
+
+union
+
+
+
+ | 
+
+'md'
+
+ | 
+
+RAW
+
+padding :
+
+{
+
+*   xs : "none"
+*   sm : "sm"
+*   md : "md"
+*   lg : "lg"
+
+}
+
+
+
+
+
+
+
+ |
+| responsivePadding | 
+
+object
+
+
+
+ | \- | 
+
+RAW
+
+responsivePadding :
+
+{
+
+*   xs :
+    
+    {...} 4 keys
+    
+*   xl :
+    
+    {...} 4 keys
+    
+
+}
+
+
+
+
+
+
+
+ |
+| stretch | 
+
+If `true`, the panel background will fill the height of the container.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| textAlign | 
+
+Text alignment for panel.
+
+union
+
+
+
+ | 
+
+'inherit'
+
+ | Set object |
+
+### Text align
 
 Text alignment can be set to `inherit`, `left`, `center`, `right` or `justify`.
 
 It's default value is `inherit`.
 
+[](./iframe.html?id=components-panel--text-align)
+
 inherit
 -------
 
@@ -296,9 +771,7 @@ justify
 
 His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.
 
-Hide code
-
-\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
+```
 
 <IressStack gutter\="md"\>
   <IressPanel textAlign\="center"\>
@@ -327,17 +800,96 @@ Hide code
     His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.  </IressPanel\>
 </IressStack\>
 
-Copy
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| background | 
+Panel background - controls the background style (set via the theme).
+
+union
+
+
+
+ | 
+
+'default'
+
+ | Set object |
+| children | 
+
+Content to be grouped using a panel.
+
+ReactNode
+
+
+
+ | \- | Choose option...nonetextparagraphsstory |
+| noBorderRadius | 
+
+Setting to true will ignore the border radius set in the theme and set it to zero.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| noGutter | 
+
+Removes bottom margin from last child of the panel element if true.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| padding | 
+
+Padding of the panel.
+
+union
+
+
+
+ | 
+
+'md'
+
+ | Set object |
+| stretch | 
 
-### [](#stretch)Stretch
+If `true`, the panel background will fill the height of the container.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| textAlign | 
+
+Text alignment for panel.
+
+union
+
+
+
+ | 
+
+'inherit'
+
+ | \- |
+
+### Stretch
 
 Panel can be set to fill its available container height by setting the `stretch` prop.
 
-His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.
+[](./iframe.html?id=components-panel--stretch)
 
-Hide code
+His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.
 
-\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
+```
 
 <IressStack
   style\={{
@@ -348,33 +900,178 @@ Hide code
     His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.  </IressPanel\>
 </IressStack\>
 
-Copy
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| background | 
+Panel background - controls the background style (set via the theme).
+
+union
+
+
+
+ | 
+
+'default'
+
+ | Set object |
+| children | 
+
+Content to be grouped using a panel.
+
+ReactNode
+
+
+
+ | \- | Choose option...nonetextparagraphsstory |
+| noBorderRadius | 
+
+Setting to true will ignore the border radius set in the theme and set it to zero.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| noGutter | 
+
+Removes bottom margin from last child of the panel element if true.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| padding | 
+
+Padding of the panel.
+
+union
+
+
+
+ | 
+
+'md'
+
+ | Set object |
+| stretch | 
+
+If `true`, the panel background will fill the height of the container.
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| textAlign | 
 
-### [](#noborderradius)`noBorderRadius`
+Text alignment for panel.
+
+union
+
+
+
+ | 
+
+'inherit'
+
+ | Set object |
+
+### `noBorderRadius`
 
 Panels can inherit the theme's border radius which may result in an undesirable look to those components that use panels internally such as slideouts. To remove rounding from all panels set the prop `noBorderRadius` to ensure all panels have a zero border radius.
 
-His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.
+[](./iframe.html?id=components-panel--no-border-radius)
 
-Hide code
+His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.
 
-\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
+```
 
 <IressPanel noBorderRadius\>
   His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.
 </IressPanel\>
 
-Copy
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| background | 
+Panel background - controls the background style (set via the theme).
+
+union
+
+
+
+ | 
+
+'default'
+
+ | Set object |
+| children | 
+
+Content to be grouped using a panel.
+
+ReactNode
+
+
+
+ | \- | Choose option...nonetextparagraphsstory |
+| noBorderRadius | 
+
+Setting to true will ignore the border radius set in the theme and set it to zero.
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| noGutter | 
+
+Removes bottom margin from last child of the panel element if true.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| padding | 
+
+Padding of the panel.
+
+union
+
+
+
+ | 
+
+'md'
+
+ | Set object |
+| stretch | 
+
+If `true`, the panel background will fill the height of the container.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| textAlign | 
+
+Text alignment for panel.
+
+union
+
+
+
+ | 
 
-On this page
+'inherit'
 
-*   [Overview](#overview)
-*   [Props](#props)
-*   [Examples](#examples)
-    *   [Background](#background)
-    *   [Padding](#padding)
-    *   [Responsive padding](#responsive-padding)
-    *   [Variable padding](#variable-padding)
-    *   [Text align](#text-align)
-    *   [Stretch](#stretch)
-    *   [noBorderRadius](#noborderradius)
+ | Set object |