@iress-oss/ids-mcp-server 0.0.1-dev.0

package/generated/docs/components-panel-docs.md

@@ -0,0 +1,380 @@
+[](#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.
+
+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\>
+  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
+
+[](#examples)Examples
+---------------------
+
+### [](#background)Background
+
+The `background` prop allows you to vary the styling of the panel component. It has four variants.
+
+default
+-------
+
+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.
+
+alt
+---
+
+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.
+
+page
+----
+
+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.
+
+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"\>
+    <IressText element\="h2"\>
+      default    </IressText\>
+    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\>
+  <IressPanel background\="alt"\>
+    <IressText element\="h2"\>
+      alt    </IressText\>
+    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\>
+  <IressPanel background\="page"\>
+    <IressText element\="h2"\>
+      page    </IressText\>
+    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\>
+  <IressPanel background\="transparent"\>
+    <IressText element\="h2"\>
+      transparent    </IressText\>
+    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
+
+### [](#padding)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`.
+
+none
+----
+
+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.
+
+sm
+--
+
+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.
+
+md
+--
+
+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.
+
+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"\>
+    <IressText element\="h2"\>
+      none    </IressText\>
+    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\>
+  <IressPanel padding\="sm"\>
+    <IressText element\="h2"\>
+      sm    </IressText\>
+    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\>
+  <IressPanel padding\="md"\>
+    <IressText element\="h2"\>
+      md    </IressText\>
+    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\>
+  <IressPanel padding\="lg"\>
+    <IressText element\="h2"\>
+      lg    </IressText\>
+    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
+
+### [](#responsive-padding)Responsive padding
+
+The `padding` prop can take an object that takes five key/value pairs that correlate with the IDS breakpoints.
+
+Current breakpoint: **xl** breakpoint (1200px - 1499px).
+
+padding={{
+  "xs": "none",
+  "sm": "sm",
+  "md": "md",
+  "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
+  padding\={{
+    lg: 'lg',
+    md: 'md',
+    sm: 'sm',
+    xs: 'none'
+  }}
+\>
+  <p\>
+    Current breakpoint:{' '}
+    <CurrentBreakpoint />
+    .  </p\>
+  <p\>
+    <pre\>
+      {\`padding={{
+        "xs": "none",        "sm": "sm",        "md": "md",        "lg": "lg"      }}\`}
+    </pre\>
+  </p\>
+</IressPanel\>
+
+Copy
+
+### [](#variable-padding)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.
+
+A VariablePadding object can consist of any of the following keys:
+
+*   `x`: horizontal
+*   `y`: vertical
+*   `t`: top
+*   `r`: right
+*   `b`: bottom
+*   `l`: left
+
+Variable padding can also be passed as part of a responsive object.
+
+Variable padding
+----------------
+
+padding={{
+  "xs": "none",
+  "sm": "sm",
+  "md": "md",
+  "lg": "lg"
+}}
+
+Responsive variable padding
+---------------------------
+
+Current breakpoint: **xl** breakpoint (1200px - 1499px).
+
+padding={{
+  "xs": {
+    "b": "sm",
+    "t": "lg",
+    "r": "sm",
+    "l": "lg"
+  },
+  "xl": {
+    "b": "none",
+    "t": "sm",
+    "r": "lg",
+    "l": "sm"
+  }
+}}
+
+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
+    noGutter
+    padding\={{
+      lg: 'lg',
+      md: 'md',
+      sm: 'sm',
+      xs: 'none'
+    }}
+  \>
+    <h2\>
+      Variable padding    </h2\>
+    <p\>
+      <pre\>
+        {\`padding={{
+          "xs": "none",          "sm": "sm",          "md": "md",          "lg": "lg"        }}\`}
+      </pre\>
+    </p\>
+  </IressPanel\>
+  <IressPanel
+    noGutter
+    padding\={{
+      xl: {
+        b: 'none',
+        l: 'sm',
+        r: 'lg',
+        t: 'sm'
+      },
+      xs: {
+        b: 'sm',
+        l: 'lg',
+        r: 'sm',
+        t: 'lg'
+      }
+    }}
+  \>
+    <h2\>
+      Responsive variable padding    </h2\>
+    <p\>
+      Current breakpoint:{' '}
+      <CurrentBreakpoint />
+      .    </p\>
+    <p\>
+      <pre\>
+        {\`padding={{
+          "xs": {            "b": "sm",            "t": "lg",            "r": "sm",            "l": "lg"          },          "xl": {            "b": "none",            "t": "sm",            "r": "lg",            "l": "sm"          }        }}\`}
+      </pre\>
+    </p\>
+  </IressPanel\>
+</IressStack\>
+
+Copy
+
+### [](#text-align)Text align
+
+Text alignment can be set to `inherit`, `left`, `center`, `right` or `justify`.
+
+It's default value is `inherit`.
+
+inherit
+-------
+
+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.
+
+### Inherits center align of parent panel
+
+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.
+
+left
+----
+
+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.
+
+center
+------
+
+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.
+
+right
+-----
+
+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.
+
+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"\>
+    <IressText element\="h2"\>
+      inherit    </IressText\>
+    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 textAlign\="inherit"\>
+      <h3\>
+        Inherits center align of parent panel      </h3\>
+      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\>
+  </IressPanel\>
+  <IressPanel textAlign\="left"\>
+    <IressText element\="h2"\>
+      left    </IressText\>
+    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\>
+  <IressPanel textAlign\="center"\>
+    <IressText element\="h2"\>
+      center    </IressText\>
+    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\>
+  <IressPanel textAlign\="right"\>
+    <IressText element\="h2"\>
+      right    </IressText\>
+    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\>
+  <IressPanel textAlign\="justify"\>
+    <IressText element\="h2"\>
+      justify    </IressText\>
+    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
+
+### [](#stretch)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.
+
+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
+  style\={{
+    height: '200px'
+  }}
+\>
+  <IressPanel stretch\>
+    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
+
+### [](#noborderradius)`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.
+
+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 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
+
+On this page
+
+*   [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)

package/generated/docs/components-placeholder-docs.md

@@ -0,0 +1,27 @@
+[](#placeholder)Placeholder
+===========================
+
+Overview
+--------
+
+A placeholder is a UI element that allows you to reserve space for content that has not been created yet, usually used for prototyping.
+
+Placeholder
+
+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; }
+
+<IressPlaceholder
+  height\="300"
+  width\="300"
+\>
+  Placeholder
+</IressPlaceholder\>
+
+Copy
+
+On this page
+
+*   [Overview](#overview)
+*   [Props](#props)